Logger Class Reference

#include <Logger.hpp>

Collaboration diagram for Logger:

Public Types
enum	LogLevel {   lTRACE, lDEBUG, lVERBOSE, lINFO,   lWARNING, lERROR, lNone }
typedef int(*	LogWriter) (const char *fmt, va_list args)

Public Member Functions
	Logger (Logger const &)=delete
void	operator= (Logger const &)=delete

Static Public Member Functions
static void	Trace (const char *tag, const char *fmt,...)
static void	Verbose (const char *tag, const char *fmt,...)
static void	Debug (const char *tag, const char *fmt,...)
static void	Info (const char *tag, const char *fmt,...)
static void	Warning (const char *tag, const char *fmt,...)
static void	Error (const char *tag, const char *fmt,...)
static void	Print (const char *fmt,...)
static bool	addWriter (LogWriter writer)
static bool	removeWriter (LogWriter writer)
static void	setLevel (LogLevel level)
static LogLevel	getLevel ()
static Logger &	the ()

Private Member Functions
	Logger ()
const char *	levelToString (LogLevel lvl)
void	LogHelper (const char *tag, LogLevel lvl, const char *fmt, va_list args)
void	LogHelperPrint (const char *fmt, va_list args)

Private Attributes
Mutex	m_logBufferMutex
size_t	m_writersIdx
LogLevel	m_logLevel
LogWriter	m_writers [m_maxWriterCount]
char	m_logBuffer [m_maxBufferSize]

Static Private Attributes
static const uint8_t	m_maxWriterCount = 2
static const uint32_t	m_maxBufferSize = 1024

Detailed Description

Definition at line 16 of file Logger.hpp.

Member Typedef Documentation

LogWriter

typedef int(* Logger::LogWriter) (const char *fmt, va_list args)

Definition at line 30 of file Logger.hpp.

Member Enumeration Documentation

LogLevel

enum Logger::LogLevel

Enumerator
lTRACE
lDEBUG
lVERBOSE
lINFO
lWARNING
lERROR
lNone

Definition at line 20 of file Logger.hpp.

              {
    lTRACE,
    lDEBUG,
    lVERBOSE,
    lINFO,
    lWARNING,
    lERROR,
    lNone,
};

Constructor & Destructor Documentation

Logger() [1/2]

Logger::Logger ( Logger const &  )

delete

Logger() [2/2]

Logger::Logger ( )

private

Definition at line 147 of file Logger.cpp.

    : m_logBufferMutex("Logger")
    , m_writersIdx(0)
#if defined(RELEASE)
    , m_logLevel(lINFO)
#elif defined(DEBUG)
    , m_logLevel(lDEBUG)
#endif
{
    // Default constructor
}

Member Function Documentation

addWriter()

bool Logger::addWriter ( LogWriter  writer )

static

Definition at line 119 of file Logger.cpp.

