fhicl::detail::MaybeDisplayParent Class Reference

#include "MaybeDisplayParent.h"

Public Member Functions
	MaybeDisplayParent (ParameterBase const &p, bool const showParents, Indentation &ind)
std::string const &	parent_names () const
std::string	closing_braces () const

Private Member Functions
std::vector< std::string >	get_parents (std::string const &k)
bool	is_sequence_element (ParameterBase const &p)

Private Attributes
bool	show_
std::string	fullPayload_ {}
std::vector< std::string >	names_
std::vector< std::string >	closingBraces_ {}
Indentation &	indent_

Detailed Description

Definition at line 19 of file MaybeDisplayParent.h.

Constructor & Destructor Documentation

fhicl::detail::MaybeDisplayParent::MaybeDisplayParent ( ParameterBase const &  p, bool const  showParents, Indentation &  ind  )

inline

Definition at line 21 of file MaybeDisplayParent.h.

References closingBraces_, e, fullPayload_, get_parents(), art::detail::indent(), indent_, names_, fhicl::detail::Indentation::push(), and show_.

        : show_{showParents}
        , names_{showParents ? get_parents(p.key()) :
                               std::vector<std::string>{}}
        , indent_{ind}
      {
        std::ostringstream os;

        if (show_) {

          for (auto it = names_.begin(), e = names_.end() - 1; it != e; ++it) {
            std::string const& name = *it;
            std::string const& next_name = *std::next(it);

            // We use the indent_ member so that we can properly
            // update the indentation level.  However, the literal
            // indented string should not include any characters in it
            // for the parents of the parameter in question.
            std::string const indent(indent_().size(), ' ');
            if (!std::isdigit(name[0])) {
              if (std::isdigit(next_name[0])) {
                os << indent << name << ": [  # index: " << next_name << '\n';
                closingBraces_.push_back(indent + "]\n");
              } else {
                os << indent << name << ": {\n";
                closingBraces_.push_back(indent + "}\n");
              }
            } else {
              if (!std::isdigit(next_name[0])) {
                os << indent << "{\n";
                closingBraces_.push_back(indent + "}\n");
              } else {
                os << indent << "[  # index: " << next_name << '\n';
                closingBraces_.push_back(indent + "]\n");
              }
            }
            indent_.push();
          }
        } else {
        }

        fullPayload_ = os.str();
      }

Member Function Documentation

std::string fhicl::detail::MaybeDisplayParent::closing_braces ( ) const

inline

Definition at line 74 of file MaybeDisplayParent.h.

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

      {
        if (!show_)
          return "";

        std::string result;
        for (auto it = closingBraces_.crbegin(), re = closingBraces_.crend();
             it != re;
             ++it) {
          result.append(*it);
          indent_.pop();
        }
        return result;
      }

std::vector< std::string > fhicl::detail::MaybeDisplayParent::get_parents ( std::string const &  k )

private

Definition at line 16 of file MaybeDisplayParent.cc.

Referenced by MaybeDisplayParent().

    {
      std::regex const r_index{"\\[(\\d+)\\]"};
      std::vector<std::string> parents;
      for (auto const& key : cet::split_by_regex(k, "\\."))
        for (auto const& token :
             cet::split_by_regex(std::regex_replace(key, r_index, ",$1"), ","))
          parents.push_back(token);

      // Skip first key, which is something like "<some_label>" in the context
      // whenever this function is called.
      return std::vector<std::string>(parents.begin() + 1, parents.end());
    }

bool fhicl::detail::MaybeDisplayParent::is_sequence_element ( ParameterBase const &  p )

inlineprivate

Definition at line 99 of file MaybeDisplayParent.h.

References fhicl::detail::ParameterBase::key().

      {
        auto pos = p.key().find_last_of("]");
        return pos != std::string::npos && pos == p.key().size() - 1;
      }

std::string const& fhicl::detail::MaybeDisplayParent::parent_names ( ) const

inline

Definition at line 68 of file MaybeDisplayParent.h.

References fullPayload_.

      {
        return fullPayload_;
      }

Member Data Documentation

std::vector<std::string> fhicl::detail::MaybeDisplayParent::closingBraces_ {}

private

Definition at line 93 of file MaybeDisplayParent.h.

Referenced by closing_braces(), and MaybeDisplayParent().

std::string fhicl::detail::MaybeDisplayParent::fullPayload_ {}

private

Definition at line 91 of file MaybeDisplayParent.h.

Referenced by MaybeDisplayParent(), and parent_names().

Indentation& fhicl::detail::MaybeDisplayParent::indent_

private

Definition at line 94 of file MaybeDisplayParent.h.

Referenced by closing_braces(), and MaybeDisplayParent().

std::vector<std::string> fhicl::detail::MaybeDisplayParent::names_

private

Definition at line 92 of file MaybeDisplayParent.h.

Referenced by MaybeDisplayParent().

bool fhicl::detail::MaybeDisplayParent::show_

private

Definition at line 90 of file MaybeDisplayParent.h.

Referenced by closing_braces(), and MaybeDisplayParent().

---

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

• fhiclcpp/types/detail/MaybeDisplayParent.h
• fhiclcpp/types/detail/MaybeDisplayParent.cc