errorcheck::ReportMessage Class Reference

Helper class to use to report a message. More...

#include <errorcheck.h>

Inheritance diagram for errorcheck::ReportMessage:

Collaboration diagram for errorcheck::ReportMessage:

Public Member Functions
	ReportMessage (MSG::Level level, int line, const char *file, const char *func, const char *pkg, const std::string &context, StatusCode sc)
	Constructor.
	ReportMessage (MSG::Level level, int line, const char *file, const char *func, const char *pkg, const std::string &context)
	Constructor.
	~ReportMessage ()
	Destructor.
virtual MsgStream &	doOutput () override
	Emit the message.
MsgStream &	msgstream ()
	Convert to a MsgStream reference.

Static Public Member Functions
static void	hideErrorLocus (bool flag=true)
	If set to true, hide the source file and line number in the output.
static void	hideFunctionNames (bool flag=true)
	If set to true, hide function names in the output.

Private Member Functions
void	format_common (MSG::Level level, int line, const char *file, const char *func, const char *pkg)
	Generate the common header for messages.

Private Attributes
std::string::size_type	m_pos
	The position in the output message after the standard header.

Static Private Attributes
static std::atomic< bool >	s_hide_error_locus
	If true, hide the source file and line number in output messages.
static std::atomic< bool >	s_hide_function_names
	If true, hide the function names in output messages.

Detailed Description

Helper class to use to report a message.

To report a message, create an instance of this class. A standard header, containing the file/line, context name, and so forth, is automatically put at the start of the message. More text may be added using the standard MsgStream streaming operators. The message is actually emitted when this object is destroyed.

Definition at line 171 of file Control/AthenaKernel/AthenaKernel/errorcheck.h.

Constructor & Destructor Documentation

ReportMessage() [1/2]

errorcheck::ReportMessage::ReportMessage	(	MSG::Level	level,
		int	line,
		const char *	file,
		const char *	func,
		const char *	pkg,
		const std::string &	context,
		StatusCode	sc )

Constructor.

Parameters

level	The error logging level for the message.
line	The source line from which the report is being made.
file	The source file name from which the report is being made.
func	The name of the function from which the report is being made.
pkg	The name of the package from which the report is being made.
context	The name of the context (algorithm/tool/service/etc.) from which the report is being made.
sc	The StatusCode to include in the error message.

Definition at line 64 of file errorcheck.cxx.

  : MsgStream (Athena::getMessageSvc(), context)
{
  // The common part.
  format_common (level, line, file, func, pkg);
 
  // The status code.
  *this << ": code " << sc;
 
  // Remember the end of the header.
  m_pos = stream().str().size();
}

ReportMessage() [2/2]

errorcheck::ReportMessage::ReportMessage	(	MSG::Level	level,
		int	line,
		const char *	file,
		const char *	func,
		const char *	pkg,
		const std::string &	context )

Constructor.

Parameters

level	The error logging level for the message.
line	The source line from which the report is being made.
file	The source file name from which the report is being made.
func	The name of the function from which the report is being made.
pkg	The name of the package from which the report is being made.
context	The name of the context (algorithm/tool/service/etc.) from which the report is being made.

Definition at line 94 of file errorcheck.cxx.

  : MsgStream (Athena::getMessageSvc(), context)
{
  // The common part.
  format_common (level, line, file, func, pkg);
 
  // Remember the end of the header.
  m_pos = stream().str().size();
}

~ReportMessage()

errorcheck::ReportMessage::~ReportMessage

(

)

Destructor.

This will cause the message to be emitted, if it hasn't already been.

Definition at line 152 of file errorcheck.cxx.

{
  // Don't do anything if the message has already been emitted
  // (due to using << endmsg, for example).
  if (!stream().str().empty())
    *this << endmsg;
}

Member Function Documentation

doOutput()

MsgStream & errorcheck::ReportMessage::doOutput ( )

overridevirtual

Emit the message.

We override this method from MsgStream in order to fix up the message punctuation.

