Logging.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_H_INCLUDED
#define ICL_CORE_LOGGING_LOGGING_H_INCLUDED

#include <assert.h>
#include <boost/shared_ptr.hpp>

#include <icl_core/TimeSpan.h>
#include <icl_core/TimeStamp.h>
#include "icl_core_logging/Constants.h"
#include "icl_core_logging/ImportExport.h"
#include "icl_core_logging/LoggingManager.h"
#include "icl_core_logging/LogStream.h"
#include "icl_core_logging/ThreadStream.h"
#include "icl_core_config/GetoptParser.h"

// -- START Deprecated compatibility headers --
#include "icl_core_logging/tLoggingManager.h"
#include "icl_core_logging/tLogLevel.h"
// -- END Deprecated compatibility headers --

#include "icl_core_logging/LoggingMacros_LOGGING.h"
#include "icl_core_logging/LoggingMacros_LOGGING_FMT.h"
#include "icl_core_logging/LoggingMacros_LLOGGING.h"
#include "icl_core_logging/LoggingMacros_LLOGGING_FMT.h"
#include "icl_core_logging/LoggingMacros_MLOGGING.h"
#include "icl_core_logging/LoggingMacros_MLOGGING_FMT.h"
#include "icl_core_logging/LoggingMacros_SLOGGING.h"
#include "icl_core_logging/LoggingMacros_SLOGGING_FMT.h"

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

#define LOG_THREAD_STREAM(name) name::instance().ThreadStream()

