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

#include <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
	~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 nlohmann::detail::json_sax_dom_parser< BasicJsonType >

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 5807 of file json.hpp.

Member Typedef Documentation

◆ binary_t

template<typename BasicJsonType>

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

Definition at line 5814 of file json.hpp.

◆ number_float_t

template<typename BasicJsonType>

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

Definition at line 5812 of file json.hpp.

◆ number_integer_t

template<typename BasicJsonType>

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

Definition at line 5810 of file json.hpp.

◆ number_unsigned_t

template<typename BasicJsonType>

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

Definition at line 5811 of file json.hpp.

◆ string_t

template<typename BasicJsonType>

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

Definition at line 5813 of file json.hpp.

Constructor & Destructor Documentation

◆ json_sax_dom_parser() [1/3]

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]	r	reference to a JSON value that is manipulated while parsing
[in]	allow_exceptions_	whether parse errors yield exceptions

Definition at line 5821 of file json.hpp.

References allow_exceptions, nlohmann::BasicJsonType(), and root.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ json_sax_dom_parser() [2/3]

template<typename BasicJsonType>

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( const json_sax_dom_parser< BasicJsonType > & )

delete

References json_sax_dom_parser().

Here is the call graph for this function:

◆ json_sax_dom_parser() [3/3]

template<typename BasicJsonType>

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( json_sax_dom_parser< BasicJsonType > && )

default

References json_sax_dom_parser().

Here is the call graph for this function:

◆ ~json_sax_dom_parser()

template<typename BasicJsonType>

nlohmann::detail::json_sax_dom_parser< BasicJsonType >::~json_sax_dom_parser ( )

default

Member Function Documentation

◆ binary()

template<typename BasicJsonType>

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

inline

Definition at line 5871 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ boolean()

template<typename BasicJsonType>

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

inline

Definition at line 5841 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ end_array()

template<typename BasicJsonType>

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

inline

Definition at line 5913 of file json.hpp.

References ref_stack.

◆ end_object()

template<typename BasicJsonType>

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

inline

Definition at line 5895 of file json.hpp.

References ref_stack.

◆ handle_value()

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 5941 of file json.hpp.

References nlohmann::BasicJsonType(), JSON_ASSERT, JSON_HEDLEY_RETURNS_NON_NULL, object_element, ref_stack, root, and v.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_errored()

template<typename BasicJsonType>

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

inlineconstexpr

Definition at line 5931 of file json.hpp.

References errored.

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

Here is the caller graph for this function:

◆ key()

template<typename BasicJsonType>

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

inline

Definition at line 5888 of file json.hpp.

References object_element, and ref_stack.

◆ null()

template<typename BasicJsonType>

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

inline

Definition at line 5835 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ number_float()

template<typename BasicJsonType>

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

inline

Definition at line 5859 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ number_integer()

template<typename BasicJsonType>

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

inline

Definition at line 5847 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ number_unsigned()

template<typename BasicJsonType>

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

inline

Definition at line 5853 of file json.hpp.

References handle_value().

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename BasicJsonType>

json_sax_dom_parser & nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= ( const json_sax_dom_parser< BasicJsonType > & )

delete

References json_sax_dom_parser().

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename BasicJsonType>

json_sax_dom_parser & nlohmann::detail::json_sax_dom_parser< BasicJsonType >::operator= ( json_sax_dom_parser< BasicJsonType > && )

default

References json_sax_dom_parser().

Here is the call graph for this function:

◆ parse_error()

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 5921 of file json.hpp.

References allow_exceptions, errored, and JSON_THROW.

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

Here is the caller graph for this function:

◆ start_array()

template<typename BasicJsonType>

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

inline

Definition at line 5902 of file json.hpp.

References nlohmann::detail::out_of_range::create(), handle_value(), JSON_HEDLEY_UNLIKELY, JSON_THROW, and ref_stack.

Here is the call graph for this function:

◆ start_object()

template<typename BasicJsonType>

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

inline

Definition at line 5877 of file json.hpp.

References nlohmann::detail::out_of_range::create(), handle_value(), JSON_HEDLEY_UNLIKELY, JSON_THROW, and ref_stack.

Here is the call graph for this function:

◆ string()

template<typename BasicJsonType>

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

inline

Definition at line 5865 of file json.hpp.

References handle_value().

Here is the call graph for this function:

Member Data Documentation

◆ allow_exceptions

template<typename BasicJsonType>

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

private

Definition at line 5970 of file json.hpp.

Referenced by json_sax_dom_parser(), and parse_error().

◆ errored

template<typename BasicJsonType>

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

private

Definition at line 5968 of file json.hpp.

Referenced by is_errored(), and parse_error().

◆ object_element

template<typename BasicJsonType>

BasicJsonType* nlohmann::detail::json_sax_dom_parser< BasicJsonType >::object_element = nullptr

private

Definition at line 5966 of file json.hpp.

Referenced by handle_value(), and key().

◆ ref_stack

template<typename BasicJsonType>

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

private

Definition at line 5964 of file json.hpp.

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

◆ root

template<typename BasicJsonType>

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

private

Definition at line 5962 of file json.hpp.

Referenced by json_sax_dom_parser(), and handle_value().

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

install/include/nlohmann/json.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ binary_t

◆ number_float_t

◆ number_integer_t

◆ number_unsigned_t

◆ string_t

Constructor & Destructor Documentation

◆ json_sax_dom_parser() [1/3]

◆ json_sax_dom_parser() [2/3]

◆ json_sax_dom_parser() [3/3]

◆ ~json_sax_dom_parser()

Member Function Documentation

◆ binary()

◆ boolean()

◆ end_array()

◆ end_object()

◆ handle_value()

◆ is_errored()

◆ key()

◆ null()

◆ number_float()

◆ number_integer()

◆ number_unsigned()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse_error()

◆ start_array()

◆ start_object()

◆ string()

Member Data Documentation

◆ allow_exceptions

◆ errored

◆ object_element

◆ ref_stack

◆ root