Root::TMsgLogger Class Reference

#include <TMsgLogger.h>

Inheritance diagram for Root::TMsgLogger:

Collaboration diagram for Root::TMsgLogger:

Public Member Functions
	TMsgLogger (const TObject *source, TMsgLevel minLevel=kINFO)
	TMsgLogger (const std::string &source, TMsgLevel minLevel=kINFO)
	TMsgLogger (TMsgLevel minLevel=kINFO)
	TMsgLogger (const TMsgLogger &parent)
virtual	~TMsgLogger ()
void	SetSource (const char *source)
void	SetSource (const std::string &source)
void	SetSource (const TString &source)
const std::string &	GetSource () const
UInt_t	GetMaxSourceSize () const
std::string	GetPrintedSource () const
std::string	GetFormattedSource () const
TMsgLevel	GetMinLevel () const
const std::string &	GetMinLevelStr () const
TMsgLevel	MapLevel (const TString &instr) const
TMsgLogger &	operator= (const TMsgLogger &parent)
TMsgLogger &	operator<< (TMsgLogger &(*_f)(TMsgLogger &))
TMsgLogger &	operator<< (std::ostream &(*_f)(std::ostream &))
TMsgLogger &	operator<< (std::ios &(*_f)(std::ios &))
TMsgLogger &	operator<< (TMsgLevel level)
template<class T>
TMsgLogger &	operator<< (T arg)

Static Public Member Functions
static TMsgLogger &	endmsg (TMsgLogger &logger)
static void	SetMinLevel (TMsgLevel minLevel)

Private Member Functions
void	Send ()
void	InitMaps ()
void	WriteMsg (TMsgLevel level, const std::string &line) const

Private Attributes
const TObject *	m_objSource
std::string	m_strSource
const std::string	m_prefix
const std::string	m_suffix
TMsgLevel	m_activeLevel
const std::string::size_type	m_maxSourceSize
std::map< TMsgLevel, std::string >	m_levelMap
std::map< TMsgLevel, std::string >	m_colorMap

Static Private Attributes
static std::atomic< TMsgLevel >	m_minLevel = kINFO

Detailed Description

Definition at line 47 of file TMsgLogger.h.

Constructor & Destructor Documentation

TMsgLogger() [1/4]

Root::TMsgLogger::TMsgLogger	(	const TObject *	source,
		TMsgLevel	minLevel = kINFO )

Definition at line 42 of file TMsgLogger.cxx.

   : m_objSource( source ), 
     m_strSource( "" ), 
     m_prefix( PREFIX ), 
     m_suffix( SUFFIX ), 
     m_activeLevel( kINFO ), 
     m_maxSourceSize( MAXIMUM_SOURCE_NAME_LENGTH )
{
   // constructor
   InitMaps();
}

TMsgLogger() [2/4]

Root::TMsgLogger::TMsgLogger	(	const std::string &	source,
		TMsgLevel	minLevel = kINFO )

Definition at line 54 of file TMsgLogger.cxx.

   : m_objSource( 0 ),
     m_strSource( source ), 
     m_prefix( PREFIX ), 
     m_suffix( SUFFIX ), 
     m_activeLevel( kINFO ), 
     m_maxSourceSize( MAXIMUM_SOURCE_NAME_LENGTH )
{
   // constructor
   InitMaps();
}

TMsgLogger() [3/4]

Root::TMsgLogger::TMsgLogger

(

TMsgLevel

minLevel = kINFO

)

Definition at line 66 of file TMsgLogger.cxx.

   : m_objSource( 0 ), 
     m_strSource( "Unknown" ), 
     m_prefix( PREFIX ), 
     m_suffix( SUFFIX ), 
     m_activeLevel( kINFO ), 
     m_maxSourceSize( MAXIMUM_SOURCE_NAME_LENGTH )
{
   // constructor
   InitMaps();
}

TMsgLogger() [4/4]

Root::TMsgLogger::TMsgLogger

(

const TMsgLogger &

parent

)

Definition at line 78 of file TMsgLogger.cxx.

  : basic_ios< TMsgLogger::char_type, TMsgLogger::traits_type >(),
     ostringstream(),
     TObject(),
     m_prefix( PREFIX ), 
     m_suffix( SUFFIX ),
     m_maxSourceSize( MAXIMUM_SOURCE_NAME_LENGTH )
{
   InitMaps();
   *this = parent;
}

~TMsgLogger()

Root::TMsgLogger::~TMsgLogger ( )

virtual

Definition at line 90 of file TMsgLogger.cxx.

{}

Member Function Documentation

endmsg()

Root::TMsgLogger & Root::TMsgLogger::endmsg ( TMsgLogger & logger )

static

Definition at line 188 of file TMsgLogger.cxx.

{
   // end line
   logger.Send();
   return logger;
}

GetFormattedSource()

string Root::TMsgLogger::GetFormattedSource

