Logging.hpp

Go to the documentation of this file.

/*
 * (c) Copyright 2020 CORSIKA Project, corsika-project@lists.kit.edu
 *
 * This software is distributed under the terms of the GNU General Public
 * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
 * the license.
 */

#pragma once

// Configure some behaviour of sdlog.
// This must be done before spdlog is included.

// use the coarse system clock. This is *much* faster
// but introduces a timestamp error of O(10 ms) which is fine for us.
#define SPDLOG_CLOCK_COARSE

// do not create a default logger (we provide our own "corsika" logger)
#define SPDLOG_DISABLE_DEFAULT_LOGGER

// use __PRETTY_FUNCTION__ instead of __FUNCTION__ where
// printing function names in trace statements. This is much
// nicer than __FUNCTION__ under GCC/clang.
#define SPDLOG_FUNCTION __PRETTY_FUNCTION__

// if this is a Debug build, include debug messages in objects
#ifdef _C8_DEBUG_
// trace is the highest level of logging (ALL messages will be printed)
#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE
#else // otherwise, remove everything but "error" and worse messages
#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_DEBUG
#endif

#include <spdlog/fmt/ostr.h> // will output whenerver a streaming operator is found
#include <spdlog/sinks/stdout_color_sinks.h>
#include <spdlog/spdlog.h>

namespace corsika {

  /*
   * The default pattern for CORSIKA8 loggers.
   */
  const std::string minimal_pattern{"[%n:%^%-8l%$] %v"};
  const std::string default_pattern{"[%n:%^%-8l%$(%s:%#)] %v"};
  const std::string source_pattern{"[%n:%^%-8l%$(%s:%!:%#)] %v"};

  std::shared_ptr<spdlog::logger> create_logger(std::string const& name,
                                                bool const defaultlog = false);

  std::shared_ptr<spdlog::logger> get_logger(std::string const& name,
                                             bool const defaultlog = false);

  static inline std::shared_ptr<spdlog::logger> corsika_logger =
      get_logger("corsika", true);

  // many of these free functions are special to the logging
  // infrastructure so we hide them in the corsika::logging namespace.
  namespace logging {

    // bring spdlog into the corsika::logging namespace
    using namespace spdlog;

    auto set_default_level(level::level_enum const minlevel) -> void;

    template <typename TLogger>
    auto add_source_info(TLogger& logger) -> void;

    template <typename TLogger>
    auto reset_pattern(TLogger& logger) -> void;

  } // namespace logging

// define our macro-style loggers
// these use the default "corsika" logger
#define CORSIKA_LOG_TRACE SPDLOG_TRACE
#define CORSIKA_LOG_DEBUG SPDLOG_DEBUG
#define CORSIKA_LOG_INFO SPDLOG_INFO
#define CORSIKA_LOG_WARN SPDLOG_WARN
#define CORSIKA_LOG_ERROR SPDLOG_ERROR
#define CORSIKA_LOG_CRITICAL SPDLOG_CRITICAL

// and the specific logger versions
// these take a logger instance as their first argument
#define CORSIKA_LOGGER_TRACE SPDLOG_LOGGER_TRACE
#define CORSIKA_LOGGER_DEBUG SPDLOG_LOGGER_DEBUG
#define CORSIKA_LOGGER_INFO SPDLOG_LOGGER_INFO
#define CORSIKA_LOGGER_WARN SPDLOG_LOGGER_WARN
#define CORSIKA_LOGGER_ERROR SPDLOG_LOGGER_ERROR
#define CORSIKA_LOGGER_CRITICAL SPDLOG_LOGGER_CRITICAL

} // namespace corsika

#include <corsika/detail/framework/core/Logging.inl>