Message Class Reference

The Message class. More...

#include <GaudiKernel/Message.h>

Collaboration diagram for Message:

Public Member Functions
	Message ()=default
	Default constructor. More...
	Message (const char *src, int type, const char *msg)
	Constructor. More...
	Message (std::string src, int type, std::string msg)
	Constructor. More...
	~Message ()=default
	Default destructor. More...
const std::string &	getMessage () const
	Get the message string. More...
void	setMessage (std::string msg)
	Set the message string. More...
int	getType () const
	Get the message type. More...
void	setType (int msg_type)
	Set the message type. More...
const std::string &	getSource () const
	Get the message source. More...
void	setSource (std::string src)
	Set the message source. More...
const std::string &	getFormat () const
	Get the format string. More...
void	setFormat (std::string msg) const
	Set the format string. More...
const std::string &	getTimeFormat () const
	Get the time format string. More...
void	setTimeFormat (std::string timeFormat) const
	Set the time format string. More...
bool	operator< (const Message &test)
	Needed to build maps. More...

Static Public Member Functions
static const std::string	getDefaultFormat ()
	Get the default format string. More...
static const std::string	getDefaultTimeFormat ()
	Get the default time format string. More...

Private Member Functions
void	invalidFormat () const
	Called when an invalid format string is encountered. More...
void	makeFormattedMsg (const std::string &format) const
	Format the message. More...
void	decodeFormat (const std::string &format) const
	Decode format. More...
void	sizeField (const std::string &text) const
	Truncate or pad the output string to the field width as necessary. More...
void	setWidth (const std::string &formatArg) const
	Set the width of a stream. More...

Private Attributes
std::string	m_message
	The message text. More...
std::string	m_source {"UNKNOWN"}
	The message source. More...
int	m_type {0}
	The message type/level. More...
std::string	m_format {DEFAULT_FORMAT}
	The format string. More...
std::string	m_time_format {DEFAULT_TIME_FORMAT}
	Time format string. More...
std::string	m_formatted_msg
	Formatted message. More...
char	m_fill {' '}
	Current fill character. More...
int	m_width {0}
	Current field width. More...
bool	m_left {true}
	The message alignment. More...
Event identifiers
EventContext::ContextID_t	m_ecSlot {Gaudi::Hive::currentContext().slot()}
	Event slot. More...
EventContext::ContextEvt_t	m_ecEvt {Gaudi::Hive::currentContext().evt()}
	Event number. More...
EventIDBase	m_ecEvtId {Gaudi::Hive::currentContext().eventID()}
	Full event ID. More...
pthread_t	m_ecThrd {pthread_self()}
	Thread ID. More...

Static Private Attributes
static constexpr const char *	DEFAULT_FORMAT = "% F%18W%S%7W%R%T %0W%M"
	The default message format. More...
static constexpr const char *	DEFAULT_TIME_FORMAT = "%Y-%m-%d %H:%M:%S,%f"
	The default time format (accepts strftime formatters plus %f for milliseconds). More...
Formatting characters
static const char	FORMAT_PREFIX = '%'
	The character used to prefix formatting commands. More...
static const char	JUSTIFY_LEFT = 'L'
	The character used to indicate start of left text justification. More...
static const char	JUSTIFY_RIGHT = 'R'
	The character used to indicate start of right text justification. More...
static const char	MESSAGE = 'M'
	The character used to indicate that the message should be printed. More...
static const char	TYPE = 'T'
	The character used to indicate that the message type should be printed. More...
static const char	TIME = 't'
	The character used to indicate that the message timestamp should be printed. More...
static const char	UTIME = 'u'
	The character used to indicate that the message timestamp should be printed in UTC time. More...
static const char	SOURCE = 'S'
	The character used to indicate that the message source should be printed. More...
static const char	SLOT = 's'
	The character used to indicate that the slot number should be printed. More...
static const char	EVTNUM = 'e'
	The character used to indicate that the event number should be printed. More...
static const char	THREAD = 'X'
	The character used to indicate that the thread ID should be printed. More...
static const char	EVENTID = 'E'
	The character used to indicate that the full event ID should be printed. More...
static const char	FILL = 'F'
	The character used to indicate that the previous character is used to pad fields if the text is not long enough. More...
static const char	WIDTH = 'W'
	The character used to indicate that the previous decimal characters should be taken as the field width. More...

Friends
std::ostream &	operator<< (std::ostream &stream, const Message &msg)
	Insert the message into a stream. More...
