icecream cpp
v0.3.1
IceCream-CPPは、C ++ 11以降での印刷デバッグを支援するための小さな（シングルヘッダー）ライブラリです。
コンパイラエクスプローラーで試してみてください！
コンテンツ
IceCreamを使用して、実行検査：
auto my_function ( int i, double d) -> void
{
std::cout << " 1 " << std::endl;
if (condition)
std::cout << " 2 " << std::endl;
else
std::cout << " 3 " << std::endl;
}代わりにコード化できます：
auto my_function ( int i, double d) -> void
{
IC ();
if (condition)
IC ();
else
IC ();
}そして、次のようなものを印刷します
ic| test.cpp:34 in "void my_function(int, double)"
ic| test.cpp:36 in "void my_function(int, double)"
また、次のような変数検査
std::cout << " a: " << a
<< " , b: " << b
<< " , sum(a, b): " << sum(a, b)
<< std::endl;次のことを簡素化できます。
IC (a, b, sum(a, b));そして印刷します：
ic| a: 7, b: 2, sum(a, b): 9
また、関心のある時点でIC_V()関数を挿入することにより、範囲ビューパイプライン（STL範囲と範囲-V3の両方）を介して流れるデータを検査することもできます。
auto rv = std::vector< int >{ 1 , 0 , 2 , 3 , 0 , 4 , 5 }
| vws::split( 0 )
| IC_V()
| vws::enumerate; rvを反復すると、印刷が表示されます。
ic| range_view_63:16[0]: [1]
ic| range_view_63:16[1]: [2, 3]
ic| range_view_63:16[2]: [4, 5]
このライブラリは、元のPython IceCreamライブラリに触発されています。
IceCream-CPPは、STLをその唯一の依存関係として持つ1つのファイル、ヘッダーのみのライブラリです。それを使用する最も差し迫った方法は、 icecream.hppヘッダーをプロジェクトにコピーすることです。
CMAKEプロジェクトファイルとともにシステムを広くインストールするには、ICECREAM-CPPプロジェクトルートディレクトリでこれらのコマンドを実行します。
mkdir build
cd build
cmake ..
cmake --install .nixを使用している場合、Icecream-cppはフレーク入力として含めることができます
inputs . icecream-cpp . url = "github:renatoGarcia/icecream-cpp" ; IceCream-CPPフレークはオーバーレイを定義しているため、 nixpkgsをインポートするときに使用できます。
import nixpkgs {
system = "x86_64-linux" ;
overlays = [
icecream-cpp . overlays . default
] ;
}これを行うと、 icecream-cpp派生がnixpkgs属性セットに追加されます。
フレークプロジェクトでIcecream-CPPを使用する方法の実用的な例はこちらです。
リリースバージョンはコナンでも入手できます。
conan install icecream-cpp/0.3.1@cmakeを使用する場合：
find_package (IcecreamCpp)
include_directories ( ${IcecreamCpp_INCLUDE_DIRS} )インクルードパスリスト内にインストールされたディレクトリを追加します。
ソースファイルにicecream.hppヘッダーを含めた後：
# include < icecream.hpp > ICECREAM-CPPライブラリのすべての機能は、関数IC 、 IC_A 、およびIC_Vによって利用可能になります。それぞれのカウンターパートIC_F 、 IC_FA 、およびIC_FVと一緒に。それは同じように振る舞いますが、出力フォーマット文字列を最初の引数として受け入れます。
IC 、ICECREAM関数の中で最も単純なものです。引数なしで呼び出された場合、プレフィックス、ソースファイル名、現在の行番号、および現在の関数の署名を印刷します。コード：
auto my_function ( int foo, double bar) -> void
{
// ...
IC ();
// ...
}印刷します：
ic| test.cpp:34 in "void my_function(int, double)"
引数で呼び出されると、プレフィックス、これらの引数名、およびその値が印刷されます。コード：
auto v0 = std::vector< int >{ 1 , 2 , 3 };
auto s0 = std::string{ " bla " };
IC (v0, s0, 3.14 );印刷します：
ic| v0: [1, 2, 3], s0: "bla", 3.14: 3.14
バリアントIC_F IC関数と同じ動作をしますが、出力フォーマット文字列を最初の引数として受け入れます。
範囲ビューパイプライン（STL範囲と範囲V3の両方）を介して流れるデータを印刷するには、 IC_V関数を使用して、前のビューから受信した入力を印刷します。 IC_V関数は範囲ビューパイプライン内にあるため、各要素が生成され、印刷は怠lazに行われます。例えば：
namespace vws = std::views;
auto v0 = vws::iota( ' a ' ) | vws::enumerate | IC_V() | vws::take( 3 );
for ( auto e : v0)
{
// ...
}このコードでは、 v0が作成されたときに、それを繰り返すときに、何も印刷されません。 forループの各反復で、出力が得られるまで1つの行が印刷されます。
ic| range_view_61:53[0]: (0, 'a')
ic| range_view_61:53[1]: (1, 'b')
ic| range_view_61:53[2]: (2, 'c')
注記
IceCream-CPPは、Range-V3ライブラリがインストールされているかどうかを検出しようとしますが、もしそうなら、それへのサポートは自動的に有効になります。ただし、C ++ 11およびC ++ 14を使用する場合、システムに範囲V3がある可能性がありますが、IceCreamはそれを見つけません。 range-v3へのサポートが有効になっていることを確認するには、 icecream.hppヘッダーを含める前に、macro ICECREAM_RANGE_V3を定義するだけです
IC_V関数には、 IC_V(name, projection) 2つのオプションパラメーターがあります。
印刷時にビューに使用される変数名。印刷レイアウトは次のとおりです。 <name>[<idx>]: <value> 。名前パラメーターが使用されていない場合、 <name>のデフォルト値はrange_view_<source_location>です。
コード：
vws::iota ( ' a ' ) | vws::enumerate | IC_V( " foo " ) | vws::take( 2 );反復したときに印刷します：
ic| foo[0]: (0, 'a')
ic| foo[1]: (1, 'b')
前のビューから要素を入力し、実際のオブジェクトを返すように印刷する必要がある呼び出し可能。
コード：
vws::iota ( ' a ' ) | vws::enumerate | IC_V([]( auto e){ return std::get< 1 >(e);}) | vws::take( 2 );反復したときに印刷します：
ic| range_view_61:53[0]: 'a'
ic| range_view_61:53[1]: 'b'
注記
IC_V関数は、以前のビューから受信されたとまったく同じように、変更されていない入力要素を次のビューに転送します。 projection関数によって行われたアクションはそれに影響を与えません。
Variant IC_FV IC_V関数と同じ動作を持っていますが、出力フォーマット文字列を最初の引数として受け入れます。
正確に1つの引数で呼び出された場合を除き、 IC関数はすべての入力引数でタプルを返します。 1つの引数で呼び出されると、引数自体が返されます。
これは、 ICを使用して呼び出しポイントで関数引数を検査できるように、この方法で行われ、コード変更はそれ以上ありません。コード：
my_function (IC(MyClass{})); MyClassオブジェクトは、 IC関数が存在していないのとまったく同じmy_functionに転送されます。 my_function 、 MyClassオブジェクトへのrvalue参照を受け取り続けます。
ただし、このアプローチは、関数に多くの引数がある場合、それほど実用的ではありません。コード：
my_function (IC(a), IC(b), IC(c), IC(d)); IC関数の4倍の書き込みに加えて、印刷された出力は4つの異なる線で分割されます。次のようなもの：
ic| a: 1
ic| b: 2
ic| c: 3
ic| d: 4
残念ながら、4つの引数をすべて1回のIC呼び出しで包むだけでは機能しません。返された値は(a, b, c, d)を備えたstd:::tupleになり、 my_function 4つの引数を期待します。
それを回避するために、 IC_A関数があります。 IC_A IC関数とまったく同じように動作しますが、最初の引数として呼ばれる可能性を受け取り、次のすべての引数を使用して呼び出し、その前にすべてを印刷します。その前の例コードは、次のように書き換えることができます。
IC_A (my_function, a, b, c, d);そして今回は印刷します：
ic| a: 1, b: 2, c: 3, d: 4
IC_A関数は、コール可能なものによって返されるのと同じ値を返します。コード：
auto mc = std::make_unique<MyClass>();
auto r = IC_A(mc->my_function, a, b);まったく同じ動作：
auto mc = std::make_unique<MyClass>();
auto r = mc-> my_function (a, b);ただし、 aとbの値を印刷します。
バリアントIC_FA IC_A関数と同じ動作をしますが、呼び出し可能な引数の前でさえ、出力フォーマット文字列を最初の引数として受け入れます。
印刷中に値をフォーマットする方法を構成することができます。次のコード：
auto a = int { 42 };
auto b = int { 20 };
IC_F ( " #X " , a, b);印刷します：
ic| a: 0X2A, b: 0X14
プレーンIC機能の代わりにIC_Fバリアントを使用する場合。それぞれIC_AとIC_Vの代わりにIC_FAとIC_FVを使用する場合、同様の結果が得られます。
フォーマット関数バリアント（ IC_FおよびIC_FA ）を使用する場合、同じフォーマット文字列がデフォルトですべての引数に適用されます。それは、明確なフォーマットを使用して引数を持ちたい場合、または議論に相互に有効な構文を持つ複数のタイプがある場合に問題になる可能性があります。したがって、特定の引数に個別のフォーマット文字列を設定するには、 IC_関数でそれを包むことができます。コード：
auto a = int { 42 };
auto b = int { 20 };
IC_F ( " #X " , a, IC_( " d " , b));印刷します：
ic| a: 0X2A, b: 20
IC_関数は、プレーンIC （またはIC_A ）関数内でも使用できます。
auto a = int { 42 };
auto b = int { 20 };
IC (IC_( " #x " , a), b);印刷します：
ic| a: 0x2a, b: 20
IC_関数呼び出しの最後の引数は、印刷されるものであり、最後に前に来る他のすべての引数は、 to_string関数を使用して文字列に変換され、結果のフォーマット文字列として連結されます。
auto a = float { 1.234 };
auto width = int { 7 };
IC (IC_( " *< " ,width, " .3 " , a));結果として、文字列"*<7.3"入力され、印刷されます。
ic| a: 1.23***
例の完全性のために、 IC_FAとIC_FVの使用は次のとおりです。
IC_FA ( " #x " , my_function, 10 , 20 );
auto rv0 = vws::iota( 0 ) | IC_FV( " [::2]:#x " , " bar " ) | vws::take( 5 );これは印刷されます：
ic| 10: 0xa, 20: 0x14
そして、 rv0で反復するとき：
ic| bar[0]: 0
ic| bar[2]: 0x2
ic| bar[4]: 0x4
IC_FおよびIC_FAに、フォーマット文字列の構文仕様は、印刷されるタイプTとICECREAMが使用するタイプの印刷戦略の両方に依存します。
IC_FVに、範囲形式の文字列と同じ場合のフォーマット構文。
C ++での文字エンコードは乱雑です。
char8_t 、 char16_t 、およびchar32_t文字列はよく定義されています。それらは能力があり、それぞれ8、16、および32ビットのユニコードコードユニットを保持しており、それぞれUTF-8、UTF-16、およびUTF-32でエンコードされています。
char文字列には、明確に定義されたコードユニットビットサイズ（ CHAR_BIT 、通常は8ビットで与えられます）がありますが、エンコードに関する要件はありません。
wchar_t文字列には、明確に定義されたコードユニットサイズも、そのエンコードに関する要件もありません。
このようなコードで：
auto const str = std::string{ " foo " };
std::cout << str;関心のある3つのキャラクターエンコードポイントがあります。最初のものでは、コンパイルする前に、そのコードは、不特定の「ソースエンコーディング」のソースファイルになります。 2番目の関心点では、コンパイルされたバイナリには、「Foo」文字列が不特定の「実行エンコード」に保存されます。最後に、3番目のポイントでは、 std::coutによって受信された「Foo」バイトストリームが最終的にシステムに転送されます。これは、ストリームが不特定の「出力エンコード」でエンコードされると予想します。
キャラクターエンコーディングの3つの関心点から、「実行エンコード」と「出力エンコード」の両方が、Icecream-CPPの内部作業に影響を及ぼし、両方で使用されるエンコードが何であるかを確実に知る方法はありません。この不確実性に直面して、採用された戦略は、データを適切なエンコードに変換して、必要に応じて独自の実装を使用できるようにする合理的なデフォルトトランスコーディング関数を提供します。
幅の広い文字列とユニコードの文字列タイプ（以下で説明）を除き、他のタイプを印刷するときは、「実行エンコード」にシリアル化されたテキストデータが表示されます。 「実行エンコード」は、「出力エンコード」と同じである場合と同じである場合があります。これは、構成された出力によって予想されるエンコードです。そのため、そのデータを出力に送信する前に、「出力エンコーディング」にあることを確認するためにそれをトランスコードする必要があります。そのため、テキストデータを出力に配信する前に、構成されたoutput_transcoder関数に送信します。これにより、正しい「出力エンコード」でエンコードされるようにする必要があります。
幅の広い文字列タイプとUnicodeの文字列タイプを印刷するときは、テキストデータが予想される「実行エンコード」からエンコードされている明確な文字である可能性があるため、もう1つのトランスコーディングレベルが必要です。そのため、追加のロジックが適用されて、出力に送信する前に文字列が「実行エンコード」にあることを確認します。これについては、広い文字列とUnicode文字列セクションでさらに説明します。
IceCream-CPP構成システムは、「範囲で階層化された」動作します。基底レベルでは、グローバルIC_CONFIGオブジェクトがあります。そのグローバルなインスタンスは、グローバル変数に予想されるように、ランニングプログラム全体で共有されています。デフォルト値にすべての設定オプションを使用して作成され、変更はプログラム全体で容易に見られます。
コードの任意の時点で、新しいIC_CONFIG変数をインスタンス化して、 IC_CONFIG_SCOPE()マクロを呼び出すことにより、現在のスコープで新しい構成レイヤーを作成できます。この新しいインスタンスのすべての構成オプションは、デフォルトで「Unset」状態になり、まだ設定されていないオプション値への要求は親に委任されます。そのリクエストは、最初のオプションが回答を設定するまで、親チェーンで上昇します。
すべての構成オプションは、 IC_CONFIGオブジェクトのアクセサのメソッドを使用して設定され、それらをチェーンすることができます。
IC_CONFIG
.prefix( " ic: " )
.show_c_string( false )
.line_wrap_width( 70 ); IC_CONFIG 、衝突を非常にありそうもないという面白い名前を持つ通常の変数です。 IC*(...)マクロを呼び出すと、他の通常の変数に適用された同じルールを使用して、資格のない名前検索を行うことにより、SCOPEでIC_CONFIGインスタンスを選択します。
コードで上記のすべてを要約するには：
auto my_function () -> void
{
IC_CONFIG. line_wrap_width ( 20 );
IC_CONFIG_SCOPE ();
IC_CONFIG. context_delimiter ( " | " );
IC_CONFIG. show_c_string ( true );
{
IC_CONFIG_SCOPE ();
IC_CONFIG. show_c_string ( false );
// A
}
// B
}行Aでは、 IC_CONFIGのline_wrap_width 、 context_delimiter 、およびshow_c_stringの値は次のとおりです20 、 "|" 、そしてfalse 。
最も内側のスコープブロックの閉鎖後、行Bでは、 IC_CONFIGのline_wrap_width 、 context_delimiter 、およびshow_c_stringの値は次のとおりです20 、 "|" 、そしてtrue 。
IC_CONFIGオブジェクトの読み取りおよび書き込み操作は、スレッドセーフです。
注記
グローバルインスタンス以外のIC_CONFIGの変更は、現在の範囲内でのみ見られます。結果として、これらの変更は、呼び出された関数の範囲に伝播しません。
IC(...)マクロの出力を有効または無効にし、デフォルトを有効にします。
auto is_enabled () const -> bool; auto enable () -> Config&;
auto disable () -> Config&;コード：
IC ( 1 );
IC_CONFIG.disable();
IC ( 2 );
IC_CONFIG.enable();
IC ( 3 );印刷します：
ic| 1: 1
ic| 3: 3
シリアル化されたテキストデータが印刷される場所を設定します。デフォルトでは、そのデータは、 std::cerrと同じ標準エラー出力に印刷されます。
auto output () const -> std::function<void(std::string const &)>; template < typename T>
auto output (T&& t) -> Config&;タイプTいずれかになる可能性があります：
std::ostreamから継承するクラス。push_back(char)を持つクラス。*it = 'c'たとえば、コード：
auto str = std::string{};
IC_CONFIG.output(str);
IC ( 1 , 2 ); str文字列に出力"ic| 1: 1, 2: 2n"を印刷します。
警告
Icecream-CPPは引数tの所有権を取得しないため、ユーザーが生きていることを確認するために、ユーザーが注意する必要があります。
各出力の前に印刷されるテキストを生成する関数。
auto prefix () const -> std::function<std::string()>; template < typename ... Ts>
auto prefix (Ts&& ...values) -> Config&;タイプTsは次のいずれかになります。
T() -> U 。ここで、 U operator<<(ostream&, U)を持っています。印刷されたプレフィックスは、これらすべての要素の連結になります。
コード：
IC_CONFIG.prefix( " icecream| " );
IC ( 1 );
IC_CONFIG.prefix([]{ return 42 ;}, " - " );
IC ( 2 );
IC_CONFIG.prefix( " thread " , std::this_thread::get_id, " | " );
IC ( 3 );印刷します：
icecream| 1: 1
42- 2: 2
thread 1 | 3: 3
char*変数をヌル終端Cストリング（ true ）またはchar （ false ）へのポインターとして解釈する必要があるかどうかを制御します。デフォルト値はtrueです。
auto show_c_string () const -> bool; auto show_c_string ( bool value) -> Config&;コード：
char const * flavor = " mango " ;
IC_CONFIG.show_c_string( true );
IC (flavor);
IC_CONFIG.show_c_string( false );
IC (flavor);印刷します：
ic| flavor: "mango";
ic| flavor: 0x55587b6f5410
システム「実行エンコード」のシステム「エンコード」内のchar文字列に定義されたシステムからwchar_t文字列をトランスコードする関数。
auto wide_string_transcoder () const -> std::function<std::string( wchar_t const *, std:: size_t )>; auto wide_string_transcoder (std::function<std::string( wchar_t const *, std:: size_t )> transcoder) -> Config&;
auto wide_string_transcoder (std::function<std::string(std::wstring_view)> transcoder) -> Config&;入力文字列がnullターミネーターで終了するという保証はありません（これはstring_viewの実際のセマンティックです）ため、ユーザーは入力文字列サイズの値を遵守する必要があります。
デフォルトの実装は、Cロケールが「C」または「POSIX」以外の値に設定されているかどうかを確認します。はいの場合、入力をSTD :: wcrtomb関数に転送します。それ以外の場合は、入力がUnicodeエンコード（UTF-16またはUTF-32、それに応じてwchar_tのサイズに）であると仮定し、UTF-8にトランスコードします。
UTF-32エンコーディングからシステム「実行エンコード」のchar文字列まで、 char32_t文字列をトランスコードする関数。
auto unicode_transcoder () const -> std::function<std::string( char32_t const *, std:: size_t )>; auto unicode_transcoder (std::function<std::string( char32_t const *, std:: size_t )> transcoder) -> Config&;
auto unicode_transcoder (std::function<std::string(std::u32string_view)> transcoder) -> Config&;入力文字列がnullターミネーターで終了するという保証はありません（これはstring_viewの実際のセマンティックです）ため、ユーザーは入力文字列サイズの値を遵守する必要があります。
デフォルトの実装では、Cロケールが「C」または「POSIX」以外の値に設定されていることを確認します。はいの場合、入力がSTD :: C32RTOMB関数に転送されます。それ以外の場合は、UTF-8にトランスコードされます。
この関数は、すべてのchar8_t 、 char16_t 、およびchar32_t文字列をトランスコードするために使用されます。 char8_tおよびchar16_t文字列をトランスコードすると、この関数への入力として送信される前に、最初にchar32_t文字列に変換されます。
構成された出力で予想されるように、システム「実行エンコード」システム「実行エンコード」からシステム「出力エンコード」のchar文字列に至るまでのchar文字列をトランスコードする関数。
auto output_transcoder () const -> std::function<std::string( char const *, std:: size_t )>; auto output_transcoder (std::function<std::string( char const *, std:: size_t )> transcoder) -> Config&;
auto output_transcoder (std::function<std::string(std::string_view)> transcoder) -> Config&;入力文字列がnullターミネーターで終了するという保証はありません（これはstring_viewの実際のセマンティックです）ため、ユーザーは入力文字列サイズの値を遵守する必要があります。
デフォルトの実装は、「実行エンコード」が「出力エンコード」と同じであると想定しており、変更されていない入力を返すだけです。
出力が複数の行で破損する前の文字の最大数。 70のデフォルト値。
auto line_wrap_width () const -> std::size_t; auto line_wrap_width (std:: size_t value) -> Config&;変数を印刷する場合でも、コンテキスト（ソース名、行番号、および関数名）を印刷する必要がある場合。デフォルト値はfalseです。
auto include_context () const -> bool; auto include_context ( bool value) -> Config&;コンテキストテキストを変数値から分離する文字列。デフォルト値は"- "です。
auto context_delimiter () const -> std::string; auto context_delimiter (std::string const & value) -> Config&;印刷できるためには、タイプT次のセクションで説明されている戦略の1つを満たす必要があります。複数の戦略が満たされていることが発生した場合、優先順位が高い戦略が選択されます。
優先順位が最も高い戦略は、STLストリームベースのI/Oを使用することです。その結果、タイプTのオブジェクトを印刷するとき、過負荷の関数operator<<(ostream&, T)が存在する場合、使用されます。
C文字列はあいまいです。 char* foo変数は、単一のcharへのポインターとして、またはヌル終端文字列として解釈する必要がありますか？同様に、 char bar[]は単一文字の配列ですか、それともヌル終端文字列ですか？ char baz[3] 3つのシングル文字を持つ配列ですか、それともサイズ2と' 'の文字列ですか？
foo 、 bar 、およびbazのこれらの解釈のそれぞれは、明確な方法で印刷されます。コードへ：
char flavor[] = " pistachio " ;
IC (flavor);以下の3つの出力はすべて正しいです。それぞれがflavor変数であるべきものを明確に解釈しています。
ic| flavor: 0x55587b6f5410
ic| flavor: ['p', 'i', 's', 't', 'a', 'c', 'h', 'i', 'o', ' ']
ic| flavor: "pistachio"
IceCream-CPPポリシーは、単一文字の配列として、境界付きcharアレイ（IE：既知のサイズの配列）を処理します。だからコード：
char flavor[] = " chocolate " ;
IC (flavor);印刷します：
ic| flavor: ['c', 'h', 'o', 'c', 'o', 'l', 'a', 't', 'e', ' ']
Unbounded char[]アレイ（つまり、未知のサイズの配列）はchar*ポインターに崩壊し、Show_c_stringオプションで構成されている文字列またはポインターとして印刷されます。
wchar_t* 、 std::wstring 、 std::string_viewなどのwchar_t文字列の実現
出力はchar列を予想するため、テキストデータをその形式に変換し、「実行エンコード」にあることを確認する必要があります。 IceCream-CPPは、それを行うためにデフォルトのトランスコダー関数を実装していますが、Wide_string_transcoderオプションを設定してカスタマイズすることができます。
char8_t 、 char16_t 、およびchar32_t文字列の実現、 char32_t* 、 std::u8string 、 std::u16string_view
出力はchar文字列を期待するため、データをその形式に変換し、「実行エンコード」にあることを確認する必要があります。 IceCream-CPPは、それを行うためにデフォルトのトランスコダー関数を実装していますが、Unicode_Transcoderオプションを設定してカスタマイズすることができます。
過負荷関数operator<<(std::ostream&, T)が定義されている場合、タイプTはストリーミング可能です。これは、優先度が最も高い印刷戦略です。したがって、その過負荷がタイプTに存在する場合、使用済み戦略になります。
STLストリームベースのI/Oには、フォーマット文字列の概念がありません。すべての構成はマニピュレーターを使用して行われます。そのため、{fmt}とSTLフォーマットに強く基づいて、カスタムフォーマット文字列構文を作成しました。
次の仕様があります。
format_spec ::= [[fill]align][sign]["#"][width]["." precision][type]
fill ::= <a character>
align ::= "<" | ">" | "v"
sign ::= "+" | "-"
width ::= integer
precision ::= integer
type ::= "a" | "A" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "o" | "x" | "X"
integer ::= digit+
digit ::= "0"..."9"
塗りつぶしの文字は任意のcharにすることができます。塗りつぶしの文字の存在は、それに続くキャラクターによってシグナル化されます。これは、アライメントオプションの1つでなければなりません。アライメントオプションの意味は次のとおりです。
| シンボル | 意味 |
|---|---|
'<' | 使用可能なスペース内に左アライメントします。 |
'>' | 使用可能なスペース内で右に揃っています。これがデフォルトです。 |
'v' | データを内部的に整列させ、フィル文字が数字とベースまたはサインの間に配置されます。整数とフローティングポイントに適用されます。 |
最小フィールド幅が定義されていない限り、フィールド幅は常にデータと同じサイズになり、この場合にアライメントオプションに意味がないことに注意してください。
標識オプションは、数値タイプに対してのみ有効であり、次のいずれかになります。
| シンボル | 意味 |
|---|---|
'+' | 非陰性および負の数にサインが使用されます。 |
'-' | サインは、負の数に対してのみ使用されます。これがデフォルトです。 |
「代替フォーム」を変換に使用します。代替フォームは、異なるタイプで異なる方法で定義されています。このオプションは、整数とフローティングポイントタイプに対してのみ有効です。整数の場合、バイナリ、オクタル、または16進出力が使用される場合、このオプションは、それぞれの「0b」（「0b」）、「0」、または「0x」（「0x」（ "0x"）を出力値に追加します。プレフィックスが低ケースであるか上限ケースであるかは、タイプ指定子の場合によって決定されます。たとえば、プレフィックス「0x」はタイプ 'x'に使用され、「0x」は「x」に使用されます。浮動小数点数の場合、代替フォームは、桁に従っていなくても、変換の結果を常に小数点文字を含むようにします。通常、10進点は、数字に従っている場合にのみ、これらの変換の結果に表示されます。さらに、「g」および「g」変換の場合、結果からゼロを除去することはありません。
最小フィールド幅を定義する小数整数。指定されていない場合、フィールド幅はコンテンツによって決定されます。
精度は、「f」と「f」でフォーマットされたフローティングポイント値の小数点の後の数字の数を表示する数字数を示す小数点以下、または「g」または「g」で形式化された流体ポイント値の小数点の前後に表示されることを示します。非番号タイプの場合、フィールドは最大フィールドサイズを示します。つまり、フィールドコンテンツから使用される文字の数です。精度は、整数、文字、ブール値、およびポインター値では許可されていません。精度が指定されていても、C文字列はヌル終了する必要があることに注意してください。
データの表示方法を決定します。
利用可能な整数プレゼンテーションタイプは次のとおりです。
| シンボル | 意味 |
|---|---|
'd' | 10進整数。ベース10に数を出力します。 |
'o' | オクタル形式。ベース8に数を出力します。 |
'x' | ヘックス形式。 9を超える数字に低ケース文字を使用して、ベース16の数を出力します。このタイプで「＃」オプションを使用すると、プレフィックス「0x」が出力値に追加されます。 |
'X' | ヘックス形式。 9を超える数字に上限ケース文字を使用して、ベース16の数を出力します。このタイプで「＃」オプションを使用すると、プレフィックス「0x」が出力値に追加されます。 |
フローティングポイント値の利用可能なプレゼンテーションタイプは次のとおりです。
| シンボル | 意味 |
|---|---|
'a' | 16進浮遊点形式。ベース16の数字をプレフィックス「0x」と9を超える数字の低ケース文字で印刷します。「P」を使用して指数を示します。 |
'A' | 「a」と同じプレフィックスに上部ケース文字を使用し、9を超えて指数を示すために桁を使用します。 |
'e' | 指数表記。文字「e」を使用して指数を示す科学表記で数を印刷します。 |
'E' | 指数表記。 「e」と同じ「e」は、セパレーター文字として上限「e」を使用します。 |
'f' | 固定点。数値を固定点数として表示します。 |
'F' | 固定点。 「f」と同じですが、ナンをナンに変換し、infにinfに変換します。 |
'g' | 一般的な形式。特定の精度p> = 1の場合、これは数をPに比べてPに丸め、その結果をその大きさに応じて、固定点形式または科学表記法のいずれかでフォーマットします。 0の精度は、1の精度に相当するものとして扱われます。 |
'G' | 一般的な形式。数値が大きくなりすぎる場合の「E」に切り替えることを除いて、「G」と同じ。 InfinityとNanの表現も大文字になっています。 |
std::unique_ptr<T> （C ++ 20の前）およびboost::scoped_ptr<T>タイプは、通常の生のポインターのように印刷されます。
std::weak_ptr<T>およびboost::weak_ptr<T>型は、それ以外の場合は「有効または「有効期限」している場合はアドレスを印刷します。コード：
auto v0 = std::make_shared< int >( 7 );
auto v1 = std::weak_ptr< int > {v0};
IC (v1);
v0.reset();
IC (v1);印刷します：
ic| v1: 0x55bcbd840ec0
ic| v1: expired
範囲とは、[ begin 、 end ）iteratorペアを提供できる任意のタイプです。正確に言えば、IceCream-CPPライブラリは、 forward_range概念を満たす場合、範囲タイプRを印刷できます。ほぼ用語では、イテレータータイプIとセンチネルタイプS （範囲の終わりをマークするために使用される、 Iと同じタイプになります）を持つ範囲タイプRは、次のすべての操作が有効な場合、フォワード範囲です。
I i0 = begin(r);
S s = end(r);
I i1 (i0);
i0 == i1
i0 != i1
i0 == s
i0 != s
++i0;
*i0;すべての操作が有効な場合、タイプRはストリーミングできませんが、 R内の要素はR自体の代わりにR内のすべてのアイテムを印刷します。
コード：
auto v0 = std::list< int >{ 10 , 20 , 30 };
IC (v0);印刷します：
ic| v0: [10, 20, 30]
一度に一度に1つのアイテムを1つずつゆっくりと印刷しますが、一度に全範囲ではなく。 IC_V機能も範囲を印刷しています。
範囲タイプへの受け入れられたフォーマット文字列は、範囲フォーマットとその要素のフォーマットの両方の組み合わせです。範囲のフォーマットは、パイソンスライシングと構文的および意味的にほぼ同一です。
正式には、受け入れられている範囲タイプのフォーマット文字列は次のとおりです。
format_spec ::= [range_fmt][":"elements_fmt]
range_fmt ::= "[" slicing | index "]"
slicing ::= [lower_bound] ":" [upper_bound] [ ":" [stride] ]
lower_bound ::= integer
upper_bound ::= integer
stride ::= integer
index ::= integer
integer ::= ["-"]digit+
digit ::= "0"..."9"
同じelements_fmt列はすべての印刷要素によって使用されるため、範囲要素のフォーマット文字列と同じ構文があります。
コード：
auto arr = std::vector< int >{ 10 , 11 , 12 , 13 , 14 , 15 };
IC_F ( " [:2:-1]:#x " , arr);印刷します：
ic| arr: [:2:-1]->[0xf, 0xe, 0xd]
仕様では、 lower_bound 、 upper_bound 、 stride 、およびindexが整数値を持つことができると述べていますが、一部のrange機能はそれらを正の値に制限することができます。
range sizedがない場合、 lower_bound 、 upper_bound 、およびindex値は正でなければなりません。同様に、 rangeがbidirectionalでない場合、 stride値もプラスでなければなりません。
範囲内で印刷する場合、 IC_FV関数を使用してパイプラインを表示する場合、すべてのlower_bound 、 upper_bound 、およびindex値が正でなければなりません。
std::pair<T1, T2>またはstd::tuple<Ts...>タイプされた変数は、そのすべての要素を印刷します。
コード：
auto v0 = std::make_pair( 10 , 3.14 );
auto v1 = std::make_tuple( 7 , 6.28 , " bla " );
IC (v0, v1);印刷します：
ic| v0: (10, 3.14), v1: (7, 6.28, "bla")
std::optional<T>タイプ付き変数は、その値がある場合、またはそれ以外の場合はnulloptを印刷します。
コード：
auto v0 = std::optional< int > { 10 };
auto v1 = std::optional< int > {};
IC (v0, v1);印刷します：
ic| v0: 10, v1: nullopt
std::variant<Ts...>またはboost::variant2::variant<Ts...> typed変数がその値を印刷します。
コード：
auto v0 = std::variant< int , double , char > { 4.2 };
IC (v0);印刷します：
ic| v0: 4.2
std::exceptionから継承するタイプはstd::exception::what()メソッドの返されたものを印刷します。それを超えてboost::exceptionから継承する場合、 boost::diagnostic_information()の応答も印刷されます。
コード：
auto v0 = std::runtime_error( " error description " );
IC (v0);印刷します：
ic| v0: error description
Clang> = 15を使用している場合、 operator<<(ostream&, T)オーバーロードがなくてもクラスは印刷されます。
コード：
class S
{
public:
float f;
int ii[ 3 ];
};
S s = { 3.14 , { 1 , 2 , 3 }};
IC (s);印刷します：
ic| s: {f: 3.14, ii: [1, 2, 3]}
IC(...)はプリプロセッサマクロであり、コードに他のIC識別子がある場合、競合を引き起こす可能性があります。 IC(...)マクロをより長いICECREAM(...)に変更するには、 icecream.hppヘッダーを含める前にICECREAM_LONG_NAME定義するだけです。
# define ICECREAM_LONG_NAME
# include " icecream.hpp "ほとんどのコンパイラは、C ++ 20が標準を呼び出すときに少なくとも1つの引数を必要とするまで、正常に動作しますが。これを処理するために、Nullary Macros IC0()およびICECREAM0() IC(...)およびICECREAM(...)とともに定義されます。
