FreeRDP
Loading...
Searching...
No Matches
include/winpr/wlog.h
1
23#ifndef WINPR_LOG_H
24#define WINPR_LOG_H
25
26#ifdef __cplusplus
27extern "C"
28{
29#endif
30
31#include <stdarg.h>
32
33#include <winpr/platform.h>
34#include <winpr/wtypes.h>
35#include <winpr/winpr.h>
36#include <winpr/synch.h>
37#include <winpr/thread.h>
38
42#define WLOG_TRACE 0
43#define WLOG_DEBUG 1
44#define WLOG_INFO 2
45#define WLOG_WARN 3
46#define WLOG_ERROR 4
47#define WLOG_FATAL 5
48#define WLOG_OFF 6
49#define WLOG_LEVEL_INHERIT 0xFFFF
50
54#define WLOG_MESSAGE_TEXT 0
55#define WLOG_MESSAGE_DATA 1
56#define WLOG_MESSAGE_IMAGE 2
57#define WLOG_MESSAGE_PACKET 3
65#define WLOG_APPENDER_CONSOLE 0
66#define WLOG_APPENDER_FILE 1
67#define WLOG_APPENDER_BINARY 2
68#define WLOG_APPENDER_CALLBACK 3
69#define WLOG_APPENDER_SYSLOG 4
70#define WLOG_APPENDER_JOURNALD 5
71#define WLOG_APPENDER_UDP 6
72
73 typedef struct
74 {
75 DWORD Type;
76
77 DWORD Level;
78
79 LPSTR PrefixString;
80
81 LPCSTR FormatString;
82 LPCSTR TextString;
83
84 size_t LineNumber; /* __LINE__ */
85 LPCSTR FileName; /* __FILE__ */
86 LPCSTR FunctionName; /* __func__ */
87
88 /* Data Message */
89
90 void* Data;
91 size_t Length;
92
93 /* Image Message */
94
95 void* ImageData;
96 size_t ImageWidth;
97 size_t ImageHeight;
98 size_t ImageBpp;
99
100 /* Packet Message */
101
102 void* PacketData;
103 size_t PacketLength;
104 DWORD PacketFlags;
105 } wLogMessage;
106 typedef struct s_wLogLayout wLogLayout;
107 typedef struct s_wLogAppender wLogAppender;
108 typedef struct s_wLog wLog;
109
110#define WLOG_PACKET_INBOUND 1
111#define WLOG_PACKET_OUTBOUND 2
112
126 WINPR_ATTR_FORMAT_ARG(6, 7)
127 WINPR_API BOOL WLog_PrintTextMessage(wLog* log, DWORD level, size_t line, const char* file,
128 const char* function, WINPR_FORMAT_ARG const char* fmt,
129 ...);
130
144 WINPR_ATTR_FORMAT_ARG(6, 0)
145 WINPR_API BOOL WLog_PrintTextMessageVA(wLog* log, DWORD level, size_t line, const char* file,
146 const char* function, WINPR_FORMAT_ARG const char* fmt,
147 va_list args);
148
161 WINPR_API BOOL WLog_PrintMessage(wLog* log, DWORD type, DWORD level, size_t line,
162 const char* file, const char* function, ...);
163
176 WINPR_API BOOL WLog_PrintMessageVA(wLog* log, DWORD type, DWORD level, size_t line,
177 const char* file, const char* function, va_list args);
178
179 WINPR_ATTR_NODISCARD
180 WINPR_API wLog* WLog_GetRoot(void);
181
182 WINPR_ATTR_NODISCARD
183 WINPR_API wLog* WLog_Get(LPCSTR name);
184
185 WINPR_ATTR_NODISCARD
186 WINPR_API DWORD WLog_GetLogLevel(wLog* log);
187
188 WINPR_ATTR_NODISCARD
189 WINPR_API BOOL WLog_IsLevelActive(wLog* _log, DWORD _log_level);
190
201 WINPR_API BOOL WLog_SetContext(wLog* log, const char* (*fkt)(void*), void* context);
202
216 WINPR_API BOOL WLog_SetGlobalContext(const char* globalprefix);
217
218#define WLog_Print_unchecked(_log, _log_level, ...) \
219 do \
220 { \
221 WLog_PrintTextMessage(_log, _log_level, __LINE__, __FILE__, __func__, __VA_ARGS__); \
222 } while (0)
223
224#define WLog_Print(_log, _log_level, ...) \
225 do \
226 { \
227 if (WLog_IsLevelActive(_log, _log_level)) \
228 { \
229 WLog_Print_unchecked(_log, _log_level, __VA_ARGS__); \
230 } \
231 } while (0)
232
233#define WLog_Print_tag(_tag, _log_level, ...) \
234 do \
235 { \
236 static wLog* _log_cached_ptr = nullptr; \
237 if (!_log_cached_ptr) \
238 _log_cached_ptr = WLog_Get(_tag); \
239 WLog_Print(_log_cached_ptr, _log_level, __VA_ARGS__); \
240 } while (0)
241
242#define WLog_PrintVA_unchecked(_log, _log_level, _fmt, _args) \
243 do \
244 { \
245 WLog_PrintTextMessageVA(_log, _log_level, __LINE__, __FILE__, __func__, _fmt, _args); \
246 } while (0)
247
248#define WLog_PrintVA(_log, _log_level, _fmt, _args) \
249 do \
250 { \
251 if (WLog_IsLevelActive(_log, _log_level)) \
252 { \
253 WLog_PrintVA_unchecked(_log, _log_level, _fmt, _args); \
254 } \
255 } while (0)
256
257#define WLog_Data(_log, _log_level, ...) \
258 do \
259 { \
260 if (WLog_IsLevelActive(_log, _log_level)) \
261 { \
262 WLog_PrintMessage(_log, WLOG_MESSAGE_DATA, _log_level, __LINE__, __FILE__, __func__, \
263 __VA_ARGS__); \
264 } \
265 } while (0)
266
267#define WLog_Image(_log, _log_level, ...) \
268 do \
269 { \
270 if (WLog_IsLevelActive(_log, _log_level)) \
271 { \
272 WLog_PrintMessage(_log, WLOG_MESSAGE_DATA, _log_level, __LINE__, __FILE__, __func__, \
273 __VA_ARGS__); \
274 } \
275 } while (0)
276
277#define WLog_Packet(_log, _log_level, ...) \
278 do \
279 { \
280 if (WLog_IsLevelActive(_log, _log_level)) \
281 { \
282 WLog_PrintMessage(_log, WLOG_MESSAGE_PACKET, _log_level, __LINE__, __FILE__, __func__, \
283 __VA_ARGS__); \
284 } \
285 } while (0)
286
287 WINPR_ATTR_FORMAT_ARG(6, 7)
288 static inline void WLog_Print_dbg_tag(const char* WINPR_RESTRICT tag, DWORD log_level,
289 size_t line, const char* file, const char* fkt,
290 WINPR_FORMAT_ARG const char* fmt, ...)
291 {
292 static wLog* log_cached_ptr = nullptr;
293 if (!log_cached_ptr)
294 log_cached_ptr = WLog_Get(tag);
295
296 if (WLog_IsLevelActive(log_cached_ptr, log_level))
297 {
298 va_list ap = WINPR_C_ARRAY_INIT;
299 va_start(ap, fmt);
300 WLog_PrintTextMessageVA(log_cached_ptr, log_level, line, file, fkt, fmt, ap);
301 va_end(ap);
302 }
303 }
304
305#define WLog_LVL(tag, lvl, ...) \
306 WLog_Print_dbg_tag(tag, lvl, __LINE__, __FILE__, __func__, __VA_ARGS__)
307#define WLog_VRB(tag, ...) \
308 WLog_Print_dbg_tag(tag, WLOG_TRACE, __LINE__, __FILE__, __func__, __VA_ARGS__)
309#define WLog_DBG(tag, ...) \
310 WLog_Print_dbg_tag(tag, WLOG_DEBUG, __LINE__, __FILE__, __func__, __VA_ARGS__)
311#define WLog_INFO(tag, ...) \
312 WLog_Print_dbg_tag(tag, WLOG_INFO, __LINE__, __FILE__, __func__, __VA_ARGS__)
313#define WLog_WARN(tag, ...) \
314 WLog_Print_dbg_tag(tag, WLOG_WARN, __LINE__, __FILE__, __func__, __VA_ARGS__)
315#define WLog_ERR(tag, ...) \
316 WLog_Print_dbg_tag(tag, WLOG_ERROR, __LINE__, __FILE__, __func__, __VA_ARGS__)
317#define WLog_FATAL(tag, ...) \
318 WLog_Print_dbg_tag(tag, WLOG_FATAL, __LINE__, __FILE__, __func__, __VA_ARGS__)
319
320 WINPR_ATTR_NODISCARD
321 WINPR_API BOOL WLog_SetLogLevel(wLog* log, DWORD logLevel);
322
323 WINPR_ATTR_NODISCARD
324 WINPR_API BOOL WLog_SetStringLogLevel(wLog* log, LPCSTR level);
325
326 WINPR_ATTR_NODISCARD
327 WINPR_API BOOL WLog_AddStringLogFilters(LPCSTR filter);
328
329 WINPR_ATTR_NODISCARD
330 WINPR_API BOOL WLog_SetLogAppenderType(wLog* log, DWORD logAppenderType);
331
332 WINPR_ATTR_NODISCARD
333 WINPR_API wLogAppender* WLog_GetLogAppender(wLog* log);
334
335 WINPR_ATTR_NODISCARD
336 WINPR_API BOOL WLog_OpenAppender(wLog* log);
337
338 WINPR_ATTR_NODISCARD
339 WINPR_API BOOL WLog_CloseAppender(wLog* log);
340
341 WINPR_ATTR_NODISCARD
342 WINPR_API BOOL WLog_ConfigureAppender(wLogAppender* appender, const char* setting, void* value);
343
344 WINPR_ATTR_NODISCARD
345 WINPR_API wLogLayout* WLog_GetLogLayout(wLog* log);
346
347 WINPR_ATTR_NODISCARD
348 WINPR_API BOOL WLog_Layout_SetPrefixFormat(wLog* log, wLogLayout* layout, const char* format);
349
350#if defined(WITH_WINPR_DEPRECATED)
352 WINPR_DEPRECATED(WINPR_ATTR_NODISCARD WINPR_API BOOL WLog_Init(void));
353
355 WINPR_DEPRECATED(WINPR_ATTR_NODISCARD WINPR_API BOOL WLog_Uninit(void));
356#endif
357
358 typedef BOOL (*wLogCallbackMessage_t)(const wLogMessage* msg);
359 typedef BOOL (*wLogCallbackData_t)(const wLogMessage* msg);
360 typedef BOOL (*wLogCallbackImage_t)(const wLogMessage* msg);
361 typedef BOOL (*wLogCallbackPackage_t)(const wLogMessage* msg);
362
363 typedef struct
364 {
365 WINPR_ATTR_NODISCARD wLogCallbackData_t data;
366 WINPR_ATTR_NODISCARD wLogCallbackImage_t image;
367 WINPR_ATTR_NODISCARD wLogCallbackMessage_t message;
368 WINPR_ATTR_NODISCARD wLogCallbackPackage_t package;
369 } wLogCallbacks;
370
371#ifdef __cplusplus
372}
373#endif
374
375#endif /* WINPR_WLOG_H */
s_wLogAppender
Definition libwinpr/utils/wlog/wlog.h:41
s_wLogLayout
Definition Layout.h:30
s_wLog
Definition libwinpr/utils/wlog/wlog.h:62