IoTeX client
client_helper.h
1#ifndef CLIENT_HELPERS_H
2#define CLIENT_HELPERS_H
3
4#include "extern/cpplogger/cpplogger.h"
5#include "IoTeXResultCodes.h"
6#include <cstring>
7#include <string>
8#include <vector>
9
10// clang-format off
11
12/**************************************************************************/
13/* Log level macros */
14/**************************************************************************/
15
16#define IOTEX_LOG_LEVEL_TRACE cpplogger::LogLevel::TRACE
17#define IOTEX_LOG_LEVEL_DEBUG cpplogger::LogLevel::DEBUG
18#define IOTEX_LOG_LEVEL_INFO cpplogger::LogLevel::INFO
19#define IOTEX_LOG_LEVEL_WARNING cpplogger::LogLevel::WARNING
20#define IOTEX_LOG_LEVEL_ERROR cpplogger::LogLevel::ERROR
21#define IOTEX_LOG_LEVEL_NONE cpplogger::LogLevel::NONE
22
23#define IOTEX_DEFAULT_LOG_LEVEL IOTEX_LOG_LEVEL_NONE
24
25/**************************************************************************/
26/* Set default log level */
27/**************************************************************************/
28
29#ifndef IOTEX_LOG_LEVEL
30 #define IOTEX_LOG_LEVEL IOTEX_DEFAULT_LOG_LEVEL
31#endif
32
33/**************************************************************************/
34/* Conditinally include board specific files and add board specific flags */
35/**************************************************************************/
36
37#if defined(ARDUINO) || defined(ESP8266) || defined(ESP32) || defined(__SAMD21G18A__)
38 #include <Arduino.h>
39 #define IotexString String // Use Arduino String intead of std::string in Arduino
40#else
41 #define IotexString std::string
42 #ifndef OS
43 #define OS
44 #endif
45#endif
46
47/**************************************************************************/
48/* Remove log statements from compiled binary if IOTEX_ENABLE_LOG not defined */
49/**************************************************************************/
50
51#ifndef IOTEX_ENABLE_LOG
52 #define IOTEX_DEBUG(module, ...)
53 #define IOTEX_INFO(module, ...)
54 #define IOTEX_WARNING(module, ...)
55 #define IOTEX_TRACE(module, ...)
56 #define IOTEX_ERROR(module, ...)
57 #define IOTEX_DEBUG_F(module, ...)
58 #define IOTEX_INFO_F(module, ...)
59 #define IOTEX_WARNING_F(module, ...)
60 #define IOTEX_TRACE_F(module, ...)
61 #define IOTEX_ERROR_F(module, ...)
62 #define IOTEX_DEBUG_BUF(module, ...)
63 #define IOTEX_INFO_BUF(module, ...)
64 #define IOTEX_WARNING_BUF(module, ...)
65 #define IOTEX_TRACE_BUF(module, ...)
66 #define IOTEX_ERROR_BUF(module, ...)
67#endif
68
69/**************************************************************************/
70/* Helper macros for logging a message with different levels */
71/**************************************************************************/
72
73#ifdef IOTEX_ENABLE_LOG
74 #define IOTEX_DEBUG(module, ...) IotexHelpers.logger.LOG_MSG(cpplogger::LogLevel::DEBUG, module, __VA_ARGS__)
75 #define IOTEX_INFO(module, ...) IotexHelpers.logger.LOG_MSG(cpplogger::LogLevel::INFO, module, __VA_ARGS__)
76 #define IOTEX_WARNING(module, ...) IotexHelpers.logger.LOG_MSG(cpplogger::LogLevel::WARNING, module, __VA_ARGS__)
77 #define IOTEX_TRACE(module, ...) IotexHelpers.logger.LOG_MSG(cpplogger::LogLevel::TRACE, module, __VA_ARGS__)
78 #define IOTEX_ERROR(module, ...) IotexHelpers.logger.LOG_MSG(cpplogger::LogLevel::ERROR, module, __VA_ARGS__)
79#endif
80
81/**************************************************************************/
82/* Helper macros for logging a hex dump of a buffer with different levels */
83/**************************************************************************/
84
85#ifdef IOTEX_ENABLE_LOG
86 #define IOTEX_DEBUG_BUF(module, buf, size) IotexHelpers.logger.LOG_BUF(cpplogger::LogLevel::DEBUG, module, buf, size)
87 #define IOTEX_INFO_BUF(module, buf, size) IotexHelpers.logger.LOG_BUF(cpplogger::LogLevel::INFO, module, buf, size)
88 #define IOTEX_WARNING_BUF(module, buf, size) IotexHelpers.logger.LOG_BUF(cpplogger::LogLevel::WARNING, module, buf, size)
89 #define IOTEX_TRACE_BUF(module, buf, size) IotexHelpers.logger.LOG_BUF(cpplogger::LogLevel::TRACE, module, buf, size)
90 #define IOTEX_ERROR_BUF(module, buf, size) IotexHelpers.logger.LOG_BUF(cpplogger::LogLevel::ERROR, module, buf, size)
91#endif
92
93/**************************************************************************/
94/* Helper macros for logging a flash string with different levels (for ESP) */
95/**************************************************************************/
96
97#ifdef IOTEX_ENABLE_LOG
98 #if !defined(ESP8266) && !defined(ESP32)
99 #define IOTEX_FLASH_STRING_SUPPORT false
100 #else
101 #define IOTEX_FLASH_STRING_SUPPORT true
102 #endif
103
104 #if !IOTEX_FLASH_STRING_SUPPORT
105 #define IOTEX_DEBUG_F(module, ...) IOTEX_DEBUG(module, __VA_ARGS__)
106 #define IOTEX_INFO_F(module, ...) IOTEX_INFO(module, __VA_ARGS__)
107 #define IOTEX_WARNING_F(module, ...) IOTEX_WARNING(module, __VA_ARGS__)
108 #define IOTEX_TRACE_F(module, ...) IOTEX_TRACE(module, __VA_ARGS__)
109 #define IOTEX_ERROR_F(module, ...) IOTEX_ERROR(module, __VA_ARGS__)
110 #else
111 #define IOTEX_DEBUG_F(module, msg) IotexHelpers.logger.LOG_PROGMEM_STRING(cpplogger::LogLevel::DEBUG, module, msg)
112 #define IOTEX_INFO_F(module, msg) IotexHelpers.logger.LOG_PROGMEM_STRING(cpplogger::LogLevel::DEBUG, module, msg)
113 #define IOTEX_WARNING_F(module, msg) IotexHelpers.logger.LOG_PROGMEM_STRING(cpplogger::LogLevel::DEBUG, module, msg)
114 #define IOTEX_TRACE_F(module, msg) IotexHelpers.logger.LOG_PROGMEM_STRING(cpplogger::LogLevel::DEBUG, module, msg)
115 #define IOTEX_ERROR_F(module, msg) IotexHelpers.logger.LOG_PROGMEM_STRING(cpplogger::LogLevel::DEBUG, module, msg)
116 #endif
117#endif
118
119// clang-format on
120
121namespace iotex
122{
128{
129 USER,
130 GENERAL,
131 HTTP,
132 CONTRACT,
133 VALUES_COUNT
134};
135
141extern const std::string& userLogModule;
142
147extern const std::string logModuleNamesLookupTable[(int)LogModules::VALUES_COUNT];
148
154{
155 NONE,
156 ERROR,
157 WARNING,
158 INFO,
159 DEBUG,
160 TRACE
161};
162
168{
169 public:
170 Helpers();
171 cpplogger::Logger logger;
172
179 void vectorToHexString(std::vector<uint8_t>& data, IotexString& out);
180
187 const char* GetResultString(ResultCode code);
188
195
203 void setModuleLogLevel(const std::string& module, IotexLogLevel level);
204};
205} // namespace iotex
206
211extern iotex::Helpers IotexHelpers;
212
213#endif
Class that contains helper methods.
Definition: client_helper.h:168
void vectorToHexString(std::vector< uint8_t > &data, IotexString &out)
Gets the hex string representation of a vector of bytes.
Definition: client_helper.cpp:55
void setModuleLogLevel(const std::string &module, IotexLogLevel level)
Set the Mlog level for a module. Note that the global lov level can override a module log level.
Definition: client_helper.cpp:76
const char * GetResultString(ResultCode code)
Gets the result strinf value of a ResultCode.
Definition: client_helper.cpp:66
void setGlobalLogLevel(IotexLogLevel level)
Sets the log level globally. Overrides log level modules if they are of a higher level.
Definition: client_helper.cpp:71
Definition: abi.h:12
const std::string & userLogModule
General log module name exposed to the user, so the logger can be used by user code if needed.
Definition: client_helper.cpp:32
IotexLogLevel
Enum representing all the log levels.
Definition: client_helper.h:154
LogModules
Enum that contains the different logging modules of the library.
Definition: client_helper.h:128
const std::string logModuleNamesLookupTable[(int) LogModules::VALUES_COUNT]
Lookup table for log module names. This should be only used by the internal library code.
Definition: client_helper.cpp:22