#ifndef _IC_BUILDER_DEPRECATED_STYLE_
# define DECLARE_LOG_STREAM_CLASS_DEFINITION(name)                 \
  name : public ::icl_core::logging::LogStream                     \
  {                                                                \
  public:                                                          \
    static ::icl_core::logging::LogStream& instance();             \
    static ::icl_core::logging::LogStream *create();               \
  private:                                                         \
    name()                                                         \
      : LogStream(#name)                                           \
    { }                                                            \
    ~name() { }                                                    \
    static name *m_instance;                                       \
    friend class ::icl_core::logging::LoggingManager;              \
    friend class ::icl_core::logging::hidden::LogStreamRegistrar;  \
  };
#else
// Provide deprecated method calls as well.
# define DECLARE_LOG_STREAM_CLASS_DEFINITION(name)                      \
  name : public ::icl_core::logging::LogStream                          \
  {                                                                     \
  public:                                                               \
    static ::icl_core::logging::LogStream& instance();                  \
    static ::icl_core::logging::LogStream *create();                    \
    static ICL_CORE_VC_DEPRECATE_STYLE ::icl_core::logging::LogStream& Instance() ICL_CORE_GCC_DEPRECATE_STYLE; \
    static ICL_CORE_VC_DEPRECATE_STYLE ::icl_core::logging::LogStream *Create() ICL_CORE_GCC_DEPRECATE_STYLE; \
  private:                                                              \
    name()                                                              \
      : LogStream(#name)                                                \
    { }                                                                 \
    ~name() { }                                                         \
    static name *m_instance;                                            \
    friend class ::icl_core::logging::LoggingManager;                   \
    friend class ::icl_core::logging::hidden::LogStreamRegistrar;       \
  };                                                                    \
  inline ::icl_core::logging::LogStream& name::Instance()               \
  { return instance(); }                                                \
  inline ::icl_core::logging::LogStream *name::Create()                 \
  { return create(); }
#endif

#define DECLARE_LOG_STREAM(name) class DECLARE_LOG_STREAM_CLASS_DEFINITION(name)
#define DECLARE_LOG_STREAM_IMPORT_EXPORT(name, decl) class decl DECLARE_LOG_STREAM_CLASS_DEFINITION(name)

// Remark: The log stream object is created here but will be deleted in the
// destructor of LoggingManager!
#define REGISTER_LOG_STREAM(name)                                       \
  name * name::m_instance = NULL;                                       \
  ::icl_core::logging::LogStream& name::instance()                      \
  {                                                                     \
    if (m_instance == NULL)                                             \
    {                                                                   \
      std::cout << "WARNING: Logging Instance is null, did you initialize the logging framework?\nYou should initialize the logging framework at the beginning of your program. This will also enable setting the log level on the command line." << std::endl; \
      ::icl_core::logging::LoggingManager::instance().initialize();     \
      assert(m_instance != NULL && "Tried to initialize LoggingManager but m_instance still not available."); \
      return *m_instance;                                               \
    }                                                                   \
    else                                                                \
    {                                                                   \
      return *m_instance;                                               \
    }                                                                   \
  }                                                                     \
  ::icl_core::logging::LogStream * name::create()                       \
  {                                                                     \
    if (m_instance == NULL)                                             \
    {                                                                   \
      m_instance = new name;                                            \
    }                                                                   \
    return m_instance;                                                  \
  }                                                                     \
  ::icl_core::logging::hidden::LogStreamRegistrar registrar##name(#name, &name::create);

#define REGISTER_LOG_OUTPUT_STREAM(name, factory)                       \
  ::icl_core::logging::hidden::LogOutputStreamRegistrar registrar##name(#name, factory);

#define DECLARE_LOG_STREAM_OPERATOR(object_type)                        \
  ::icl_core::logging::ThreadStream & operator << (::icl_core::logging::ThreadStream &str, \
                                                   const object_type &object);

#ifdef _SYSTEM_LXRT_
#define REGISTER_LOG_STREAM_OPERATOR(object_type)                       \
  ::icl_core::logging::ThreadStream & operator << (::icl_core::logging::ThreadStream &str, \
                                                   const object_type &object) \
  {                                                                     \
    str << "std::ostream redirection is not available in LXRT";         \
    return str;                                                         \
  }
#else // _SYSTEM_LXRT_
#define REGISTER_LOG_STREAM_OPERATOR(object_type)                       \
  ::icl_core::logging::ThreadStream & operator << (::icl_core::logging::ThreadStream &str, \
                                                   const object_type &object) \
  {                                                                     \
    std::ostringstream stream;                                          \
    stream << object;                                                   \
    str << stream.str();                                                \
    return str;                                                         \
  }
#endif // _SYSTEM_LXRT_

namespace icl_core {
namespace logging {

ICL_CORE_LOGGING_IMPORT_EXPORT
ThreadStream& operator << (ThreadStream& stream, const icl_core::TimeStamp& time_stamp);

ICL_CORE_LOGGING_IMPORT_EXPORT
ThreadStream& operator << (ThreadStream& stream, const icl_core::TimeSpan& time_span);

DECLARE_LOG_STREAM_IMPORT_EXPORT(Default, ICL_CORE_LOGGING_IMPORT_EXPORT)
DECLARE_LOG_STREAM_IMPORT_EXPORT(Nirwana, ICL_CORE_LOGGING_IMPORT_EXPORT)
DECLARE_LOG_STREAM_IMPORT_EXPORT(QuickDebug, ICL_CORE_LOGGING_IMPORT_EXPORT)


bool ICL_CORE_LOGGING_IMPORT_EXPORT initialize(int& argc, char *argv[], bool remove_read_arguments);

bool ICL_CORE_LOGGING_IMPORT_EXPORT
initialize(int& argc, char *argv[],
           icl_core::config::Getopt::CommandLineCleaning cleanup
           = icl_core::config::Getopt::eCLC_None,
           icl_core::config::Getopt::ParameterRegistrationCheck registration_check
           = icl_core::config::Getopt::ePRC_Strict);

void ICL_CORE_LOGGING_IMPORT_EXPORT initialize();

void ICL_CORE_LOGGING_IMPORT_EXPORT shutdown();

boost::shared_ptr<LifeCycle> ICL_CORE_LOGGING_IMPORT_EXPORT autoStart(int &argc, char *argv[]);

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


#ifdef _IC_BUILDER_DEPRECATED_STYLE_

bool ICL_CORE_LOGGING_IMPORT_EXPORT ICL_CORE_VC_DEPRECATE_STYLE
Initialize(int& argc, char *argv[], bool remove_read_arguments)
  ICL_CORE_GCC_DEPRECATE_STYLE;

bool ICL_CORE_LOGGING_IMPORT_EXPORT ICL_CORE_VC_DEPRECATE_STYLE
Initialize(int& argc, char *argv[],
           icl_core::config::Getopt::CommandLineCleaning cleanup
           = icl_core::config::Getopt::eCLC_None,
           icl_core::config::Getopt::ParameterRegistrationCheck registration_check
           = icl_core::config::Getopt::ePRC_Strict)
  ICL_CORE_GCC_DEPRECATE_STYLE;

void ICL_CORE_LOGGING_IMPORT_EXPORT ICL_CORE_VC_DEPRECATE_STYLE Initialize()
  ICL_CORE_GCC_DEPRECATE_STYLE;

void ICL_CORE_LOGGING_IMPORT_EXPORT ICL_CORE_VC_DEPRECATE_STYLE Shutdown()
  ICL_CORE_GCC_DEPRECATE_STYLE;

#endif


}
}

#endif