コンソールの豊富な書式設定ツールを知っています：スペースとの整列、テキストと背景の現在の色の変更。数行を印刷したい場合は、これで十分です。ただし、スペースによるハイフネーションの欠如は時には面倒です。テーブルを表示する必要がある場合は、列の幅を手動で計算する必要があり、多くの場合、幅をハードコードするだけです。出力を色付けする必要がある場合は、無限の切り替えと色回復を使用してテキスト出力をストリークする必要があります。ハイフネーションを使用してテキストを表示するか、上記のすべてを組み合わせる必要がある場合...

コードはすぐに判読不能な混乱に変わりますが、それはわかりません。どこにロジックがあり、どこにテキストがあり、どこにフォーマットがあります。これはひどいです！ GUIを作成するとき、MV *パターン、バインディング、その他のクールなものなど、モダンデザインの魅力を自由に使用できます。 GUIを使用した後、コンソールアプリケーションの作成は、石器時代に戻ることに似ています。

CsConsoleFormatが助けになります！

特徴

HTMLの要素 ：段落、スパン、表、リスト、境界線、区切り文字。
レイアウト ：テーブル（グリッド）、パイル（スタック）、ベルクロ（ドック）、ハイフネーション（ラップ）、アブソリュート（キャンバス）。
テキストの書式設定 ：テキストと背景色、ハイフネーション、ワードラッピング 。
Unicode文字フォーマット ：ハイフン、ソフトハイフン、改行なしハイフン、スペース、改行なしスペース、幅ゼロのスペース。
いくつかの構文 （以下を参照）：
- WPFのように ：プロパティチェーン（1回限りのバインディング）、リソース、コンバーター、添付プロパティの値を取得するXAML、リソースからドキュメントを読み込む。
- LINQ to XMLのように ：C＃オブジェクト初期化子、拡張メソッドまたはインデクサーによる添付プロパティの設定、要素のリストを折りたたみ、オブジェクトを文字列に変換してサブ要素を追加します。
描画：擬似グラフィックシンボル、色変換（より明るい、より暗い）、テキスト出力に基づく幾何学的プリミティブ（線、長方形）。
国際化 ：文化は、任意の要素のレベルで再定義できます。
多くの形式にエクスポート ：エスケープシーケンスを含むテキスト、書式なしテキスト、HTML。 RTF、XPF、WPF FixedDocument、WPF FlowDocument（WPFが必要）。
JetBrains R＃注釈 ：CanBeNull、NotNull、ValueProviderなど。
WPF ：ドキュメント、ドキュメントコンバーター、イメージインポートを表示するためのコントロール。

使い慣れたクラスOrder、OrderItem、Customerがあるとします。注文を詳細に表示するドキュメントを作成しましょう。使用可能な構文は2つあり、いずれかを使用することも、組み合わせることもできます。

XAML （a la WPF）：

<Document xmlns="urn:alba:cs-console-format" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"> <Span Background="Yellow" Text="Order #"/> <Span Text="{Get OrderId}"/> <Br/> <Span Background="Yellow" Text="Customer: "/> <Span Text="{Get Customer.Name}"/> <Grid Color="Gray"> <Grid.Columns> <Column Width="Auto"/> <Column Width="*"/> <Column Width="Auto"/> </Grid.Columns> <Cell Stroke="Single Wide" Color="White">Id</Cell> <Cell Stroke="Single Wide" Color="White">Name</Cell> <Cell Stroke="Single Wide" Color="White">Count</Cell> <Repeater Items="{Get OrderItems}"> <Cell> <Span Text="{Get Id}"/> </Cell> <Cell> <Span Text="{Get Name}"/> </Cell> <Cell Align="Right"> <Span Text="{Get Count}"/> </Cell> </Repeater> </Grid> </Document>

C＃（a LINQ to XML）：

 using static System.ConsoleColor; var headerThickness = new LineThickness(LineWidth.Single, LineWidth.Wide); var doc = new Document() .AddChildren( new Span("Order #") { Color = Yellow }, Order.Id, "\n", new Span("Customer: ") { Color = Yellow }, Order.Customer.Name, new Grid { Color = Gray } .AddColumns( new Column { Width = GridLength.Auto }, new Column { Width = GridLength.Star(1) }, new Column { Width = GridLength.Auto } ) .AddChildren( new Cell { Stroke = headerThickness } .AddChildren("Id"), new Cell { Stroke = headerThickness } .AddChildren("Name"), new Cell { Stroke = headerThickness } .AddChildren("Count"), Order.OrderItems.Select(item => new[] { new Cell() .AddChildren(item.Id), new Cell() .AddChildren(item.Name), new Cell { Align = HorizontalAlignment.Right } .AddChildren(item.Count), }) ) );