{
    if (the().m_writersIdx < the().m_maxWriterCount) {
        the().m_writers[the().m_writersIdx++] = writer;
        return true;
    }
 
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Debug()

void Logger::Debug ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 71 of file Logger.cpp.

{
    if (lDEBUG >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lDEBUG, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Error()

void Logger::Error ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 101 of file Logger.cpp.

{
    if (lERROR >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lERROR, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

getLevel()

static LogLevel Logger::getLevel ( )

inlinestatic

Definition at line 46 of file Logger.hpp.

{ return the().m_logLevel; }

Here is the call graph for this function:

Here is the caller graph for this function:

Info()

void Logger::Info ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 81 of file Logger.cpp.

{
    if (lINFO >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lINFO, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

levelToString()

const char * Logger::levelToString ( LogLevel  lvl )

private

Definition at line 15 of file Logger.cpp.

{
    switch (lvl) {
        case lTRACE:
            return "\033[36mTRACE\033[0m";
        case lDEBUG:
            return "\033[96mDEBUG\033[0m";
        case lVERBOSE:
            return "\033[92mVERBOSE\033[0m";
        case lINFO:
            return "\033[94mINFO\033[0m";
        case lWARNING:
            return "\033[93mWARNING\033[0m";
        case lERROR:
            return "\033[91mERROR\033[0m";
        default:
            return "UNKNOWN";
    }
}

Here is the caller graph for this function:

LogHelper()

void Logger::LogHelper ( const char *  tag, LogLevel  lvl, const char *  fmt, va_list  args  )

private

Definition at line 35 of file Logger.cpp.

{
    RAIIMutex(the().m_logBufferMutex);
    ksprintf(the().m_logBuffer, "[%s] [%s] %s\n", tag, levelToString(lvl), fmt);
    LogHelperPrint(m_logBuffer, ap);
}

Here is the call graph for this function:

Here is the caller graph for this function:

LogHelperPrint()

void Logger::LogHelperPrint ( const char *  fmt, va_list  args  )

private

Definition at line 42 of file Logger.cpp.

{
    for (size_t i = 0; i < m_writersIdx; i++) {
        if (the().m_writers[i] != nullptr) {
            the().m_writers[i](fmt, ap);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void Logger::operator= ( Logger const &  )

delete

Print()

void Logger::Print ( const char *  fmt,   ...  )

static

Definition at line 111 of file Logger.cpp.

{
    va_list ap;
    va_start(ap, fmt);
    the().LogHelperPrint(fmt, ap);
    va_end(ap);
}

Here is the call graph for this function:

Here is the caller graph for this function:

removeWriter()

bool Logger::removeWriter ( LogWriter  writer )

static

Definition at line 129 of file Logger.cpp.

{
    for (size_t idx = 0; idx < the().m_writersIdx; idx++) {
        if (the().m_writers[idx] == writer) {
            the().m_writers[idx] = nullptr;
            return true;
        }
    }
 
    return false;
}

Here is the call graph for this function:

setLevel()

static void Logger::setLevel ( LogLevel  level )

inlinestatic

Definition at line 45 of file Logger.hpp.

{ the().m_logLevel = level; }

Here is the call graph for this function:

the()

Logger & Logger::the ( )

static

Definition at line 141 of file Logger.cpp.

{
    static Logger instance;
    return instance;
}

Here is the caller graph for this function:

Trace()

void Logger::Trace ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 51 of file Logger.cpp.

{
    if (lTRACE >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lTRACE, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

Verbose()

void Logger::Verbose ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 61 of file Logger.cpp.

{
    if (lVERBOSE >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lVERBOSE, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

Warning()

void Logger::Warning ( const char *  tag, const char *  fmt,   ...  )

static

Definition at line 91 of file Logger.cpp.

{
    if (lWARNING >= getLevel()) {
        va_list ap;
        va_start(ap, fmt);
        the().LogHelper(tag, lWARNING, fmt, ap);
        va_end(ap);
    }
}

Here is the call graph for this function:

Field Documentation

m_logBuffer

char Logger::m_logBuffer[m_maxBufferSize]

private

Definition at line 62 of file Logger.hpp.

m_logBufferMutex

Mutex Logger::m_logBufferMutex

private

Definition at line 58 of file Logger.hpp.

m_logLevel

LogLevel Logger::m_logLevel

private

Definition at line 60 of file Logger.hpp.

m_maxBufferSize

const uint32_t Logger::m_maxBufferSize = 1024

staticprivate

Definition at line 57 of file Logger.hpp.

m_maxWriterCount

const uint8_t Logger::m_maxWriterCount = 2

staticprivate

Definition at line 56 of file Logger.hpp.

m_writers

LogWriter Logger::m_writers[m_maxWriterCount]

private

Definition at line 61 of file Logger.hpp.

m_writersIdx

size_t Logger::m_writersIdx

private

Definition at line 59 of file Logger.hpp.

---

The documentation for this class was generated from the following files:

• Logger.hpp
• Logger.cpp