Add simple level based debug infrastructure: yDebug

Author: raphendyr

common_macros.hh

@@ -9,7 +9,8 @@
 
 // src: avr-include/avr/interrupt.h
 #ifndef __STRINGIFY
-#  define __STRINGIFY(x) #x
+#  define __STRINGIFY2(x) #x
+#  define __STRINGIFY(x) __STRINGIFY2(x)
 #endif
 
 #endif

debug.hh

@@ -0,0 +1,67 @@
+#ifndef __YAAL_DEBUG__
+#define __YAAL_DEBUG__ 1
+
+#include "common_macros.hh"
+
+// Some ideas of yDebug come from QDebug and KDebug
+
+/* FIXME: defining _T here brakes functionality on real AVR hardware
+ * Currently this setup works ok on test programs (run on development computer)
+ * i.e. yDebug is not ready for debugging on AVR, but works nicely for developing tests
+ */
+#ifndef _T
+#  define _T(s) (s)
+#endif
+
+
+namespace yaal {
+    struct YaalNoDebug {
+        template<typename T>
+        YaalNoDebug& operator << (const T&) {
+            return *this;
+        }
+    };
+}
+#define yDebugImplPipeNull ::yaal::YaalNoDebug()
+
+#ifndef yDebugImplPipe
+#  define yDebugImplPipe yDebugImplPipeNull
+#endif
+
+#ifndef yDebugImplEndl
+#  define yDebugImplEndl '\n'
+#endif
+
+#ifndef yDebugImpl
+namespace yaal {
+    struct YaalDebug {
+        YaalDebug() {}
+        ~YaalDebug() {
+            yDebugImplPipe << yDebugImplEndl;
+        }
+
+        template<typename T>
+        YaalDebug& operator << (const T& o) {
+            yDebugImplPipe << o;
+            return *this;
+        }
+    };
+}
+#  define yDebugImpl ::yaal::YaalDebug()
+#endif
+
+#define yDebugIf(level, level_name) if (level >= yDebugLevel) \
+    yDebugImpl << _T(level_name " " __FILE__ ":" __STRINGIFY(__LINE__) " ")
+
+#define yDebug() yDebugIf(1, "DEBUG")
+#define yInfo() yDebugIf(2, "INFO")
+#define yWarning() yDebugIf(3, "WARNING")
+#define yError() yDebugIf(4, "ERROR")
+#define yCritical() yDebugIf(5, "CRITICAL")
+#define yFatal() yDebugIf(6, "FATAL")
+
+#ifndef yDebugLevel
+#  define yDebugLevel 0
+#endif
+
+#endif

requirements.hh

@@ -21,6 +21,7 @@
 #  include <stdint.h>
 #  include "common_macros.hh"
 #  include "qualifiers.hh"
+#  include "debug.hh"
 
 // Fixes for avr gcc library
 //  Allow debrecated macros (Some debrecated macros are used inside #ifdef in io/registers)

tests/testing.hh

@@ -28,9 +28,10 @@ typedef unsigned long long reg_size_t;
 #define EQ(left, right) ASSERT(left, ==, right)
 
 #define EQ_F2(left, right, mult, accuracy) do { \
-    cout << left << " =?= " << right << endl; \
+    std::cout << left << " <> " << right << "  ->  "; \
     signed long a_ = (signed long)(left * mult); \
     signed long b_ = (signed long)(right * mult); \
+    std::cout << std::dec << a_ << " <> " << std::dec << b_ << std::endl; \
     signed long d_  = a_ - b_; \
     signed long ad_ = d_ < 0 ? -d_ : d_; \
     ASSERT(ad_, < , accuracy); \
@@ -104,4 +105,12 @@ void print_hex<float>(std::ostream& out, const float& value) {
     out << "0x" << std::hex << *(int*)&value << " (" << value << ")";
 };
 
+
+// define yDebugImpl so debug messages are outputted
+#ifndef NO_YDEBUG
+#  include <yaal/common_macros.hh>
+#  define yDebugImplPipe std::cout
+#  define yDebugImplEndl std::endl
+#endif
+
 #endif

util/formating.hh

@@ -99,17 +99,19 @@ namespace yaal {
     }
 
 
-    /* ProgramMemory String */
+    /* Program Memory String */
 
 # ifdef __AVR__
+//  _T is defined in debug.hh as pass-through macro, so undefine it first
+#   ifdef _T
+#     undef _T
+#   endif
 #   define _T(s) (__extension__({ \
         static const char __attribute__ ((__progmem__,used)) __CONCAT(c_,__LINE__)[] = (s); \
         ::yaal::internal::StreamPgmString __CONCAT(p_,__LINE__); \
         __CONCAT(p_,__LINE__).string = __CONCAT(c_,__LINE__); \
         __CONCAT(p_,__LINE__); \
     }))
-# else
-#   define _T(s) (s)
 # endif