構文選択

XAML （a WPF）は、モデルとビューを分離することを明確にします。これは美徳と見なすことができます。ただし、XAMLは厳密に型指定またはコンパイルされていないため、実行時エラーが発生する可能性があります。構文はあいまいです。一方で、XMLは冗長（ <Grid><Grid.Columns><Column/></Grid.Columns></Grid>

）であり、一方で、列挙レコード（ Color="White"

）で保存できます。コンバーターを使用します（ Stroke="Single Wide"

）。

MonoのXAMLライブラリはあいまいで制限されています。クロスプラットフォームアプリケーションが必要な場合、XAMLを使用すると問題が発生する可能性があります。ただし、WPFに精通していて、Windowsサポートのみが必要な場合は、XAMLは自然なはずです。 .NET Standardのバージョンでは、Portable.Xamlライブラリを使用しています。これはわずかに優れているはずですが、これまでのところ、戦闘状態で十分にテストされていません。

一般的に、XAMLはVisual StudioとReSharperでのみ限定的にサポートされています。構文の強調表示とコード補完は通常機能しますが、バインディングパスの完了は考慮せず、エラーが強調表示されない場合もあります。ただし、XAMLに精通している人にとっては、これは新しいことではありません。

C＃（a LINQ to XML）を使用すると、サブ要素を追加するときにLINQと折りたたみリストにより、コード内でさまざまな変換を直接実行できます。 using static

をサポートしusing static

C＃6 using static

しusing static

場合、いくつかの列挙を減らすことができます。弱い型付けを持つ唯一の場所は、 AddChildren(params object[])

拡張AddChildren(params object[])

（その使用はオプションです）。

コードでのドキュメントの作成は、どの開発環境でも完全にサポートされていますが、ReSharperを使用すると、多くのページで1つの式で巨大なドキュメントを作成しようとするとブレーキがかかります（9番目のバージョンでは、スタジオがハングアップすることがありますが、おそらく今では関係ありません）。

実際の例

Githubリポジトリには、システム内の現在のプロセスを表示し、新しいプロセスを起動するためのサンプルコンソールアプリケーションがあります。次のようになります。

すべてのフォーマットは、1つの小さくてクリアなファイルに収まります。ここでは、可能なすべての方法で、メッセージ出力、エラー出力、プロセステーブルのフォーマット、およびヘルプ出力を確認できます。

コマンドラインを処理するには、人気のあるCommandLineParserライブラリ、そこからのBaseOptionAttribute

