logging.h

Go to the documentation of this file.

#pragma once
 
#include "imports.h"
 
#define STRINGIFY(x)   #x
#define TO_STRING(x)   STRINGIFY(x)
#define TRACE_FILE_LOG "[" __TIME__ "]" "[EMBER_ENGINE - " __FILE__ ":" TO_STRING(__LINE__)"] - "
 
/*
   @brief Class for logging, tracing and debugging
 
   - Web - Output to javascript console
   - Windows - Output to console and file
   - macOS - Output to xcode console
   - Linux - Output to console and file
   - Android - Output to logcat
   - iOS - Output to xcode console
 
   Use the LOG_ERROR, LOG_INFO, LOG_WARN, LOG_DEBUG macros to log messages
   
   @note Do not push sensitive data to the logs
 
   @version 0.0.9
 
*/
class Logger {
public:
    static Logger& Get() {
        static Logger instance;
        return instance;
    }
 
    static void Start();
 
    void Push(const std::string& formatted_log);
 
    static void Destroy();
 
private:
    Logger()  = default;
    ~Logger() = default;
 
    void LogThread();
 
    std::mutex _mutex = std::mutex();
    SDL_Thread* _log_thread = nullptr;
    std::condition_variable _condition = std::condition_variable();
    std::atomic<bool> _bIsRunning = false;
    std::deque<std::string> _log_queue = std::deque<std::string>();
};
 
 
#define LOG_ERROR(...)                                                    \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);         \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_INFO(...)                                                     \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogInfo(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);          \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_DEBUG(...)                                                    \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogDebug(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);         \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_VERBOSE(...)                                                  \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogVerbose(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);       \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_WARN(...)                                                     \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogWarn(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);          \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_TRACE(...)                                                    \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogInfo(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);          \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_CRITICAL(...)                                                 \
    do {                                                                  \
        char buffer[1024];                                                \
        SDL_snprintf(buffer, sizeof(buffer), TRACE_FILE_LOG __VA_ARGS__); \
        SDL_LogCritical(SDL_LOG_CATEGORY_APPLICATION, "%s", buffer);      \
        Logger::Get().Push(buffer);                                        \
    } while (0)
 
#define LOG_QUIT_ON_FAIL(x)              \
    if (!x) {                            \
        LOG_ERROR("%s", SDL_GetError()); \
        return SDL_APP_FAILURE;          \
    }
 
 
#define GL_ERROR()                                  \
    {                                               \
        unsigned int error = glGetError();          \
        if (error != GL_NO_ERROR) {                 \
            LOG_ERROR("API ERROR_CODE: %d", error); \
        }                                           \
    }
 
#define EMBER_TIMER_START() auto start = std::chrono::high_resolution_clock::now();
 
 
#define EMBER_TIMER_END(description)                                                                \
    do {                                                                                            \
        auto end      = std::chrono::high_resolution_clock::now();                                  \
        auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start).count(); \
        LOG_INFO("%s took %lld (us), %.2f (ms)", description, duration, (float) duration / 1000.f); \
    } while (0)