lar::debug::CallInfoPrinter Class Reference

Class handling the output of information in a CallInfo_t object. More...

#include <DebugUtils.h>

Classes
struct	opt
	Set of options for printing. More...

Public Member Functions
	CallInfoPrinter ()
	Default constructor: use default options. More...
	CallInfoPrinter (opt opts)
	Constructor: use specified options. More...
void	setOptions (opt opts)
	Override all the options. More...
template<typename Stream >
void	print (Stream &&out, CallInfo_t const &info) const
	Print the content of info into the stream out, using the current options. More...
template<typename Stream >
void	operator() (Stream &&out, CallInfo_t const &info) const
	Print the content of info into the stream out, using the current options. More...
void	setDefaultOptions ()
	Sets this object to use a set of default options. More...

Static Public Member Functions
static opt	defaultOptions ()
	Returns a set of default options. More...

Public Attributes
opt	options
	Set of current options. More...

Detailed Description

Class handling the output of information in a CallInfo_t object.

This class has a "default" print function (also replicated as a call operator), and a set of options that can be tweaked to change the amount of information and format to be printed.

Definition at line 132 of file DebugUtils.h.

Constructor & Destructor Documentation

lar::debug::CallInfoPrinter::CallInfoPrinter ( )

inline

Default constructor: use default options.

Definition at line 160 of file DebugUtils.h.

{ setDefaultOptions(); }

lar::debug::CallInfoPrinter::CallInfoPrinter ( opt  opts )

inline

Constructor: use specified options.

Definition at line 163 of file DebugUtils.h.

: options(opts) {}

Member Function Documentation

static opt lar::debug::CallInfoPrinter::defaultOptions ( )

inlinestatic

Returns a set of default options.

Definition at line 181 of file DebugUtils.h.

      {
        opt options;
        options.set(opt::demangled);
        options.set(opt::library);
        options.set(opt::shortLibrary);
        options.set(opt::address);
        return options;
      }

template<typename Stream >

void lar::debug::CallInfoPrinter::operator() ( Stream &&  out, CallInfo_t const &  info  ) const

inline

Print the content of info into the stream out, using the current options.

Definition at line 174 of file DebugUtils.h.

      { print(std::forward<Stream>(out), info); }

template<typename Stream >

void lar::debug::CallInfoPrinter::print	(	Stream &&	out,
		CallInfo_t const &	info
	)		const

Print the content of info into the stream out, using the current options.

Definition at line 354 of file DebugUtils.h.

                                                                        {
    if (!info) {
      out << info.original << " (?)";
      return;
    }

    if (info.mangledFunctionName.empty()) {
      if (options.has(opt::library)) {
        out << "in "
          << (options.has(opt::shortLibrary)? info.shortLibrary(): info.libraryName);
      }
      else out << "unknown";
    }
    else {
    //  auto flags = out.flags(); // not available in message facility streams
      out << info.function();
      auto offset = info.offset;
      if (offset && options.has(opt::offset)) {
        out << " [";
        if (offset > 0) out << '+';
        else {
          out << '-';
          offset = -offset;
        }
        out << std::showbase << std::hex << offset << "]";
      } // if has offset
    //  out << std::ios::setiosflags(flags);
      if (!info.libraryName.empty() && options.has(opt::library)) {
        out << " in "
          << (options.has(opt::shortLibrary)? info.shortLibrary(): info.libraryName);
      }
    }
    if (info.address && options.has(opt::address))
       out << " at " << ((void*) info.address);
    out << std::flush;
  } // CallInfoPrinter::print()

void lar::debug::CallInfoPrinter::setDefaultOptions ( )

inline

Sets this object to use a set of default options.

Definition at line 178 of file DebugUtils.h.

{ options = defaultOptions(); }

void lar::debug::CallInfoPrinter::setOptions ( opt  opts )

inline

Override all the options.

Definition at line 166 of file DebugUtils.h.

{ options = opts; }

Member Data Documentation

opt lar::debug::CallInfoPrinter::options

Set of current options.

Definition at line 157 of file DebugUtils.h.

---

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

• larcorealg/larcorealg/CoreUtils/DebugUtils.h