STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
detail::json_sax_dom_parser< BasicJsonType > Class Template Reference

SAX implementation to create a JSON value from SAX events. More...

#include <json.hpp>

Collaboration diagram for detail::json_sax_dom_parser< BasicJsonType >:
[legend]

Public Types

using number_integer_t = typename BasicJsonType::number_integer_t
using number_unsigned_t = typename BasicJsonType::number_unsigned_t
using number_float_t = typename BasicJsonType::number_float_t
using string_t = typename BasicJsonType::string_t
using binary_t = typename BasicJsonType::binary_t

Public Member Functions

 json_sax_dom_parser (BasicJsonType &r, const bool allow_exceptions_=true)
 json_sax_dom_parser (const json_sax_dom_parser &)=delete
 json_sax_dom_parser (json_sax_dom_parser &&)=default
json_sax_dom_parser & operator= (const json_sax_dom_parser &)=delete
json_sax_dom_parser & operator= (json_sax_dom_parser &&)=default
 ~json_sax_dom_parser ()=default
bool null ()
bool boolean (bool val)
bool number_integer (number_integer_t val)
bool number_unsigned (number_unsigned_t val)
bool number_float (number_float_t val, const string_t &)
bool string (string_t &val)
bool binary (binary_t &val)
bool start_object (std::size_t len)
bool key (string_t &val)
bool end_object ()
bool start_array (std::size_t len)
bool end_array ()
template<class Exception>
bool parse_error (std::size_t, const std::string &, const Exception &ex)
constexpr bool is_errored () const

Private Member Functions

template<typename Value>
JSON_HEDLEY_RETURNS_NON_NULL BasicJsonType * handle_value (Value &&v)

Private Attributes

BasicJsonType & root
 the parsed JSON value
std::vector< BasicJsonType * > ref_stack {}
 stack to model hierarchy of values
BasicJsonType * object_element = nullptr
 helper to hold the reference for the next object element
bool errored = false
 whether a syntax error occurred
const bool allow_exceptions = true
 whether to throw exceptions in case of errors

Detailed Description

template<typename BasicJsonType>
class detail::json_sax_dom_parser< BasicJsonType >

SAX implementation to create a JSON value from SAX events.

This class implements the json_sax interface and processes the SAX events to create a JSON value which makes it basically a DOM parser. The structure or hierarchy of the JSON value is managed by the stack ref_stack which contains a pointer to the respective array or object for each recursion depth.

After successful parsing, the value that is passed by reference to the constructor contains the parsed value.

Template Parameters
BasicJsonTypethe JSON type

Definition at line 6799 of file json.hpp.

Member Typedef Documentation

◆ binary_t

template<typename BasicJsonType>
using detail::json_sax_dom_parser< BasicJsonType >::binary_t = typename BasicJsonType::binary_t

Definition at line 6806 of file json.hpp.

◆ number_float_t

template<typename BasicJsonType>
using detail::json_sax_dom_parser< BasicJsonType >::number_float_t = typename BasicJsonType::number_float_t

Definition at line 6804 of file json.hpp.

◆ number_integer_t

template<typename BasicJsonType>
using detail::json_sax_dom_parser< BasicJsonType >::number_integer_t = typename BasicJsonType::number_integer_t

Definition at line 6802 of file json.hpp.

◆ number_unsigned_t

template<typename BasicJsonType>
using detail::json_sax_dom_parser< BasicJsonType >::number_unsigned_t = typename BasicJsonType::number_unsigned_t

Definition at line 6803 of file json.hpp.

◆ string_t

template<typename BasicJsonType>
using detail::json_sax_dom_parser< BasicJsonType >::string_t = typename BasicJsonType::string_t

Definition at line 6805 of file json.hpp.

Constructor & Destructor Documentation

◆ json_sax_dom_parser() [1/3]

template<typename BasicJsonType>
detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( BasicJsonType & r,
const bool allow_exceptions_ = true )
inlineexplicit
Parameters
[in,out]rreference to a JSON value that is manipulated while parsing
[in]allow_exceptions_whether parse errors yield exceptions

Definition at line 6813 of file json.hpp.

References allow_exceptions, r, and root.

Referenced by json_sax_dom_parser(), json_sax_dom_parser(), operator=(), and operator=().

◆ json_sax_dom_parser() [2/3]

template<typename BasicJsonType>
detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( const json_sax_dom_parser< BasicJsonType > & )
delete

References json_sax_dom_parser().

◆ json_sax_dom_parser() [3/3]

template<typename BasicJsonType>
detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( json_sax_dom_parser< BasicJsonType > && )
default

References json_sax_dom_parser().

