Replacing enum class DebugLevel with constants

Author: aentinger

README.md

@@ -5,12 +5,12 @@ This class provides functionality useful for debugging sketches via `printf`-sty
 
 # How-To-Use Basic
 ArduinoDebugUtils has 6 different debug levels (described descending from highest to lowest priority):
-* `DebugLevel::None` - no debug output is shown
-* `DebugLevel::Error` - critical errors
-* `DebugLevel::Warning` - non-critical errors
-* `DebugLevel::Info` - information
-* `DebugLevel::Debug` - more information
-* `DebugLevel::Verbose` - most information
+* `DEBUG_LVL_NONE` - no debug output is shown
+* `DEBUG_LVL_ERROR` - critical errors
+* `DEBUG_LVL_WARNING` - non-critical errors
+* `DEBUG_LVL_INFO` - information
+* `DEBUG_LVL_DEBUG` - more information
+* `DEBUG_LVL_VERBOSE` - most information
 
 The desired debug level can be set via `setDebugLevel(DebugLevel::Warning)`.
 
@@ -20,7 +20,7 @@ Example:
 ```C++
 int i = 1;
 float pi = 3.1459;
-ArduinoDebugUtils.debugPrint(DebugLevel::Verbose, "i = %d, pi = %f, i, pi);
+ArduinoDebugUtils.debugPrint(DEBUG_LVL_VERBOSE, "i = %d, pi = %f, i, pi);
 ```
 
 If desired timestamps can be prefixed to the debug message. Timestamp output can be enabled and disabled via `timestampOn` and `timestampOff`.

examples/Arduino_Debug_Basic/Arduino_Debug_Basic.ino

@@ -11,7 +11,7 @@ int i = 0;
 
 void loop() {
 
-  ArduinoDebugUtils.debugPrint(DebugLevel::Info, "i = %d", i);
+  ArduinoDebugUtils.debugPrint(DEBUG_LVL_INFO, "i = %d", i);
   i++;
   delay(1000);
 }

keywords.txt

@@ -22,10 +22,9 @@ debugPrint	KEYWORD2
 # Constants (LITERAL1)
 #######################################
 
-DebugLevel	LITERAL1
-None	LITERAL1
-Error	LITERAL1
-Warning	LITERAL1
-Info	LITERAL1
-Debug	LITERAL1
-Verbose	LITERAL1
+DEBUG_LVL_NONE	LITERAL1
+DEBUG_LVL_ERROR	LITERAL1
+DEBUG_LVL_WARNING	LITERAL1
+DEBUG_LVL_INFO	LITERAL1
+DEBUG_LVL_DEBUG	LITERAL1
+DEBUG_LVL_VERBOSE	LITERAL1

src/ArduinoDebugUtils.cpp

@@ -32,8 +32,8 @@ namespace impl
    CONSTANTS
  ******************************************************************************/
 
-static DebugLevel const DEFAULT_DEBUG_LEVEL   = DebugLevel::Info;
-static Stream *         DEFAULT_OUTPUT_STREAM = &Serial;
+static int const DEFAULT_DEBUG_LEVEL   = DEBUG_LVL_INFO;
+static Stream *  DEFAULT_OUTPUT_STREAM = &Serial;
 
 /******************************************************************************
    CTOR/DTOR
@@ -50,7 +50,7 @@ ArduinoDebugUtils::ArduinoDebugUtils()
    PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-void ArduinoDebugUtils::setDebugLevel(DebugLevel const debug_level)
+void ArduinoDebugUtils::setDebugLevel(int const debug_level)
 {
   _debug_level = debug_level;
 }
@@ -70,10 +70,10 @@ void ArduinoDebugUtils::timestampOff()
   _timestamp_on = false;
 }
 
-void ArduinoDebugUtils::debugPrint(DebugLevel const debug_level, const char * fmt, ...)
+void ArduinoDebugUtils::debugPrint(int const debug_level, const char * fmt, ...)
 {
-  if (debug_level >= DebugLevel::Error   &&
-      debug_level <= DebugLevel::Verbose &&
+  if (debug_level >= DEBUG_LVL_ERROR   &&
+      debug_level <= DEBUG_LVL_VERBOSE &&
       debug_level <= _debug_level)
   {
     if(_timestamp_on)

src/ArduinoDebugUtils.h

@@ -27,17 +27,15 @@
 #include <stdarg.h>
 
 /******************************************************************************
-   TYPEDEF
+   CONSTANTS
  ******************************************************************************/
 
-enum class DebugLevel : int {
-  None    = -1,
-  Error   =  0,
-  Warning =  1,
-  Info    =  2,
-  Debug   =  3,
-  Verbose =  4
-};
+static int const DEBUG_LVL_NONE    = -1;
+static int const DEBUG_LVL_ERROR   =  0;
+static int const DEBUG_LVL_WARNING =  1;
+static int const DEBUG_LVL_INFO    =  2;
+static int const DEBUG_LVL_DEBUG   =  3;
+static int const DEBUG_LVL_VERBOSE =  4;
 
 /******************************************************************************
    NAMESPACE
@@ -57,20 +55,20 @@ class ArduinoDebugUtils
 
   ArduinoDebugUtils();
 
-  void setDebugLevel(DebugLevel const debug_level);
+  void setDebugLevel(int const debug_level);
   void setDebugOutputStream(Stream * stream);
 
   void timestampOn();
   void timestampOff();
 
-  void debugPrint(DebugLevel const debug_level, const char * fmt, ...);
+  void debugPrint(int const debug_level, const char * fmt, ...);
 
 
 private:
 
-  bool          _timestamp_on;
-  DebugLevel    _debug_level;
-  Stream     *  _debug_output_stream;
+  bool      _timestamp_on;
+  int       _debug_level;
+  Stream *  _debug_output_stream;
 
   void vDebugPrint(char const * fmt, va_list args);