クラスが使用され、1つのコマンドまたはパラメーターに関する情報が含まれます。ここではC＃6のいくつかの機能が使用されていますが、残りのコードについては特別な説明は必要ないと思います。

 using System.Collections.Generic; using System.Diagnostics; using System.Linq; using CommandLine; using static System.ConsoleColor; internal class View { private static readonly LineThickness StrokeHeader = new LineThickness(LineWidth.None, LineWidth.Wide); private static readonly LineThickness StrokeRight = new LineThickness(LineWidth.None, LineWidth.None, LineWidth.Single, LineWidth.None); public Document Error (string message, string extra = null) => new Document { Background = Black, Color = Gray } .AddChildren( new Span("Error\n") { Color = Red }, new Span(message) { Color = White }, extra != null ? $"\n\n{extra}" : null ); public Document Info (string message) => new Document { Background = Black, Color = Gray } .AddChildren(message); public Document ProcessList (IEnumerable<Process> processes) => new Document { Background = Black, Color = Gray } .AddChildren( new Grid { Stroke = StrokeHeader, StrokeColor = DarkGray } .AddColumns( new Column { Width = GridLength.Auto }, new Column { Width = GridLength.Auto, MaxWidth = 20 }, new Column { Width = GridLength.Star(1) }, new Column { Width = GridLength.Auto } ) .AddChildren( new Cell { Stroke = StrokeHeader, Color = White } .AddChildren("Id"), new Cell { Stroke = StrokeHeader, Color = White } .AddChildren("Name"), new Cell { Stroke = StrokeHeader, Color = White } .AddChildren("Main Window Title"), new Cell { Stroke = StrokeHeader, Color = White } .AddChildren("Private Memory"), processes.Select(process => new[] { new Cell { Stroke = StrokeRight } .AddChildren(process.Id), new Cell { Stroke = StrokeRight, Color = Yellow, TextWrap = TextWrapping.NoWrap } .AddChildren(process.ProcessName), new Cell { Stroke = StrokeRight, Color = White, TextWrap = TextWrapping.NoWrap } .AddChildren(process.MainWindowTitle), new Cell { Stroke = LineThickness.None, Align = HorizontalAlignment.Right } .AddChildren(process.PrivateMemorySize64.ToString("n0")), }) ) ); public Document HelpOptionsList (IEnumerable<BaseOptionAttribute> options, string instruction) => new Document { Background = Black, Color = Gray } .AddChildren( new Div { Color = White } .AddChildren(instruction), "", new Grid { Stroke = LineThickness.None } .AddColumns(GridLength.Auto, GridLength.Star(1)) .AddChildren(options.Select(OptionNameAndHelp)) ); public Document HelpAllOptionsList (ILookup<BaseOptionAttribute, BaseOptionAttribute> verbsWithOptions, string instruction) => new Document { Background = Black, Color = Gray } .AddChildren( new Span($"{instruction}\n") { Color = White }, new Grid { Stroke = LineThickness.None } .AddColumns(GridLength.Auto, GridLength.Star(1)) .AddChildren( verbsWithOptions.Select(verbWithOptions => new object[] { OptionNameAndHelp(verbWithOptions.Key), new Grid { Stroke = LineThickness.None, Margin = new Thickness(4, 0, 0, 0) } .Set(Grid.ColumnSpanProperty, 2) .AddColumns(GridLength.Auto, GridLength.Star(1)) .AddChildren(verbWithOptions.Select(OptionNameAndHelp)), }) ) ); private static object[] OptionNameAndHelp (BaseOptionAttribute option) => new[] { new Div { Margin = new Thickness(1, 0, 1, 1), Color = Yellow, MinWidth = 14 } .AddChildren(GetOptionSyntax(option)), new Div { Margin = new Thickness(1, 0, 1, 1) } .AddChildren(option.HelpText), }; private static object GetOptionSyntax (BaseOptionAttribute option) { if (option is VerbOptionAttribute) return option.LongName; else if (option.ShortName != null) { if (option.LongName != null) return $"--{option.LongName}, -{option.ShortName}"; else return $"-{option.ShortName}"; } else if (option.LongName != null) return $"--{option.LongName}"; else return ""; } }

魔法

これらの要素の積み上げはどのように構築され、ドキュメントになりますか？鳥瞰図：

論理ツリーの構築：LINQからXMLへの変換を使用して、 IEnumerable

はAddChidlren

およびその他のパラメーターでAddChidlren

ます。
ビジュアルツリーの構築：各要素は、エンジンにとって便利なビューに変換されます。
要素のサイズの計算：各要素は、必要なスペースと子に与えるスペースを決定します。
要素の位置の計算：要素は、子を自分の中に配置する座標を決定します。
コンソールをシミュレートする仮想バッファーへの要素のレンダリング。
バッファーを実際のコンソールまたはその他の形式にレンダリングします。

そして今、各アイテムについての詳細。

論理ツリー

XAMLでのドキュメントの構築は、 {Binding Foo, Mode=OneTime}

代わりに{Get Foo}

と{StaticResource Bar}

代わりに{StaticResource Bar}

{Res Bar}

のみを使用して、WPFに似ています。ここのコンバーターはクラスではなく、 {Call Baz}

介してアクセスできる単一のメソッドです。 WPFの場合と同様に、1、2、または4つの数字の文字列を使用して、マージンとパディングが設定されます。添付プロパティはクラス名で指定され、プロパティはドットで指定されます。要するに、WPFに精通している人にとっては、すべてが身近で明確でなければなりません。

C＃でのドキュメントの構築はLINQ to XML（System.Xml.Linq）の精神で行われ、 params object[]

引数を持つコンストラクターの代わりにAddChildren

メソッド（およびAddColumns

）のみが使用されます。利用可能な変換は次のとおりです。

null

要素は完全に無視されます。特に、これにより、三項演算子を使用して条件付きでいくつかの要素を含めることができます。
IEnumerable

シーケンスは展開され、その要素が代わりに追加されます。シーケンスはネストできます。たとえば、これにより、 AddChildren

1回の呼び出しでSelect

を使用して、テーブルAddChildren

とそのコンテンツを作成できます。
要素ではないオブジェクトは文字列に変換されます。可能であれば（ IFormattable

サポート）、要素のロケールを考慮します。

WPFに不慣れな人にとって、 添付プロパティの概念はなじみがないかもしれません。肝心なのは、要素の既存のプロパティを補完する必要がある場合があることです。たとえば、Canvasは独自のプロパティと要素の座標プロパティの両方を持っています。これらはSet拡張メソッドを使用して便利に設定されnew Div(...).Set(Canvas.LeftProperty, 10)

