#include "PrintAllowedConfiguration.h"

Inheritance diagram for fhicl::detail::PrintAllowedConfiguration:

Public Member Functions
	PrintAllowedConfiguration (std::ostream &os, bool const showParents=false, std::string const &prefix=std::string(3, ' '), bool const stlf=false)

void	walk_over (tt::maybe_const_t< ParameterBase, C > &)

bool	do_before_action (tt::maybe_const_t< ParameterBase, C > &p)

void	do_after_action (tt::maybe_const_t< ParameterBase, C > &p)

void	do_enter_table (tt::maybe_const_t< TableBase, C > &t)

void	do_exit_table (tt::maybe_const_t< TableBase, C > &t)

void	do_enter_sequence (tt::maybe_const_t< SequenceBase, C > &s)

void	do_exit_sequence (tt::maybe_const_t< SequenceBase, C > &s)

void	do_atom (tt::maybe_const_t< AtomBase, C > &a)

void	do_delegated_parameter (tt::maybe_const_t< DelegateBase, C > &dp)

Private Member Functions
bool	before_action (ParameterBase const &) override

void	after_action (ParameterBase const &) override

void	enter_table (TableBase const &) override

void	exit_table (TableBase const &) override

void	enter_sequence (SequenceBase const &) override

void	exit_sequence (SequenceBase const &) override

void	atom (AtomBase const &) override

void	delegated_parameter (DelegateBase const &) override

void	cacheTopLevelParameter (ParameterBase const &p)

void	maybeReleaseTopLevelParameter (ParameterBase const &p)

bool	suppressFormat (ParameterBase const &p)

Private Attributes
std::ostream &	buffer_

Indentation	indent_

bool	suppressTopLevelFormatting_

std::string	cachedTopLevelParameter_ {}

std::stack< MaybeDisplayParent >	mps_ {}

std::unordered_set< std::string >	keysWithCommas_ {}

std::unordered_set< std::string >	keysWithEllipses_ {}

bool	showParentsForFirstParam_

Detailed Description

Definition at line 18 of file PrintAllowedConfiguration.h.

Constructor & Destructor Documentation

PrintAllowedConfiguration::PrintAllowedConfiguration	(	std::ostream &	os,
		bool const	showParents = `false`,
		std::string const &	prefix = `std::string(3, ' ')`,
		bool const	stlf = `false`
	)

Definition at line 95 of file PrintAllowedConfiguration.cc.

References indent_, showParentsForFirstParam_, and suppressTopLevelFormatting_.

   : buffer_{os}
   , indent_{prefix}
   , suppressTopLevelFormatting_{stlf}
   , showParentsForFirstParam_{showParents}
 {}

Member Function Documentation

void PrintAllowedConfiguration::after_action ( ParameterBase const & p )

overrideprivate

Definition at line 157 of file PrintAllowedConfiguration.cc.

References fhicl::ATOM, buffer_, fhicl::detail::ParameterBase::has_default(), indent_, fhicl::detail::ParameterBase::is_conditional(), fhicl::detail::ParameterBase::is_optional(), fhicl::detail::ParameterBase::key(), maybeReleaseTopLevelParameter(), fhicl::detail::Indentation::modify_top(), mps_, fhicl::detail::ParameterBase::parameter_type(), and suppressFormat().

 {
   buffer_ << suffix(keysWithCommas_, keysWithEllipses_, p.key(), indent_());
 
   if (p.has_default() && p.parameter_type() == par_type::ATOM)
     buffer_ << "  # default";
 
   if (!suppressFormat(p)) {
     if (p.is_conditional()) {
       indent_.modify_top("└" + string_repeat(30, "─"));
       buffer_ << '\n' << indent_();
       indent_.modify_top(std::string(3, ' '));
     } else if (p.is_optional()) {
       indent_.modify_top(std::string(3, ' '));
     }
   }
 
   maybeReleaseTopLevelParameter(p);
   buffer_ << '\n' << mps_.top().closing_braces();
   mps_.pop();
 }

void PrintAllowedConfiguration::atom ( AtomBase const & a )

overrideprivate

Definition at line 242 of file PrintAllowedConfiguration.cc.

References buffer_, indent_, and fhicl::detail::AtomBase::stringified_value().

 {
   buffer_ << maybeName{a, indent_()} << a.stringified_value();
 }

bool PrintAllowedConfiguration::before_action ( ParameterBase const & p )

overrideprivate

Definition at line 106 of file PrintAllowedConfiguration.cc.

