dump::DumperBase Class Reference

Base class for data dumpers. More...

#include <DumperBase.h>

Inheritance diagram for dump::DumperBase:

Classes
struct	IndentSettings

Public Member Functions
	DumperBase ()
	Default constructor: no indentation. More...
template<typename Stream >
decltype(auto)	indenter (Stream &&out) const
	Returns an Indenter object tied to this dumper and out stream. More...

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{ {} } {}

Member Function Documentation

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(); }

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(); 
      }

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:

• DumperBase.h