bool	operator== (const Message &a, const Message &b)
	Insert the message into a stream. More...

Detailed Description

The Message class.

This class is used to contain messages which can then be formatted and sent to a message service

Author

Iain Last

Definition at line 27 of file Message.h.

Constructor & Destructor Documentation

Message() [1/3]

Message::Message ( )

default

Default constructor.

Message() [2/3]

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

Constructor.

Definition at line 39 of file Message.cpp.

: m_message( msg ), m_source( src ), m_type( type ) {}

Message() [3/3]

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

Constructor.

Definition at line 47 of file Message.cpp.

    : m_message( std::move( msg ) ), m_source( std::move( src ) ), m_type( type ) {}

~Message()

Message::~Message ( )

default

Default destructor.

Member Function Documentation

decodeFormat()

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

private

Decode format.

Definition at line 231 of file Message.cpp.

                                                          {
  if ( !format.empty() ) {
    const char        FORMAT_TYPE  = format[format.length() - 1];
    const std::string FORMAT_PARAM = format.substr( 0, format.length() - 1 );

    // Now test the format.
    std::string level;
    switch ( FORMAT_TYPE ) {
    case FILL:
      if ( FORMAT_PARAM.length() == 1 ) {
        m_fill = FORMAT_PARAM[0];
      } else
        invalidFormat();
      break;

    case TIME: {
      sizeField( formattedTime( m_time_format ) );
    } break;

    case UTIME: {
      sizeField( formattedTime( m_time_format, true ) );
    } break;

    case THREAD: {
      std::ostringstream ost;
      //    ost << "0x" << std::hex << pthread_self();
      ost << "0x" << std::hex << m_ecThrd;
      const std::string& thrStr( ost.str() );
      sizeField( thrStr );
    } break;

    case SLOT: {
      std::ostringstream ost;
      if ( m_ecSlot != EventContext::INVALID_CONTEXT_ID ) { ost << m_ecSlot; }
      sizeField( ost.str() );
    } break;

    case EVTNUM: {
      std::ostringstream ost;
      if ( m_ecEvt != EventContext::INVALID_CONTEXT_EVT ) { ost << m_ecEvt; }
      sizeField( ost.str() );
    } break;

    case EVENTID: {
      std::ostringstream ost;
      if ( m_ecEvtId.isValid() ) { ost << m_ecEvtId; }
      sizeField( ost.str() );
    } break;

    case MESSAGE:
      sizeField( m_message );
      break;

    case SOURCE:
      sizeField( m_source );
      break;

    case TYPE:
      switch ( m_type ) {
#define SET( x )                                                                                                       \
  case x:                                                                                                              \
    level = #x;                                                                                                        \
    break
        SET( NIL );
        SET( VERBOSE );
        SET( DEBUG );
        SET( INFO );
        SET( WARNING );
        SET( ERROR );
        SET( FATAL );
      case ALWAYS:
        level = "SUCCESS";
        break;
      default:
        level = "UNKNOWN";
        break;
#undef SET
      }
      sizeField( level );
      break;

    case FORMAT_PREFIX:
      m_formatted_msg += FORMAT_PREFIX;
      break;
    case JUSTIFY_RIGHT:
      m_left = false;
      break;
    case JUSTIFY_LEFT:
      m_left = true;
      break;
    case WIDTH:
      setWidth( FORMAT_PARAM );
      break;
    default:
      invalidFormat();
      break;
    }
  } else
    invalidFormat();
}

getDefaultFormat()

const std::string Message::getDefaultFormat ( )

static

Get the default format string.

Definition at line 144 of file Message.cpp.

{ return DEFAULT_FORMAT; }

getDefaultTimeFormat()

const std::string Message::getDefaultTimeFormat ( )

static

Get the default time format string.

Definition at line 175 of file Message.cpp.

{ return DEFAULT_TIME_FORMAT; }

getFormat()

const std::string & Message::getFormat

(

)

const

Get the format string.

Definition at line 136 of file Message.cpp.

{ return m_format; }

getMessage()

const std::string & Message::getMessage

(

)

const

Get the message string.

Definition at line 56 of file Message.cpp.

{ return m_message; }

getSource()

const std::string & Message::getSource

(

)

const

Get the message source.

Definition at line 88 of file Message.cpp.

{ return m_source; }

getTimeFormat()

const std::string & Message::getTimeFormat

(

)

const

Get the time format string.

Definition at line 167 of file Message.cpp.

{ return m_time_format; }

