Logger.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstdarg>
#include <cstring>
#include <memory>
#include <atomic>
 
// Forward declarations
class BaseLogger;
 
enum class LogStyle : uint8_t {
    NORMAL = 0,         
    BOLD = 1,           
    ITALIC = 2,         
    UNDERLINE = 3,      
    STRIKETHROUGH = 4,  
    DOUBLE_UNDERLINE = 5 
};
 
enum class LogColor : uint8_t {
    DEFAULT = 0,        
    BLACK = 30,         
    RED = 31,           
    GREEN = 32,         
    YELLOW = 33,        
    BLUE = 34,          
    MAGENTA = 35,       
    CYAN = 36,          
    WHITE = 37,         
    BRIGHT_BLACK = 90,  
    BRIGHT_RED = 91,    
    BRIGHT_GREEN = 92,  
    BRIGHT_YELLOW = 93, 
    BRIGHT_BLUE = 94,   
    BRIGHT_MAGENTA = 95,
    BRIGHT_CYAN = 96,   
    BRIGHT_WHITE = 97   
};
 
enum class LogBackground : uint8_t {
    DEFAULT = 0,        
    BLACK = 40,         
    RED = 41,           
    GREEN = 42,         
    YELLOW = 43,        
    BLUE = 44,          
    MAGENTA = 45,       
    CYAN = 46,          
    WHITE = 47,         
    BRIGHT_BLACK = 100, 
    BRIGHT_RED = 101,   
    BRIGHT_GREEN = 102, 
    BRIGHT_YELLOW = 103,
    BRIGHT_BLUE = 104,  
    BRIGHT_MAGENTA = 105,
    BRIGHT_CYAN = 106,  
    BRIGHT_WHITE = 107  
};
 
enum class LogLevel : uint8_t {
    ERROR = 0,          
    WARN = 1,           
    INFO = 2,           
    DEBUG = 3,          
    VERBOSE = 4         
};
 
struct LogConfig {
    LogLevel level = LogLevel::INFO;           
    LogColor color = LogColor::DEFAULT;        
    LogBackground background = LogBackground::DEFAULT; 
    LogStyle style = LogStyle::NORMAL;         
    bool enable_colors = true;                 
    bool enable_effects = true;                
    uint32_t max_width = 80;                   
    bool center_text = false;                  
    bool add_border = false;                   
    char border_char = '*';                    
    uint32_t border_padding = 2;               
    bool enable_ascii_art = true;              
    bool format_ascii_art = true;              
};
 
struct AsciiArtFormat {
    LogColor color = LogColor::DEFAULT;        
    LogBackground background = LogBackground::DEFAULT; 
    LogStyle style = LogStyle::NORMAL;         
    bool center_art = false;                   
    bool add_border = false;                   
    char border_char = '#';                    
    uint32_t border_padding = 1;               
    uint32_t max_width = 80;                   
};
 
class Logger {
public:
    static Logger& GetInstance() noexcept;
 
    bool Initialize(const LogConfig& config = LogConfig{}) noexcept;
 
    bool Initialize(const LogConfig& config,
                    std::unique_ptr<BaseLogger> backend) noexcept;
 
    void Deinitialize() noexcept;
 
    bool IsInitialized() const noexcept;
 
    void SetLogLevel(const char* tag, LogLevel level) noexcept;
 
    LogLevel GetLogLevel(const char* tag) const noexcept;
 
    //==============================================================================
    // BASIC LOGGING METHODS
    //==============================================================================
 
    void SetTagLevel(const char* tag, LogLevel level) noexcept;
 
    void Error(const char* tag, const char* format, ...) noexcept;
 
    void Warn(const char* tag, const char* format, ...) noexcept;
 
    void Info(const char* tag, const char* format, ...) noexcept;
 
    void Debug(const char* tag, const char* format, ...) noexcept;
 
    void Verbose(const char* tag, const char* format, ...) noexcept;
 
    //==============================================================================
    // FORMATTED LOGGING METHODS
    //==============================================================================
 
    void Error(const char* tag, LogColor color, LogStyle style, const char* format, ...) noexcept;
 
    void Warn(const char* tag, LogColor color, LogStyle style, const char* format, ...) noexcept;
 
    void Info(const char* tag, LogColor color, LogStyle style, const char* format, ...) noexcept;
 
    void Debug(const char* tag, LogColor color, LogStyle style, const char* format, ...) noexcept;
 
    void Verbose(const char* tag, LogColor color, LogStyle style, const char* format, ...) noexcept;
 
