Message.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_MESSAGE_H
#define GAUDIKERNEL_MESSAGE_H

#include "GaudiKernel/EventContext.h"
#include "GaudiKernel/Kernel.h" // for GAUDI_API
#include "GaudiKernel/ThreadLocalContext.h"
#include <iostream>
#include <string>

class GAUDI_API Message final {
public:
  Message() = default;

  Message( const char* src, int type, const char* msg );

  Message( std::string src, int type, std::string msg );

  ~Message() = default;

  const std::string& getMessage() const;

  void setMessage( std::string msg );

  int getType() const;

  void setType( int msg_type );

  const std::string& getSource() const;

  void setSource( std::string src );

  const std::string& getFormat() const;

  static const std::string getDefaultFormat();

  void setFormat( std::string msg ) const;

  const std::string& getTimeFormat() const;

  static const std::string getDefaultTimeFormat();

  void setTimeFormat( std::string timeFormat ) const;

  bool operator<( const Message& test );

  friend std::ostream& operator<<( std::ostream& stream, const Message& msg );

  friend bool operator==( const Message& a, const Message& b );

private:
  void invalidFormat() const;

  void makeFormattedMsg( const std::string& format ) const;

  void decodeFormat( const std::string& format ) const;

  void sizeField( const std::string& text ) const;

  void setWidth( const std::string& formatArg ) const;

  std::string         m_message;                          
  std::string         m_source{"UNKNOWN"};                
  int                 m_type{0};                          
  mutable std::string m_format{DEFAULT_FORMAT};           
  mutable std::string m_time_format{DEFAULT_TIME_FORMAT}; 
  mutable std::string m_formatted_msg;                    
  mutable char        m_fill{' '};                        
  mutable int         m_width{0};                         
  mutable bool        m_left{true};                       

  EventContext::ContextID_t  m_ecSlot{Gaudi::Hive::currentContext().slot()};     
  EventContext::ContextEvt_t m_ecEvt{Gaudi::Hive::currentContext().evt()};       
  EventIDBase                m_ecEvtId{Gaudi::Hive::currentContext().eventID()}; 
  pthread_t                  m_ecThrd{pthread_self()};                           


  static const char FORMAT_PREFIX = '%';

  static const char JUSTIFY_LEFT = 'L';

  static const char JUSTIFY_RIGHT = 'R';

  static const char MESSAGE = 'M';

  static const char TYPE = 'T';

  static const char TIME = 't';

  static const char UTIME = 'u';

  static const char SOURCE = 'S';

  static const char SLOT = 's';

  static const char EVTNUM = 'e';

  static const char THREAD = 'X';

  static const char EVENTID = 'E';

  static const char FILL = 'F';

  static const char WIDTH = 'W';

  static constexpr const char* DEFAULT_FORMAT = "% F%18W%S%7W%R%T %0W%M";

  static constexpr const char* DEFAULT_TIME_FORMAT = "%Y-%m-%d %H:%M:%S,%f";
};

GAUDI_API std::ostream& operator<<( std::ostream& stream, const Message& msg );

GAUDI_API bool operator==( const Message& a, const Message& b );

#endif