ErrorLogger.h

Go to the documentation of this file.

#ifndef _utl_ErrorLogger_h_
#define _utl_ErrorLogger_h_

#include <string>
#include <map>
#include <iostream>
#include <sstream>

#ifndef __CINT__
#  include <boost/format.hpp>
#endif

#include <utl/Singleton.h>
#include <utl/Verbosity.h>


namespace utl {

  class ErrorLogger : public LeakingSingleton<ErrorLogger> {

  public:
    typedef Verbosity::EVerbosity EVerbosity;

    enum ESeverityLevel {
      eDebug   = -1,            
      eMinSeverity = eDebug,
      eInfo    = 0,             
      eWarning = 1,             
      eError   = 2,             
      eFatal   = 3,             
      eMaxSeverity = eFatal
    };

    void Log(const ESeverityLevel severity,
             const std::string& functionName,
             const std::string& fileName,
             const int lineNumber,
             const std::string& message,
             EVerbosity verbosity = Verbosity::eDefault,
             bool stripBaseDir = true) const;

    void Log(const ESeverityLevel severity,
             const std::string& functionName,
             const std::string& fileName,
             const int lineNumber,
             const std::ostringstream& message,
             const EVerbosity verbosity = Verbosity::eDefault,
             bool stripBaseDir = true) const
    { Log(severity, functionName, fileName, lineNumber, message.str(), verbosity, stripBaseDir); }

#ifndef __CINT__
    void Log(const ESeverityLevel severity,
             const std::string& functionName,
             const std::string& fileName,
             const int lineNumber,
             const boost::format& message,
             const EVerbosity verbosity = Verbosity::eDefault,
             bool stripBaseDir = true) const
    { Log(severity, functionName, fileName, lineNumber, message.str(), verbosity, stripBaseDir); }
#endif

    void WriteErrorMessagesToStream();

    void SetStream(std::ostream& stream) { fOStream = &stream; SetColorOutput(false); }

    void SetVerbosity(const EVerbosity verbosity)
    { if (verbosity != Verbosity::eDefault) fVerbosity = verbosity; }

    EVerbosity GetVerbosity() const { return fVerbosity; }

    void SetMinSeverity(const ESeverityLevel severity)
    { fMinSeverity = severity; }

    ESeverityLevel GetMinSeverity() const { return fMinSeverity; }

    void SetColorOutput(const bool color) { fColorOutput = color; }
    bool HasColor() const { return fColorOutput; }

    std::string GetSeverityName(const ESeverityLevel severity) const;

  private:
    ErrorLogger();
    ~ErrorLogger() = default;
    ErrorLogger(const ErrorLogger& er);
    ErrorLogger& operator=(const ErrorLogger& rhs);

    std::ostream* fOStream = nullptr;     
    EVerbosity fVerbosity = Verbosity::eFileInfo;  
    unsigned int fBaseDirLength = 0;
    bool fColorOutput = false;
    ESeverityLevel fMinSeverity = eInfo;

    mutable std::map<std::string, int> fListOfErrorMessages;

    friend class LeakingSingleton<ErrorLogger>;

  };

}


#define LOG_MESSAGE_(severity, message) \
utl::ErrorLogger::GetInstance().Log(severity, __func__, __FILE__, __LINE__, \
  message)

#define LOG_TERSE_MESSAGE_(severity, message) \
utl::ErrorLogger::GetInstance().Log(severity, __func__, __FILE__,  __LINE__, \
  message, utl::Verbosity::eFunction)

#ifdef DEBUG
#  define DEBUGLOG(message) LOG_MESSAGE_(utl::ErrorLogger::eDebug, message)
#else
#  define DEBUGLOG(message)
#endif

#define INFO(message) LOG_MESSAGE_(utl::ErrorLogger::eInfo, message)
#define WARNING(message) LOG_MESSAGE_(utl::ErrorLogger::eWarning, message)
#define ERROR(message) LOG_MESSAGE_(utl::ErrorLogger::eError, message)
#define FATAL(message) LOG_MESSAGE_(utl::ErrorLogger::eFatal, message)

#define LOGG4COUT(message) utl::ErrorLogger::GetInstance().Log(utl::ErrorLogger::eInfo, \
    "G4COut", "", 0, message, utl::Verbosity::eSeverity)
#define LOGG4CERR(message) utl::ErrorLogger::GetInstance().Log(utl::ErrorLogger::eError, \
    "G4CErr", "", 0, message, utl::Verbosity::eSeverity)

#define INFO_TERSE(message) LOG_TERSE_MESSAGE_(utl::ErrorLogger::eInfo, message)
#define WARNING_TERSE(message) LOG_TERSE_MESSAGE_(utl::ErrorLogger::eWarning, message)
#define ERROR_TERSE(message) LOG_TERSE_MESSAGE_(utl::ErrorLogger::eError, message)
#define FATAL_TERSE(message) LOG_TERSE_MESSAGE_(utl::ErrorLogger::eFatal, message)

#endif