Definition at line 166 of file errorcheck.cxx.

{
  // The deal here is this.  We want
  //  REPORT_MESSAGE(MSG::INFO) << "foo";
  // to get a `: ' before the `foo'.
  // But we don't want
  //  REPORT_MESSAGE(MSG::INFO);
  // to have a trailing `: '.
  // So, after we generate the common header part, we remember
  // where we are in the string.  When the message is emitted, we look
  // to see if additional text has been added.  If not, then we don't
  // need to do anything.  But if so, we insert a `: ' after the header.
  if (m_pos != stream().str().size()) {
    std::string tmp1 = stream().str();
    std::string tmp2 = tmp1.substr(0, m_pos);
    tmp2 += ": ";
    tmp2.append( tmp1, m_pos);
    stream().str (tmp2);
  }
  return MsgStream::doOutput();
}

format_common()

void errorcheck::ReportMessage::format_common ( MSG::Level level, int line, const char * file, const char * func, const char * pkg )

private

Generate the common header for messages.

Parameters

level	The error logging level for the message.
line	The source line from which the report is being made.
file	The source file name from which the report is being made.
func	The name of the function from which the report is being made.
pkg	The name of the package from which the report is being made.

Definition at line 118 of file errorcheck.cxx.

{
  // Logging level.
  *this << level;
 
  // Write the source file/line.
  if (s_hide_error_locus)
    *this << "FILE:LINE";
  else {
    if (pkg && pkg[0] != '\0')
      *this << munge_filename(file, pkg) << ":" << line;
    else
      *this << file << ":" << line;
  }
 
  // Include the function name if available.
  if (s_hide_function_names)
    *this << " (FUNC)";
  else {
    if (func && func[0] != '\0') {
      *this << " (" << CxxUtils::normalizeFunctionName(func) << ")";
    }
  }
}

hideErrorLocus()

void errorcheck::ReportMessage::hideErrorLocus ( bool flag = true )

static

If set to true, hide the source file and line number in the output.

This is intended for use in regression tests, where it's undesirable to have the output change if source lines are added or deleted.

Definition at line 197 of file errorcheck.cxx.

{
  s_hide_error_locus = flag;
}

hideFunctionNames()

void errorcheck::ReportMessage::hideFunctionNames ( bool flag = true )

static

If set to true, hide function names in the output.

in the output.

This is intended for use in regression tests, where function names may be formatted differently on different platforms.

Definition at line 211 of file errorcheck.cxx.

{
  s_hide_function_names = flag;
}

msgstream()

MsgStream & errorcheck::ReportMessage::msgstream ( )

inline

Convert to a MsgStream reference.

Trying to use a ReportMessage like

ReportMessage(...) << "foo";

doesn't work, because (as of Gaudi 19) the MsgStream inserters are written as free functions:

MsgStream& operator<< (MsgStream&, ...);

and the non-const MsgStream reference won't bind to the temporary. We can work around this problem with this method, which will convert the temporary to a non-const reference. So, this should work:

ReportMessage(...).stream() << "foo";

Definition at line 251 of file Control/AthenaKernel/AthenaKernel/errorcheck.h.

{ return *this; }

Member Data Documentation

m_pos

std::string::size_type errorcheck::ReportMessage::m_pos

private

The position in the output message after the standard header.

Definition at line 292 of file Control/AthenaKernel/AthenaKernel/errorcheck.h.

s_hide_error_locus

std::atomic< bool > errorcheck::ReportMessage::s_hide_error_locus

staticprivate

If true, hide the source file and line number in output messages.

Definition at line 295 of file Control/AthenaKernel/AthenaKernel/errorcheck.h.

s_hide_function_names

std::atomic< bool > errorcheck::ReportMessage::s_hide_function_names

staticprivate

If true, hide the function names in output messages.

Definition at line 298 of file Control/AthenaKernel/AthenaKernel/errorcheck.h.

---

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

• Control/AthenaKernel/AthenaKernel/errorcheck.h
• errorcheck.cxx