Add ability to use ascdump/hexdump with printf (#290)

SergiusTheBest · Jun 28, 2024 · eebe143 · eebe143
1 parent 5e86847
commit eebe143
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 0 deletions.
diff --git a/include/plog/Helpers/AscDump.h b/include/plog/Helpers/AscDump.h
@@ -13,6 +13,11 @@ namespace plog
         {
         }
 
+        util::nstring str() const
+        {
+            return (util::nostringstream() << *this).str();
+        }
+
         friend util::nostringstream& operator<<(util::nostringstream& stream, const AscDump& ascDump);
 
     private:

diff --git a/include/plog/Helpers/HexDump.h b/include/plog/Helpers/HexDump.h
@@ -35,6 +35,11 @@ namespace plog
             return *this;
         }
 
+        util::nstring str() const
+        {
+            return (util::nostringstream() << *this).str();
+        }
+
         friend util::nostringstream& operator<<(util::nostringstream& stream, const HexDump&);
 
     private:

diff --git a/samples/AscDump/Main.cpp b/samples/AscDump/Main.cpp
@@ -28,5 +28,28 @@ int main()
     void* p = malloc(100);
     PLOGI << "p: " << plog::ascdump(p, 100);
 
+    // `plog::ascdump` can be used with `printf`. Note that `.str()` returns `nstring`,
+    // so it can be narrow or wide and thus requires a proper format specifier.
+    //
+    // If `nstring` is wide:
+    // - use wide format string and %s (preferable)
+    // - use narrow format string and %S
+    // If `nstring` is narrow:
+    // - use narrow format string and %s (preferable)
+    //
+    // Wrap format string with `PLOG_NSTR` to automatically support wide and narrow strings with %s.
+    //
+    // `nstring` is narrow if char encoding is UTF-8 otherwise it's wide. This allows to
+    // support all symbols from different languages.
+
+    PLOGI.printf(PLOG_NSTR("printf: %s"), plog::ascdump(p, 100).str().c_str());
+
+#if PLOG_CHAR_IS_UTF8
+    PLOGI.printf("printf: %s", plog::ascdump(p, 100).str().c_str());
+#else
+    PLOGI.printf(L"printf: %s", plog::ascdump(p, 100).str().c_str());
+    PLOGI.printf("printf: %S", plog::ascdump(p, 100).str().c_str());
+#endif
+
     return 0;
 }
diff --git a/samples/HexDump/Main.cpp b/samples/HexDump/Main.cpp
@@ -40,5 +40,28 @@ int main()
     void* p = malloc(100);
     PLOGI << "p: " << plog::hexdump(p, 100);
 
+    // `plog::hexdump` can be used with `printf`. Note that `.str()` returns `nstring`,
+    // so it can be narrow or wide and thus requires a proper format specifier.
+    //
+    // If `nstring` is wide:
+    // - use wide format string and %s (preferable)
+    // - use narrow format string and %S
+    // If `nstring` is narrow:
+    // - use narrow format string and %s (preferable)
+    //
+    // Wrap format string with `PLOG_NSTR` to automatically support wide and narrow strings with %s.
+    //
+    // `nstring` is narrow if char encoding is UTF-8 otherwise it's wide. This allows to
+    // support all symbols from different languages.
+
+    PLOGI.printf(PLOG_NSTR("printf: %s"), plog::hexdump(p, 100).str().c_str());
+
+#if PLOG_CHAR_IS_UTF8
+    PLOGI.printf("printf: %s", plog::hexdump(p, 100).str().c_str());
+#else
+    PLOGI.printf(L"printf: %s", plog::hexdump(p, 100).str().c_str());
+    PLOGI.printf("printf: %S", plog::hexdump(p, 100).str().c_str());
+#endif
+
     return 0;
 }