log_functions.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "../interfaces/global_logger_registry.h"
#include "../utils/source_location.h"
 
#include <memory>
#include <string>
#include <string_view>
 
namespace kcenon::common::logging {
 
inline VoidResult log(interfaces::log_level level,
                      std::string_view message,
                      const source_location& loc = source_location::current()) {
    auto logger = interfaces::get_logger();
    if (!logger->is_enabled(level)) {
        return VoidResult::ok({});
    }
    // Use the new source_location-based interface (Issue #177)
    return logger->log(level, message, loc);
}
 
inline VoidResult log(interfaces::log_level level,
                      std::string_view message,
                      const std::shared_ptr<interfaces::ILogger>& logger,
                      const source_location& loc = source_location::current()) {
    if (!logger || !logger->is_enabled(level)) {
        return VoidResult::ok({});
    }
    // Use the new source_location-based interface (Issue #177)
    return logger->log(level, message, loc);
}
 
inline VoidResult log(interfaces::log_level level,
                      std::string_view message,
                      const std::string& logger_name,
                      const source_location& loc = source_location::current()) {
    auto logger = interfaces::get_logger(logger_name);
    if (!logger->is_enabled(level)) {
        return VoidResult::ok({});
    }
    // Use the new source_location-based interface (Issue #177)
    return logger->log(level, message, loc);
}
 
// =============================================================================
// Level-specific logging functions
// =============================================================================
 
inline VoidResult log_trace(std::string_view message,
                            const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::trace, message, loc);
}
 
inline VoidResult log_debug(std::string_view message,
                            const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::debug, message, loc);
}
 
inline VoidResult log_info(std::string_view message,
                           const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::info, message, loc);
}
 
inline VoidResult log_warning(std::string_view message,
                              const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::warning, message, loc);
}
 
inline VoidResult log_error(std::string_view message,
                            const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::error, message, loc);
}
 
inline VoidResult log_critical(std::string_view message,
                               const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::critical, message, loc);
}
 
// =============================================================================
// Level-specific logging functions with named logger
// Note: Using "_to" suffix to avoid overload ambiguity with source_location
// =============================================================================
 
inline VoidResult log_trace_to(const std::string& logger_name,
                               std::string_view message,
                               const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::trace, message, logger_name, loc);
}
 
inline VoidResult log_debug_to(const std::string& logger_name,
                               std::string_view message,
                               const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::debug, message, logger_name, loc);
}
 
inline VoidResult log_info_to(const std::string& logger_name,
                              std::string_view message,
                              const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::info, message, logger_name, loc);
}
 
inline VoidResult log_warning_to(const std::string& logger_name,
                                 std::string_view message,
                                 const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::warning, message, logger_name, loc);
}
 
inline VoidResult log_error_to(const std::string& logger_name,
                               std::string_view message,
                               const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::error, message, logger_name, loc);
}
 
inline VoidResult log_critical_to(const std::string& logger_name,
                                  std::string_view message,
                                  const source_location& loc = source_location::current()) {
    return log(interfaces::log_level::critical, message, logger_name, loc);
}
 
// =============================================================================
// Utility functions
// =============================================================================
 
inline bool is_enabled(interfaces::log_level level) {
    return interfaces::get_logger()->is_enabled(level);
}
 
inline bool is_enabled(interfaces::log_level level, const std::string& logger_name) {
    return interfaces::get_logger(logger_name)->is_enabled(level);
}
 
inline VoidResult flush() {
    return interfaces::get_logger()->flush();
}
 
inline VoidResult flush(const std::string& logger_name) {
    return interfaces::get_logger(logger_name)->flush();
}
 
} // namespace kcenon::common::logging