errorcheck Namespace Reference

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

Functions
std::string	context_name (const INamedInterface *context)
	Return the context name from a context (this) pointer.
std::string	context_name (const void *context)
	Return the context name from a context (this) pointer.
std::string	munge_filename (const std::string &file, const std::string &pkg)
	Shorten filename.
std::string	context_name (const SG::VarHandleBase *context)
	Return a context name for a VarHandle.

Function Documentation

context_name() [1/3]

std::string errorcheck::context_name

(

const INamedInterface *

context

)

Return the context name from a context (this) pointer.

Parameters

context

The context from which to get the name.

Returns

The name of this context.

This is the specialization for an INamedInterface.

Definition at line 230 of file errorcheck.cxx.

{
  return context->name();
}

context_name() [2/3]

std::string errorcheck::context_name

(

const SG::VarHandleBase *

context

)

Return a context name for a VarHandle.

Parameters

context

The VarHandle.

For use with the CHECK and REPORT_MESSAGE macros.

Definition at line 70 of file StoreGate/src/VarHandleBase.cxx.

  {
  return std::format("VarHandle({}+{}[{}])", context->storeHandle().name(), context->key(), context->clid());
  }

context_name() [3/3]

std::string errorcheck::context_name

(

const void *

context

)

Return the context name from a context (this) pointer.

Parameters

context

The context from which to get the name.

Returns

The name of this context.

This is the specialization for an unknown context type; it returns a blank name.

Definition at line 244 of file errorcheck.cxx.

{
  return "";
}

munge_filename()

std::string errorcheck::munge_filename	(	const std::string &	file,
		const std::string &	pkg )

Shorten filename.

Parameters

file	The full file path
pkg	The package name (with optional version)

Returns

Returns the file path starting from the package name

Definition at line 38 of file errorcheck.cxx.

{
  // Extract package name in case there is a version (MyPackage-00-00-00)
  const std::string p = pkg.substr(0, pkg.find('-'));
  if (!p.empty()) {
    // Find package name in path and remove any leading entries
    std::string::size_type ipos = file.find("/"+p+"/");
    if (ipos != std::string::npos) {
      return file.substr(ipos+1, std::string::npos);
    }
  }
  return file;
}