#include "Prettifier.h"

Inheritance diagram for fhicl::detail::Prettifier:

Public Types
using	key_t = std::string

using	any_t = std::any

Public Member Functions
	Prettifier (unsigned initial_indent_level=0)

std::string	result () const

void	do_enter_table (key_t const &k, any_t const &a)

void	do_enter_sequence (key_t const &k, any_t const &a)

void	do_atom (key_t const &k, any_t const &a)

void	do_before_action (key_t const &k, any_t const &a, ParameterSet const *ps)

void	do_after_action (key_t const &k)

void	do_exit_table (key_t const &k, any_t const &a)

void	do_exit_sequence (key_t const &k, any_t const &a)

Private Member Functions
void	enter_table (key_t const &, any_t const &) override

void	enter_sequence (key_t const &, any_t const &) override

void	exit_table (key_t const &, any_t const &) override

void	exit_sequence (key_t const &, any_t const &) override

void	atom (key_t const &, any_t const &) override

void	before_action (key_t const &, any_t const &, ParameterSet const *) override

void	push_size_ (any_t const &)

void	pop_size_ ()

std::string	maybe_indent_ (std::size_t)

std::string	maybe_nl_ (std::size_t)

Private Attributes
std::ostringstream	buffer_ {}

Indentation	indent_

std::stack< std::size_t >	sequence_sizes_

std::size_t	seq_size_

std::size_t	table_size_

Detailed Description

Definition at line 86 of file Prettifier.h.

Member Typedef Documentation

using fhicl::ParameterSetWalker::any_t = std::any

inherited

Definition at line 79 of file ParameterSetWalker.h.

using fhicl::ParameterSetWalker::key_t = std::string

inherited

Definition at line 78 of file ParameterSetWalker.h.

Constructor & Destructor Documentation

Prettifier::Prettifier ( unsigned initial_indent_level = 0 )

Definition at line 18 of file Prettifier.cc.

References seq_size_, sequence_sizes_, and table_size_.

   : indent_{initial_indent_level}
   , sequence_sizes_{{size_t_max}}
   , seq_size_{sequence_sizes_.top()}
   , table_size_{0u}
 {}

Member Function Documentation

void Prettifier::atom	(	key_t const &	key,
		any_t const &	a
	)

overrideprivatevirtual

Implements fhicl::ParameterSetWalker.

Definition at line 85 of file Prettifier.cc.

References buffer_, indent_, fhicl::detail::nl(), fhicl::detail::atom::printed_prefix(), fhicl::detail::printed_suffix(), seq_size_, and fhicl::detail::atom::value().

Referenced by result().

 {
   buffer_ << indent_() << atom::printed_prefix(key) << atom::value(a)
           << printed_suffix(key, seq_size_) << nl();
 }

void Prettifier::before_action	(	key_t const &	key,
		any_t const &	a,
		ParameterSet const *	ps
	)

overrideprivatevirtual

Reimplemented from fhicl::ParameterSetWalker.

Definition at line 27 of file Prettifier.cc.

References fhicl::ParameterSet::get(), fhicl::detail::is_table(), and table_size_.

Referenced by result().

 {
   if (!is_table(a))
     return;
   table_size_ = ps->get<fhicl::ParameterSet>(key).get_all_keys().size();
 }

void fhicl::ParameterSetWalker::do_after_action ( key_t const & k )

inlineinherited

Definition at line 103 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::after_action().

Referenced by fhicl::ParameterSet::walk().

     {
       after_action(k);
     }

void fhicl::ParameterSetWalker::do_atom	(	key_t const &	k,
		any_t const &	a
	)

inlineinherited

Definition at line 92 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::atom().

Referenced by fhicl::ParameterSet::walk().

     {
       atom(k, a);
     }

void fhicl::ParameterSetWalker::do_before_action	(	key_t const &	k,
		any_t const &	a,
		ParameterSet const *	ps
	)

inlineinherited

Definition at line 98 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::before_action().

Referenced by fhicl::ParameterSet::walk().

     {
       before_action(k, a, ps);
     }

void fhicl::ParameterSetWalker::do_enter_sequence	(	key_t const &	k,
		any_t const &	a
	)

inlineinherited

Definition at line 87 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::enter_sequence().

Referenced by fhicl::ParameterSet::walk().

     {
       enter_sequence(k, a);
     }

void fhicl::ParameterSetWalker::do_enter_table	(	key_t const &	k,
		any_t const &	a
	)

inlineinherited

Definition at line 82 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::enter_table().

Referenced by fhicl::ParameterSet::walk().

     {
       enter_table(k, a);
     }

void fhicl::ParameterSetWalker::do_exit_sequence	(	key_t const &	k,
		any_t const &	a
	)

inlineinherited

Definition at line 114 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::atom(), fhicl::ParameterSetWalker::enter_sequence(), fhicl::ParameterSetWalker::enter_table(), and fhicl::ParameterSetWalker::exit_sequence().

Referenced by fhicl::ParameterSet::walk().

     {
       exit_sequence(k, a);
     }

void fhicl::ParameterSetWalker::do_exit_table	(	key_t const &	k,
		any_t const &	a
	)

inlineinherited

Definition at line 109 of file ParameterSetWalker.h.

References fhicl::ParameterSetWalker::exit_table().

Referenced by fhicl::ParameterSet::walk().

     {
       exit_table(k, a);
     }

void Prettifier::enter_sequence	(	key_t const &	key,
		any_t const &	a
	)

