Add ASCII dumper (#213)

Author: SergiusTheBest

README.md

@@ -1002,6 +1002,7 @@ There are a number of samples that demonstrate various aspects of using plog. Th
 |------|-----------|
 |[Android](samples/Android)|Shows how to use [AndroidAppender](#androidappender).|
 |[Arduino](samples/Arduino)|Arduino sample - not finished yet!|
+|[AscDump](samples/AscDump)|Shows how to use `plog::ascdump` to dump binary buffers into ASCII.|
 |[Chained](samples/Chained)|Shows how to chain a logger in a shared library with the main logger (route messages).|
 |[ColorConsole](samples/ColorConsole)|Shows how to use [ColorConsoleAppender](#colorconsoleappender).|
 |[CustomAppender](samples/CustomAppender)|Shows how to implement a custom appender that stores log messages in memory.|

include/plog/Helpers/AscDump.h

@@ -0,0 +1,40 @@
+#pragma once
+#include <plog/Util.h>
+#include <cctype>
+
+namespace plog
+{
+    class AscDump
+    {
+    public:
+        AscDump(const void* ptr, size_t size)
+            : m_ptr(static_cast<const char*>(ptr))
+            , m_size(size)
+        {
+        }
+
+        friend util::nostringstream& operator<<(util::nostringstream& stream, const AscDump& ascDump);
+
+    private:
+        const char* m_ptr;
+        size_t m_size;
+    };
+
+    inline util::nostringstream& operator<<(util::nostringstream& stream, const AscDump& ascDump)
+    {
+        for (size_t i = 0; i < ascDump.m_size; ++i)
+        {
+            stream << (std::isprint(ascDump.m_ptr[i]) ? ascDump.m_ptr[i] : '.');
+        }
+
+        return stream;
+    }
+
+    inline AscDump ascdump(const void* ptr, size_t size) { return AscDump(ptr, size); }
+
+    template<class Container>
+    inline AscDump ascdump(const Container& container) { return AscDump(container.data(), container.size() * sizeof(*container.data())); }
+
+    template<class T, size_t N>
+    inline AscDump ascdump(const T (&arr)[N]) { return AscDump(arr, N * sizeof(*arr)); }
+}

samples/AscDump/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_executable(AscDump Main.cpp)
+target_link_libraries(AscDump plog)
+set_target_properties(AscDump PROPERTIES FOLDER Samples)

samples/AscDump/Main.cpp

@@ -0,0 +1,34 @@
+//
+// AscDump - shows how to use plog::ascdump to dump binary buffers into ASCII.
+//
+
+#include <plog/Log.h>
+#include <plog/Init.h>
+#include <plog/Formatters/TxtFormatter.h>
+#include <plog/Appenders/ColorConsoleAppender.h>
+#include <plog/Helpers/AscDump.h>
+
+#include <vector>
+
+int main()
+{
+    static plog::ColorConsoleAppender<plog::TxtFormatter> consoleAppender;
+    plog::init(plog::verbose, &consoleAppender);
+
+    std::vector<short> v;
+    v.push_back(0x6548);
+    v.push_back(0x6c6c);
+    v.push_back(0x216f);
+    v.push_back(0);
+    v.push_back(-1);
+
+    PLOGI << "v: " << plog::ascdump(v);
+
+    unsigned char arr[] = {0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x21, 0xff};
+    PLOGI << "arr: " << plog::ascdump(arr);
+
+    void* p = malloc(100);
+    PLOGI << "p: " << plog::ascdump(p, 100);
+
+    return 0;
+}

samples/CMakeLists.txt

@@ -40,6 +40,7 @@ elseif(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANGXX)
 endif()
 
 add_subdirectory(Android)
+add_subdirectory(AscDump)
 add_subdirectory(Chained)
 add_subdirectory(ColorConsole)
 add_subdirectory(CustomAppender)