icecream cpp
v0.3.1
ICECREAM-CPP هي مكتبة صغيرة (رأس واحد) للمساعدة في تصحيح الأخطاء المطبوعة في C ++ 11 و Rolffer.
جربه في برنامج التحويل البرمجي!
محتويات
مع 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
يمكننا أيضًا فحص البيانات التي تتدفق من خلال خط أنابيب عرض المدى (كل من نطاقات STL و Range-V3) ، عن طريق إدخال دالة IC_V() عند نقطة الاهتمام:
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 كاعتمادها الوحيد. الطريقة الأكثر إلحاحًا لاستخدامها هي مجرد نسخ 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 في مشروع Flake موجود هنا.
الإصدارات التي تم إصدارها متوفرة على كونان أيضًا:
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 و Range-V3) ، نستخدم وظيفة IC_V ، والتي ستطبع أي إدخال تتلقاها من العرض السابق. نظرًا لأن وظيفة IC_V موجودة ضمن خط أنابيب مشاهدات النطاق ، ستتم الطباعة بتكاسل ، بينما يتم إنشاء كل عنصر. على سبيل المثال:
namespace vws = std::views;
auto v0 = vws::iota( ' a ' ) | vws::enumerate | IC_V() | vws::take( 3 );
for ( auto e : v0)
{
// ...
} في هذا الرمز ، لن يتم طباعة أي شيء عند إنشاء v0 ، فقط عند التكرار عليه. في كل تكرار في خط for ، سيتم طباعة سطر واحد ، حتى يكون لدينا الإخراج:
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 ذلك. للتأكد من تمكين الدعم للمدى V3 ، فقط حدد Macro ICECREAM_RANGE_V3 قبل تضمين icecream.hpp header
تحتوي وظيفة IC_V على معلمتين اختياريتين ، IC_V(name, projection) .
الاسم المتغير المستخدم في العرض عند الطباعة. تخطيط الطباعة هو: <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 سيكون له أي تأثير على ذلك.
يحتوي IC_FV المتغير على نفس سلوك وظيفة IC_V ، ولكنه يقبل سلسلة تنسيق الإخراج كوسيطة لها الأولى.
باستثناء ما تم استدعاؤه مع وسيطة واحدة بالضبط ، ستعيد دالة IC tuple مع جميع وسيطات الإدخال الخاصة بها. إذا تم استدعاؤه بحجة واحدة ، فسوف يعيد الحجة نفسها.
يتم ذلك بهذه الطريقة حتى تتمكن من استخدام IC لتفقد وسيطة الوظيفة في نقطة الاتصال ، مع عدم وجود تغيير رمز إضافي. في الكود:
my_function (IC(MyClass{})); سيتم إعادة توجيه كائن MyClass إلى my_function تمامًا كما لو كانت وظيفة IC لم تكن موجودة. سيستمر my_function في تلقي مرجع RValue إلى كائن MyClass .
ومع ذلك ، فإن هذا النهج ليس عمليًا عندما يكون للوظيفة العديد من الحجج. على الكود:
my_function (IC(a), IC(b), IC(c), IC(d)); إلى جانب الكتابة أربعة أضعاف وظيفة IC ، سيتم تقسيم المخرجات المطبوعة في أربعة خطوط متميزة. شيء مثل:
ic| a: 1
ic| b: 2
ic| c: 3
ic| d: 4
لسوء الحظ ، فقط لف جميع الحجج الأربع في مكالمة IC واحدة لن يعمل أيضًا. ستكون القيمة التي تم إرجاعها std:::tuple مع (a, b, c, d) ويتوقع my_function أربع وسيطات.
للتغلب على ذلك ، هناك وظيفة IC_A . يتصرف IC_A تمامًا مثل وظيفة IC ، ولكنه يتلقى قابلاً للاستدعاء كوسيطة أولى ، وسيسميها باستخدام جميع الوسائط التالية ، وطباعةها جميعًا قبل ذلك. يمكن إعادة كتابة رمز المثال السابق على النحو التالي:
IC_A (my_function, a, b, c, d);وهذه المرة سوف تطبع:
ic| a: 1, b: 2, c: 3, d: 4
ستعيد وظيفة IC_A نفس القيمة التي يتم إرجاعها بواسطة Callable. الرمز:
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_F بدلاً من Plain IC functio. سيتم الحصول على نتيجة مماثلة في حالة استخدام IC_FA و IC_FV بدلاً من IC_A و IC_V على التوالي.
عند استخدام متغيرات دالة التنسيق ( 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 بشكل جيد. إنهم قادرون ، ويحملون وحدات رمز Unicode من 8 و 16 و 32 بت على التوالي ، ويتم ترميزها في UTF-8 و UTF-16 و UTF-32 على التوالي.
تحتوي سلاسل char على حجم بتات وحدة الكود المحددة جيدًا (المقدمة بواسطة CHAR_BIT ، عادة 8 بتات) ، ولكن لا توجد متطلبات حول ترميزها.
لا تحتوي سلاسل wchar_t على حجم وحدة رمز محددة جيدًا ، ولا أي متطلبات حول ترميزها.
في رمز مثل هذا:
auto const str = std::string{ " foo " };
std::cout << str; سيكون لدينا ثلاث نقاط ترميز الأحرف ذات الاهتمام. في أول واحد ، قبل التجميع ، سيكون هذا الرمز في ملف مصدر في "تشفير مصدر" غير محدد. في نقطة الاهتمام الثانية ، سيكون للثنائي المترجم سلسلة "FOO" المحفوظة في "تنفيذ" غير محدد. أخيرًا في النقطة الثالثة ، سيتم إعادة توجيه دفق البايت "Foo" الذي تلقاه std::cout إلى النظام ، والذي يتوقع تشفير الدفق في "ترميز الإخراج" غير محدد أيضًا.
من بين نقاط الاهتمام الثلاثة لترميز الأحرف ، كل من "ترميز التنفيذ" و "ترميز الإخراج" لهما تأثير في العمل الداخلي لـ Icecream-CPP ، ولا توجد طريقة لمعرفة ما هو الترميز المستخدم في كل منهما. في مواجهة عدم اليقين هذا ، تقدم الاستراتيجية المعتمدة وظيفة ترميز الافتراضي المعقولة ، والتي ستحاول تحويل البيانات إلى الترميز الأيمن ، والسماح للمستخدم باستخدام تنفيذه الخاص عند الحاجة.
باستثناء أنواع السلسلة الواسعة والوحدة (التي تمت مناقشتها أدناه) ، عند طباعة أي نوع آخر ، سيكون لدينا بيانات نصي متسلسلة في "تنفيذ ترميز". قد يكون أو لا يكون أو لا يكون "ترميز التنفيذ" هو نفسه "ترميز الإخراج" ، وهذا هو الترميز المتوقع من خلال الإخراج المكون. ولهذا السبب ، قبل أن نرسل تلك البيانات إلى الإخراج ، يجب أن ننقلها للتأكد من أننا في "ترميز الإخراج". تحقيقًا لهذه الغاية ، قبل توصيل البيانات النصية إلى الإخراج ، نرسلها إلى وظيفة Output_transcoder التي تم تكوينها ، والتي يجب أن تتأكد من ترميزها في "الترميز" الصحيح.
عند طباعة أنواع السلسلة الواسعة والوحدة ، نحتاج إلى الحصول على مستوى ترميز آخر ، لأنه من الممكن أن تكون البيانات النصية في حرف مميز تشفير من "ترميز التنفيذ" المتوقع. ولهذا السبب ، يتم تطبيق منطق إضافي للتأكد من أن الأوتار في "ترميز التنفيذ" قبل أن نرسلها إلى الإخراج. تمت مناقشة هذا في الأوتار الواسعة ، وأقسام سلاسل يونيكود.
يعمل نظام تكوين Icecream-CPP "طبقة حسب النطاق". على مستوى الأساس لدينا كائن IC_CONFIG العالمي. يتم مشاركة هذه الحالة العالمية من خلال برنامج التشغيل بالكامل ، كما هو متوقع من متغير عالمي. يتم إنشاؤه مع جميع خيارات التكوين في قيمها الافتراضية ، ويتم رؤية أي تغيير بسهولة من قبل البرنامج بأكمله.
في أي نقطة من الكود ، يمكننا إنشاء طبقة تكوين جديدة في النطاق الحالي عن طريق إنشاء متغير جديد IC_CONFIG ، واتصال الماكرو IC_CONFIG_SCOPE() . جميع خيارات التكوين لهذا المثيل الجديد ستكون في حالة "إلغاء تعيين" افتراضيًا ، وسيتم تفويض أي طلب إلى قيمة خيار لم يتم تعيينه بعد إلى الوالد. سوف يرتفع هذا الطلب على السلسلة الأصلية حتى يتم تعيين الإجابات على الخيار الأول.
يتم تعيين جميع خيارات التكوين باستخدام أساليب الوصول لكائن IC_CONFIG ، ويمكن ربطها:
IC_CONFIG
.prefix( " ic: " )
.show_c_string( false )
.line_wrap_width( 70 ); IC_CONFIG هو مجرد متغير منتظم مع اسم مضحك لجعل التصادم غير مرجح للغاية. عند استدعاء أي ماكرو IC*(...) ، فسيختار مثيل IC_CONFIG في SCOPE عن طريق إجراء بحث غير مؤهل للاسم ، باستخدام نفس القواعد المطبقة على أي متغير عادي آخر.
لتلخيص كل ما سبق ، في الكود:
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 'S 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 ); سيقوم بطباعة الإخراج "ic| 1: 1, 2: 2n" على سلسلة str .
تحذير
لن يأخذ 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
الوظيفة التي تُقلِّل ترميز سلسلة wchar_t ، من نظام محدد للترميز إلى سلسلة char في النظام "ترميز التنفيذ".
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&;لا يوجد أي ضمان بأن سلسلة الإدخال ستنتهي على مُنمِّع فارغ (هذا هو الدلالي الفعلي لـ String_View) ، لذلك يجب على المستخدم ملاحظة قيمة حجم سلسلة الإدخال.
سيقوم التنفيذ الافتراضي بالتحقق مما إذا تم تعيين لغة C على قيمة أخرى غير "C" أو "Posix". إذا كانت الإجابة بنعم ، فسيتم إعادة توجيه المدخلات إلى وظيفة STD :: WCRTOMB. خلاف ذلك ، سوف نفترض أن الإدخال يتم ترميزه (UTF-16 أو UTF-32 ، وفقًا لحجم البايت لـ wchar_t ) ، وتجاوزه إلى UTF-8.
الوظيفة التي تُقلِّل ترميز سلسلة char32_t ، من ترميز UTF-32 إلى سلسلة char في النظام "تنفيذ الترميز".
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&;لا يوجد أي ضمان بأن سلسلة الإدخال ستنتهي على مُنمِّع فارغ (هذا هو الدلالي الفعلي لـ 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&;لا يوجد أي ضمان بأن سلسلة الإدخال ستنتهي على مُنمِّع فارغ (هذا هو الدلالي الفعلي لـ 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 بأحد الاستراتيجيات الموضحة في الأقسام التالية. إذا حدث أن يتم استيفاء استراتيجيات متعددة ، فسيتم اختيار الاستراتيجيات ذات الأسبقية العليا.
الاستراتيجية ذات الأسبقية الأعلى هي استخدام I/O القائم على دفق STL. وبالتالي ، عند طباعة كائن من النوع T ، إذا كان هناك operator<<(ostream&, T) ، فسيتم استخدامه.
ج السلاسل غامضة. هل يجب تفسير متغير char* foo على أنه مؤشر إلى char واحد أو كسلسلة مطلقة على الفرق؟ وبالمثل ، هل يتغير char bar[] مجموعة من الأحرف المفردة أو سلسلة من إنهاء الفرق؟ هل char baz[3] صفيف مع ثلاثة أحرف واحدة أم أنها سلسلة من الحجم اثنين بالإضافة إلى ' ' ؟
سيتم طباعة كل واحد من تلك التفسيرات لـ foo و bar و baz بطريقة مميزة. إلى الكود:
char flavor[] = " pistachio " ;
IC (flavor); جميع المخرجات الثلاثة أدناه صحيحة ، كل واحد له تفسير متميز لما ينبغي أن يكون متغير flavor .
ic| flavor: 0x55587b6f5410
ic| flavor: ['p', 'i', 's', 't', 'a', 'c', 'h', 'i', 'o', ' ']
ic| flavor: "pistachio"
تتم التعامل مع سياسة Icecream-CPP مع أي صفيف char (أي: صفيف بحجم معروف) كمجموعة من الأحرف المفردة. لذلك الرمز:
char flavor[] = " chocolate " ;
IC (flavor);سوف يطبع:
ic| flavor: ['c', 'h', 'o', 'c', 'o', 'l', 'a', 't', 'e', ' ']
ستعمل صفيفات char[] غير المقيدة (أي: صفيف بحجم غير معروف) على مؤشرات char* ، وسيتم طباعتها إما كسلسلة أو مؤشر كما تم تكوينه بواسطة خيار show_c_string.
أي إدراك لسلاسل wchar_t ، مثل wchar_t* ، std::wstring ، و std::string_view
نظرًا لأن الإخراج يتوقع سلسلة char ، يجب علينا تحويل البيانات النصية إلى هذا التنسيق ، مع التأكد من أنه في "ترميز التنفيذ". تقوم ICECream-CPP بتنفيذ وظيفة TranscoDer افتراضية للقيام بذلك ، ولكن من الممكن تخصيصها عن طريق تعيين خيار Wide_String_TransCoder.
أي إدراك لأسلاك char8_t و char16_t و char32_t ، مثل char32_t* ، std::u8string ، و std::u16string_view
نظرًا لأن الإخراج يتوقع سلسلة char ، يجب علينا تحويل البيانات إلى هذا التنسيق ، مع التأكد من أنه في "ترميز التنفيذ". تقوم ICECream-CPP بتنفيذ وظيفة TranscoDer الافتراضية للقيام بذلك ، ولكن من الممكن تخصيصها عن طريق تعيين خيار Unicode_TransCoder.
يكون النوع T قابلاً للباقي إذا تم تعريف operator<<(std::ostream&, T) . هذه هي استراتيجية الطباعة ذات الأولوية القصوى ، لذلك إذا كان هذا الحمل الزائد موجودًا إلى النوع T ، فستكون الإستراتيجية المستخدمة.
لا يحتوي I/O المستند إلى دفق STL على مفهوم سلسلة التنسيق ، وتتم جميع التكوينات باستخدام المناورات. ولهذا السبب ، قمنا بإنشاء بناء جملة سلسلة تنسيق مخصصة ، يعتمد بقوة على تنسيق {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. يتم الإشارة إلى وجود حرف التعبئة بواسطة الحرف الذي يتبعه ، والذي يجب أن يكون أحد خيارات المحاذاة. معنى خيارات المحاذاة هو كما يلي:
| رمز | معنى |
|---|---|
'<' | اليسار محاذاة داخل المساحة المتاحة. |
'>' | المحاذاة اليمنى داخل المساحة المتاحة. هذا هو الافتراضي. |
'v' | قم بمحاذاة البيانات داخليًا ، مع وضع حرف التعبئة بين الأرقام وإما القاعدة أو العلامة. ينطبق على عدد صحيح ونقطة عائمة. |
لاحظ أنه ما لم يتم تعريف الحد الأدنى لعرض الحقل ، فإن عرض الحقل سيكون دائمًا بنفس حجم البيانات لملئه ، بحيث لا يكون لخيار المحاذاة أي معنى في هذه الحالة.
خيار الإشارة صالح فقط لأنواع الأرقام ، ويمكن أن يكون أحد ما يلي:
| رمز | معنى |
|---|---|
'+' | سيتم استخدام علامة لكل من الأرقام غير السالبة وكذلك السلبية. |
'-' | سيتم استخدام علامة فقط للأرقام السلبية. هذا هو الافتراضي. |
يؤدي إلى استخدام "النموذج البديل" للتحويل. يتم تعريف النموذج البديل بشكل مختلف لأنواع مختلفة. هذا الخيار صالح فقط لأنواع عدد صحيح ونقاط عائمة. بالنسبة للأعداد الصحيحة ، عند استخدام الإخراج الثنائي أو الثماني أو السداسي عشر ، يضيف هذا الخيار البادئة "0B" ("0B") أو "0" أو "0x" ("0x") إلى قيمة الإخراج. ما إذا كانت البادئة هي حالة أقل أو يتم تحديد الحالة العليا من خلال حالة محدد النوع ، على سبيل المثال ، يتم استخدام البادئة "0x" للنوع "X" و "0x" في "X". بالنسبة لأرقام الفاصلة العائمة ، يتسبب النموذج البديل في أن يحتوي التحويل دائمًا على حرف نقاط عشرية ، حتى لو لم يتبعه أي أرقام. عادة ، تظهر حرف نقطة عشرية في نتيجة هذه التحويلات فقط إذا تابعها الرقم. بالإضافة إلى ذلك ، بالنسبة لتحويلات "G" و "G" ، لا تتم إزالة الأصفار الزائدة من النتيجة.
عدد صحيح عشري يحدد الحد الأدنى لعرض الحقل. إذا لم يتم تحديدها ، فسيتم تحديد عرض الحقل بواسطة المحتوى.
الدقة هي رقم عشري يشير إلى عدد الأرقام التي يجب عرضها بعد النقطة العشرية لقيمة نقطة عائمة منسقة مع "F" و "F" ، أو قبل وبعد النقطة العشرية لقيمة نقطة عائمة مُنسقة مع "G" أو "G". بالنسبة لأنواع غير المرتبة ، يشير الحقل إلى الحد الأقصى لحجم الحقل - بمعنى آخر ، عدد الأحرف التي سيتم استخدامها من محتوى الحقل. الدقة غير مسموح بقيم عدد صحيح والشخصية والطراز المنطقي والمؤشر. لاحظ أنه يجب أن تكون سلسلة C منتهية فارغًا حتى لو تم تحديد الدقة.
يحدد كيفية تقديم البيانات.
أنواع العروض العاطفية المتاحة هي:
| رمز | معنى |
|---|---|
'd' | عدد صحيح عشري. يخرج الرقم في القاعدة 10. |
'o' | تنسيق ثماني. يخرج الرقم في القاعدة 8. |
'x' | تنسيق سداسي عشرية. يخرج الرقم في القاعدة 16 ، باستخدام أحرف الحالة السفلية للأرقام أعلاه 9. باستخدام خيار "#" مع هذا النوع يضيف البادئة "0x" إلى قيمة الإخراج. |
'X' | تنسيق سداسي عشرية. يخرج الرقم في القاعدة 16 ، باستخدام أحرف الحالة العليا للأرقام أعلاه 9. باستخدام خيار "#" مع هذا النوع يضيف البادئة "0x" إلى قيمة الإخراج. |
أنواع العرض التقديمي المتاحة لقيم الفاصلة العائمة هي:
| رمز | معنى |
|---|---|
'a' | تنسيق نقطة عائمة السداسي عشرية. يطبع الرقم في القاعدة 16 مع البادئة "0x" وأحرف الحالة السفلية للأرقام أعلاه. يستخدم "P" للإشارة إلى الأسس. |
'A' | مثل "A" باستثناء أنه يستخدم الأحرف العلوية للبادئة ، والأرقام أعلى من 9 وللإشارة إلى الأسس. |
'e' | تدوين الأسعار. يطبع الرقم في الترميز العلمي باستخدام الحرف "E" للإشارة إلى الأسس. |
'E' | تدوين الأسعار. مثل "E" باستثناء أنه يستخدم الحالة العلوية "E" كحرف فاصل. |
'f' | نقطة ثابتة. يعرض الرقم كرقم نقطة ثابتة. |
'F' | نقطة ثابتة. مثل "F" ، ولكن يحول NAN إلى NAN و INF إلى INF. |
'g' | التنسيق العام. بالنسبة لدقة معينة p> = 1 ، فإن هذا يربط الرقم إلى P أرقام مهمة ومن ثم ينظم النتيجة إما تنسيق نقطة ثابتة أو في تدوين علمي ، اعتمادًا على حجمه. يتم التعامل مع دقة 0 على أنها مكافئة لدقة 1. |
'G' | التنسيق العام. مثل "G" باستثناء التبديل إلى "E" إذا كان الرقم كبيرًا جدًا. تمثل تمثيل اللانهاية و 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
النطاق هو أي نوع قادر على توفير زوج end [ begin ). بعبارات دقيقة ، تكون مكتبة Icecream-CPP قادرة على طباعة نوع النطاق R إذا كانت تفي بمفهوم forward_range . بعبارات تقريبًا ، يمكن أن يكون نوع النطاق R الذي يحتوي على نوع Iterator من النوع I ونوع Sentinel S (المستخدم للاحتفال بنهاية النطاق ، هو نفس النوع كما I ) هو نطاق أمامي إذا كانت جميع العمليات التالية صالحة:
I i0 = begin(r);
S s = end(r);
I i1 (i0);
i0 == i1
i0 != i1
i0 == s
i0 != s
++i0;
*i0; إذا كانت كل هذه العمليات صالحة ، R النوع R غير قابلاً للباقي ولكن العناصر الموجودة داخل R ، ستقوم Icecream بطباعة جميع العناصر داخل R نفسها.
الرمز:
auto v0 = std::list< int >{ 10 , 20 , 30 };
IC (v0);سوف يطبع:
ic| v0: [10, 20, 30]
على الرغم من أن طباعة عنصر واحد في وقت واحد ، بدلاً من النطاق بأكمله مرة واحدة. وظيفة 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 موجبة.
A 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
A std::variant<Ts...> أو boost::variant2::variant<Ts...> المتغير المكتوبة سيطبع قيمته.
الرمز:
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) overload.
الرمز:
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_LONG_NAME قبل إدراج icecream.hpp header:
# define ICECREAM_LONG_NAME
# include " icecream.hpp " على الرغم من أن معظم المترجمين ستعمل بشكل جيد ، حتى يتطلب المعيار C ++ 20 وسيطة واحدة على الأقل عند استدعاء ماكرو متغير. للتعامل مع هذا ، يتم تعريف الماكرو الخلاصة IC0() و ICECREAM0() جنبًا إلى جنب مع IC(...) و ICECREAM(...) .
