SeverityChannelLogging.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
 
#pragma once
 
#ifdef _MSC_VER
#pragma warning(disable: 4714) // not inlined despite forceinline (logger)
#endif
 
#include "SeverityChannelLoggingSystem.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <string>
#include <boost/log/common.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/keywords/format.hpp>
#include <boost/log/keywords/filter.hpp>
#include <boost/log/keywords/severity.hpp>
#include <boost/log/keywords/channel.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/utility/setup/filter_parser.hpp>
#include <boost/log/utility/setup/formatter_parser.hpp>
#include <boost/log/utility/exception_handler.hpp>
#include <ThirdPartyWarningsRestore.h>
 
 
namespace scl {
 
  enum SeverityLevel {
    Debug,
    Info,
    Warning,
    Error,
    Critical
  };
 
  template<typename CharT, typename TraitsT>
  std::basic_ostream<CharT, TraitsT>& operator<<(std::basic_ostream<CharT, TraitsT>& stream, SeverityLevel level)
  {
    static const char* const str[] =
    {
      "Debug",
      "Info",
      "Warning",
      "Error",
      "Critical"
    };
 
    if (level < (sizeof(str) / sizeof(*str))) {
      stream << str[level];
    }
    else {
      stream << "Unknown";
    }
 
    return stream;
  }
 
  BOOST_LOG_ATTRIBUTE_KEYWORD(severity, "Severity", SeverityLevel);
  BOOST_LOG_ATTRIBUTE_KEYWORD(channel, "Channel", std::string);
 
  typedef boost::log::sources::severity_channel_logger<SeverityLevel> Logger;
  typedef boost::log::sources::severity_channel_logger_mt<SeverityLevel> ThreadSafeLogger;
 
  typedef boost::log::sinks::sink Sink;
  typedef boost::shared_ptr<Sink> SinkPtr;
 
  namespace keywords = boost::log::keywords;
 
  using boost::log::add_console_log;
  using boost::log::add_file_log;
  using boost::log::parse_formatter;
  using boost::log::parse_filter;
  using boost::log::formatter;
  using boost::log::filter;
 
  template<typename SinkType>
  void remove_log(boost::shared_ptr<SinkType> sink)
  {
    auto core = boost::log::core::get();
    core->remove_sink(sink);
  }
 
  SEVERITYCHANNELLOGGING_EXPORT void initialize();
}
 
#define LOG_WITH_SEVERITY BOOST_LOG_SEV
#define LOG_DEBUG(logger) LOG_WITH_SEVERITY(logger, ::scl::Debug)
#define LOG_INFO(logger) LOG_WITH_SEVERITY(logger, ::scl::Info)
#define LOG_WARNING(logger) LOG_WITH_SEVERITY(logger, ::scl::Warning)
#define LOG_ERROR(logger) LOG_WITH_SEVERITY(logger, ::scl::Error)
#define LOG_CRITICAL(logger) LOG_WITH_SEVERITY(logger, ::scl::Critical)
 
 
namespace scl {
 
  template<typename LoggerType, SeverityLevel level>
  class ScopedLog
  {
  public:
    template<typename ConstructionMsgType, typename DestructionMsgType>
    ScopedLog(LoggerType& logger_,
      const ConstructionMsgType& creationMsg, const DestructionMsgType& destructionMsg_)
      : logger(&logger_), destructionMsg(destructionMsg_)
    {
      LOG_WITH_SEVERITY(*logger, level) << creationMsg;
    }
 
    ~ScopedLog()
    {
      LOG_WITH_SEVERITY(*logger, level) << destructionMsg;
    }
 
  private:
    LoggerType* logger;
    std::string destructionMsg;
  };
 
}