Message.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/EventContext.h>
#include <GaudiKernel/Kernel.h> // for GAUDI_API
#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 { return m_message; }

  void setMessage( std::string msg ) { m_message = std::move( msg ); }

  int getType() const { return m_type; }

  void setType( int msg_type ) { m_type = msg_type; }

  const std::string& getSource() const { return m_source; }

  void setSource( std::string_view src ) { m_source = src; }

  EventContext::ContextID_t  getEventSlot() const { return m_ecSlot; }
  EventContext::ContextEvt_t getEventNumber() const { return m_ecEvt; }
  const EventIDBase&         getEventID() const { return m_ecEvtId; }

  const std::string& getFormat() const { return m_format; }

  static const std::string getDefaultFormat() { return DEFAULT_FORMAT; }

  void setFormat( std::string msg ) const;

  const std::string& getTimeFormat() const { return m_time_format; }

  static const std::string getDefaultTimeFormat() { return DEFAULT_TIME_FORMAT; }

  void setTimeFormat( std::string timeFormat ) const;

  friend bool operator<( const Message& lhs, const Message& rhs );

  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, bool middle = false ) 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{ EventContext::INVALID_CONTEXT_ID }; 
  EventContext::ContextEvt_t m_ecEvt{ EventContext::INVALID_CONTEXT_EVT }; 
  EventIDBase                m_ecEvtId;                                    
  pthread_t                  m_ecThrd{};                                   


  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 COMP = 'C';

  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";
};