LogMacros.h

Go to the documentation of this file.

#pragma once

 
#include "LogCategory.h"
#include <plog/Log.h>
#include <format>
#include <string>
 
namespace EngineCore
{

template<typename... Args>
inline void logImpl(LogCategory& category, LogVerbosity verbosity, const char* file, int line,
                    const char* func, std::format_string<Args...> fmt, Args&&... args)
{
    std::string message = std::format(fmt, std::forward<Args>(args)...);
    std::string fullMessage = std::format("[{}] {}", category.getName(), message);
 
    // Route to plog with appropriate severity
    switch (verbosity) {
        case LogVerbosity::Fatal:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::fatal).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Error:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::error).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Warning:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::warning).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Info:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::info).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Debug:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::debug).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Verbose:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::verbose).printf("%s", fullMessage.c_str());
            break;
    }
}

inline void logImplSimple(LogCategory& category, LogVerbosity verbosity, const char* file, int line,
                          const char* func, const char* message)
{
    std::string fullMessage = std::format("[{}] {}", category.getName(), message);
 
    switch (verbosity) {
        case LogVerbosity::Fatal:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::fatal).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Error:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::error).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Warning:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::warning).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Info:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::info).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Debug:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::debug).printf("%s", fullMessage.c_str());
            break;
        case LogVerbosity::Verbose:
            PLOG_(PLOG_DEFAULT_INSTANCE_ID, plog::verbose).printf("%s", fullMessage.c_str());
            break;
    }
}
 
}  // namespace EngineCore
 
// ============================================================================
// Compile-time verbosity check
// ============================================================================

#ifndef VS_LOG_COMPILE_TIME_VERBOSITY
    #ifdef NDEBUG
        #define VS_LOG_COMPILE_TIME_VERBOSITY ::EngineCore::LogVerbosity::Info
    #else
        #define VS_LOG_COMPILE_TIME_VERBOSITY ::EngineCore::LogVerbosity::Verbose
    #endif
#endif
 
// ============================================================================
// Main Logging Macros
// ============================================================================

#define VS_LOG(Category, Verbosity, Format, ...) \
    do { \
        if constexpr (static_cast<uint8_t>(::EngineCore::LogVerbosity::Verbosity) <= \
                      static_cast<uint8_t>(VS_LOG_COMPILE_TIME_VERBOSITY)) { \
            if (!Category.isSuppressed(::EngineCore::LogVerbosity::Verbosity)) { \
                ::EngineCore::logImpl(Category, ::EngineCore::LogVerbosity::Verbosity, \
                    __FILE__, __LINE__, __func__, Format __VA_OPT__(,) __VA_ARGS__); \
            } \
        } \
    } while (0)

#define VS_LOG_SIMPLE(Category, Verbosity, Message) \
    do { \
        if constexpr (static_cast<uint8_t>(::EngineCore::LogVerbosity::Verbosity) <= \
                      static_cast<uint8_t>(VS_LOG_COMPILE_TIME_VERBOSITY)) { \
            if (!Category.isSuppressed(::EngineCore::LogVerbosity::Verbosity)) { \
                ::EngineCore::logImplSimple(Category, ::EngineCore::LogVerbosity::Verbosity, \
                    __FILE__, __LINE__, __func__, Message); \
            } \
        } \
    } while (0)

#define VS_CLOG(Condition, Category, Verbosity, Format, ...) \
    do { \
        if (Condition) { \
            VS_LOG(Category, Verbosity, Format __VA_OPT__(,) __VA_ARGS__); \
        } \
    } while (0)

#define VS_LOG_ONCE(Category, Verbosity, Format, ...) \
    do { \
        static bool _vs_logged_once = false; \
        if (!_vs_logged_once) { \
            _vs_logged_once = true; \
            VS_LOG(Category, Verbosity, Format __VA_OPT__(,) __VA_ARGS__); \
        } \
    } while (0)
 
// ============================================================================
// Convenience Macros (shorter names for common verbosity levels)
// ============================================================================
 
#define VS_LOG_FATAL(Category, Format, ...)   VS_LOG(Category, Fatal, Format __VA_OPT__(,) __VA_ARGS__)
#define VS_LOG_ERROR(Category, Format, ...)   VS_LOG(Category, Error, Format __VA_OPT__(,) __VA_ARGS__)
#define VS_LOG_WARNING(Category, Format, ...) VS_LOG(Category, Warning, Format __VA_OPT__(,) __VA_ARGS__)
#define VS_LOG_INFO(Category, Format, ...)    VS_LOG(Category, Info, Format __VA_OPT__(,) __VA_ARGS__)
#define VS_LOG_DEBUG(Category, Format, ...)   VS_LOG(Category, Debug, Format __VA_OPT__(,) __VA_ARGS__)
#define VS_LOG_VERBOSE(Category, Format, ...) VS_LOG(Category, Verbose, Format __VA_OPT__(,) __VA_ARGS__)