log.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_DEBUG_LOG_HPP
#define ANTKEEPER_DEBUG_LOG_HPP
 
#include <engine/config.hpp>
#include <engine/debug/log/log-message-severity.hpp>
#include <engine/debug/log/logger.hpp>
#include <source_location>
#include <string>
#include <format>
 
// Enable logging of messages of all severities by default.
#if !defined(ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY)
    #define ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY (ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_TRACE)
#endif
 
namespace debug {
 
 
[[nodiscard]] logger& default_logger() noexcept;
 
template <log_message_severity Severity, class... Args>
struct log_message
{
    log_message
    (
        [[maybe_unused]] std::string_view format,
        [[maybe_unused]] Args&&... args,
        [[maybe_unused]] std::source_location&& location = std::source_location::current()
    )
    {
        if constexpr (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= static_cast<std::underlying_type_t<log_message_severity>>(Severity))
        {
            default_logger().log(std::vformat(format, std::make_format_args(std::forward<Args>(args)...)), Severity, std::forward<std::source_location>(location));
        }
    }
};
 
// Use class template argument deduction (CTAD) to capture source location as a default argument following variadic format arguments.
template <log_message_severity Severity, class... Args>
log_message(std::string_view, Args&&...) -> log_message<Severity, Args...>;
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_TRACE)
    template <class... Args>
    using log_trace = log_message<log_message_severity::trace, Args...>;
#else
    // Disable trace message logging.
    template <class... Args>
    inline void log_trace([[maybe_unused]] Args&&...) noexcept {};
#endif
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_DEBUG)
    template <class... Args>
    using log_debug = log_message<log_message_severity::debug, Args...>;
#else
    // Disable debug message logging.
    template <class... Args>
    inline void log_debug([[maybe_unused]] Args&&...) noexcept {};
#endif
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_INFO)
    template <class... Args>
    using log_info = log_message<log_message_severity::info, Args...>;
#else
    // Disable info message logging.
    template <class... Args>
    inline void log_info([[maybe_unused]] Args&&...) noexcept {};
#endif
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_WARNING)
    template <class... Args>
    using log_warning = log_message<log_message_severity::warning, Args...>;
#else
    // Disable warning message logging.
    template <class... Args>
    inline void log_warning([[maybe_unused]] Args&&...) noexcept {};
#endif
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_ERROR)
    template <class... Args>
    using log_error = log_message<log_message_severity::error, Args...>;
#else
    // Disable error message logging.
    template <class... Args>
    inline void log_error([[maybe_unused]] Args&&...) noexcept {};
#endif
 
#if (ANTKEEPER_DEBUG_LOG_MIN_MESSAGE_SEVERITY <= ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_FATAL)
    template <class... Args>
    using log_fatal = log_message<log_message_severity::fatal, Args...>;
#else
    // Disable fatal error message logging.
    template <class... Args>
    inline void log_fatal([[maybe_unused]] Args&&...) noexcept {};
#endif
 
 
} // namespace debug
 
#endif // ANTKEEPER_DEBUG_LOG_HPP