Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
detail::json_sax_dom_parser< BasicJsonType > Class Template Reference

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

#include <json.hpp>

Public Types

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

Public Member Functions

bool binary (binary_t &val)
 
bool boolean (bool val)
 
bool end_array ()
 
bool end_object ()
 
constexpr bool is_errored () const
 
 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
 
bool key (string_t &val)
 
bool null ()
 
bool number_float (number_float_t val, const string_t &)
 
bool number_integer (number_integer_t val)
 
bool number_unsigned (number_unsigned_t val)
 
json_sax_dom_parseroperator= (const json_sax_dom_parser &)=delete
 
json_sax_dom_parseroperator= (json_sax_dom_parser &&)=default
 
template<class Exception >
bool parse_error (std::size_t, const std::string &, const Exception &ex)
 
bool start_array (std::size_t len)
 
bool start_object (std::size_t len)
 
bool string (string_t &val)
 
 ~json_sax_dom_parser ()=default
 

Private Member Functions

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

Private Attributes

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

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.

◆ 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

◆ 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

◆ ~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.

◆ boolean()

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

Definition at line 6830 of file json.hpp.

◆ end_array()

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

Definition at line 6910 of file json.hpp.

◆ end_object()

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

Definition at line 6888 of file json.hpp.

◆ 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.

◆ is_errored()

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

Definition at line 6933 of file json.hpp.

◆ key()

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

Definition at line 6878 of file json.hpp.

◆ null()

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

Definition at line 6824 of file json.hpp.

◆ 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.

◆ 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.

◆ 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.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ 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

Definition at line 6921 of file json.hpp.

◆ start_array()

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

Definition at line 6898 of file json.hpp.

◆ start_object()

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

Definition at line 6866 of file json.hpp.

◆ string()

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

Definition at line 6854 of file json.hpp.

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.

◆ 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.

◆ 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.

◆ 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.

◆ root

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

the parsed JSON value

Definition at line 6970 of file json.hpp.


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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Dec 13 2024 03:19:19