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

#include "json.h"

Collaboration diagram for nlohmann::detail::json_sax_dom_parser< BasicJsonType >:

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
	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 ()=default

bool	binary (binary_t &val)

bool	boolean (bool val)

bool	end_array ()

bool	end_object ()

constexpr bool	is_errored () const

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)

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

BasicJsonType the JSON type

Definition at line 5396 of file json.h.

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 5403 of file json.h.

◆ 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 5401 of file json.h.

◆ 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 5399 of file json.h.

◆ 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 5400 of file json.h.

◆ string_t

template<typename BasicJsonType >

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

Definition at line 5402 of file json.h.

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 5410 of file json.h.

◆ 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

◆ 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

◆ ~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 5457 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5427 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5502 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::ref_stack.

◆ end_object()

template<typename BasicJsonType >

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

inline

Definition at line 5483 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5535 of file json.h.

References JSON_ASSERT, nlohmann::detail::json_sax_dom_parser< BasicJsonType >::object_element, nlohmann::detail::json_sax_dom_parser< BasicJsonType >::ref_stack, and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::root.

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::binary(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::boolean(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::null(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_float(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_integer(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::number_unsigned(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_array(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_object(), and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::string().

Here is the caller graph for this function:

◆ is_errored()

template<typename BasicJsonType >

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

inlineconstexpr

Definition at line 5521 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5476 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::object_element, and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::ref_stack.

◆ null()

template<typename BasicJsonType >

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

inline

Definition at line 5421 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5445 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5433 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5439 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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

◆ operator=() [2/2]

template<typename BasicJsonType >

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

default

◆ 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 5509 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::allow_exceptions, nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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 5489 of file json.h.

References nlohmann::detail::out_of_range::create(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::handle_value(), JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::json_sax_dom_parser< BasicJsonType >::ref_stack, and nlohmann::to_string().

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 5463 of file json.h.

References nlohmann::detail::out_of_range::create(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::handle_value(), JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::json_sax_dom_parser< BasicJsonType >::ref_stack, and nlohmann::to_string().

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 5451 of file json.h.

References nlohmann::detail::json_sax_dom_parser< BasicJsonType >::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

whether to throw exceptions in case of errors

Definition at line 5566 of file json.h.

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::parse_error().

◆ errored

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

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::is_errored(), and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::parse_error().

◆ object_element

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

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::handle_value(), and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::key().

◆ ref_stack

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

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_array(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::end_object(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::handle_value(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::key(), nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_array(), and nlohmann::detail::json_sax_dom_parser< BasicJsonType >::start_object().

◆ root

template<typename BasicJsonType >

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

private

the parsed JSON value

Definition at line 5558 of file json.h.

Referenced by nlohmann::detail::json_sax_dom_parser< BasicJsonType >::handle_value().

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

src/applications/utils/json.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

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

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