getType()

int Message::getType

(

)

const

Get the message type.

Definition at line 72 of file Message.cpp.

{ return m_type; }

invalidFormat()

void Message::invalidFormat ( ) const

private

Called when an invalid format string is encountered.

Definition at line 339 of file Message.cpp.

{ makeFormattedMsg( DEFAULT_FORMAT ); }

makeFormattedMsg()

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

private

Format the message.

Definition at line 194 of file Message.cpp.

                                                              {
  m_formatted_msg.clear();
  auto i = format.begin();
  while ( i != format.end() ) {

    // Output format string until format statement found.
    while ( i != format.end() && *i != FORMAT_PREFIX ) m_formatted_msg += *i++;

    // Test for end of format string.
    if ( i == format.end() ) break;
    i++;

    // Find type of formatting.
    std::string this_format;
    while ( i != format.end() && *i != FORMAT_PREFIX && *i != MESSAGE && *i != TYPE && *i != SOURCE && *i != FILL &&
            *i != WIDTH && *i != TIME && *i != UTIME && *i != SLOT && *i != EVTNUM && *i != THREAD && *i != EVENTID &&
            *i != JUSTIFY_LEFT && *i != JUSTIFY_RIGHT ) {
      this_format += *i++;
    }

    // Reached end of string with improper format.
    if ( i == format.end() ) {
      invalidFormat();
      break;
    }

    this_format += *i++;
    decodeFormat( this_format );
  }
}

operator<()

bool Message::operator<

(

const Message &

test

)

Needed to build maps.

Definition at line 116 of file Message.cpp.

                                          {
  return m_type < b.m_type || m_source < b.m_source || m_message < b.m_message;
}

setFormat()

void Message::setFormat

(

std::string

msg

)

const

Set the format string.

Definition at line 153 of file Message.cpp.

                                                {
  if ( LIKELY( !format.empty() ) ) {
    m_format = std::move( format );
  } else {
    m_format = DEFAULT_FORMAT;
  }
}

setMessage()

void Message::setMessage

(

std::string

msg

)

Set the message string.

Definition at line 64 of file Message.cpp.

{ m_message = std::move( msg ); }

setSource()

void Message::setSource

(

std::string

src

)

Set the message source.

Definition at line 96 of file Message.cpp.

{ m_source = std::move( src ); }

setTimeFormat()

void Message::setTimeFormat

(

std::string

timeFormat

)

const

Set the time format string.

Definition at line 184 of file Message.cpp.

                                                        {
  m_time_format = ( timeFormat.empty() ? DEFAULT_TIME_FORMAT : std::move( timeFormat ) );
}

setType()

void Message::setType

(

int

msg_type

)

Set the message type.

Definition at line 80 of file Message.cpp.

{ m_type = msg_type; }

setWidth()

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

private

Set the width of a stream.

Definition at line 358 of file Message.cpp.

                                                         {
  // Convert string to int, if string contains digits only...
  if ( all_digits( formatArg ) )
    m_width = std::stoi( formatArg );
  else
    invalidFormat();
}

sizeField()

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

private

Truncate or pad the output string to the field width as necessary.

Definition at line 373 of file Message.cpp.

                                                     {
  std::string newText;
  if ( m_width == 0 || m_width == static_cast<int>( text.length() ) ) {
    newText = text;
  } else {

    // Truncate the text if it is too long.
    if ( m_width < static_cast<int>( text.length() ) ) {
      newText = text.substr( 0, m_width );
      for ( int i = 0, j = newText.length() - 1; i < 3 && j >= 0; ++i, --j ) newText[j] = '.';
    }

    // Pad the text.
    else {
      newText = std::string( m_width, m_fill );
      if ( m_left )
        newText.replace( newText.begin(), newText.begin() + text.length(), text.begin(), text.end() );
      else
        newText.replace( newText.end() - text.length(), newText.end(), text.begin(), text.end() );
    }
  }

  m_formatted_msg += newText;
}

Friends And Related Function Documentation

operator<<

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

friend

Insert the message into a stream.

Definition at line 104 of file Message.cpp.

                                                                 {
  msg.makeFormattedMsg( msg.m_format );
  stream << msg.m_formatted_msg;
  return stream;
}

operator==

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

friend

Insert the message into a stream.

Definition at line 126 of file Message.cpp.

                                                      {
  return a.m_source == b.m_source && a.m_type == b.m_type && a.m_message == b.m_message;
}

Member Data Documentation

DEFAULT_FORMAT

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

