fhicl::NameStackRegistry Class Reference

#include "NameStackRegistry.h"

Static Public Member Functions
static std::string	full_key (std::string const &key)
static void	end_of_ctor ()
static void	clear ()
static bool	empty ()
static std::string	current ()

Static Private Member Functions
static NameStackRegistry &	instance_ ()

Private Attributes
std::vector< std::string >	names_ {}

Detailed Description

Definition at line 43 of file NameStackRegistry.h.

Member Function Documentation

void fhicl::NameStackRegistry::clear ( )

static

Definition at line 37 of file NameStackRegistry.cc.

References instance_(), and names_.

Referenced by fhicl::detail::TableBase::validate().

  {
    instance_().names_.clear();
  }

std::string fhicl::NameStackRegistry::current ( )

static

Definition at line 49 of file NameStackRegistry.cc.

References instance_(), and names_.

Referenced by fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), and fhicl::Sequence< T,-1ull >::do_prepare_elements_for_validation().

  {
    return instance_().names_.back();
  }

bool fhicl::NameStackRegistry::empty ( )

static

Definition at line 43 of file NameStackRegistry.cc.

References instance_(), and names_.

Referenced by fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), and fhicl::Sequence< T,-1ull >::do_prepare_elements_for_validation().

  {
    return instance_().names_.empty();
  }

void fhicl::NameStackRegistry::end_of_ctor ( )

static

Definition at line 31 of file NameStackRegistry.cc.

References instance_(), and names_.

Referenced by fhicl::Atom< T >::Atom(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalAtom< T >::OptionalAtom(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalSequence< T, N >::OptionalSequence(), fhicl::OptionalSequence< T,-1ull >::OptionalSequence(), fhicl::OptionalTable< T >::OptionalTable(), fhicl::OptionalTuple< T >::OptionalTuple(), fhicl::Sequence< T, N >::Sequence(), fhicl::Sequence< T,-1ull >::Sequence(), fhicl::Table< T, KeysToIgnore >::Table(), and fhicl::Tuple< T >::Tuple().

  {
    instance_().names_.pop_back();
  }

std::string fhicl::NameStackRegistry::full_key ( std::string const &  key )

static

Definition at line 14 of file NameStackRegistry.cc.

References instance_(), names_, and fhicl::other.

Referenced by fhicl::detail::ParameterMetadata::ParameterMetadata().

  {
    if (name.empty()) {
      throw exception{error::other, "NameStackRegistry::full_key"}
        << "Cannot insert empty name into 'NameStackRegistry'.\n";
    }

    auto& names = instance_().names_;
    if (names.empty() || std::regex_match(name, re_sequence_element)) {
      names.emplace_back(name);
    } else {
      names.emplace_back("." + name);
    }
    return std::accumulate(names.begin(), names.end(), std::string{});
  }

NameStackRegistry & fhicl::NameStackRegistry::instance_ ( )

staticprivate

Definition at line 55 of file NameStackRegistry.cc.

References fhicl::detail::per_thread_holder< T >::slot_for_current_thread().

Referenced by clear(), current(), empty(), end_of_ctor(), and full_key().

  {
    // The use of the registry is restricted to the construction of
    // fhiclcpp types.  As construction happens on only one thread,
    // it is sufficient for each thread to have its own copy.
    // Although a thread-local static would be appropriate here, not
    // all implementations adequately support thread-local variables
    // for the use case here.  We thus use a custom-built per-thread
    // cache.
    static detail::per_thread_holder<NameStackRegistry> registry;
    return registry.slot_for_current_thread();
  }

Member Data Documentation

std::vector<std::string> fhicl::NameStackRegistry::names_ {}

private

Definition at line 53 of file NameStackRegistry.h.

Referenced by clear(), current(), empty(), end_of_ctor(), and full_key().

---

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

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