LoggingManager.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_LOGGING_LOGGING_MANAGER_H_INCLUDED
#define ICL_CORE_LOGGING_LOGGING_MANAGER_H_INCLUDED

#include <icl_core/BaseTypes.h>
#include <icl_core/List.h>
#include <icl_core/Map.h>
#include "icl_core_logging/ImportExport.h"
#include "icl_core_logging/LogLevel.h"

#include <boost/shared_ptr.hpp>

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace logging {

class LogOutputStream;
class LogStream;

typedef LogOutputStream* (*LogOutputStreamFactory)(const icl_core::String& name,
                                                   const icl_core::String& config_prefix,
                                                   LogLevel log_level);
typedef LogStream* (*LogStreamFactory)();

class ICL_CORE_LOGGING_IMPORT_EXPORT LoggingManager
{
public:
  static LoggingManager& instance()
  {
    static LoggingManager manager_instance;
    return manager_instance;
  }

  void configure();

  void initialize();

  bool initialized() const { return m_initialized; }

  void assertInitialized() const;

  void registerLogOutputStream(const icl_core::String& name, LogOutputStreamFactory factory);

  void removeLogOutputStream(LogOutputStream *log_output_stream, bool remove_from_list = true);

  void registerLogStream(const icl_core::String& name, LogStreamFactory factory);

  void registerLogStream(LogStream *log_stream);

  void removeLogStream(const icl_core::String& log_stream_name);

  void printConfiguration() const;

  void changeLogFormat(const icl_core::String& name, const char *format = "~T ~S(~L)~ C~(O~::D: ~E");

  void shutdown();

  void setLogLevel(icl_core::logging::LogLevel log_level);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  static ICL_CORE_VC_DEPRECATE_STYLE LoggingManager& Instance()
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Configure()
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Initialize()
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Initialized() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AssertInitialized() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RegisterLogOutputStream(const icl_core::String& name,
                                                           LogOutputStreamFactory factory)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RemoveLogOutputStream(LogOutputStream *log_output_stream,
                                                         bool remove_from_list = true)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RegisterLogStream(const icl_core::String& name,
                                                     LogStreamFactory factory)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RegisterLogStream(LogStream *log_stream)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RemoveLogStream(const icl_core::String& log_stream_name)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void PrintConfiguration() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void ChangeLogFormat(const icl_core::String& name,
                                                   const char *format = "~T ~S(~L)~ C~(O~::D: ~E")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Shutdown()
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  typedef icl_core::List<icl_core::String> StringList;

  struct LogOutputStreamConfig
  {
    icl_core::String output_stream_name;
    icl_core::String name;
    LogLevel log_level;
    StringList log_streams;
  };
  typedef icl_core::Map<icl_core::String, LogOutputStreamConfig> LogOutputStreamConfigMap;

  struct LogStreamConfig
  {
    icl_core::String name;
    LogLevel log_level;
  };
  typedef icl_core::Map<icl_core::String, LogStreamConfig> LogStreamConfigMap;

  LoggingManager();

  ~LoggingManager();

  // Forbid copying logging manager objects.
  LoggingManager(const LoggingManager&);
  LoggingManager& operator = (const LoggingManager&);

  bool m_initialized;
  bool m_shutdown_running;

  LogOutputStreamConfigMap m_output_stream_config;
  LogStreamConfigMap m_log_stream_config;

  typedef icl_core::Map<icl_core::String, LogStream*> LogStreamMap;
  typedef icl_core::Map<icl_core::String, LogOutputStreamFactory> LogOutputStreamFactoryMap;
  typedef icl_core::Map<icl_core::String, LogStreamFactory> LogStreamFactoryMap;
  typedef icl_core::Map<icl_core::String, LogOutputStream*> LogOutputStreamMap;
  LogStreamMap m_log_streams;
  LogOutputStreamFactoryMap m_log_output_stream_factories;
  LogStreamFactoryMap m_log_stream_factories;
  LogOutputStreamMap m_log_output_streams;

  LogOutputStream *m_default_log_output;
};

namespace hidden {

class ICL_CORE_LOGGING_IMPORT_EXPORT LogOutputStreamRegistrar
{
public:
  LogOutputStreamRegistrar(const icl_core::String& name, LogOutputStreamFactory factory);
};

class ICL_CORE_LOGGING_IMPORT_EXPORT LogStreamRegistrar
{
public:
  LogStreamRegistrar(const icl_core::String& name, LogStreamFactory factory);
};

}

class ICL_CORE_LOGGING_IMPORT_EXPORT LifeCycle
{
public:
  typedef boost::shared_ptr<LifeCycle> Ptr;
  typedef boost::shared_ptr<const LifeCycle> ConstPtr;

  LifeCycle(int &argc, char *argv[]);

  ~LifeCycle();
};

}
}

#endif