： new Div(...).Set(Canvas.LeftProperty, 10)

。

ビジュアルツリー

要素は、初期のHTMLと同様に、ブロックと小文字の2つの大きなグループに分けられます。パターンに応じて両方として機能するジェネレーター要素（つまり、1つの要素）もあります。

元の要素のツリーは、WPFの観点からは論理的です。つまり、プログラマが作成した形式で要素が含まれています。そして、それは取り返しのつかないほど視覚的なものに変わります。つまり、エンジンに便利な形式の要素を含んでいます（大まかに言うと、高レベルの抽象化は、実際に自分自身を表現できる要素に変換されます）。この変換には以下が含まれます。

どの要素もその内容を完全に置き換えることができます。たとえば、Repeaterジェネレーターはテンプレートを複製し、それ自体を除外しながら数回繰り返し、Listブロックはグリッド内のサブ要素を準備します。
複数のライン要素が次々に移動する場合、それらは1つのブロック（InlineContainer）に結合されます。
複数のブロック要素が次々に移動する場合、それらは1つのスタック（スタック）に結合されます。

また、一部の要素はWPFよりも暗黙的な変換を実行できることに注意してください。たとえば、グリッドはデフォルトでセルの自動連続配置を使用するため、テーブル行の作成と各セルの座標の指定が不要になります。

要素サイズの計算

すべての要素について、Measureメソッドが再帰的に呼び出されます。このメソッドでは、親が子供にどのくらいの空き領域を割り当てるかを子供に伝え、子供が望む量に答えます。子供は、提案された以上の数を要求する場合がありますが、より多くを要求した場合、親は図を表示します。無限では、親は提供されていてもイチジクを表示します。

子を配置するための複雑なロジックを持つ要素は、このステージを使用してほとんどの作業を実行します（たとえば、小文字の要素のコンテナは、ハイフネーションと色に基づいてテキストをフォーマットします）。

要素の位置の計算

すべての要素について、Arrangeは再帰的に呼び出され、各親は子の配置に関与します。

要素のレンダリング

Renderはすべての要素に対して再帰的に呼び出され、各要素はConsoleBuffer仮想コンソールバッファーに表示されます。 ConsoleBufferクラスは、HDC、System.Windows.Forms.Graphics、Graphics.TCanvasなどに似ています。テキスト、描画などを表示するためのメソッドが含まれています。

バッファは利用可能な領域が限られた便利な形式で各要素に提供されるので、気にすることなく座標（0; 0）-（幅;高さ）で自分を描くことができます。

バッファレンダリング

この段階では、バッファはテキストと色の付いた長方形の領域です。意図したとおりにコンソールに表示するか、HTMLに変換したり、WPFウィンドウに表示したりして、他の何かで作成できます。 IRenderTargetを実装するクラスがこれを担当します。

そして、それはどれほど難しいですか？

簡単です。難しいのは、ConsoleFramework、さらにはAvaloniaです。障害も双方向性もありません。文書を書くだけで、要素を書くだけです。すべての木は使い捨てです。

実際には、 AddChildren

を使用する方法（そして試してみる方法）だけでなく、基本要素、特にGrid

を使用するためのパターンを知るだけで済みます。他のすべてが必要なのは、独自の要素を作成する場合のみです。

また、独自の要素を作成する場合でも、たとえば、リストはグリッドを介して実装され、すべてのロジックが16行の1つの簡単な方法に収まるように、自分自身の表示方法を既に知っている要素への単純な変換に制限することができます。

同様に

これはすべて、.NET 4.0 + 、. NET Standard 1.3+で機能します。純粋主義者のために、XAMLサポートのないバージョンがあります。 .NET 3.5のサポートが含まれているため、保守的です。

Colorful.ConsoleのFIGletフォントをサポートするパッケージがありますが、Colorful.Consoleは通常の方法でFIGletを実行する方法を知らないため、この依存関係は誤りでした。後で、Figgleパッケージに基づくサポート、または独自の実装のいずれかが提供されます。

リポジトリには、中程度のスコールをカバーする2つのサンプルプロジェクトとテストも含まれています。

免許

Apache 2.0 コードの一部は、MITライセンスの下でIgor Kostominによって書かれたConsoleFrameworkライブラリから借用されています。

参照資料

guthubのCsConsoleFormat-並べ替え
NuGetのCsConsoleFormat-バイナリ

CsConsoleFormat：コンソールの新しい方法でのフォーマット（.NET）

特徴