mitkLog.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkLog_h
#define mitkLog_h
 
#include <mitkLogBackendBase.h>
 
#include <sstream>
 
#include <MitkLogExports.h>
 
#ifndef MITKLOG_MODULENAME
#  if defined(US_MODULE_NAME)
#    define MITKLOG_STR_(x) #x
#    define MITKLOG_STR(x) MITKLOG_STR_(x)
#    define MITKLOG_MODULENAME MITKLOG_STR(US_MODULE_NAME)
#  else
#    define MITKLOG_MODULENAME "n/a"
#  endif
#endif
 
namespace mitk
{
  void MITKLOG_EXPORT RegisterBackend(LogBackendBase* backend);
 
  void MITKLOG_EXPORT UnregisterBackend(LogBackendBase* backend);
 
  void MITKLOG_EXPORT DistributeToBackends(LogMessage& message);
 
  void MITKLOG_EXPORT EnableBackends(LogBackendBase::OutputType type);
 
  void MITKLOG_EXPORT DisableBackends(LogBackendBase::OutputType type);
 
  bool MITKLOG_EXPORT IsBackendEnabled(LogBackendBase::OutputType type);
 
  class MITKLOG_EXPORT PseudoLogStream
  {
  public:
    PseudoLogStream(LogLevel level, const std::string& filePath, int lineNumber, const std::string& functionName)
      : m_Disabled(false),
        m_Message(level, filePath, lineNumber, functionName),
        m_Stream(std::stringstream::out)
    {
    }
 
    ~PseudoLogStream()
    {
      if (!m_Disabled)
      {
        m_Message.Message = m_Stream.str();
        m_Message.ModuleName = MITKLOG_MODULENAME;
        DistributeToBackends(m_Message);
      }
    }
 
    template <class T>
    PseudoLogStream& operator<<(const T& data)
    {
      if (!m_Disabled)
      {
        std::locale C("C");
        std::locale originalLocale = m_Stream.getloc();
        m_Stream.imbue(C);
 
        m_Stream << data;
 
        m_Stream.imbue(originalLocale);
      }
 
      return *this;
    }
 
    template <class T>
    PseudoLogStream& operator<<(T& data)
    {
      if (!m_Disabled)
      {
        std::locale C("C");
        std::locale originalLocale = m_Stream.getloc();
        m_Stream.imbue(C);
 
        m_Stream << data;
 
        m_Stream.imbue(originalLocale);
      }
 
      return *this;
    }
 
    PseudoLogStream& operator<<(std::ostream& (*func)(std::ostream&))
    {
      if (!m_Disabled)
      {
        std::locale C("C");
        std::locale originalLocale = m_Stream.getloc();
        m_Stream.imbue(C);
 
        m_Stream << func;
 
        m_Stream.imbue(originalLocale);
      }
 
      return *this;
    }
 
    PseudoLogStream& operator()(const std::string& category)
    {
      if (!m_Disabled)
      {
        if (m_Message.Category.length())
          m_Message.Category += ".";
 
        m_Message.Category += category;
      }
 
      return *this;
    }
 
    PseudoLogStream& operator()(bool enabled)
    {
      m_Disabled |= !enabled;
      return *this;
    }
 
  protected:
    bool m_Disabled;
    LogMessage m_Message;
    std::stringstream m_Stream;
  };
 
  class MITKLOG_EXPORT NullLogStream
  {
  public:
    template <class T>
    NullLogStream& operator<<(const T&)
    {
      return *this;
    }
 
    template <class T>
    NullLogStream& operator<<(T&)
    {
      return *this;
    }
 
    NullLogStream& operator<<(std::ostream &(*)(std::ostream &))
    {
      return *this;
    }
 
    NullLogStream& operator()(const char*)
    {
      return *this;
    }
 
    NullLogStream& operator()(bool)
    {
      return *this;
    }
  };
}
 
#define MITK_INFO mitk::PseudoLogStream(mitk::LogLevel::Info, __FILE__, __LINE__, __FUNCTION__)
 
#define MITK_WARN mitk::PseudoLogStream(mitk::LogLevel::Warn, __FILE__, __LINE__, __FUNCTION__)
 
#define MITK_ERROR mitk::PseudoLogStream(mitk::LogLevel::Error, __FILE__, __LINE__, __FUNCTION__)
 
#define MITK_FATAL mitk::PseudoLogStream(mitk::LogLevel::Fatal, __FILE__, __LINE__, __FUNCTION__)
 
#ifdef MITK_ENABLE_DEBUG_MESSAGES
#define MITK_DEBUG mitk::PseudoLogStream(mitk::LogLevel::Debug, __FILE__, __LINE__, __FUNCTION__)
#else
#define MITK_DEBUG true ? mitk::NullLogStream() : mitk::NullLogStream()
#endif
 
#endif