staticprivate

The default message format.

Definition at line 166 of file Message.h.

DEFAULT_TIME_FORMAT

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

staticprivate

The default time format (accepts strftime formatters plus %f for milliseconds).

Definition at line 169 of file Message.h.

EVENTID

const char Message::EVENTID = 'E'

staticprivate

The character used to indicate that the full event ID should be printed.

Definition at line 156 of file Message.h.

EVTNUM

const char Message::EVTNUM = 'e'

staticprivate

The character used to indicate that the event number should be printed.

Definition at line 150 of file Message.h.

FILL

const char Message::FILL = 'F'

staticprivate

The character used to indicate that the previous character is used to pad fields if the text is not long enough.

Definition at line 159 of file Message.h.

FORMAT_PREFIX

const char Message::FORMAT_PREFIX = '%'

staticprivate

The character used to prefix formatting commands.

Definition at line 123 of file Message.h.

JUSTIFY_LEFT

const char Message::JUSTIFY_LEFT = 'L'

staticprivate

The character used to indicate start of left text justification.

Definition at line 126 of file Message.h.

JUSTIFY_RIGHT

const char Message::JUSTIFY_RIGHT = 'R'

staticprivate

The character used to indicate start of right text justification.

Definition at line 129 of file Message.h.

m_ecEvt

EventContext::ContextEvt_t Message::m_ecEvt {Gaudi::Hive::currentContext().evt()}

private

Event number.

Definition at line 115 of file Message.h.

m_ecEvtId

EventIDBase Message::m_ecEvtId {Gaudi::Hive::currentContext().eventID()}

private

Full event ID.

Definition at line 116 of file Message.h.

m_ecSlot

EventContext::ContextID_t Message::m_ecSlot {Gaudi::Hive::currentContext().slot()}

private

Event slot.

Definition at line 114 of file Message.h.

m_ecThrd

pthread_t Message::m_ecThrd {pthread_self()}

private

Thread ID.

Definition at line 117 of file Message.h.

m_fill

char Message::m_fill {' '}

mutableprivate

Current fill character.

Definition at line 108 of file Message.h.

m_format

std::string Message::m_format {DEFAULT_FORMAT}

mutableprivate

The format string.

Definition at line 105 of file Message.h.

m_formatted_msg

std::string Message::m_formatted_msg

mutableprivate

Formatted message.

Definition at line 107 of file Message.h.

m_left

bool Message::m_left {true}

mutableprivate

The message alignment.

Definition at line 110 of file Message.h.

m_message

std::string Message::m_message

private

The message text.

Definition at line 102 of file Message.h.

m_source

std::string Message::m_source {"UNKNOWN"}

private

The message source.

Definition at line 103 of file Message.h.

m_time_format

std::string Message::m_time_format {DEFAULT_TIME_FORMAT}

mutableprivate

Time format string.

Definition at line 106 of file Message.h.

m_type

int Message::m_type {0}

private

The message type/level.

Definition at line 104 of file Message.h.

m_width

int Message::m_width {0}

mutableprivate

Current field width.

Definition at line 109 of file Message.h.

MESSAGE

const char Message::MESSAGE = 'M'

staticprivate

The character used to indicate that the message should be printed.

Definition at line 132 of file Message.h.

SLOT

const char Message::SLOT = 's'

staticprivate

The character used to indicate that the slot number should be printed.

Definition at line 147 of file Message.h.

SOURCE

const char Message::SOURCE = 'S'

staticprivate

The character used to indicate that the message source should be printed.

Definition at line 144 of file Message.h.

THREAD

const char Message::THREAD = 'X'

staticprivate

The character used to indicate that the thread ID should be printed.

Definition at line 153 of file Message.h.

TIME

const char Message::TIME = 't'

staticprivate

The character used to indicate that the message timestamp should be printed.

Definition at line 138 of file Message.h.

TYPE

const char Message::TYPE = 'T'

staticprivate

The character used to indicate that the message type should be printed.

Definition at line 135 of file Message.h.

UTIME

const char Message::UTIME = 'u'

staticprivate

The character used to indicate that the message timestamp should be printed in UTC time.

Definition at line 141 of file Message.h.

WIDTH

const char Message::WIDTH = 'W'

staticprivate

The character used to indicate that the previous decimal characters should be taken as the field width.

Definition at line 162 of file Message.h.

---

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

• GaudiKernel/GaudiKernel/Message.h
• GaudiKernel/src/Lib/Message.cpp