gar::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 130 of file DebugUtils.h.

Constructor & Destructor Documentation

gar::debug::CallInfoPrinter::CallInfoPrinter ( )

inline

Default constructor: use default options.

Definition at line 158 of file DebugUtils.h.

{ setDefaultOptions(); }

gar::debug::CallInfoPrinter::CallInfoPrinter ( opt  opts )

inline

Constructor: use specified options.

Definition at line 161 of file DebugUtils.h.

: options(opts) {}

Member Function Documentation

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

inlinestatic

Returns a set of default options.

Definition at line 215 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 gar::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 208 of file DebugUtils.h.

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

template<typename Stream >

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

inline

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

Definition at line 168 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;
      } // print()

void gar::debug::CallInfoPrinter::setDefaultOptions ( )

inline

Sets this object to use a set of default options.

Definition at line 212 of file DebugUtils.h.

{ options = defaultOptions(); }

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

inline

Override all the options.

Definition at line 164 of file DebugUtils.h.

{ options = opts; }

Member Data Documentation

opt gar::debug::CallInfoPrinter::options

set of current options

Definition at line 155 of file DebugUtils.h.

---

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

• garsoft/CoreUtils/DebugUtils.h