◆ ~json_sax_dom_parser()

template<typename BasicJsonType>
detail::json_sax_dom_parser< BasicJsonType >::~json_sax_dom_parser ( )
default

Member Function Documentation

◆ binary()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::binary ( binary_t & val)
inline

Definition at line 6860 of file json.hpp.

References handle_value().

◆ boolean()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::boolean ( bool val)
inline

Definition at line 6830 of file json.hpp.

References handle_value().

◆ end_array()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::end_array ( )
inline

Definition at line 6910 of file json.hpp.

References JSON_ASSERT, and ref_stack.

◆ end_object()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::end_object ( )
inline

Definition at line 6888 of file json.hpp.

References JSON_ASSERT, and ref_stack.

◆ handle_value()

template<typename BasicJsonType>
template<typename Value>
JSON_HEDLEY_RETURNS_NON_NULL BasicJsonType * detail::json_sax_dom_parser< BasicJsonType >::handle_value ( Value && v)
inlineprivate
Invariant
If the ref stack is empty, then the passed value will be the new root.
If the ref stack contains a value, then it is an array or an object to which we can add elements

Definition at line 6947 of file json.hpp.

References JSON_ASSERT, object_element, ref_stack, and root.

Referenced by binary(), boolean(), null(), number_float(), number_integer(), number_unsigned(), start_array(), start_object(), and string().

◆ is_errored()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::is_errored ( ) const
inlineconstexpr

Definition at line 6933 of file json.hpp.

References errored.

Referenced by detail::parser< BasicJsonType, InputAdapterType >::parse().

◆ key()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::key ( string_t & val)
inline

Definition at line 6878 of file json.hpp.

References JSON_ASSERT, object_element, and ref_stack.

◆ null()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::null ( )
inline

Definition at line 6824 of file json.hpp.

References handle_value().

◆ number_float()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::number_float ( number_float_t val,
const string_t &  )
inline

Definition at line 6848 of file json.hpp.

References handle_value().

◆ number_integer()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::number_integer ( number_integer_t val)
inline

Definition at line 6836 of file json.hpp.

References handle_value().

◆ number_unsigned()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::number_unsigned ( number_unsigned_t val)
inline

Definition at line 6842 of file json.hpp.

References handle_value().

◆ operator=() [1/2]

template<typename BasicJsonType>
json_sax_dom_parser & detail::json_sax_dom_parser< BasicJsonType >::operator= ( const json_sax_dom_parser< BasicJsonType > & )
delete

References json_sax_dom_parser().

◆ operator=() [2/2]

template<typename BasicJsonType>
json_sax_dom_parser & detail::json_sax_dom_parser< BasicJsonType >::operator= ( json_sax_dom_parser< BasicJsonType > && )
default

References json_sax_dom_parser().

◆ parse_error()

template<typename BasicJsonType>
template<class Exception>
bool detail::json_sax_dom_parser< BasicJsonType >::parse_error ( std::size_t ,
const std::string & ,
const Exception & ex )
inline

◆ start_array()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::start_array ( std::size_t len)
inline

◆ start_object()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::start_object ( std::size_t len)
inline

◆ string()

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::string ( string_t & val)
inline

Definition at line 6854 of file json.hpp.

References handle_value().

Member Data Documentation

◆ allow_exceptions

template<typename BasicJsonType>
const bool detail::json_sax_dom_parser< BasicJsonType >::allow_exceptions = true
private

whether to throw exceptions in case of errors

Definition at line 6978 of file json.hpp.

Referenced by json_sax_dom_parser(), and parse_error().

◆ errored

template<typename BasicJsonType>
bool detail::json_sax_dom_parser< BasicJsonType >::errored = false
private

whether a syntax error occurred

Definition at line 6976 of file json.hpp.

Referenced by is_errored(), and parse_error().

◆ object_element

template<typename BasicJsonType>
BasicJsonType* detail::json_sax_dom_parser< BasicJsonType >::object_element = nullptr
private

helper to hold the reference for the next object element

Definition at line 6974 of file json.hpp.

Referenced by handle_value(), and key().

◆ ref_stack

template<typename BasicJsonType>
std::vector<BasicJsonType*> detail::json_sax_dom_parser< BasicJsonType >::ref_stack {}
private

stack to model hierarchy of values

Definition at line 6972 of file json.hpp.

Referenced by end_array(), end_object(), handle_value(), key(), start_array(), and start_object().

◆ root

template<typename BasicJsonType>
BasicJsonType& detail::json_sax_dom_parser< BasicJsonType >::root
private

The documentation for this class was generated from the following file:
  • daq-server/diablo_server/lib/include/nlohmann/json.hpp