fhicl::extended_value Class Reference

#include "extended_value.h"

Public Types
using	atom_t = std::string
using	complex_t = std::pair< std::string, std::string >
using	sequence_t = std::vector< extended_value >
using	table_t = shims::map< std::string, extended_value >

Public Member Functions
	extended_value ()
	~extended_value ()
	extended_value (bool const in_prolog, value_tag const tag, std::any const value, Protection const protection, std::string src={})
	extended_value (bool const in_prolog, value_tag const tag, std::any const value, std::string src={})
bool	is_a (value_tag const t) const noexcept
std::string	to_string () const
void	set_prolog (bool new_prolog_state)
void	set_src_info (std::string const &src)
void	reset_protection ()
std::string	pretty_src_info () const
	operator atom_t () const
	operator complex_t () const
	operator sequence_t () const
	operator table_t () const

Public Attributes
bool	in_prolog {false}
value_tag	tag {UNKNOWN}
std::any	value {}
std::string	src_info {}
Protection	protection {Protection::NONE}

Detailed Description

Definition at line 37 of file extended_value.h.

Member Typedef Documentation

using fhicl::extended_value::atom_t = std::string

Definition at line 39 of file extended_value.h.

using fhicl::extended_value::complex_t = std::pair<std::string, std::string>

Definition at line 40 of file extended_value.h.

using fhicl::extended_value::sequence_t = std::vector<extended_value>

Definition at line 41 of file extended_value.h.

using fhicl::extended_value::table_t = shims::map<std::string, extended_value>

Definition at line 42 of file extended_value.h.

Constructor & Destructor Documentation

fhicl::extended_value::extended_value ( )

default

fhicl::extended_value::~extended_value ( )

default

fhicl::extended_value::extended_value ( bool const  in_prolog, value_tag const  tag, std::any const  value, Protection const  protection, std::string  src = {}  )

inline

Definition at line 47 of file extended_value.h.

References src_info.

                                 {})
    : in_prolog{in_prolog}
    , tag{tag}
    , value{value}
    , src_info{std::move(src)}
    , protection{protection}
  {}

fhicl::extended_value::extended_value ( bool const  in_prolog, value_tag const  tag, std::any const  value, std::string  src = {}  )

inline

Definition at line 59 of file extended_value.h.

References src_info.

                                 {})
    : in_prolog{in_prolog}, tag{tag}, value{value}, src_info{std::move(src)}
  {}

Member Function Documentation

bool fhicl::extended_value::is_a ( value_tag const  t ) const

inlinenoexcept

Definition at line 67 of file extended_value.h.

References set_prolog(), tag, and to_string().

Referenced by fhicl::detail::decode(), fhicl::detail::encode(), fhicl::intermediate_table::exists(), fhicl::intermediate_table::find(), fhicl::intermediate_table::locate_(), and fhicl::ParameterSet::make().

  {
    return t == tag;
  }

fhicl::extended_value::operator atom_t ( ) const

inline

Definition at line 91 of file extended_value.h.

References value.

{ return std::any_cast<atom_t>(value); }

fhicl::extended_value::operator complex_t ( ) const

inline

Definition at line 92 of file extended_value.h.

References value.

{ return std::any_cast<complex_t>(value); }

fhicl::extended_value::operator sequence_t ( ) const

inline

Definition at line 93 of file extended_value.h.

References value.

{ return std::any_cast<sequence_t>(value); }

fhicl::extended_value::operator table_t ( ) const

inline

Definition at line 94 of file extended_value.h.

References value.

{ return std::any_cast<table_t>(value); }

std::string fhicl::extended_value::pretty_src_info

(

)

const

Definition at line 120 of file extended_value.cc.

References src_info.

Referenced by fhicl::intermediate_table::locate_(), and reset_protection().

{
  std::string result;
  static std::regex const splitRE("(.*):([0-9-]*)");
  std::smatch m;
  if (std::regex_match(src_info, m, splitRE)) {
    result =
      std::string("line ") + m[2].str() + " of file \"" + m[1].str() + '"';
  } else {
    result = "<unknown>";
  }
  return result;
}

void fhicl::extended_value::reset_protection ( )

inline

Definition at line 83 of file extended_value.h.

References fhicl::NONE, and pretty_src_info().

  {
    // See notes below.
    protection = Protection::NONE;
  }

void fhicl::extended_value::set_prolog

(

bool

new_prolog_state

)

Definition at line 79 of file extended_value.cc.

