logserializer.h

Go to the documentation of this file.

#pragma once
 
 
#include <cx/log/log.h>
 
CX_C_BEGIN
 
enum LOG_DATE_FORMATS {
    LOG_DateISO,             
    LOG_DateISOCompact,      
    LOG_DateNCSA,            
    LOG_DateSyslog,          
    LOG_DateISOCompactMsec,  
    LOG_DateTimeOnly,        
    LOG_DateTimeOnlyMsec     
};
 
enum LOG_FLAGS {
    LOG_LocalTime      = 0x0001,   
    LOG_OmitLevel      = 0x0002,   
    LOG_ShortLevel     = 0x0004,   
    LOG_BracketLevel   = 0x0008,   
    LOG_JustifyLevel   = 0x0010,   
    LOG_IncludeChannel = 0x0020,   
    LOG_BracketChannel = 0x0040,   
    LOG_AddColon       = 0x0080,   
    LOG_ChannelFirst   = 0x0100,   
    LOG_IncludeContext = 0x0200,   
    LOG_OmitDate       = 0x0400,   
};
 
typedef void (*LogSerializeFunc)(_Inout_ string* out, _In_ const LogRecord* rec,
                                 _In_opt_ void* userdata);
 
typedef void (*LogSerializerClose)(_In_opt_ void* userdata);
 
typedef struct LogSerializer {
    LogSerializeFunc serialize;   
    LogSerializerClose close;     
    void* userdata;               
} LogSerializer;
 
_Ret_valid_ LogSerializer* logSerializerCreate(_In_ LogSerializeFunc serialize,
                                               _In_opt_ LogSerializerClose close,
                                               _In_opt_ void* userdata);
 
void logSerializerDestroy(_Inout_ LogSerializer** ser);
 
void logSerialize(_Inout_ string* out, _In_opt_ LogSerializer* ser, _In_ const LogRecord* rec);
 
typedef struct LogTextConfig {
    int dateFormat;   
    int spacing;      
    uint32 flags;     
 
    strref ctxfields;
} LogTextConfig;
 
_Ret_valid_ LogSerializer* logTextSerializer(_In_opt_ LogTextConfig* config);
 
typedef struct LogNdjsonConfig {
    uint32 flags;   
} LogNdjsonConfig;
 
_Ret_valid_ LogSerializer* logNdjsonSerializer(_In_opt_ LogNdjsonConfig* config);
 
// ============================================================================
// Text formatting helpers
// ============================================================================
//
// The pieces the text serializer assembles a line from. Exported so a custom serializer can
// match its prefixes exactly instead of reimplementing them.
 
void logVarText(_Inout_ string* out, _In_ const stvar* v);
 
void logFormatDate(_Inout_ string* out, int dateFormat, uint32 flags, int64 timestamp);
 
void logFormatLevel(_Inout_ string* out, int level, uint32 flags);
 
void logFormatChannel(_Inout_ string* out, _In_opt_ LogChannel* chan, uint32 flags);
 
 
CX_C_END