TMsgLogger.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
/**********************************************************************************
 * Class  : TMsgLogger                                                            *
 *                                                                                *
 * Authors (alphabetical):                                                        *
 *      Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch> - CERN, Switzerland   *
 **********************************************************************************/
 
#ifndef ROOT_Root_TMsgLogger
#define ROOT_Root_TMsgLogger

//                                                                      //
// TMsgLogger                                                           //
//                                                                      //
// ostreamstream derivative to redirect and format output               //
//                                                                      //
 
// STL include(s):
#include <string>
#include <sstream>
#include <map>
 
// ROOT include(s)
#include "TObject.h"
#include "TString.h"
 
// Local include(s):
 
namespace Root {
 
   // define outside of class to facilite access
   enum TMsgLevel { 
      kVERBOSE = 1, 
      kDEBUG   = 2,
      kINFO    = 3,
      kWARNING = 4,
      kERROR   = 5,
      kFATAL   = 6,
      kALWAYS  = 7
   };
 
   class TMsgLogger : public std::ostringstream, public TObject {
 
   public:
 
      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();
 
      // Accessors
      void               SetSource( const char*        source ) { m_strSource = source; }
      void               SetSource( const std::string& source ) { m_strSource = source; }
      void               SetSource( const TString&     source ) { m_strSource = source.Data(); }
      const std::string& GetSource() const { return m_strSource; }
 
      UInt_t      GetMaxSourceSize() const       { return (UInt_t)m_maxSourceSize; }
      std::string GetPrintedSource() const;
      std::string GetFormattedSource() const;
 
      TMsgLevel          GetMinLevel() const     { return m_minLevel; }
      const std::string& GetMinLevelStr() const  { return m_levelMap.find( m_minLevel )->second; }
 
      TMsgLevel   MapLevel( const TString& instr ) const;
      
      // Needed for copying
      TMsgLogger& operator= ( const TMsgLogger& parent );
 
      // Stream modifier(s)
      static TMsgLogger& endmsg( TMsgLogger& logger );
      
      // Accept stream modifiers
      TMsgLogger& operator<< ( TMsgLogger& ( *_f )( TMsgLogger& ) );
      TMsgLogger& operator<< ( std::ostream& ( *_f )( std::ostream& ) );
      TMsgLogger& operator<< ( std::ios& ( *_f )( std::ios& ) );
      
      // Accept message level specification
      TMsgLogger& operator<< ( TMsgLevel level );
      
      // For all the "conventional" inputs
      template <class T> TMsgLogger& operator<< ( T arg ) {
         *static_cast<std::ostringstream*>(this) << arg; 
         return *this;
      }
 
      static void SetMinLevel( TMsgLevel minLevel ) { m_minLevel = minLevel; }
 
   private:
 
      // the current minimum level is global for the whole Root
      // it can only be changed by the central storage singleton object
      // we make this atomic to suppress thread-checker warnings
      static std::atomic<TMsgLevel>    m_minLevel;       // minimum level for logging output
 
      // private utility routines
      void Send();
      void InitMaps();
      void WriteMsg( TMsgLevel level, const std::string& line ) const;
 
      const TObject*                   m_objSource;      // the source TObject (used for name)
      std::string                      m_strSource;      // alternative string source
      const std::string                m_prefix;         // the prefix of the source name
      const std::string                m_suffix;         // suffix following source name
      TMsgLevel                        m_activeLevel;    // active level
      const std::string::size_type     m_maxSourceSize;  // maximum length of source name
 
      std::map<TMsgLevel, std::string> m_levelMap;       // matches output levels with strings
      std::map<TMsgLevel, std::string> m_colorMap;       // matches output levels with terminal colors
 
      //ClassDef(TMsgLogger,0)
 
   }; // class TMsgLogger
 
   inline TMsgLogger& TMsgLogger::operator<< ( TMsgLogger& (*_f)( TMsgLogger& ) ) 
   {
      return (_f)(*this);
   }
 
   inline TMsgLogger& TMsgLogger::operator<< ( std::ostream& (*_f)( std::ostream& ) ) 
   {
      (_f)(*this);
      return *this;
   }
 
   inline TMsgLogger& TMsgLogger::operator<< ( std::ios& ( *_f )( std::ios& ) ) 
   {
      (_f)(*this);
      return *this;
   }
 
   inline TMsgLogger& TMsgLogger::operator<< ( TMsgLevel level ) 
   {
      m_activeLevel = level;
      return *this;
   }
 
   // Although the proper definition of "Endl" as a function pointer
   // would be nicer C++-wise, it introduces some "unused variable"
   // warnings so let's use the #define definition after all...
   // [ static TMsgLogger& ( *Endl )( TMsgLogger& ) = &TMsgLogger::endmsg; ]
#define GEndl TMsgLogger::endmsg
 
}
 
#endif // Root_TMsgLogger