References buffer_, cacheTopLevelParameter(), fhicl::detail::ParameterBase::comment(), indent_, fhicl::detail::ParameterBase::is_conditional(), fhicl::detail::ParameterBase::is_optional(), fhicl::detail::is_sequence_element(), fhicl::detail::ParameterBase::key(), fhicl::detail::Indentation::modify_top(), mps_, showParentsForFirstParam_, fhicl::detail::Indentation::size(), suppressFormat(), and suppressTopLevelFormatting_.

 {
 
   if (suppressTopLevelFormatting_)
     cacheTopLevelParameter(p);
 
   if (!suppressFormat(p)) {
 
     if (p.is_conditional()) {
       buffer_ << '\n';
       indent_.modify_top("┌" + string_repeat(30, "─"));
       buffer_ << non_whitespace(indent_(), indent_.size()) << '\n';
       indent_.modify_top("│  ");
     }
 
     if (!p.comment().empty()) {
       if (!p.is_conditional())
         buffer_ << non_whitespace(indent_(), indent_.size()) << '\n';
       for (auto const& line : cet::split_by_regex(p.comment(), "\n"))
         buffer_ << indent_() << "## " << line << '\n';
     }
   }
 
   if (!is_sequence_element(p.key())) {
     buffer_ << non_whitespace(indent_(), indent_.size()) << '\n';
 
     // In general, optional parameters cannot be template arguments to
     // sequences.  However, the implementation for 'TupleAs' uses
     // OptionalTuple<...> as the holding type of the sequence
     // elements.  In the case where we have Sequence< TupleAs<> >, the
     // TupleAs entries will be prefaced with '#', and we don't want
     // that.  Therefore, we modify the top indentation fragment only
     // if the parameter is not a sequence element.
 
     if (p.is_optional()) {
       if (p.is_conditional())
         indent_.modify_top("│# ");
       else
         indent_.modify_top(" # ");
     }
   }
 
   mps_.emplace(p, showParentsForFirstParam_, indent_);
   showParentsForFirstParam_ = false;
 
   buffer_ << mps_.top().parent_names();
 
   return true;
 }

void fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter ( ParameterBase const & p )

inlineprivate

Definition at line 50 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

Referenced by before_action().

       {
         if (cachedTopLevelParameter_ == "")
           cachedTopLevelParameter_ = p.key();
       }

void PrintAllowedConfiguration::delegated_parameter ( DelegateBase const & dp )

overrideprivate

Definition at line 250 of file PrintAllowedConfiguration.cc.

References buffer_, and indent_.

 {
   buffer_ << maybeName{dp, indent_()} << "<< delegated >>";
 }

void fhicl::detail::ParameterWalker< C >::do_after_action ( tt::maybe_const_t< ParameterBase, C > & p )

inlineinherited

Definition at line 98 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::after_action().

       {
         after_action(p);
       }

void fhicl::detail::ParameterWalker< C >::do_atom ( tt::maybe_const_t< AtomBase, C > & a )

inlineinherited

Definition at line 126 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::atom().

       {
         atom(a);
       }

bool fhicl::detail::ParameterWalker< C >::do_before_action ( tt::maybe_const_t< ParameterBase, C > & p )

inlineinherited

Definition at line 93 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::before_action().

       {
         return before_action(p);
       }

void fhicl::detail::ParameterWalker< C >::do_delegated_parameter ( tt::maybe_const_t< DelegateBase, C > & dp )

inlineinherited

Definition at line 132 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::atom(), fhicl::detail::ParameterWalker< C >::delegated_parameter(), fhicl::detail::ParameterWalker< C >::enter_sequence(), and fhicl::detail::ParameterWalker< C >::enter_table().

       {
         delegated_parameter(dp);
       }

void fhicl::detail::ParameterWalker< C >::do_enter_sequence ( tt::maybe_const_t< SequenceBase, C > & s )

inlineinherited

Definition at line 115 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::enter_sequence().

       {
         enter_sequence(s);
       }

void fhicl::detail::ParameterWalker< C >::do_enter_table ( tt::maybe_const_t< TableBase, C > & t )

inlineinherited

Definition at line 104 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::enter_table().

       {
         enter_table(t);
       }

void fhicl::detail::ParameterWalker< C >::do_exit_sequence ( tt::maybe_const_t< SequenceBase, C > & s )

inlineinherited

Definition at line 120 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::exit_sequence().

       {
         exit_sequence(s);
       }

void fhicl::detail::ParameterWalker< C >::do_exit_table ( tt::maybe_const_t< TableBase, C > & t )

inlineinherited

Definition at line 109 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::exit_table().

       {
         exit_table(t);
       }

void PrintAllowedConfiguration::enter_sequence ( SequenceBase const & s )

overrideprivate

Definition at line 198 of file PrintAllowedConfiguration.cc.

