ilogger.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <kcenon/pacs/integration/logger_adapter.h>
#include <kcenon/pacs/compat/format.h>
 
#include <memory>
#include <string_view>
 
namespace kcenon::pacs::di {
 
// =============================================================================
// Logger Interface
// =============================================================================
 
class ILogger {
public:
    virtual ~ILogger() = default;
 
    // =========================================================================
    // Log Level Methods
    // =========================================================================
 
    virtual void trace(std::string_view message) = 0;
 
    virtual void debug(std::string_view message) = 0;
 
    virtual void info(std::string_view message) = 0;
 
    virtual void warn(std::string_view message) = 0;
 
    virtual void error(std::string_view message) = 0;
 
    virtual void fatal(std::string_view message) = 0;
 
    // =========================================================================
    // Level Check
    // =========================================================================
 
    [[nodiscard]] virtual bool is_enabled(integration::log_level level) const noexcept = 0;
 
    // =========================================================================
    // Formatted Logging (Convenience Templates)
    // =========================================================================
 
    template <typename... Args>
    void trace_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::trace)) {
            trace(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
    template <typename... Args>
    void debug_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::debug)) {
            debug(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
    template <typename... Args>
    void info_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::info)) {
            info(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
    template <typename... Args>
    void warn_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::warn)) {
            warn(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
    template <typename... Args>
    void error_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::error)) {
            error(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
    template <typename... Args>
    void fatal_fmt(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        if (is_enabled(integration::log_level::fatal)) {
            fatal(kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
        }
    }
 
protected:
    ILogger() = default;
    ILogger(const ILogger&) = default;
    ILogger& operator=(const ILogger&) = default;
    ILogger(ILogger&&) = default;
    ILogger& operator=(ILogger&&) = default;
};
 
// =============================================================================
// Null Logger Implementation
// =============================================================================
 
class NullLogger final : public ILogger {
public:
    NullLogger() = default;
    ~NullLogger() override = default;
 
    void trace(std::string_view /*message*/) override {}
    void debug(std::string_view /*message*/) override {}
    void info(std::string_view /*message*/) override {}
    void warn(std::string_view /*message*/) override {}
    void error(std::string_view /*message*/) override {}
    void fatal(std::string_view /*message*/) override {}
 
    [[nodiscard]] bool is_enabled(integration::log_level /*level*/) const noexcept override {
        return false;
    }
};
 
// =============================================================================
// Logger Service Implementation
// =============================================================================
 
class LoggerService final : public ILogger {
public:
    LoggerService() = default;
    ~LoggerService() override = default;
 
    void trace(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::trace, std::string{message});
    }
 
    void debug(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::debug, std::string{message});
    }
 
    void info(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::info, std::string{message});
    }
 
    void warn(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::warn, std::string{message});
    }
 
    void error(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::error, std::string{message});
    }
 
    void fatal(std::string_view message) override {
        integration::logger_adapter::log(integration::log_level::fatal, std::string{message});
    }
 
    [[nodiscard]] bool is_enabled(integration::log_level level) const noexcept override {
        return integration::logger_adapter::is_level_enabled(level);
    }
};
 
// =============================================================================
// Global Null Logger Instance
// =============================================================================
 
[[nodiscard]] inline std::shared_ptr<ILogger> null_logger() {
    static auto instance = std::make_shared<NullLogger>();
    return instance;
}
 
}  // namespace kcenon::pacs::di