Skip to content

Provide API for printing the debug level as a string. #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 22, 2022
Merged

Provide API for printing the debug level as a string. #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions src/Arduino_DebugUtils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ static Stream * DEFAULT_OUTPUT_STREAM = &Serial;
Arduino_DebugUtils::Arduino_DebugUtils() {
timestampOff();
newlineOn();
debugLabelOff();
setDebugLevel(DEFAULT_DEBUG_LEVEL);
setDebugOutputStream(DEFAULT_OUTPUT_STREAM);
}
Expand Down Expand Up @@ -63,6 +64,14 @@ void Arduino_DebugUtils::newlineOff() {
_newline_on = false;
}

void Arduino_DebugUtils::debugLabelOn() {
_print_debug_label = true;
}

void Arduino_DebugUtils::debugLabelOff() {
_print_debug_label = false;
}

void Arduino_DebugUtils::timestampOn() {
_timestamp_on = true;
}
Expand All @@ -76,6 +85,9 @@ void Arduino_DebugUtils::print(int const debug_level, const char * fmt, ...)
if (!shouldPrint(debug_level))
return;

if (_print_debug_label)
printDebugLabel(debug_level);

if (_timestamp_on)
printTimestamp();

Expand All @@ -90,6 +102,9 @@ void Arduino_DebugUtils::print(int const debug_level, const __FlashStringHelper
if (!shouldPrint(debug_level))
return;

if (_print_debug_label)
printDebugLabel(debug_level);

if (_timestamp_on)
printTimestamp();

Expand Down Expand Up @@ -136,6 +151,24 @@ void Arduino_DebugUtils::printTimestamp()
_debug_output_stream->print(timestamp);
}

void Arduino_DebugUtils::printDebugLabel(int const debug_level)
{
static char const * DEBUG_MODE_STRING[5] =
{
"[DBG_ERROR ] ",
"[DBG_WARNING] ",
"[DBG_INFO ] ",
"[DBG_DEBUG ] ",
"[DBG_VERBOSE] ",
};

bool is_valid_debug_level = (debug_level >= DBG_ERROR) && (debug_level <= DBG_VERBOSE);
if (!is_valid_debug_level)
return;

_debug_output_stream->print(DEBUG_MODE_STRING[debug_level]);
}

bool Arduino_DebugUtils::shouldPrint(int const debug_level) const
{
return ((debug_level >= DBG_ERROR) && (debug_level <= DBG_VERBOSE) && (debug_level <= _debug_level));
Expand Down
5 changes: 5 additions & 0 deletions src/Arduino_DebugUtils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ class Arduino_DebugUtils {
void newlineOn();
void newlineOff();

void debugLabelOn();
void debugLabelOff();

void print(int const debug_level, const char * fmt, ...);
void print(int const debug_level, const __FlashStringHelper * fmt, ...);

Expand All @@ -69,11 +72,13 @@ class Arduino_DebugUtils {

bool _timestamp_on;
bool _newline_on;
bool _print_debug_label;
int _debug_level;
Stream * _debug_output_stream;

void vPrint(char const * fmt, va_list args);
void printTimestamp();
void printDebugLabel(int const debug_level);
bool shouldPrint(int const debug_level) const;

};
Expand Down