nlohmann::detail::lexer< BasicJsonType > Class Template Reference

lexical analysis More...

#include <json.hpp>

Public Types
enum class	token_type {   uninitialized , literal_true , literal_false , literal_null ,   value_string , value_unsigned , value_integer , value_float ,   begin_array , begin_object , end_array , end_object ,   name_separator , value_separator , parse_error , end_of_input ,   literal_or_value }
	token types for the parser More...

Public Member Functions
	lexer (detail::input_adapter_t &&adapter)
	lexer (const lexer &)=delete
	lexer (lexer &&)=delete
lexer &	operator= (lexer &)=delete
lexer &	operator= (lexer &&)=delete
	~lexer ()=default
constexpr number_integer_t	get_number_integer () const noexcept
	return integer value
constexpr number_unsigned_t	get_number_unsigned () const noexcept
	return unsigned integer value
constexpr number_float_t	get_number_float () const noexcept
	return floating-point value
string_t &	get_string ()
	return current string value (implicitly resets the token; useful only once)
constexpr position_t	get_position () const noexcept
	return position of last read token
std::string	get_token_string () const
constexpr const char *	get_error_message () const noexcept
	return syntax error message
bool	skip_bom ()
	skip the UTF-8 byte order mark
token_type	scan ()

Static Public Member Functions
static const char *	token_type_name (const token_type t) noexcept
	return name of values of type token_type (only used for errors)

Detailed Description

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

lexical analysis

This class organizes the lexical analysis during JSON deserialization.

Member Enumeration Documentation

token_type

template<typename BasicJsonType>

enum class nlohmann::detail::lexer::token_type

strong

token types for the parser

Enumerator
uninitialized	indicating the scanner is uninitialized
literal_true	the true literal
literal_false	the false literal
literal_null	the null literal
value_string	a string – use get_string() for actual value
value_unsigned	an unsigned integer – use get_number_unsigned() for actual value
value_integer	a signed integer – use get_number_integer() for actual value
value_float	an floating point number – use get_number_float() for actual value
begin_array	the character for array begin [
begin_object	the character for object begin {
end_array	the character for array end ]
end_object	the character for object end }
name_separator	the name separator :
value_separator	the value separator ,
parse_error	indicating a parse error
end_of_input	indicating the end of the input buffer
literal_or_value	a literal or the begin of a value (only for diagnostics)

Constructor & Destructor Documentation

lexer() [1/3]

template<typename BasicJsonType>

nlohmann::detail::lexer< BasicJsonType >::lexer ( detail::input_adapter_t && adapter )

inlineexplicit

lexer() [2/3]

template<typename BasicJsonType>

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

delete

lexer() [3/3]

template<typename BasicJsonType>

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

delete

~lexer()

template<typename BasicJsonType>

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

default

Member Function Documentation

get_error_message()

template<typename BasicJsonType>

const char * nlohmann::detail::lexer< BasicJsonType >::get_error_message ( ) const

inlineconstexprnoexcept

return syntax error message

get_number_float()

template<typename BasicJsonType>

number_float_t nlohmann::detail::lexer< BasicJsonType >::get_number_float ( ) const

inlineconstexprnoexcept

return floating-point value

get_number_integer()

template<typename BasicJsonType>

number_integer_t nlohmann::detail::lexer< BasicJsonType >::get_number_integer ( ) const

inlineconstexprnoexcept

return integer value

get_number_unsigned()

template<typename BasicJsonType>

number_unsigned_t nlohmann::detail::lexer< BasicJsonType >::get_number_unsigned ( ) const

inlineconstexprnoexcept

return unsigned integer value

get_position()

template<typename BasicJsonType>

position_t nlohmann::detail::lexer< BasicJsonType >::get_position ( ) const

inlineconstexprnoexcept

return position of last read token

get_string()

template<typename BasicJsonType>

string_t & nlohmann::detail::lexer< BasicJsonType >::get_string ( )

inline

return current string value (implicitly resets the token; useful only once)

get_token_string()

template<typename BasicJsonType>

std::string nlohmann::detail::lexer< BasicJsonType >::get_token_string ( ) const

inline

return the last read token (for errors only). Will never contain EOF (an arbitrary value that is not a valid char value, often -1), because 255 may legitimately occur. May contain NUL, which should be escaped.

operator=() [1/2]

template<typename BasicJsonType>

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

delete

operator=() [2/2]

template<typename BasicJsonType>

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

delete

scan()

template<typename BasicJsonType>

token_type nlohmann::detail::lexer< BasicJsonType >::scan ( )

inline

skip_bom()

template<typename BasicJsonType>

bool nlohmann::detail::lexer< BasicJsonType >::skip_bom ( )

inline

skip the UTF-8 byte order mark

Returns

true iff there is no BOM or the correct BOM has been skipped

token_type_name()

template<typename BasicJsonType>

const char * nlohmann::detail::lexer< BasicJsonType >::token_type_name ( const token_type t )

inlinestaticnoexcept

return name of values of type token_type (only used for errors)

---

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

• json.hpp