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

#include <nlohmann_json.hpp>

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

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

std::vector< BasicJsonType * >	ref_stack {}
	stack to model hierarchy of values More...

BasicJsonType *	object_element = nullptr
	helper to hold the reference for the next object element More...

bool	errored = false
	whether a syntax error occurred More...

const bool	allow_exceptions = true
	whether to throw exceptions in case of errors 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

BasicJsonType the JSON type

Definition at line 6734 of file nlohmann_json.hpp.

Member Typedef Documentation

◆ number_integer_t

template<typename BasicJsonType >

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

Definition at line 6737 of file nlohmann_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 6738 of file nlohmann_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 6739 of file nlohmann_json.hpp.

◆ string_t

template<typename BasicJsonType >

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

Definition at line 6740 of file nlohmann_json.hpp.

◆ binary_t

template<typename BasicJsonType >

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

Definition at line 6741 of file nlohmann_json.hpp.

Constructor & Destructor Documentation

◆ json_sax_dom_parser()

template<typename BasicJsonType >

detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser	(	BasicJsonType &	r,
		const bool	allow_exceptions_ = `true`
	)

inlineexplicit

Parameters

[in,out]	r	reference to a JSON value that is manipulated while parsing
[in]	allow_exceptions_	whether parse errors yield exceptions

Definition at line 6748 of file nlohmann_json.hpp.

Member Function Documentation

◆ null()

template<typename BasicJsonType >

bool detail::json_sax_dom_parser< BasicJsonType >::null ( )

inline

Definition at line 6759 of file nlohmann_json.hpp.

◆ boolean()

template<typename BasicJsonType >

bool detail::json_sax_dom_parser< BasicJsonType >::boolean ( bool val )

inline

Definition at line 6765 of file nlohmann_json.hpp.

◆ number_integer()

template<typename BasicJsonType >

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

inline

Definition at line 6771 of file nlohmann_json.hpp.

◆ number_unsigned()

template<typename BasicJsonType >

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

inline

Definition at line 6777 of file nlohmann_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 6783 of file nlohmann_json.hpp.

◆ string()

template<typename BasicJsonType >

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

inline

Definition at line 6789 of file nlohmann_json.hpp.

◆ binary()

template<typename BasicJsonType >

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

inline

Definition at line 6795 of file nlohmann_json.hpp.

◆ start_object()

template<typename BasicJsonType >

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

inline

Definition at line 6801 of file nlohmann_json.hpp.

◆ key()

template<typename BasicJsonType >

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

inline

Definition at line 6813 of file nlohmann_json.hpp.

◆ end_object()

template<typename BasicJsonType >

bool detail::json_sax_dom_parser< BasicJsonType >::end_object ( )

inline

Definition at line 6823 of file nlohmann_json.hpp.

◆ start_array()

template<typename BasicJsonType >

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

inline

Definition at line 6833 of file nlohmann_json.hpp.

◆ end_array()

template<typename BasicJsonType >

bool detail::json_sax_dom_parser< BasicJsonType >::end_array ( )

inline

Definition at line 6845 of file nlohmann_json.hpp.

◆ 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 6856 of file nlohmann_json.hpp.

◆ is_errored()

template<typename BasicJsonType >

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

inlineconstexpr

Definition at line 6868 of file nlohmann_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 6882 of file nlohmann_json.hpp.

Member Data Documentation

◆ root

template<typename BasicJsonType >

BasicJsonType& detail::json_sax_dom_parser< BasicJsonType >::root

private

the parsed JSON value

Definition at line 6905 of file nlohmann_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 6907 of file nlohmann_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 6909 of file nlohmann_json.hpp.

◆ errored

template<typename BasicJsonType >

bool detail::json_sax_dom_parser< BasicJsonType >::errored = false

private

whether a syntax error occurred

Definition at line 6911 of file nlohmann_json.hpp.

◆ 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 6913 of file nlohmann_json.hpp.

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

nlohmann_json.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ number_integer_t

◆ number_unsigned_t

◆ number_float_t

◆ string_t

◆ binary_t

Constructor & Destructor Documentation

◆ json_sax_dom_parser()

Member Function Documentation

◆ null()

◆ boolean()

◆ number_integer()

◆ number_unsigned()

◆ number_float()

◆ string()

◆ binary()

◆ start_object()

◆ key()

◆ end_object()

◆ start_array()

◆ end_array()

◆ parse_error()

◆ is_errored()

◆ handle_value()

Member Data Documentation

◆ root

◆ ref_stack

◆ object_element

◆ errored

◆ allow_exceptions