overrideprivatevirtual

Implements fhicl::ParameterSetWalker.

Definition at line 56 of file Prettifier.cc.

References buffer_, indent_, maybe_nl_(), fhicl::detail::sequence::printed_prefix(), fhicl::detail::Indentation::push(), push_size_(), and seq_size_.

Referenced by result().

 {
   push_size_(a);
   buffer_ << indent_() << sequence::printed_prefix(key) << maybe_nl_(seq_size_);
   indent_.push();
 }

void Prettifier::enter_table	(	key_t const &	key,
		any_t const &
	)

overrideprivatevirtual

Implements fhicl::ParameterSetWalker.

Definition at line 39 of file Prettifier.cc.

References buffer_, indent_, maybe_nl_(), fhicl::detail::table::printed_prefix(), fhicl::detail::Indentation::push(), and table_size_.

Referenced by result().

 {
   buffer_ << indent_() << table::printed_prefix(key) << maybe_nl_(table_size_);
   indent_.push();
 }

void Prettifier::exit_sequence	(	key_t const &	key,
		any_t const &
	)

overrideprivatevirtual

Reimplemented from fhicl::ParameterSetWalker.

Definition at line 64 of file Prettifier.cc.

References buffer_, fhicl::detail::sequence::closing_brace(), indent_, maybe_indent_(), fhicl::detail::nl(), fhicl::detail::Indentation::pop(), pop_size_(), fhicl::detail::printed_suffix(), and seq_size_.

Referenced by result().

 {
   // FIXME: To support a printout like:
   //
   //   empty: []
   //
   // We need to first capture the size of the sequence (0) before we
   // call pop_size_().  However, for non-empty sequences (I think...)
   // pop_size_ needs to be called before we determine if an
   // indentation should take place.  This needs to be cleaned up.
   bool const empty_sequence = seq_size_ == 0;
   indent_.pop();
   pop_size_();
   buffer_ << (empty_sequence ? "" : maybe_indent_(seq_size_))
           << sequence::closing_brace() << printed_suffix(key, seq_size_)
           << nl();
 }

void Prettifier::exit_table	(	key_t const &	key,
		any_t const &
	)

overrideprivatevirtual

Reimplemented from fhicl::ParameterSetWalker.

Definition at line 46 of file Prettifier.cc.

References buffer_, fhicl::detail::table::closing_brace(), indent_, maybe_indent_(), fhicl::detail::nl(), fhicl::detail::Indentation::pop(), fhicl::detail::printed_suffix(), seq_size_, and table_size_.

Referenced by result().

 {
   indent_.pop();
   buffer_ << maybe_indent_(table_size_) << table::closing_brace()
           << printed_suffix(key, seq_size_) << nl();
 }

std::string Prettifier::maybe_indent_ ( std::size_t sz )

private

Definition at line 108 of file Prettifier.cc.

References indent_.

Referenced by exit_sequence(), exit_table(), and result().

 {
   return sz ? indent_() : "";
 }

std::string Prettifier::maybe_nl_ ( std::size_t sz )

private

Definition at line 114 of file Prettifier.cc.

References fhicl::detail::nl().

Referenced by enter_sequence(), enter_table(), and result().

 {
   return sz ? nl() : "";
 }

void Prettifier::pop_size_ ( )

private

Definition at line 101 of file Prettifier.cc.

References seq_size_, and sequence_sizes_.

Referenced by exit_sequence(), and result().

 {
   sequence_sizes_.pop();
   seq_size_ = sequence_sizes_.top();
 }

void Prettifier::push_size_ ( any_t const & a )

private

Definition at line 94 of file Prettifier.cc.

References seq_size_, sequence_sizes_, and util::size().

Referenced by enter_sequence(), and result().

 {
   sequence_sizes_.emplace(std::any_cast<ps_sequence_t>(a).size());
   seq_size_ = sequence_sizes_.top();
 }

std::string fhicl::detail::Prettifier::result ( ) const

inline

Definition at line 91 of file Prettifier.h.

References atom(), before_action(), buffer_, enter_sequence(), enter_table(), exit_sequence(), exit_table(), maybe_indent_(), maybe_nl_(), pop_size_(), and push_size_().

     {
       return buffer_.str();
     }

Member Data Documentation

std::ostringstream fhicl::detail::Prettifier::buffer_ {}

private

Definition at line 114 of file Prettifier.h.

Referenced by atom(), enter_sequence(), enter_table(), exit_sequence(), exit_table(), and result().

Indentation fhicl::detail::Prettifier::indent_

private

Definition at line 115 of file Prettifier.h.

Referenced by atom(), enter_sequence(), enter_table(), exit_sequence(), exit_table(), and maybe_indent_().

std::size_t fhicl::detail::Prettifier::seq_size_

private

Definition at line 117 of file Prettifier.h.

Referenced by atom(), enter_sequence(), exit_sequence(), exit_table(), pop_size_(), Prettifier(), and push_size_().

std::stack<std::size_t> fhicl::detail::Prettifier::sequence_sizes_

private

Definition at line 116 of file Prettifier.h.

Referenced by pop_size_(), Prettifier(), and push_size_().

std::size_t fhicl::detail::Prettifier::table_size_

private

Definition at line 118 of file Prettifier.h.

Referenced by before_action(), enter_table(), exit_table(), and Prettifier().

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

fhiclcpp/detail/Prettifier.h
fhiclcpp/detail/Prettifier.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation