lexical analysis More...

#include <json.hpp>

Inheritance diagram for nlohmann::detail::lexer< BasicJsonType, InputAdapterType >:

Collaboration diagram for nlohmann::detail::lexer< BasicJsonType, InputAdapterType >:

Public Types
using	token_type = typename lexer_base< BasicJsonType >::token_type

using	token_type = typename lexer_base< BasicJsonType >::token_type

using	token_type = typename lexer_base< BasicJsonType >::token_type

Public Types inherited from nlohmann::detail::lexer_base< BasicJsonType >
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 , 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 , 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...

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

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 , 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 , 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 (InputAdapterType &&adapter, bool ignore_comments_=false) noexcept

	lexer (const lexer &)=delete

	lexer (lexer &&)=default

lexer &	operator= (lexer &)=delete

lexer &	operator= (lexer &&)=default

	~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

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char *	get_error_message () const noexcept
	return syntax error message

bool	skip_bom ()
	skip the UTF-8 byte order mark

void	skip_whitespace ()

token_type	scan ()

	lexer (InputAdapterType &&adapter, bool ignore_comments_=false) noexcept

	lexer (const lexer &)=delete

	lexer (lexer &&)=default

lexer &	operator= (lexer &)=delete

lexer &	operator= (lexer &&)=default

	~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

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char *	get_error_message () const noexcept
	return syntax error message

bool	skip_bom ()
	skip the UTF-8 byte order mark

void	skip_whitespace ()

token_type	scan ()

	lexer (InputAdapterType &&adapter, bool ignore_comments_=false) noexcept

	lexer (const lexer &)=delete

	lexer (lexer &&)=default

lexer &	operator= (lexer &)=delete

lexer &	operator= (lexer &&)=default

	~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

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char *	get_error_message () const noexcept
	return syntax error message

bool	skip_bom ()
	skip the UTF-8 byte order mark

void	skip_whitespace ()

token_type	scan ()

Additional Inherited Members
Static Public Member Functions inherited from nlohmann::detail::lexer_base< BasicJsonType >
JSON_HEDLEY_RETURNS_NON_NULL static JSON_HEDLEY_CONST const char *	token_type_name (const token_type t) noexcept
	return name of values of type token_type (only used for errors)

JSON_HEDLEY_RETURNS_NON_NULL static JSON_HEDLEY_CONST const char *	token_type_name (const token_type t) noexcept
	return name of values of type token_type (only used for errors)

JSON_HEDLEY_RETURNS_NON_NULL static JSON_HEDLEY_CONST 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, typename InputAdapterType>
class nlohmann::detail::lexer< BasicJsonType, InputAdapterType >

lexical analysis

This class organizes the lexical analysis during JSON deserialization.

Definition at line 6513 of file json.hpp.

Member Typedef Documentation

◆ token_type [1/3]

template<typename BasicJsonType , typename InputAdapterType >

using nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::token_type = typename lexer_base<BasicJsonType>::token_type

Definition at line 6523 of file json.hpp.

◆ token_type [2/3]

template<typename BasicJsonType , typename InputAdapterType >

using nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::token_type = typename lexer_base<BasicJsonType>::token_type

Definition at line 6523 of file json.hpp.

◆ token_type [3/3]

template<typename BasicJsonType , typename InputAdapterType >

using nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::token_type = typename lexer_base<BasicJsonType>::token_type

Definition at line 6523 of file json.hpp.

Constructor & Destructor Documentation

◆ lexer() [1/9]

template<typename BasicJsonType , typename InputAdapterType >

nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::lexer	(	InputAdapterType &&	adapter,
		bool	ignore_comments_ = `false`
	)

inlineexplicitnoexcept

Definition at line 6525 of file json.hpp.

◆ lexer() [2/9]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ lexer() [3/9]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ ~lexer() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

default

References JSON_ASSERT.

◆ lexer() [4/9]

template<typename BasicJsonType , typename InputAdapterType >

nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::lexer	(	InputAdapterType &&	adapter,
		bool	ignore_comments_ = `false`
	)

inlineexplicitnoexcept

Definition at line 6525 of file json.hpp.

◆ lexer() [5/9]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ lexer() [6/9]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ ~lexer() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

default

References JSON_ASSERT.

◆ lexer() [7/9]

template<typename BasicJsonType , typename InputAdapterType >

nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::lexer	(	InputAdapterType &&	adapter,
		bool	ignore_comments_ = `false`
	)

inlineexplicitnoexcept

Definition at line 6525 of file json.hpp.

◆ lexer() [8/9]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ lexer() [9/9]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ ~lexer() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

default

References JSON_ASSERT.

Member Function Documentation

◆ get_error_message() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char * nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get_error_message ( ) const

inlineconstexprnoexcept

return syntax error message

Definition at line 7875 of file json.hpp.

◆ get_error_message() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char * nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get_error_message ( ) const

inlineconstexprnoexcept

return syntax error message

Definition at line 7875 of file json.hpp.

◆ get_error_message() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

JSON_HEDLEY_RETURNS_NON_NULL constexpr const char * nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get_error_message ( ) const

