log.h

Go to the documentation of this file.

#pragma once
 
 
#include <cx/cx.h>
#include <cx/string/strbase.h>
#include <cx/stype/stvar.h>
 
enum LOG_LEVEL_ENUM {
    LOG_Fatal,     
    LOG_Error,     
    LOG_Warn,      
    LOG_Notice,    
    LOG_Info,      
    LOG_Verbose,   
    LOG_Diag,      
    LOG_Debug,     
    LOG_Trace,     
 
    LOG_Count      // Not a real level, used for array sizing
};
 
extern strref LogLevelNames[];
 
extern strref LogLevelAbbrev[];
 
typedef struct LogCategory {
    string name;   
    bool priv;     
} LogCategory;
 
typedef struct LogDest LogDest;
 
extern LogCategory* LogDefault;
 
typedef struct LogDeferData LogDeferData;
 
_Ret_opt_valid_ LogCategory* logCreateCat(_In_ strref name, bool priv);
 
typedef void (*LogDestMsg)(int level, _In_opt_ LogCategory* cat, int64 timestamp,
                           _In_opt_ strref msg, uint32 batchid, _In_opt_ void* userdata);
 
typedef void (*LogDestBatchDone)(uint32 batchid, _In_opt_ void* userdata);
 
typedef void (*LogDestClose)(_In_opt_ void* userdata);
 
_Ret_opt_valid_ LogDest*
logRegisterDest(int maxlevel, _In_opt_ LogCategory* catfilter, _In_ LogDestMsg msgfunc,
                _In_opt_ LogDestBatchDone batchfunc, _In_opt_ LogDestClose closefunc,
                _In_opt_ void* userdata);
 
bool logUnregisterDest(_Pre_valid_ _Post_invalid_ LogDest* dhandle);
 
void logFlush(void);
 
void logShutdown(void);
 
void logRestart(void);
 
void logBatchBegin(void);
 
void logBatchEnd(void);
 
 
 
#define logStr(level, str) _logStr_##level(LOG_##level, LogDefault, str)
 
#define logStrC(level, cat, str) _logStr_##level(LOG_##level, cat, str)
 
#define logFmt(level, fmt, ...)                    \
    _logFmt_##level(LOG_##level,                   \
                    LogDefault,                    \
                    fmt,                           \
                    count_macro_args(__VA_ARGS__), \
                    ((stvar[]) { __VA_ARGS__ }))
 
#define logFmtC(level, cat, fmt, ...)              \
    _logFmt_##level(LOG_##level,                   \
                    cat,                           \
                    fmt,                           \
                    count_macro_args(__VA_ARGS__), \
                    ((stvar[]) { __VA_ARGS__ }))
 
 
// Internal implementation functions used by macros - do not call directly
void _logStr(int level, int64 timestamp, _In_ LogCategory* cat, _In_ strref str);
void _logFmt(int level, int64 timestamp, _In_ LogCategory* cat, _In_ strref fmtstr, int n,
             _In_ stvar* args);
 
// Implementation macros for conditional compilation based on DEBUG_LEVEL
#if DEBUG_LEVEL >= 2
#define _logStr_Trace(level, cat, str)              _logStr(level, -1, cat, str)
#define _logFmt_Trace(level, cat, fmt, nargs, args) _logFmt(level, -1, cat, fmt, nargs, args)
#else
#define _logStr_Trace(level, cat, str)              ((void)0)
#define _logFmt_Trace(level, cat, fmt, nargs, args) ((void)0)
#endif
 
#if DEBUG_LEVEL >= 1
#define _logStr_Debug(level, cat, str)                _logStr(level, -1, cat, str)
#define _logFmt_Debug(level, cat, fmt, nargs, args)   _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_DevDiag(level, cat, str)              _logStr(LOG_Diag, -1, cat, str)
#define _logFmt_DevDiag(level, cat, fmt, nargs, args) _logFmt(LOG_Diag, -1, cat, fmt, nargs, args)
#define _logStr_DevVerbose(level, cat, str)           _logStr(LOG_Verbose, -1, cat, str)
#define _logFmt_DevVerbose(level, cat, fmt, nargs, args) \
    _logFmt(LOG_Verbose, -1, cat, fmt, nargs, args)
#define _logStr_DevInfo(level, cat, str)              _logStr(LOG_Info, -1, cat, str)
#define _logFmt_DevInfo(level, cat, fmt, nargs, args) _logFmt(LOG_Info, -1, cat, fmt, nargs, args)
#define _logStr_DevNotice(level, cat, str)            _logStr(LOG_Notice, -1, cat, str)
#define _logFmt_DevNotice(level, cat, fmt, nargs, args) \
    _logFmt(LOG_Notice, -1, cat, fmt, nargs, args)
#define _logStr_DevWarn(level, cat, str)               _logStr(LOG_Warn, -1, cat, str)
#define _logFmt_DevWarn(level, cat, fmt, nargs, args)  _logFmt(LOG_Warn, -1, cat, fmt, nargs, args)
#define _logStr_DevError(level, cat, str)              _logStr(LOG_Error, -1, cat, str)
#define _logFmt_DevError(level, cat, fmt, nargs, args) _logFmt(LOG_Error, -1, cat, fmt, nargs, args)
#else
#define _logStr_Debug(level, cat, str)      ((void)0)
#define _logFmt_Debug(level, cat, str)      ((void)0)
#define _logStr_DevDiag(level, cat, str)    ((void)0)
#define _logFmt_DevDiag(level, cat, str)    ((void)0)
#define _logStr_DevVerbose(level, cat, str) ((void)0)
#define _logFmt_DevVerbose(level, cat, str) ((void)0)
#define _logStr_DevInfo(level, cat, str)    ((void)0)
#define _logFmt_DevInfo(level, cat, str)    ((void)0)
#define _logStr_DevNotice(level, cat, str)  ((void)0)
#define _logFmt_DevNotice(level, cat, str)  ((void)0)
#define _logStr_DevWarn(level, cat, str)    ((void)0)
#define _logFmt_DevWarn(level, cat, str)    ((void)0)
#define _logStr_DevError(level, cat, str)   ((void)0)
#define _logFmt_DevError(level, cat, str)   ((void)0)
#endif
 
#define _logStr_Diag(level, cat, str)                 _logStr(level, -1, cat, str)
#define _logFmt_Diag(level, cat, fmt, nargs, args)    _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Verbose(level, cat, str)              _logStr(level, -1, cat, str)
#define _logFmt_Verbose(level, cat, fmt, nargs, args) _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Info(level, cat, str)                 _logStr(level, -1, cat, str)
#define _logFmt_Info(level, cat, fmt, nargs, args)    _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Notice(level, cat, str)               _logStr(level, -1, cat, str)
#define _logFmt_Notice(level, cat, fmt, nargs, args)  _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Warn(level, cat, str)                 _logStr(level, -1, cat, str)
#define _logFmt_Warn(level, cat, fmt, nargs, args)    _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Error(level, cat, str)                _logStr(level, -1, cat, str)
#define _logFmt_Error(level, cat, fmt, nargs, args)   _logFmt(level, -1, cat, fmt, nargs, args)
#define _logStr_Fatal(level, cat, str)                _logStr(level, -1, cat, str)
#define _logFmt_Fatal(level, cat, fmt, nargs, args)   _logFmt(level, -1, cat, fmt, nargs, args)