saga/logger_8h_source.html

#pragma once

#include "../defines.h"

#include <string>


// from https://www.youtube.com/watch?v=l9e8PJskYnI&list=PLv8Ddw9K0JPg1BEO-RS-0MYs423cvLVtj&index=5


namespace Saga {


#define LOG_WARN_ENABLED 1

#define LOG_INFO_ENABLED 1

#define LOG_DEBUG_ENABLED 1

#define LOG_TRACE_ENABLED 1


#if SAGA_RELEASE == 1

#define LOG_DEBUG_ENABLED 0

#define LOG_TRACE_ENABLED 0

#endif


enum LogLevel {

    FATAL = 0,

    ERROR = 1,

    WARN = 2,

    INFO = 3,

    DEBUG = 4,

    TRACE = 5

};


bool initializeLogger();


void logOutput(LogLevel level, const char* message, ...);


void shutDownLogger();


#ifndef SFATAL

#define SFATAL(message, ...) logOutput(Saga::LogLevel::FATAL, message, ##__VA_ARGS__)

#endif


#ifndef SERROR

#define SERROR(message, ...) logOutput(Saga::LogLevel::ERROR, message, ##__VA_ARGS__)

#endif


#if LOG_WARN_ENABLED == 1

#ifndef SWARN

#define SWARN(message, ...) logOutput(Saga::LogLevel::WARN, message, ##__VA_ARGS__)

#endif

#else

#define SWARN(message, ...)

#endif


#if LOG_INFO_ENABLED == 1

#ifndef SINFO

#define SINFO(message, ...) logOutput(Saga::LogLevel::INFO, message, ##__VA_ARGS__)

#endif

#else

#define SINFO(message, ...)

#endif


#if LOG_DEBUG_ENABLED == 1

#ifndef SDEBUG

#define SDEBUG(message, ...) logOutput(Saga::LogLevel::DEBUG, message, ##__VA_ARGS__)

#endif

#else

#define SDEBUG(message, ...)

#endif


#if LOG_TRACE_ENABLED == 1

#ifndef STRACE

#define STRACE(message, ...) logOutput(Saga::LogLevel::TRACE, message, ##__VA_ARGS__)

#endif

#else

#define STRACE(message, ...)

#endif


}

Saga
Definition: app.cpp:8

Saga::shutDownLogger
void shutDownLogger()
Shut down the logger, and flush any buffered output.
Definition: logger.cpp:30

Saga::LogLevel
LogLevel
Define multiple levels of logging. Fatal and Error are always enabled, and debug and traced are left ...
Definition: logger.h:23

Saga::INFO
@ INFO
Generally useful information to log, like successful initialization or completion of significant task...
Definition: logger.h:27

Saga::ERROR
@ ERROR
Reserved for anything that will cause the application to crash, or create undefined behaviour....
Definition: logger.h:25

Saga::WARN
@ WARN
Anything that can cause oddities with the application's execution. This might or might not result in ...
Definition: logger.h:26

Saga::DEBUG
@ DEBUG
Fine-grained information events that is useful to debug the application.
Definition: logger.h:28

Saga::FATAL
@ FATAL
Reserved for anything that would cause the core engine to crash. This should force a shutdown to prev...
Definition: logger.h:24

Saga::TRACE
@ TRACE
Finer-grained information, typically targetted towards one part of the application.
Definition: logger.h:29

Saga::logOutput
void logOutput(LogLevel level, const char *message,...)
Log an output.
Definition: logger.cpp:37

Saga::initializeLogger
bool initializeLogger()
Initialize the logger. Neccessary to call before any logging.
Definition: logger.cpp:24