-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathArduino_DebugUtils.h
120 lines (86 loc) · 3.52 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
/*
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>
/******************************************************************************
CONSTANTS
******************************************************************************/
static int const DBG_NONE = -1;
static int const DBG_ERROR = 0;
static int const DBG_WARNING = 1;
static int const DBG_INFO = 2;
static int const DBG_DEBUG = 3;
static int const DBG_VERBOSE = 4;
void setDebugMessageLevel(int const debug_level);
int getDebugMessageLevel();
/******************************************************************************
CLASS DECLARATION
******************************************************************************/
class Arduino_DebugUtils {
public:
Arduino_DebugUtils();
void setDebugLevel(int const debug_level);
int getDebugLevel() const;
void setDebugOutputStream(Stream * stream);
void timestampOn();
void timestampOff();
void newlineOn();
void newlineOff();
void debugLabelOn();
void debugLabelOff();
void formatTimestampOn();
void formatTimestampOff();
void print(int const debug_level, const char * fmt, ...);
void print(int const debug_level, const __FlashStringHelper * fmt, ...);
void print(int const debug_level, const char * fmt, va_list args);
private:
bool _timestamp_on;
bool _newline_on;
bool _print_debug_label;
bool _format_timestamp_on;
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;
};
/******************************************************************************
EXTERN
******************************************************************************/
extern Arduino_DebugUtils Debug;
/**************************************************************************************
* DEFINE
**************************************************************************************/
#ifndef DEBUG_ERROR
# define DEBUG_ERROR(fmt, ...) Debug.print(DBG_ERROR, fmt, ## __VA_ARGS__)
#endif
#ifndef DEBUG_WARNING
# define DEBUG_WARNING(fmt, ...) Debug.print(DBG_WARNING, fmt, ## __VA_ARGS__)
#endif
#ifndef DEBUG_INFO
# define DEBUG_INFO(fmt, ...) Debug.print(DBG_INFO, fmt, ## __VA_ARGS__)
#endif
#ifndef DEBUG_DEBUG
# define DEBUG_DEBUG(fmt, ...) Debug.print(DBG_DEBUG, fmt, ## __VA_ARGS__)
#endif
#ifndef DEBUG_VERBOSE
# define DEBUG_VERBOSE(fmt, ...) Debug.print(DBG_VERBOSE, fmt, ## __VA_ARGS__)
#endif
#endif /* ARDUINO_DEBUG_UTILS_H_ */