Logger.hpp

Go to the documentation of this file.

// This file is part of INSTINCT, the INS Toolkit for Integrated
// Navigation Concepts and Training by the Institute of Navigation of
// the University of Stuttgart, Germany.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
// Available log levels
#define LOG_LEVEL_DATA 0     
#define LOG_LEVEL_TRACE 1    
#define LOG_LEVEL_DEBUG 2    
#define LOG_LEVEL_INFO 3     
#define LOG_LEVEL_WARN 4     
#define LOG_LEVEL_ERROR 5    
#define LOG_LEVEL_CRITICAL 6 
#define LOG_LEVEL_OFF 7      
 
// Active log level (passed as definition to cmake)
#if LOG_LEVEL == LOG_LEVEL_DATA
    #define LOG_DATA SPDLOG_TRACE
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE 
#elif LOG_LEVEL == LOG_LEVEL_TRACE
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE 
#elif LOG_LEVEL == LOG_LEVEL_DEBUG
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_DEBUG 
#elif LOG_LEVEL == LOG_LEVEL_INFO
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_INFO 
#elif LOG_LEVEL == LOG_LEVEL_WARN
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_WARN 
#elif LOG_LEVEL == LOG_LEVEL_ERROR
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_ERROR 
#elif LOG_LEVEL == LOG_LEVEL_CRITICAL
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_CRITICAL 
#elif LOG_LEVEL == LOG_LEVEL_OFF
    #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_OFF 
#endif
 
#define SPDLOG_FMT_EXTERNAL 1
 
#include "spdlog/spdlog.h"
#include "spdlog/fmt/ostr.h"
#include "spdlog/sinks/ringbuffer_sink.h"
#include <fmt/std.h>
 
#include <string>
#include <stdexcept>
 
// Macros are redefined in case SPDLOG is not available anymore and it needs to be switched to another Logger
 
#ifndef LOG_DATA
    #define LOG_DATA(...) (void)0
#endif
#define LOG_TRACE SPDLOG_TRACE
#define LOG_DEBUG SPDLOG_DEBUG
#define LOG_INFO SPDLOG_INFO
#define LOG_WARN SPDLOG_WARN
#define LOG_ERROR SPDLOG_ERROR
#define LOG_CRITICAL(...) SPDLOG_CRITICAL(__VA_ARGS__), throw std::runtime_error(fmt::format(__VA_ARGS__))
 
class Logger
{
  public:
    explicit Logger(const std::string& logpath);
 
    Logger();
    ~Logger();
    Logger(const Logger&) = delete;
    Logger(Logger&&) = default;
    Logger& operator=(const Logger&) = delete;
    Logger& operator=(Logger&&) = default;
 
    static const std::shared_ptr<spdlog::sinks::ringbuffer_sink_mt>& GetRingBufferSink();
 
  private:
    static inline std::shared_ptr<spdlog::sinks::ringbuffer_sink_mt> _ringBufferSink = nullptr;
 
    static void writeSeparator() noexcept;
 
    static void writeHeader() noexcept;
 
    static void writeFooter() noexcept;
};