References fhicl::BOOL, fhicl::COMPLEX, e, in_prolog, fhicl::NIL, fhicl::NUMBER, fhicl::SEQUENCE, fhicl::STRING, fhicl::TABLE, fhicl::TABLEID, tag, fhicl::UNKNOWN, and value.

Referenced by is_a(), and fhicl::intermediate_table::locate_().

{
  in_prolog = new_prolog_state;

  switch (tag) {

  case NIL:
  case BOOL:
  case NUMBER:
  case STRING:
  case COMPLEX:
  case TABLEID: {
    break;
  }

  case SEQUENCE: {
    auto& q = any_cast<sequence_t&>(value);
    for (auto& e : q) {
      e.set_prolog(new_prolog_state);
    }
    break;
  }

  case TABLE: {
    auto& t = any_cast<table_t&>(value);
    for (auto& pr : t) {
      pr.second.set_prolog(new_prolog_state);
    }
    break;
  }

  case UNKNOWN:
  default: {
    break;
  }

  }; // switch

} // set_prolog()

void fhicl::extended_value::set_src_info ( std::string const &  src )

inline

Definition at line 77 of file extended_value.h.

References src_info.

  {
    src_info = src;
  }

std::string fhicl::extended_value::to_string

(

)

const

Definition at line 22 of file extended_value.cc.

References fhicl::BOOL, fhicl::COMPLEX, in_prolog, shims::isSnippetMode(), fhicl::NIL, fhicl::NUMBER, fhicl::SEQUENCE, fhicl::STRING, fhicl::TABLE, fhicl::TABLEID, tag, fhicl::UNKNOWN, and value.

Referenced by is_a().

{
  if (in_prolog && !shims::isSnippetMode())
    return "";

  switch (tag) {

  case NIL:
  case BOOL:
  case NUMBER:
  case STRING: {
    return any_cast<atom_t>(value);
  }

  case COMPLEX: {
    auto c = any_cast<complex_t>(value);
    return '(' + c.first + ',' + c.second + ')';
  }

  case SEQUENCE: {
    auto q = any_cast<sequence_t>(value);
    string s("[");
    string sep;
    for (auto const& v : q) {
      s.append(sep).append(v.to_string());
      sep = ",";
    }
    return s + ']';
  }

  case TABLE: {
    auto t = any_cast<table_t>(value);
    string s("{");
    string sep;
    for (auto const& pr : t) {
      s.append(sep).append(pr.first + ':' + pr.second.to_string());
      sep = " ";
    }
    return s + '}';
  }

  case TABLEID: {
    return string("@id::") + any_cast<atom_t>(value);
  }

  case UNKNOWN:
  default: {
    return "";
  }

  }; // switch

} // to_string()

Member Data Documentation

bool fhicl::extended_value::in_prolog {false}

Definition at line 96 of file extended_value.h.

Referenced by art::detail::exists_outside_prolog(), fhicl::intermediate_table::pre_insert_(), set_prolog(), and to_string().

Protection fhicl::extended_value::protection {Protection::NONE}

Definition at line 112 of file extended_value.h.

Referenced by fhicl::intermediate_table::locate_(), and fhicl::intermediate_table::pre_insert_().

std::string fhicl::extended_value::src_info {}

Definition at line 99 of file extended_value.h.

Referenced by extended_value(), pretty_src_info(), and set_src_info().

value_tag fhicl::extended_value::tag {UNKNOWN}

Definition at line 97 of file extended_value.h.

Referenced by fhicl::detail::encode(), is_a(), set_prolog(), and to_string().

std::any fhicl::extended_value::value {}

Definition at line 98 of file extended_value.h.

Referenced by fhicl::intermediate_table::exists(), fhicl::intermediate_table::find(), fhicl::intermediate_table::locate_(), operator atom_t(), operator complex_t(), operator sequence_t(), operator table_t(), fhicl::detail::it_value_get< T, typename tt::disable_if< std::is_reference_v< T >|| std::is_pointer_v< T > >::type >::operator()(), fhicl::detail::it_value_get< intermediate_table::sequence_t >::operator()(), fhicl::detail::it_value_get< intermediate_table::sequence_t const & >::operator()(), fhicl::detail::it_value_get< intermediate_table::table_t >::operator()(), fhicl::detail::it_value_get< intermediate_table::table_t const & >::operator()(), set_prolog(), and to_string().

---

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

• fhiclcpp/extended_value.h
• fhiclcpp/extended_value.cc