#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)

Public Member Functions inherited from fhicl::detail::ParameterWalker< tt::const_flavor::require_const >
	ParameterWalker ()=default

virtual	~ParameterWalker ()=default

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 15 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 97 of file PrintAllowedConfiguration.cc.

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

Member Function Documentation

void PrintAllowedConfiguration::after_action ( ParameterBase const & p )

overrideprivate

Definition at line 159 of file PrintAllowedConfiguration.cc.

 {
   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 244 of file PrintAllowedConfiguration.cc.

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

bool PrintAllowedConfiguration::before_action ( ParameterBase const & p )

overrideprivate

Definition at line 108 of file PrintAllowedConfiguration.cc.

 {
 
   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(), reNewLine))
         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 47 of file PrintAllowedConfiguration.h.

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

void PrintAllowedConfiguration::delegated_parameter ( DelegateBase const & dp )

overrideprivate

Definition at line 252 of file PrintAllowedConfiguration.cc.

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

void PrintAllowedConfiguration::enter_sequence ( SequenceBase const & s )

overrideprivate

Definition at line 200 of file PrintAllowedConfiguration.cc.

 {
   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 184 of file PrintAllowedConfiguration.cc.

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

void PrintAllowedConfiguration::exit_sequence ( SequenceBase const & )

overrideprivate

Definition at line 235 of file PrintAllowedConfiguration.cc.

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

void PrintAllowedConfiguration::exit_table ( TableBase const & )

overrideprivate

Definition at line 191 of file PrintAllowedConfiguration.cc.

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

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

inlineprivate

Definition at line 54 of file PrintAllowedConfiguration.h.

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

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

inlineprivate

Definition at line 61 of file PrintAllowedConfiguration.h.

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

Member Data Documentation

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

private

Definition at line 24 of file PrintAllowedConfiguration.h.

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

private

Definition at line 27 of file PrintAllowedConfiguration.h.

Indentation fhicl::detail::PrintAllowedConfiguration::indent_

private

Definition at line 25 of file PrintAllowedConfiguration.h.

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

private

Definition at line 29 of file PrintAllowedConfiguration.h.

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

private

Definition at line 30 of file PrintAllowedConfiguration.h.

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

private

Definition at line 28 of file PrintAllowedConfiguration.h.

bool fhicl::detail::PrintAllowedConfiguration::showParentsForFirstParam_

private

Definition at line 31 of file PrintAllowedConfiguration.h.

bool fhicl::detail::PrintAllowedConfiguration::suppressTopLevelFormatting_

private

Definition at line 26 of file PrintAllowedConfiguration.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation