log.h

Go to the documentation of this file.

#ifndef LARLIB_LOG_H
#define LARLIB_LOG_H

#include <larlib/base.h>
#include <stdarg.h>

enum logLevel_t {
    LOG_DEBUG    = 0x0000,  
    LOG_INFO     = 0x2000,  
    LOG_WARNING  = 0x4000,  
    LOG_ERROR    = 0x6000,  
    LOG_CRITICAL = 0x8000,  
    LOG_ALWAYS   = 0xFF00   
};

enum logReservedChannels_t {
    LOG_CH_BASE = 200,  
    LOG_CH_CONV,        
    LOG_CH_DATE,        
    LOG_CH_FS,          
    LOG_CH_INI,         
    LOG_CH_MEM,         
    LOG_CH_TAB,         
    LOG_CH_STEP,        
    LOG_CH_FORMAT,      
    LOG_CH_TASK 
};

#define LOG_ALL_CHANNELS 0, 256

typedef int (*logWriteFunction_t)(void *context, uint16_t channelLevel,
                                  const char *msg, int msgLength);

typedef int (*logDumpFunction_t)(logWriteFunction_t write,
                                 void *context, uint16_t channelLevel,
                                 const void *data, int dataLen);

#ifndef NDEBUG
#define LOG_ASSERT(cond) ((void) ((!!(cond)) || (logAssertImpl(#cond, __LINE__, __FILE__), 0)))
#else
#define LOG_ASSERT(cond)
#endif

/*
 * Implementation detail -- this function prints the assertion message
 * \p condStr plus the line number \p line and the file name \p file
 * and resets the device.
 */
void logAssertImpl(const char *condStr, int line, const char *file);

int logWriteTeliumTrace(void *context, uint16_t channelLevel, const char *msg, int msgLength);

int logWriteTeliumRemoteDebugger(void *context, uint16_t channelLevel, const char *msg, int msgLength);

int logDumpFormattedAscii(logWriteFunction_t write,
                          void *context, uint16_t channelLevel,
                          const void *data, int dataLen);

int logSetChannels(uint8_t firstChannel, int numChannels, uint16_t level,
                   logWriteFunction_t writeFunction,
                   logDumpFunction_t dumpFormatFunction,
                   void *context);

int logChannelIsEnabled(uint16_t channelLevel);

int logPrintf(uint16_t channelLevel, const char *fmt, ...);

int logPrintvf(uint16_t channelLevel, const char *fmt, va_list va);

int logDump(uint16_t channelLevel, const void *buffer, int size);

/* @} */

#endif