(

)

const

Definition at line 104 of file TMsgLogger.cxx.

{
   // make sure the source name is no longer than m_maxSourceSize:
   string source_name;
   if (m_objSource) source_name = m_objSource->GetName();
   else             source_name = m_strSource;
 
   if (source_name.size() > m_maxSourceSize) {
      source_name.resize(m_maxSourceSize - 3 );
      source_name += "...";
   }
   
   return source_name;
}

GetMaxSourceSize()

UInt_t Root::TMsgLogger::GetMaxSourceSize ( ) const

inline

Definition at line 63 of file TMsgLogger.h.

{ return (UInt_t)m_maxSourceSize; }

GetMinLevel()

TMsgLevel Root::TMsgLogger::GetMinLevel ( ) const

inline

Definition at line 67 of file TMsgLogger.h.

{ return m_minLevel; }

GetMinLevelStr()

const std::string & Root::TMsgLogger::GetMinLevelStr ( ) const

inline

Definition at line 68 of file TMsgLogger.h.

{ return m_levelMap.find( m_minLevel )->second; }

GetPrintedSource()

string Root::TMsgLogger::GetPrintedSource

(

)

const

Definition at line 119 of file TMsgLogger.cxx.

{ 
   // the full logger prefix
   string source_name = GetFormattedSource();
   if (source_name.size() < m_maxSourceSize) 
      for (string::size_type i=source_name.size(); i<m_maxSourceSize; i++) source_name.push_back( ' ' );
 
   return m_prefix + source_name + m_suffix; 
}

GetSource()

const std::string & Root::TMsgLogger::GetSource ( ) const

inline

Definition at line 61 of file TMsgLogger.h.

{ return m_strSource; }

InitMaps()

void Root::TMsgLogger::InitMaps ( )

private

Definition at line 217 of file TMsgLogger.cxx.

{
   m_levelMap[kVERBOSE] = "VERBOSE";
   m_levelMap[kDEBUG]   = "DEBUG";
   m_levelMap[kINFO]    = "INFO";
   m_levelMap[kWARNING] = "WARNING";
   m_levelMap[kERROR]   = "ERROR";
   m_levelMap[kFATAL]   = "FATAL";
   m_levelMap[kALWAYS]  = "ALWAYS";
 
   m_colorMap[kVERBOSE] = "\033[1;34m";
   m_colorMap[kDEBUG]   = "\033[34m";
   m_colorMap[kINFO]    = "";
   m_colorMap[kWARNING] = "\033[1;31m";
   m_colorMap[kERROR]   = "\033[1;31m";
   m_colorMap[kFATAL]   = "\033[37;41;1m";
   m_colorMap[kALWAYS]  = "\033[30m";   
}

MapLevel()

Root::TMsgLevel Root::TMsgLogger::MapLevel

(

const TString &

instr

)

const

Definition at line 195 of file TMsgLogger.cxx.

{
   TString ins = instr; // need to copy
   ins.ToUpper();
 
   // find the corresponding key
   std::map<TMsgLevel, std::string>::const_iterator it = m_levelMap.begin();
   for (; it != m_levelMap.end(); ++it) if (ins == it->second) return it->first;
 
   // not found --> fatal error
   TString line( Form( "fatal error in <TMsgLogger::MapLevel> unknown output level: %s ==> abort", ins.Data() ) );
   std::string col;
   auto colit = m_colorMap.find( kFATAL );
   if (colit != m_colorMap.end()) {
     col = colit->second;
   }
   cout << col << m_prefix << line << "\033[0m" << endl;
   abort();
 
   return kFATAL;
}

operator<<() [1/5]

TMsgLogger & Root::TMsgLogger::operator<< ( std::ios &(* _f )(std::ios &) )

inline

Definition at line 131 of file TMsgLogger.h.

   {
      (_f)(*this);
      return *this;
   }

operator<<() [2/5]

TMsgLogger & Root::TMsgLogger::operator<< ( std::ostream &(* _f )(std::ostream &) )

inline

Definition at line 125 of file TMsgLogger.h.

   {
      (_f)(*this);
      return *this;
   }

operator<<() [3/5]

template<class T>

TMsgLogger & Root::TMsgLogger::operator<< ( T arg )

inline

Definition at line 87 of file TMsgLogger.h.

                                                          {
         *static_cast<std::ostringstream*>(this) << arg; 
         return *this;
      }

operator<<() [4/5]

TMsgLogger & Root::TMsgLogger::operator<< ( TMsgLevel level )

inline

Definition at line 137 of file TMsgLogger.h.

   {
      m_activeLevel = level;
      return *this;
   }

operator<<() [5/5]

TMsgLogger & Root::TMsgLogger::operator<< ( TMsgLogger &(* _f )(TMsgLogger &) )

inline

Definition at line 120 of file TMsgLogger.h.

   {
      return (_f)(*this);
   }

