logging_macros.h

Go to the documentation of this file.

/*
 * Copyright 2024 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
// IWYU pragma: no_include "num_collect/base/exception.h"
 
#include <concepts>
#include <iterator>
#include <string_view>
#include <utility>
 
#include <fmt/base.h>
#include <fmt/format.h>
 
#include "num_collect/logging/log_level.h"
#include "num_collect/logging/logger.h"
#include "num_collect/util/source_info_view.h"
 
namespace num_collect::logging {
 
namespace impl {
 
inline void log_without_condition_check(util::source_info_view source,
    const logger& l, log_level level, std::string_view body) {
    l.log_without_condition_check(source, level, body);
}
 
template <typename... Args>
    requires(sizeof...(Args) > 0)
inline void log_without_condition_check(util::source_info_view source,
    const logger& l, log_level level, fmt::format_string<Args...> format,
    Args&&... args) {
    l.log_without_condition_check(
        source, level, format, std::forward<Args>(args)...);
}
 
}  // namespace impl
 
template <
    std::constructible_from<std::string_view, util::source_info_view> Exception>
[[noreturn]] void log_and_throw(
    util::source_info_view source, const logger& l, std::string_view message) {
    l.error(source)(message);
    throw Exception(message, source);
}
 
template <
    std::constructible_from<std::string_view, util::source_info_view> Exception,
    typename... MessageArgs>
    requires(sizeof...(MessageArgs) > 0)
[[noreturn]] void log_and_throw(util::source_info_view source, const logger& l,
    fmt::format_string<MessageArgs...> message_format,
    MessageArgs&&... message_args) {
    fmt::memory_buffer buffer;
    fmt::format_to(std::back_inserter(buffer), message_format,
        std::forward<MessageArgs>(message_args)...);
    log_and_throw<Exception>(
        source, l, std::string_view(buffer.data(), buffer.size()));
}
 
template <
    std::constructible_from<std::string_view, util::source_info_view> Exception>
[[noreturn]] void log_and_throw(
    util::source_info_view source, std::string_view message) {
    logger l;
    log_and_throw<Exception>(source, l, message);
}
 
template <
    std::constructible_from<std::string_view, util::source_info_view> Exception,
    typename... MessageArgs>
    requires(sizeof...(MessageArgs) > 0)
[[noreturn]] void log_and_throw(util::source_info_view source,
    fmt::format_string<MessageArgs...> message_format,
    MessageArgs&&... message_args) {
    logger l;
    log_and_throw<Exception>(
        source, l, message_format, std::forward<MessageArgs>(message_args)...);
}
 
}  // namespace num_collect::logging
 
#define INTERNAL_NUM_COLLECT_LOG_IMPL(LOGGER, LEVEL, ...) /*NOLINT*/    \
    do {                                                                \
        if (LOGGER.should_log(LEVEL)) {                                 \
            ::num_collect::logging::impl::log_without_condition_check(  \
                ::num_collect::util::source_info_view(), LOGGER, LEVEL, \
                __VA_ARGS__);                                           \
        }                                                               \
    } while (false)
 
#define NUM_COLLECT_LOG_TRACE(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                    \
        LOGGER, ::num_collect::logging::log_level::trace, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_DEBUG(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                    \
        LOGGER, ::num_collect::logging::log_level::debug, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_ITERATION(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                        \
        LOGGER, ::num_collect::logging::log_level::iteration, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_ITERATION_LABEL(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(LOGGER,                       \
        ::num_collect::logging::log_level::iteration_label, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_SUMMARY(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                      \
        LOGGER, ::num_collect::logging::log_level::summary, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_INFO(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                   \
        LOGGER, ::num_collect::logging::log_level::info, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_WARNING(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                      \
        LOGGER, ::num_collect::logging::log_level::warning, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_ERROR(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                    \
        LOGGER, ::num_collect::logging::log_level::error, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_CRITICAL(LOGGER, ...) /*NOLINT*/ \
    INTERNAL_NUM_COLLECT_LOG_IMPL(                       \
        LOGGER, ::num_collect::logging::log_level::critical, __VA_ARGS__)
 
#define NUM_COLLECT_LOG_AND_THROW(EXCEPTION_TYPE, ...) /*NOLINT*/ \
    ::num_collect::logging::log_and_throw<EXCEPTION_TYPE>(        \
        ::num_collect::util::source_info_view(), __VA_ARGS__)