Goby3  3.1.4
2024.02.22
Public Types | Public Member Functions | List of all members
detail::json_sax_dom_parser< BasicJsonType > Class Template Reference

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

#include <goby/util/thirdparty/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
 
 ~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
 

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
BasicJsonTypethe JSON type

Definition at line 6730 of file json.hpp.

Member Typedef Documentation

◆ binary_t

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

Definition at line 6737 of file 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 6735 of file json.hpp.

◆ number_integer_t

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

Definition at line 6733 of file 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 6734 of file json.hpp.

◆ string_t

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

Definition at line 6736 of file json.hpp.

Constructor & Destructor Documentation

◆ json_sax_dom_parser() [1/3]

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

◆ json_sax_dom_parser() [2/3]

template<typename BasicJsonType >
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 >
detail::json_sax_dom_parser< BasicJsonType >::json_sax_dom_parser ( json_sax_dom_parser< BasicJsonType > &&  )
default

◆ ~json_sax_dom_parser()

template<typename BasicJsonType >
detail::json_sax_dom_parser< BasicJsonType >::~json_sax_dom_parser ( )
default

Member Function Documentation

◆ binary()

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

Definition at line 6791 of file json.hpp.

◆ boolean()

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

Definition at line 6761 of file json.hpp.

◆ end_array()

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

Definition at line 6841 of file json.hpp.

◆ end_object()

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

Definition at line 6819 of file json.hpp.

◆ is_errored()

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

Definition at line 6864 of file json.hpp.

◆ key()

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

Definition at line 6809 of file json.hpp.

◆ null()

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

Definition at line 6755 of file 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 6779 of file json.hpp.

◆ number_integer()

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

Definition at line 6767 of file json.hpp.

◆ number_unsigned()

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

Definition at line 6773 of file json.hpp.

◆ operator=() [1/2]

template<typename BasicJsonType >
json_sax_dom_parser& detail::json_sax_dom_parser< BasicJsonType >::operator= ( const json_sax_dom_parser< BasicJsonType > &  )
delete

◆ operator=() [2/2]

template<typename BasicJsonType >
json_sax_dom_parser& detail::json_sax_dom_parser< BasicJsonType >::operator= ( json_sax_dom_parser< BasicJsonType > &&  )
default

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

◆ start_array()

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

Definition at line 6829 of file json.hpp.

◆ start_object()

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

Definition at line 6797 of file json.hpp.

◆ string()

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

Definition at line 6785 of file json.hpp.

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