-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathArduino_DebugUtils.h
153 lines (115 loc) · 5.38 KB
/
Arduino_DebugUtils.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
This file is part of Arduino_DebugUtils.
Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
This software is released under the GNU General Public License version 3,
which covers the main part of arduino-cli.
The terms of this license can be found at:
https://www.gnu.org/licenses/gpl-3.0.en.html
You can be released from the requirements of the above licenses by purchasing
a commercial license. Buying such a license is mandatory if you want to modify or
otherwise use the software for commercial activities involving the Arduino
software without disclosing the source code of your own applications. To purchase
a commercial license, send an email to [email protected].
*/
#ifndef ARDUINO_DEBUG_UTILS_H_
#define ARDUINO_DEBUG_UTILS_H_
/******************************************************************************
INCLUDE
******************************************************************************/
#include <Arduino.h>
#include <stdarg.h>
#define DEBUG_LEVEL_NONE 0x0000
#define DEBUG_LEVEL_ERROR 0x0001
#define DEBUG_LEVEL_WARNING 0x0003
#define DEBUG_LEVEL_INFO 0x0007
#define DEBUG_LEVEL_DEBUG 0x000F
#define DEBUG_LEVEL_VERBOSE 0x001F
#define DEBUG_LEVEL_ALL 0xFFFF
/******************************************************************************
CLASS DECLARATION
******************************************************************************/
class Arduino_DebugUtils {
public:
enum class Level: uint_fast16_t {
None = DEBUG_LEVEL_NONE,
Error = DEBUG_LEVEL_ERROR,
Warning = DEBUG_LEVEL_WARNING,
Info = DEBUG_LEVEL_INFO,
Verbose = DEBUG_LEVEL_VERBOSE,
Debug = DEBUG_LEVEL_DEBUG,
All = DEBUG_LEVEL_ALL,
};
Arduino_DebugUtils();
void setDebugLevel(Level const debug_level);
Arduino_DebugUtils::Level getDebugLevel() const;
void setDebugOutputStream(Stream * stream);
void timestampOn();
void timestampOff();
void newlineOn();
void newlineOff();
void debugLabelOn();
void debugLabelOff();
void formatTimestampOn();
void formatTimestampOff();
void print(Level const debug_level, const char * fmt, ...);
void print(Level const debug_level, const __FlashStringHelper * fmt, ...);
private:
bool _timestamp_on;
bool _newline_on;
bool _print_debug_label;
bool _format_timestamp_on;
Level _debug_level;
Stream * _debug_output_stream;
void vPrint(char const * fmt, va_list args);
void printTimestamp();
void printDebugLabel(Arduino_DebugUtils::Level const debug_level);
inline bool shouldPrint(Level const debug_level) const;
};
void setDebugMessageLevel(Arduino_DebugUtils::Level const debug_level);
Arduino_DebugUtils::Level getDebugMessageLevel();
/******************************************************************************
CONSTANTS
******************************************************************************/
static constexpr Arduino_DebugUtils::Level DBG_NONE = Arduino_DebugUtils::Level::None;
static constexpr Arduino_DebugUtils::Level DBG_ERROR = Arduino_DebugUtils::Level::Error;
static constexpr Arduino_DebugUtils::Level DBG_WARNING = Arduino_DebugUtils::Level::Warning;
static constexpr Arduino_DebugUtils::Level DBG_INFO = Arduino_DebugUtils::Level::Info;
static constexpr Arduino_DebugUtils::Level DBG_DEBUG = Arduino_DebugUtils::Level::Debug;
static constexpr Arduino_DebugUtils::Level DBG_VERBOSE = Arduino_DebugUtils::Level::Verbose;
static constexpr Arduino_DebugUtils::Level DBG_ALL = Arduino_DebugUtils::Level::All;
/******************************************************************************
EXTERN
******************************************************************************/
extern Arduino_DebugUtils Debug;
/**************************************************************************************
* DEFINE
**************************************************************************************/
#ifndef DEBUG_LEVEL
# define DEBUG_LEVEL DEBUG_LEVEL_ALL
#endif
#if !defined(DEBUG_ERROR) && ((DEBUG_LEVEL & DEBUG_LEVEL_ERROR) == DEBUG_LEVEL_ERROR)
# define DEBUG_ERROR(fmt, ...) Debug.print(DBG_ERROR, fmt, ## __VA_ARGS__)
#else
# define DEBUG_ERROR(fmt, ...) (void) 0
#endif
#if !defined(DEBUG_WARNING) && ((DEBUG_LEVEL & DEBUG_LEVEL_WARNING) == DEBUG_LEVEL_WARNING)
# define DEBUG_WARNING(fmt, ...) Debug.print(DBG_WARNING, fmt, ## __VA_ARGS__)
#else
# define DEBUG_WARNING(fmt, ...) (void) 0
#endif
#if !defined(DEBUG_INFO) && ((DEBUG_LEVEL & DEBUG_LEVEL_INFO) == DEBUG_LEVEL_INFO)
# define DEBUG_INFO(fmt, ...) Debug.print(DBG_INFO, fmt, ## __VA_ARGS__)
#else
# define DEBUG_INFO(fmt, ...) (void) 0
#endif
#if !defined(DEBUG_DEBUG) && ((DEBUG_LEVEL & DEBUG_LEVEL_DEBUG) == DEBUG_LEVEL_DEBUG)
# define DEBUG_DEBUG(fmt, ...) Debug.print(DBG_DEBUG, fmt, ## __VA_ARGS__)
#else
# define DEBUG_DEBUG(fmt, ...) (void) 0
#endif
#if !defined(DEBUG_VERBOSE) && ((DEBUG_LEVEL & DEBUG_LEVEL_VERBOSE) == DEBUG_LEVEL_VERBOSE)
# define DEBUG_VERBOSE(fmt, ...) Debug.print(DBG_VERBOSE, fmt, ## __VA_ARGS__)
#else
# define DEBUG_VERBOSE(fmt, ...) (void) 0
#endif
#endif /* ARDUINO_DEBUG_UTILS_H_ */