libxr  1.0
Want to be the best embedded framework
Loading...
Searching...
No Matches
logger.hpp
1#pragma once
2
3#include <cstdarg>
4#include <cstdint>
5#include <cstdio>
6
7#include "libxr_color.hpp"
8#include "libxr_rw.hpp"
9#include "libxr_time.hpp"
10
11namespace LibXR
12{
13
26
31struct LogData
32{
35 const char* file;
36 uint32_t line;
37 char message[XR_LOG_MESSAGE_MAX_LEN];
38};
39
44class Logger
45{
46 public:
50 static void Init();
51
60 // NOLINTNEXTLINE
61 static void Publish(LogLevel level, const char* file, uint32_t line, const char* fmt,
62 ...);
63
64 private:
69 static void PrintToTerminal(const LogData& data)
70 {
71 const char* color = GetColor(data.level);
72
73 STDIO::Printf("%s%s [%u](%s:%u) %s%s\r\n", color, LevelToString(data.level),
74 static_cast<uint32_t>(data.timestamp), data.file, data.line,
75 data.message, LIBXR_FORMAT_STR[static_cast<uint8_t>(Format::RESET)]);
76 }
77
83 static const char* GetColor(LogLevel level)
84 {
85 using namespace LibXR;
86 switch (level)
87 {
89 return LIBXR_FONT_STR[static_cast<uint8_t>(Font::MAGENTA)];
91 return LIBXR_FONT_STR[static_cast<uint8_t>(Font::CYAN)];
93 return LIBXR_FONT_STR[static_cast<uint8_t>(Font::GREEN)];
95 return LIBXR_FONT_STR[static_cast<uint8_t>(Font::YELLOW)];
97 return LIBXR_FONT_STR[static_cast<uint8_t>(Font::RED)];
98 default:
99 return "";
100 }
101 }
102
108 static const char* LevelToString(LogLevel level)
109 {
110 switch (level)
111 {
113 return "D";
115 return "I";
117 return "P";
119 return "W";
121 return "E";
122 default:
123 return "UNKNOWN";
124 }
125 }
126
127 static inline std::atomic<uint32_t> initialized_ = false;
128};
129
130} // namespace LibXR
131
132#if LIBXR_LOG_LEVEL >= 4
136#define XR_LOG_DEBUG(fmt, ...) \
137 LibXR::Logger::Publish(LibXR::LogLevel::XR_LOG_LEVEL_DEBUG, __FILE__, __LINE__, fmt, \
138 ##__VA_ARGS__)
139#else
140#define XR_LOG_DEBUG(...)
141#endif
142
143#if LIBXR_LOG_LEVEL >= 3
147#define XR_LOG_INFO(fmt, ...) \
148 LibXR::Logger::Publish(LibXR::LogLevel::XR_LOG_LEVEL_INFO, __FILE__, __LINE__, fmt, \
149 ##__VA_ARGS__)
150#else
151#define XR_LOG_INFO(...)
152#endif
153
154#if LIBXR_LOG_LEVEL >= 2
158#define XR_LOG_PASS(fmt, ...) \
159 LibXR::Logger::Publish(LibXR::LogLevel::XR_LOG_LEVEL_PASS, __FILE__, __LINE__, fmt, \
160 ##__VA_ARGS__)
161#else
162#define XR_LOG_PASS(...)
163#endif
164
165#if LIBXR_LOG_LEVEL >= 1
169#define XR_LOG_WARN(fmt, ...) \
170 LibXR::Logger::Publish(LibXR::LogLevel::XR_LOG_LEVEL_WARN, __FILE__, __LINE__, fmt, \
171 ##__VA_ARGS__)
172#else
173#define XR_LOG_WARN(...)
174#endif
175
176#if LIBXR_LOG_LEVEL >= 0
180#define XR_LOG_ERROR(fmt, ...) \
181 LibXR::Logger::Publish(LibXR::LogLevel::XR_LOG_LEVEL_ERROR, __FILE__, __LINE__, fmt, \
182 ##__VA_ARGS__)
183#else
184#define XR_LOG_ERROR(...)
185#endif
日志管理器 / LibXR Logger Manager
Definition logger.hpp:45
static const char * GetColor(LogLevel level)
根据日志级别获取显示颜色 / Get color code based on log level
Definition logger.hpp:83
static void Init()
初始化日志主题 / Initialize the log topic
Definition logger.cpp:15
static const char * LevelToString(LogLevel level)
将日志级别转换为字符串 / Convert log level to string
Definition logger.hpp:108
static void Publish(LogLevel level, const char *file, uint32_t line, const char *fmt,...)
发布一条日志 / Publish a log message
Definition logger.cpp:42
static void PrintToTerminal(const LogData &data)
打印日志到终端 / Print log to terminal
Definition logger.hpp:69
static int Printf(const char *fmt,...)
Prints a formatted string to the write port (like printf).
Definition libxr_rw.hpp:838
表示毫秒级时间戳的类。Class representing a timestamp in milliseconds.
LibXR 命名空间
Definition ch32_gpio.hpp:9
constexpr const char * LIBXR_FONT_STR[]
ANSI escape sequences for font color / ANSI转义序列 - 字体颜色
constexpr const char * LIBXR_FORMAT_STR[]
ANSI escape sequences for text format / ANSI转义序列 - 文本格式
LogLevel
日志级别枚举 / Log level enumeration
Definition logger.hpp:19
@ XR_LOG_LEVEL_INFO
一般信息 / Informational message
@ XR_LOG_LEVEL_DEBUG
调试信息 / Debug message
@ XR_LOG_LEVEL_WARN
警告信息 / Warning message
@ XR_LOG_LEVEL_ERROR
错误信息 / Error message
@ XR_LOG_LEVEL_PASS
通过信息 / Pass message
日志数据结构体 / Log data structure
Definition logger.hpp:32
uint32_t line
行号 / Line number
Definition logger.hpp:36
const char * file
文件名指针 / Source file name pointer
Definition logger.hpp:35
LogLevel level
日志级别 / Log level
Definition logger.hpp:34
TimestampMS timestamp
时间戳 / Timestamp
Definition logger.hpp:33
char message[XR_LOG_MESSAGE_MAX_LEN]
日志消息内容 / Log message content
Definition logger.hpp:37