inlineconstexprnoexcept

return syntax error message

Definition at line 7875 of file json.hpp.

◆ get_number_float() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return floating-point value

Definition at line 7826 of file json.hpp.

◆ get_number_float() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return floating-point value

Definition at line 7826 of file json.hpp.

◆ get_number_float() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return floating-point value

Definition at line 7826 of file json.hpp.

◆ get_number_integer() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return integer value

Definition at line 7814 of file json.hpp.

◆ get_number_integer() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return integer value

Definition at line 7814 of file json.hpp.

◆ get_number_integer() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return integer value

Definition at line 7814 of file json.hpp.

◆ get_number_unsigned() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return unsigned integer value

Definition at line 7820 of file json.hpp.

◆ get_number_unsigned() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return unsigned integer value

Definition at line 7820 of file json.hpp.

◆ get_number_unsigned() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return unsigned integer value

Definition at line 7820 of file json.hpp.

◆ get_position() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return position of last read token

Definition at line 7842 of file json.hpp.

◆ get_position() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return position of last read token

Definition at line 7842 of file json.hpp.

◆ get_position() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inlineconstexprnoexcept

return position of last read token

Definition at line 7842 of file json.hpp.

◆ get_string() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

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

Definition at line 7832 of file json.hpp.

◆ get_string() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

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

Definition at line 7832 of file json.hpp.

◆ get_string() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

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

Definition at line 7832 of file json.hpp.

◆ get_token_string() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

std::string nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::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.

Definition at line 7850 of file json.hpp.

◆ get_token_string() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

std::string nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::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.

Definition at line 7850 of file json.hpp.

◆ get_token_string() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

std::string nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::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.

Definition at line 7850 of file json.hpp.

◆ operator=() [1/6]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ operator=() [2/6]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ operator=() [3/6]

template<typename BasicJsonType , typename InputAdapterType >

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

default

◆ operator=() [4/6]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ operator=() [5/6]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ operator=() [6/6]

template<typename BasicJsonType , typename InputAdapterType >

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

delete

◆ scan() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

Definition at line 7911 of file json.hpp.

◆ scan() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

Definition at line 7911 of file json.hpp.

◆ scan() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

Definition at line 7911 of file json.hpp.

◆ skip_bom() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

skip the UTF-8 byte order mark

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

Definition at line 7888 of file json.hpp.

References nlohmann::detail::get().

◆ skip_bom() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

skip the UTF-8 byte order mark

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

Definition at line 7888 of file json.hpp.

References nlohmann::detail::get().

◆ skip_bom() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

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

inline

skip the UTF-8 byte order mark

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

Definition at line 7888 of file json.hpp.

References nlohmann::detail::get().

◆ skip_whitespace() [1/3]

template<typename BasicJsonType , typename InputAdapterType >

void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::skip_whitespace ( )

inline

Definition at line 7902 of file json.hpp.

References nlohmann::detail::get().

◆ skip_whitespace() [2/3]

template<typename BasicJsonType , typename InputAdapterType >

void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::skip_whitespace ( )

inline

Definition at line 7902 of file json.hpp.

References nlohmann::detail::get().

◆ skip_whitespace() [3/3]

template<typename BasicJsonType , typename InputAdapterType >

void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::skip_whitespace ( )

inline

Definition at line 7902 of file json.hpp.

References nlohmann::detail::get().

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

install/include/nlohmann/json.hpp
install/services/nlohmann/json.hpp
services/nlohmann/json.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ token_type [1/3]

◆ token_type [2/3]

◆ token_type [3/3]

Constructor & Destructor Documentation

◆ lexer() [1/9]

◆ lexer() [2/9]

◆ lexer() [3/9]

◆ ~lexer() [1/3]

◆ lexer() [4/9]

◆ lexer() [5/9]

◆ lexer() [6/9]

◆ ~lexer() [2/3]

◆ lexer() [7/9]

◆ lexer() [8/9]

◆ lexer() [9/9]

◆ ~lexer() [3/3]

Member Function Documentation

◆ get_error_message() [1/3]

◆ get_error_message() [2/3]

◆ get_error_message() [3/3]

◆ get_number_float() [1/3]

◆ get_number_float() [2/3]

◆ get_number_float() [3/3]

◆ get_number_integer() [1/3]

◆ get_number_integer() [2/3]

◆ get_number_integer() [3/3]

◆ get_number_unsigned() [1/3]

◆ get_number_unsigned() [2/3]

◆ get_number_unsigned() [3/3]

◆ get_position() [1/3]

◆ get_position() [2/3]

◆ get_position() [3/3]

◆ get_string() [1/3]

◆ get_string() [2/3]

◆ get_string() [3/3]

◆ get_token_string() [1/3]

◆ get_token_string() [2/3]

◆ get_token_string() [3/3]

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ scan() [1/3]

◆ scan() [2/3]

◆ scan() [3/3]

◆ skip_bom() [1/3]

◆ skip_bom() [2/3]

◆ skip_bom() [3/3]

◆ skip_whitespace() [1/3]

◆ skip_whitespace() [2/3]

◆ skip_whitespace() [3/3]