References buffer_, fhicl::detail::SequenceBase::empty(), fhicl::detail::ParameterBase::has_default(), indent_, fhicl::detail::ParameterBase::key(), fhicl::detail::ParameterBase::parameter_type(), fhicl::detail::Indentation::push(), s, fhicl::SEQ_VECTOR, fhicl::detail::SequenceBase::size(), and util::flags::to_string().

 {
   buffer_ << maybeName{s, indent_()} << "[\n";
 
   indent_.push();
 
   if (s.empty())
     return;
 
   // We want the printout to look like this for sequences with
   // defaults:
   //
   //   list1: [
   //     1,  # default
   //     2   # default
   //   ]
   //
   // And like this for vectors w/o defaults (has length 1):
   //
   //   list2: [
   //      <int>,
   //      ...
   //   ]
 
   if (s.has_default() || (s.parameter_type() != par_type::SEQ_VECTOR)) {
     for (std::size_t i{}; i != s.size() - 1; ++i)
       keysWithCommas_.emplace(s.key() + "[" + std::to_string(i) + "]");
     return;
   }
 
   keysWithCommas_.emplace(s.key() + "[0]");
   keysWithEllipses_.emplace(s.key() + "[0]");
 }

void PrintAllowedConfiguration::enter_table ( TableBase const & t )

overrideprivate

Definition at line 182 of file PrintAllowedConfiguration.cc.

References buffer_, indent_, and fhicl::detail::Indentation::push().

 {
   buffer_ << maybeName{t, indent_()} << "{\n";
   indent_.push();
 }

void PrintAllowedConfiguration::exit_sequence ( SequenceBase const & )

overrideprivate

Definition at line 233 of file PrintAllowedConfiguration.cc.

References buffer_, indent_, and fhicl::detail::Indentation::pop().

 {
   indent_.pop();
   buffer_ << indent_() << "]";
 }

void PrintAllowedConfiguration::exit_table ( TableBase const & )

overrideprivate

Definition at line 189 of file PrintAllowedConfiguration.cc.

References buffer_, indent_, and fhicl::detail::Indentation::pop().

 {
   indent_.pop();
   buffer_ << indent_() << "}";
 }

void fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter ( ParameterBase const & p )

inlineprivate

Definition at line 57 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

Referenced by after_action().

       {
         if (p.key() == cachedTopLevelParameter_)
           cachedTopLevelParameter_ = "";
       }

bool fhicl::detail::PrintAllowedConfiguration::suppressFormat ( ParameterBase const & p )

inlineprivate

Definition at line 64 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

Referenced by after_action(), and before_action().

       {
         return p.key() == cachedTopLevelParameter_;
       }

void fhicl::detail::ParameterWalker< C >::walk_over ( tt::maybe_const_t< ParameterBase, C > & )

inherited

Member Data Documentation

std::ostream& fhicl::detail::PrintAllowedConfiguration::buffer_

private

Definition at line 27 of file PrintAllowedConfiguration.h.

Referenced by after_action(), atom(), before_action(), delegated_parameter(), enter_sequence(), enter_table(), exit_sequence(), and exit_table().

std::string fhicl::detail::PrintAllowedConfiguration::cachedTopLevelParameter_ {}

private

Definition at line 30 of file PrintAllowedConfiguration.h.

Referenced by cacheTopLevelParameter(), maybeReleaseTopLevelParameter(), and suppressFormat().

Indentation fhicl::detail::PrintAllowedConfiguration::indent_

private

Definition at line 28 of file PrintAllowedConfiguration.h.

Referenced by after_action(), atom(), before_action(), delegated_parameter(), enter_sequence(), enter_table(), exit_sequence(), exit_table(), and PrintAllowedConfiguration().

std::unordered_set<std::string> fhicl::detail::PrintAllowedConfiguration::keysWithCommas_ {}

private

Definition at line 32 of file PrintAllowedConfiguration.h.

std::unordered_set<std::string> fhicl::detail::PrintAllowedConfiguration::keysWithEllipses_ {}

private

Definition at line 33 of file PrintAllowedConfiguration.h.

std::stack<MaybeDisplayParent> fhicl::detail::PrintAllowedConfiguration::mps_ {}

private

Definition at line 31 of file PrintAllowedConfiguration.h.

Referenced by after_action(), and before_action().

bool fhicl::detail::PrintAllowedConfiguration::showParentsForFirstParam_

private

Definition at line 34 of file PrintAllowedConfiguration.h.

Referenced by before_action(), and PrintAllowedConfiguration().

bool fhicl::detail::PrintAllowedConfiguration::suppressTopLevelFormatting_

private

Definition at line 29 of file PrintAllowedConfiguration.h.

Referenced by before_action(), and PrintAllowedConfiguration().

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

fhiclcpp/types/detail/PrintAllowedConfiguration.h
fhiclcpp/types/detail/PrintAllowedConfiguration.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation