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

#include <XrdOucJson.hh>

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 >

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

Member Typedef Documentation

◆ binary_t

template<typename BasicJsonType >

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

◆ number_float_t

template<typename BasicJsonType >

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

◆ number_integer_t

template<typename BasicJsonType >

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

◆ number_unsigned_t

template<typename BasicJsonType >

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

◆ string_t

template<typename BasicJsonType >

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

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

◆ 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

◆ boolean()

template<typename BasicJsonType >

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

inline

◆ end_array()

template<typename BasicJsonType >

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

inline

◆ end_object()

template<typename BasicJsonType >

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

inline

◆ 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

References JSON_ASSERT.

◆ is_errored()

template<typename BasicJsonType >

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

inlineconstexpr

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

◆ key()

template<typename BasicJsonType >

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

inline

◆ null()

template<typename BasicJsonType >

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

inline

◆ number_float()

template<typename BasicJsonType >

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

inline

◆ number_integer()

template<typename BasicJsonType >

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

inline

◆ number_unsigned()

template<typename BasicJsonType >

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

inline

◆ 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

References JSON_THROW.

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

◆ start_array()

template<typename BasicJsonType >

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

inline

References JSON_HEDLEY_UNLIKELY, and JSON_THROW.

◆ start_object()

template<typename BasicJsonType >

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

inline

References JSON_HEDLEY_UNLIKELY, and JSON_THROW.

◆ string()

template<typename BasicJsonType >

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

inline

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

◆ errored

template<typename BasicJsonType >

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

private

whether a syntax error occurred

◆ 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

◆ ref_stack

template<typename BasicJsonType >

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

private

stack to model hierarchy of values

◆ root

template<typename BasicJsonType >

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

private

the parsed JSON value

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

XrdOucJson.hh

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