Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
nlohmann::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_parser & operator= (const json_sax_dom_parser &)=delete
 
json_sax_dom_parser & operator= (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 nlohmann::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 5396 of file json.hpp.

Member Typedef Documentation

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

Definition at line 5403 of file json.hpp.

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

Definition at line 5401 of file json.hpp.

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

Definition at line 5399 of file json.hpp.

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

Definition at line 5400 of file json.hpp.

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

Definition at line 5402 of file json.hpp.

Constructor & Destructor Documentation

template<typename BasicJsonType>
nlohmann::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 5410 of file json.hpp.

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

Member Function Documentation

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

Definition at line 5457 of file json.hpp.

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

Definition at line 5427 of file json.hpp.

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

Definition at line 5502 of file json.hpp.

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

Definition at line 5483 of file json.hpp.

template<typename BasicJsonType>
template<typename Value >
JSON_HEDLEY_RETURNS_NON_NULL BasicJsonType* nlohmann::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 5535 of file json.hpp.

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

Definition at line 5521 of file json.hpp.

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

Definition at line 5476 of file json.hpp.

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

Definition at line 5421 of file json.hpp.

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

Definition at line 5445 of file json.hpp.

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

Definition at line 5433 of file json.hpp.

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

Definition at line 5439 of file json.hpp.

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

Definition at line 5509 of file json.hpp.

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

Definition at line 5489 of file json.hpp.

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

Definition at line 5463 of file json.hpp.

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

Definition at line 5451 of file json.hpp.

Member Data Documentation

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

whether to throw exceptions in case of errors

Definition at line 5566 of file json.hpp.

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

whether a syntax error occurred

Definition at line 5564 of file json.hpp.

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

helper to hold the reference for the next object element

Definition at line 5562 of file json.hpp.

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

stack to model hierarchy of values

Definition at line 5560 of file json.hpp.

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

the parsed JSON value

Definition at line 5558 of file json.hpp.

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

plotjuggler
Author(s): Davide Faconti
autogenerated on Sun Dec 6 2020 04:02:51