operator=()

Root::TMsgLogger & Root::TMsgLogger::operator=

(

const TMsgLogger &

parent

)

Definition at line 93 of file TMsgLogger.cxx.

{
   if (this != &parent) {
     m_objSource   = parent.m_objSource;
     m_strSource   = parent.m_strSource;
     m_activeLevel = parent.m_activeLevel;
   }
 
   return *this;
}

Send()

void Root::TMsgLogger::Send ( )

private

Definition at line 129 of file TMsgLogger.cxx.

{
   // activates the logger writer
 
   // make sure the source name is no longer than m_maxSourceSize:
   string source_name = GetFormattedSource();
 
   string message = this->str();
   string::size_type previous_pos = 0, current_pos = 0;
 
   // slice the message into lines:
   for (;;) {
      current_pos = message.find( '\n', previous_pos );
      string line = message.substr( previous_pos, current_pos - previous_pos );
 
      ostringstream message_to_send;
      // must call the modifiers like this, otherwise g++ get's confused with the operators...
      message_to_send.setf( ios::adjustfield, ios::left );
      message_to_send.width( m_maxSourceSize );
      message_to_send << source_name << m_suffix << line;
      this->WriteMsg( m_activeLevel, message_to_send.str() );
 
      if (current_pos == message.npos) break;
      previous_pos = current_pos + 1;
   }
 
   // reset the stream buffer:
   this->str( "" );
   return;
}

SetMinLevel()

void Root::TMsgLogger::SetMinLevel ( TMsgLevel minLevel )

inlinestatic

Definition at line 92 of file TMsgLogger.h.

{ m_minLevel = minLevel; }

SetSource() [1/3]

void Root::TMsgLogger::SetSource ( const char * source )

inline

Definition at line 58 of file TMsgLogger.h.

{ m_strSource = source; }

SetSource() [2/3]

void Root::TMsgLogger::SetSource ( const std::string & source )

inline

Definition at line 59 of file TMsgLogger.h.

{ m_strSource = source; }

SetSource() [3/3]

void Root::TMsgLogger::SetSource ( const TString & source )

inline

Definition at line 60 of file TMsgLogger.h.

{ m_strSource = source.Data(); }

WriteMsg()

void Root::TMsgLogger::WriteMsg ( TMsgLevel level, const std::string & line ) const

private

Definition at line 160 of file TMsgLogger.cxx.

{
   if (mlevel < GetMinLevel()) return;
   map<TMsgLevel, std::string>::const_iterator slevel;
   if ((slevel = m_levelMap.find( mlevel )) == m_levelMap.end()) return;
#ifdef USE_COLORED_CONSOLE
   // no text for INFO
   std::string col;
   auto it = m_colorMap.find( mlevel );
   if (it != m_colorMap.end()) {
     col = it->second;
   }
   if (mlevel == kINFO) 
      cout << col << m_prefix << line << "\033[0m" << endl;
   else
      cout << col << m_prefix
           << "<" << slevel->second << "> " << line  << "\033[0m" << endl;
#else
   if (mlevel == kINFO) 
      cout << m_prefix << line << endl;
   else
      cout << m_prefix << "<" << slevel->second << "> " << line << endl;
#endif // USE_COLORED_CONSOLE
 
   // take decision to stop if fatal error
   if (mlevel == kFATAL) { cout << "***> abort program execution" << endl; std::abort(); }
}

Member Data Documentation

m_activeLevel

TMsgLevel Root::TMsgLogger::m_activeLevel

private

Definition at line 110 of file TMsgLogger.h.

m_colorMap

std::map<TMsgLevel, std::string> Root::TMsgLogger::m_colorMap

private

Definition at line 114 of file TMsgLogger.h.

m_levelMap

std::map<TMsgLevel, std::string> Root::TMsgLogger::m_levelMap

private

Definition at line 113 of file TMsgLogger.h.

m_maxSourceSize

const std::string::size_type Root::TMsgLogger::m_maxSourceSize

private

Definition at line 111 of file TMsgLogger.h.

m_minLevel

std::atomic< Root::TMsgLevel > Root::TMsgLogger::m_minLevel = kINFO

staticprivate

Definition at line 99 of file TMsgLogger.h.

m_objSource

const TObject* Root::TMsgLogger::m_objSource

private

Definition at line 106 of file TMsgLogger.h.

m_prefix

const std::string Root::TMsgLogger::m_prefix

private

Definition at line 108 of file TMsgLogger.h.

m_strSource

std::string Root::TMsgLogger::m_strSource

private

Definition at line 107 of file TMsgLogger.h.

m_suffix

const std::string Root::TMsgLogger::m_suffix

private

Definition at line 109 of file TMsgLogger.h.

---

The documentation for this class was generated from the following files:

• TMsgLogger.h
• TMsgLogger.cxx