logger.hpp

Go to the documentation of this file.

/* 
 * Copyright (c) 2022 Jonas Kabelitz
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 * You should have received a copy of the MIT License along with this program.
 * If not, see <https://opensource.org/licenses/MIT/>.
 */
 
#ifndef LIBSBX_CORE_LOGGER_HPP_
#define LIBSBX_CORE_LOGGER_HPP_
 
#include <memory>
#include <source_location>
#include <unordered_map>
#include <type_traits>
 
#include <fmt/format.h>
 
#include <spdlog/logger.h>
#include <spdlog/sinks/stdout_color_sinks.h>
#include <spdlog/sinks/basic_file_sink.h>
 
#include <libsbx/utility/target.hpp>
 
namespace sbx::core {
 
class logger {
 
public:
 
  template<typename... Args>
  using format_string_type = spdlog::format_string_t<Args...>;
 
  logger() = delete;
 
  ~logger() = default;
 
  template<typename... Args>
  static auto trace(format_string_type<Args...> format, Args&&... args) -> void {
    // [NOTE] KAJ 2023-03-20 : This should make trace and debug messages be no-ops in release builds.
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      _instance().trace(format, std::forward<Args>(args)...);
    }
  }
 
  template<typename Type>
  static auto trace(const Type& value) -> void {
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      _instance().trace(value);
    }
  }
 
  template<typename... Args>
  static auto debug(format_string_type<Args...> format, Args&&... args) -> void {
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      _instance().debug(format, std::forward<Args>(args)...);
    }
  }
 
  template<typename Type>
  static auto debug(const Type& value) -> void {
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      _instance().debug(value);
    }
  }
 
  template<typename... Args>
  static auto info(format_string_type<Args...> format, Args&&... args) -> void {
    _instance().info(format, std::forward<Args>(args)...);
  }
 
  template<typename Type>
  static auto info(const Type& value) -> void {
    _instance().info(value);
  }
 
  template<typename... Args>
  static auto warn(format_string_type<Args...> format, Args&&... args) -> void {
    _instance().warn(format, std::forward<Args>(args)...);
  }
 
  template<typename Type>
  static auto warn(const Type& value) -> void {
    _instance().warn(value);
  }
 
  template<typename... Args>
  static auto error(format_string_type<Args...> format, Args&&... args) -> void {
    _instance().error(format, std::forward<Args>(args)...);
  }
 
  template<typename Type>
  static auto error(const Type& value) -> void {
    _instance().error(value);
  }
 
  template<typename... Args>
  static auto critical(format_string_type<Args...> format, Args&&... args) -> void {
    _instance().critical(format, std::forward<Args>(args)...);
  }
 
  template<typename Type>
  static auto critical(const Type& value) -> void {
    _instance().critical(value);
  }
 
private:
 
  static auto _instance() -> spdlog::logger& {
    static auto instance = _create_logger();
    return instance;
  }
 
  static auto _create_logger() -> spdlog::logger {
    auto sinks = std::vector<std::shared_ptr<spdlog::sinks::sink>>{};
 
    sinks.push_back(std::make_shared<spdlog::sinks::basic_file_sink_mt>("./demo/logs/sbx.log", true));
 
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      sinks.push_back(std::make_shared<spdlog::sinks::stdout_color_sink_mt>());
    }
 
    auto logger = spdlog::logger{"logger", std::begin(sinks), std::end(sinks)};
 
    logger.set_pattern("[%Y-%m-%d %H:%M:%S] [%^%l%$] [%n] : %v");
 
    if constexpr (utility::build_configuration_v == utility::build_configuration::debug) {
      logger.set_level(spdlog::level::debug);
    } else {
      logger.set_level(spdlog::level::info);
    }
 
    return logger;
  }
 
}; // class logger
 
} // namespace sbx::core
 
// [NOTE] KAJ 2024-01-19 : Enable formatting to underlying type for all enums
template<typename Type>
requires (std::is_enum_v<Type>)
struct fmt::formatter<Type> : public fmt::formatter<std::underlying_type_t<Type>> {
 
  using base_type = fmt::formatter<std::underlying_type_t<Type>>;
 
  template<typename FormatContext>
  auto format(const Type& value, FormatContext& context) -> decltype(auto) {
    return base_type::format(static_cast<std::underlying_type_t<Type>>(value), context);
  }
 
}; // struct fmt::formatter<Type>
 
#endif // LIBSBX_CORE_LOGGER_HPP_