    //==============================================================================
    // ASCII ART LOGGING METHODS
    //==============================================================================
 
    void LogAsciiArt(const char* tag, const char* ascii_art, 
                    const AsciiArtFormat& format = AsciiArtFormat{}) noexcept;
 
    void LogAsciiArt(LogLevel level, const char* tag, const char* ascii_art, 
                    const AsciiArtFormat& format = AsciiArtFormat{}) noexcept;
 
    void LogBanner(const char* tag, const char* ascii_art, 
                  const AsciiArtFormat& format = AsciiArtFormat{}) noexcept;
 
    //==============================================================================
    // UTILITY METHODS
    //==============================================================================
 
    void SetConfig(const LogConfig& config) noexcept;
 
    // A copy on purpose: other tasks may change the configuration while the
    // caller uses the result.
    // cppcheck-suppress returnByReference
    LogConfig GetConfig() const noexcept;
 
    void EnableColors(bool enable) noexcept;
 
    void EnableEffects(bool enable) noexcept;
 
    void EnableAsciiArt(bool enable) noexcept;
 
    void Flush() noexcept;
 
private:
    //==============================================================================
    // PRIVATE MEMBERS
    //==============================================================================
 
    std::atomic<bool> initialized_;
    LogConfig config_;
 
    static constexpr size_t kMaxTagLevels = 16;
    static constexpr size_t kMaxTagLength = 32;
    struct TagLevel {
        char tag[kMaxTagLength];
        LogLevel level;
        bool in_use;
    };
    TagLevel tag_levels_[kMaxTagLevels] = {};
 
    std::unique_ptr<BaseLogger> base_logger_;
 
    //==============================================================================
    // PRIVATE METHODS
    //==============================================================================
 
    Logger() noexcept;
 
    ~Logger() noexcept;
 
    Logger(const Logger&) = delete;
 
    Logger& operator=(const Logger&) = delete;
 
    Logger(Logger&&) = delete;
 
    Logger& operator=(Logger&&) = delete;
 
    void LogInternal(LogLevel level, const char* tag, LogColor color, LogStyle style, 
                    const char* format, va_list args) noexcept;
 
    size_t WriteColorPrefix(char* buf, size_t buf_size, LogColor color,
                           LogBackground background, LogStyle style) const noexcept;
 
    static size_t WriteResetSequence(char* buf, size_t buf_size) noexcept;
 
    void FormatAndLogAsciiArt(const char* tag, LogLevel level,
                              const char* ascii_art,
                              const AsciiArtFormat& format) noexcept;
 
    bool IsLevelEnabled(LogLevel level, const char* tag) const noexcept;
 
    static std::unique_ptr<BaseLogger> CreateDefaultBaseLogger() noexcept;
    
    void DumpStatistics() const noexcept;
};
 
//==============================================================================
// CONVENIENCE MACROS
//==============================================================================
 
#define LOG_ERROR(tag, ...) Logger::GetInstance().Error(tag, __VA_ARGS__)
#define LOG_WARN(tag, ...) Logger::GetInstance().Warn(tag, __VA_ARGS__)
#define LOG_INFO(tag, ...) Logger::GetInstance().Info(tag, __VA_ARGS__)
#define LOG_DEBUG(tag, ...) Logger::GetInstance().Debug(tag, __VA_ARGS__)
#define LOG_VERBOSE(tag, ...) Logger::GetInstance().Verbose(tag, __VA_ARGS__)
 
#define LOG_ERROR_FORMATTED(tag, color, style, ...) Logger::GetInstance().Error(tag, color, style, __VA_ARGS__)
#define LOG_WARN_FORMATTED(tag, color, style, ...) Logger::GetInstance().Warn(tag, color, style, __VA_ARGS__)
#define LOG_INFO_FORMATTED(tag, color, style, ...) Logger::GetInstance().Info(tag, color, style, __VA_ARGS__)
#define LOG_DEBUG_FORMATTED(tag, color, style, ...) Logger::GetInstance().Debug(tag, color, style, __VA_ARGS__)
#define LOG_VERBOSE_FORMATTED(tag, color, style, ...) Logger::GetInstance().Verbose(tag, color, style, __VA_ARGS__)
 
#define LOG_ASCII_ART(tag, art, format) Logger::GetInstance().LogAsciiArt(tag, art, format)
#define LOG_BANNER(tag, art, format) Logger::GetInstance().LogBanner(tag, art, format)