dump::DumperBase Class Reference

Base class for data dumpers. More...

#include <DumperBase.h>

Inheritance diagram for dump::DumperBase:

Classes
class	Indenter
	Helper class to keep track of indenting. More...
struct	IndentSettings

Public Member Functions
	DumperBase ()
	Default constructor: no indentation. More...
	DumperBase (std::string const &indent, std::string const &firstIndent)
	Constructor: sets indentation. More...
	DumperBase (std::string const &indent)
	Constructor: sets indentation. More...
template<typename Stream >
decltype(auto)	indenter (Stream &&out) const
	Returns an Indenter object tied to this dumper and out stream. More...
Indentation.
Indentation strings are expected to be written by the dumping algorithms at the beginning of each output line to ensure the proper alignment of the dump. The indent() string should be written at the beginning of every new output line, with the exception of the first one, for which firstIndent() should be written instead. Note that this infrastructure only keeps track of the strings needed to indent the output, but it does not provide any tool to apply the indentation.
std::string const &	indent () const
	Returns the indentation string currently configured for all lines. More...
std::string const &	firstIndent () const
	Returns the indentation string currently configured for the first line. More...
void	setIndent (std::string const &indent, std::string const &firstIndent)
	Sets indentation strings to the specified values. More...
void	setIndent (std::string const &indent)
	Sets both indentation strings to the same specified value. More...
template<typename Stream >
Stream &	indented (Stream &&out, bool first=false) const
	Writes the indentation into a stream, and returns it for further output. More...
template<typename Stream >
Stream &	firstIndented (Stream &&out) const
template<typename Stream >
Stream &	newline (Stream &&out) const

Protected Member Functions
IndentSettings &	indentSettings ()
IndentSettings const &	indentSettings () const
IndentSettings &	saveIndentSettings ()
	Stacks a copy of the current settings, and returns the "new" ones. More...
IndentSettings &	restoreIndentSettings ()
	Restores and returns the last saved settings. More...

Private Attributes
std::vector< IndentSettings >	fIndentSettings
	All indentation settings. More...

Detailed Description

Base class for data dumpers.

This class provides some basic and common infrastructure:

• managing of indentation strings

Definition at line 39 of file DumperBase.h.

Constructor & Destructor Documentation

dump::DumperBase::DumperBase ( )

inline

Default constructor: no indentation.

Definition at line 61 of file DumperBase.h.

: fIndentSettings{ {} } {}

dump::DumperBase::DumperBase ( std::string const &  indent, std::string const &  firstIndent  )

inline

Constructor: sets indentation.

Parameters

indent	indentation for all lines except the first one (see indent())
firstIndent	indentation for the first line (see firstIndent())

Definition at line 69 of file DumperBase.h.

      : fIndentSettings{ { indent, firstIndent } }
      {}

dump::DumperBase::DumperBase ( std::string const &  indent )

inline

Constructor: sets indentation.

Parameters

indent

indentation for all lines

Definition at line 77 of file DumperBase.h.

: DumperBase(indent, indent) {}

Member Function Documentation

std::string const& dump::DumperBase::firstIndent ( ) const

inline

Returns the indentation string currently configured for the first line.

Definition at line 99 of file DumperBase.h.

      { return indentSettings().firstIndent; }

template<typename Stream >

Stream& dump::DumperBase::firstIndented ( Stream &&  out ) const

inline

Writes first line indentation into a stream, and returns it for further output.

Definition at line 118 of file DumperBase.h.

      { return indented(std::forward<Stream>(out), true); }

std::string const& dump::DumperBase::indent ( ) const

inline

Returns the indentation string currently configured for all lines.

Definition at line 96 of file DumperBase.h.

{ return indentSettings().indent; }

template<typename Stream >

Stream& dump::DumperBase::indented ( Stream &&  out, bool  first = false  ) const

inline

Writes the indentation into a stream, and returns it for further output.

Definition at line 112 of file DumperBase.h.

      { out << (first? firstIndent(): indent()); return out; }

template<typename Stream >

decltype(auto) dump::DumperBase::indenter ( Stream &&  out ) const

inline

Returns an Indenter object tied to this dumper and out stream.

Definition at line 202 of file DumperBase.h.

      { return Indenter<Stream>(std::forward<Stream>(out), *this); }

IndentSettings& dump::DumperBase::indentSettings ( )

inlineprotected

Definition at line 207 of file DumperBase.h.

{ return fIndentSettings.back(); }

IndentSettings const& dump::DumperBase::indentSettings ( ) const

inlineprotected

Definition at line 208 of file DumperBase.h.

      { return fIndentSettings.back(); }

template<typename Stream >

Stream& dump::DumperBase::newline ( Stream &&  out ) const

inline

Initiates a new output line, including indentation, and returns the stream for further output.

Definition at line 124 of file DumperBase.h.

      { return indented(std::forward<Stream>(out)); }

IndentSettings& dump::DumperBase::restoreIndentSettings ( )

inlineprotected

Restores and returns the last saved settings.

Definition at line 220 of file DumperBase.h.

      {
        if (fIndentSettings.size() > 1U) fIndentSettings.pop_back();
        assert(!fIndentSettings.empty());
        return indentSettings(); 
      }

IndentSettings& dump::DumperBase::saveIndentSettings ( )

inlineprotected

Stacks a copy of the current settings, and returns the "new" ones.

Definition at line 212 of file DumperBase.h.

      {
        auto oldSettings = indentSettings();
        fIndentSettings.push_back(std::move(oldSettings));
        return indentSettings(); 
      }

void dump::DumperBase::setIndent ( std::string const &  indent, std::string const &  firstIndent  )

inline

Sets indentation strings to the specified values.

Definition at line 103 of file DumperBase.h.

      { indentSettings() = { indent, firstIndent }; }

void dump::DumperBase::setIndent ( std::string const &  indent )

inline

Sets both indentation strings to the same specified value.

Definition at line 107 of file DumperBase.h.

{ setIndent(indent, indent); }

Member Data Documentation

std::vector<IndentSettings> dump::DumperBase::fIndentSettings

private

All indentation settings.

Definition at line 56 of file DumperBase.h.

---

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

• lardataalg/lardataalg/Dumpers/DumperBase.h