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

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

enum

token_type {
token_type::uninitialized,
token_type::literal_true,
token_type::literal_false,
token_type::literal_null,
token_type::value_string,
token_type::value_unsigned,
token_type::value_integer,
token_type::value_float,
token_type::begin_array,
token_type::begin_object,
token_type::end_array,
token_type::end_object,
token_type::name_separator,
token_type::value_separator,
token_type::parse_error,
token_type::end_of_input,
token_type::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 More...
constexpr number_unsigned_t | get_number_unsigned () const noexcept
| return unsigned integer value More...
constexpr number_float_t | get_number_float () const noexcept
| return floating-point value More...
string_t & | get_string ()
| return current string value (implicitly resets the token; useful only once) More...
constexpr position_t | get_position () const noexcept
| return position of last read token More...
std::string | get_token_string () const
JSON_HEDLEY_RETURNS_NON_NULL constexpr const char * | get_error_message () const noexcept
| return syntax error message More...
bool | skip_bom ()
| skip the UTF-8 byte order mark More...
void | skip_whitespace ()
token_type | scan ()

## Private 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 | char_type = typename InputAdapterType::char_type
using | char_int_type = typename std::char_traits< char_type >::int_type

## Private Member Functions

int | get_codepoint ()
| get codepoint from 4 hex characters following `\u` More...
bool | next_byte_in_range (std::initializer_list< char_int_type > ranges)
| check if the next byte(s) are inside a given range More...
token_type | scan_string ()
| scan a string literal More...
bool | scan_comment ()
| scan a comment More...
token_type | scan_number ()
| scan a number literal More...
token_type | scan_literal (const char_type *literal_text, const std::size_t length, token_type return_type)
void | reset () noexcept
| reset token_buffer; current character is beginning of token More...
char_int_type | get ()
void | unget ()
| unget current character (read it again on next get) More...
void | add (char_int_type c)
| add a character to token_buffer More...

## Static Private Member Functions

static JSON_HEDLEY_PURE char | get_decimal_point () noexcept
| return the locale-dependent decimal point More...
static void | strtof (float &f, const char *str, char **endptr) noexcept
static void | strtof (double &f, const char *str, char **endptr) noexcept
static void | strtof (long double &f, const char *str, char **endptr) noexcept

## Private Attributes

InputAdapterType | ia
| input adapter More...
const bool | ignore_comments = false
| whether comments should be ignored (true) or signaled as errors (false) More...
char_int_type | current = std::char_traits<char_type>::eof()
| the current character More...
bool | next_unget = false
| whether the next get() call should just return current More...
position_t | position {}
| the start position of the current token More...
std::vector< char_type > | token_string {}
| raw input token string (for error messages) More...
string_t | token_buffer {}
| buffer for variable-length tokens (numbers, strings) More...
const char * | error_message = ""
| a description of occurred lexer errors More...
number_integer_t | value_integer = 0
number_unsigned_t | value_unsigned = 0
number_float_t | value_float = 0
const char_int_type | decimal_point_char = '.'
| the decimal point More...

## 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) More...

## 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 6526 of file json.hpp.

## Member Typedef Documentation

## char_int_type

template<typename BasicJsonType, typename InputAdapterType>

using nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::char_int_type = typename std::char_traits<char_type>::int_type

private

Definition at line 6533 of file json.hpp.

## char_type

template<typename BasicJsonType, typename InputAdapterType>

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

private

Definition at line 6532 of file json.hpp.

## number_float_t

template<typename BasicJsonType, typename InputAdapterType>

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

private

Definition at line 6530 of file json.hpp.

## number_integer_t

template<typename BasicJsonType, typename InputAdapterType>

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

private

Definition at line 6528 of file json.hpp.

## number_unsigned_t

template<typename BasicJsonType, typename InputAdapterType>

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

private

Definition at line 6529 of file json.hpp.

## string_t

template<typename BasicJsonType, typename InputAdapterType>

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

private

Definition at line 6531 of file json.hpp.

## token_type

template<typename BasicJsonType, typename InputAdapterType>

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

Definition at line 6536 of file json.hpp.

## Constructor & Destructor Documentation

## lexer() [1/3]

template<typename BasicJsonType, typename InputAdapterType>

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

inline explicit noexcept

Definition at line 6538 of file json.hpp.

References JSON_HEDLEY_PURE.

## lexer() [2/3]

template<typename BasicJsonType, typename InputAdapterType>

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

delete

## lexer() [3/3]

template<typename BasicJsonType, typename InputAdapterType>

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

default

## ~lexer()

template<typename BasicJsonType, typename InputAdapterType>

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

default

## Member Function Documentation

## add()

template<typename BasicJsonType, typename InputAdapterType>

void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::add | ( | char_int_type | c | ) |

inline private

add a character to token_buffer

Definition at line 7816 of file json.hpp.

## get()

template<typename BasicJsonType, typename InputAdapterType>

char_int_type nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get | ( |  | ) |

inline private

Definition at line 7752 of file json.hpp.

References JSON_HEDLEY_LIKELY.

## get_codepoint()

template<typename BasicJsonType, typename InputAdapterType>

int nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get_codepoint | ( |  | ) |

inline private

get codepoint from 4 hex characters following `\u`

For input "\u c1 c2 c3 c4" the codepoint is: (c1 * 0x1000) + (c2 * 0x0100) + (c3 * 0x0010) + c4 = (c1 << 12) + (c2 << 8) + (c3 << 4) + (c4 << 0)

Furthermore, the possible characters '0'..'9', 'A'..'F', and 'a'..'f' must be converted to the integers 0x0..0x9, 0xA..0xF, 0xA..0xF, resp. The conversion is done by subtracting the offset (0x30, 0x37, and 0x57) between the ASCII value of the character and the desired integer value.

Returns
  codepoint (0x0000..0xFFFF) or -1 in case of an error (e.g. EOF or non-hex character)

Definition at line 6584 of file json.hpp.

References JSON_ASSERT.

## get_decimal_point()

template<typename BasicJsonType, typename InputAdapterType>

static JSON_HEDLEY_PURE char nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::get_decimal_point | ( |  | ) |

inline static private noexcept

return the locale-dependent decimal point

Definition at line 6558 of file json.hpp.

References JSON_ASSERT.

## get_error_message()

template<typename BasicJsonType, typename InputAdapterType>

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

inline noexcept

return syntax error message

Definition at line 7888 of file json.hpp.

## get_number_float()

template<typename BasicJsonType, typename InputAdapterType>

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

inline noexcept

return floating-point value

Definition at line 7839 of file json.hpp.

## get_number_integer()

template<typename BasicJsonType, typename InputAdapterType>

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

inline noexcept

return integer value

Definition at line 7827 of file json.hpp.

## get_number_unsigned()

template<typename BasicJsonType, typename InputAdapterType>

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

inline noexcept

return unsigned integer value

Definition at line 7833 of file json.hpp.

## get_position()

template<typename BasicJsonType, typename InputAdapterType>

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

inline noexcept

return position of last read token

Definition at line 7855 of file json.hpp.

## get_string()

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

## get_token_string()

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

References JSON_HEDLEY_RETURNS_NON_NULL, and nlohmann::detail::string.

## next_byte_in_range()

template<typename BasicJsonType, typename InputAdapterType>

bool nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::next_byte_in_range | ( | std::initializer_list< char_int_type > | ranges | ) |

inline private

check if the next byte(s) are inside a given range

Adds the current byte and, for each passed range, reads a new byte and checks if it is inside the range. If a violation was detected, set up an error message and return false. Otherwise, return true.

Parameters

  [in] | ranges | list of integers; interpreted as list of pairs of inclusive lower and upper bound, respectively

Precondition
  The passed list ranges must have 2, 4, or 6 elements; that is, 1, 2, or 3 pairs. This precondition is enforced by an assertion.

Returns
  true if and only if no range violation was detected

Definition at line 6632 of file json.hpp.

References JSON_ASSERT, and JSON_HEDLEY_LIKELY.

## operator=() [1/2]

template<typename BasicJsonType, typename InputAdapterType>

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

delete

## operator=() [2/2]

template<typename BasicJsonType, typename InputAdapterType>

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

default

## reset()

template<typename BasicJsonType, typename InputAdapterType>

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

inline private noexcept

reset token_buffer; current character is beginning of token

Definition at line 7735 of file json.hpp.

## scan()

template<typename BasicJsonType, typename InputAdapterType>

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

inline

Definition at line 7924 of file json.hpp.

Referenced by nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_high_precision_number().

## scan_comment()

template<typename BasicJsonType, typename InputAdapterType>

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

inline private

scan a comment

Returns
  whether comment could be scanned successfully

Definition at line 7259 of file json.hpp.

References JSON_HEDLEY_NON_NULL.

## scan_literal()

template<typename BasicJsonType, typename InputAdapterType>

token_type nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::scan_literal | ( | const char_type * | literal_text,
|  | const std::size_t | length,
|  | token_type | return_type
| ) |  |

inline private

Parameters

  [in] | literal_text | the literal text to expect
  [in] | length | the length of the passed literal text
  [in] | return_type | the token type to return on success

Definition at line 7715 of file json.hpp.

References JSON_ASSERT, and JSON_HEDLEY_UNLIKELY.

## scan_number()

template<typename BasicJsonType, typename InputAdapterType>

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

inline private

scan a number literal

This function scans a string according to Sect. 6 of RFC 8259.

The function is realized with a deterministic finite state machine derived from the grammar described in RFC 8259. Starting in state "init", the input is read and used to determined the next state. Only state "done" accepts the number. State "error" is a trap state to model errors. In the table below, "anything" means any character but the ones listed before.

state | 0 | 1-9 | e E | + | - | . | anything
--- | --- | --- | --- | --- | --- | --- | ---
init | zero | any1 | [error] | [error] | minus | [error] | [error]
minus | zero | any1 | [error] | [error] | [error] | [error] | [error]
zero | done | done | exponent | done | done | decimal1 | done
any1 | any1 | any1 | exponent | done | done | decimal1 | done
decimal1 | decimal2 | decimal2 | [error] | [error] | [error] | [error] | [error]
decimal2 | decimal2 | decimal2 | exponent | done | done | done | done
exponent | any2 | any2 | [error] | sign | sign | [error] | [error]
sign | any2 | any2 | [error] | [error] | [error] | [error] | [error]
any2 | any2 | any2 | done | done | done | done | done

The state machine is realized with one label per state (prefixed with "scan_number_") and `goto` statements between them. The state machine contains cycles, but any cycle can be left when EOF is read. Therefore, the function is guaranteed to terminate.

During scanning, the read bytes are stored in token_buffer. This string is then converted to a signed integer, an unsigned integer, or a floating-point number.

Returns
  token_type::value_unsigned, token_type::value_integer, or token_type::value_float if number could be successfully scanned, token_type::parse_error otherwise

Note
  The scanner is independent of the current locale. Internally, the locale's decimal point is used instead of `.` to work with the locale-dependent converters.

Definition at line 7384 of file json.hpp.

References JSON_ASSERT, and JSON_HEDLEY_NON_NULL.

## scan_string()

template<typename BasicJsonType, typename InputAdapterType>

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

inline private

scan a string literal

This function scans a string according to Sect. 7 of RFC 8259. While scanning, bytes are escaped and copied into buffer token_buffer. Then the function returns successfully, token_buffer is not null-terminated (as it may contain \0 bytes), and token_buffer.size() is the number of bytes in the string.

Returns
  token_type::value_string if string could be successfully scanned, token_type::parse_error otherwise

Note
  In case of errors, variable error_message contains a textual description.

Definition at line 6669 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_LIKELY, and JSON_HEDLEY_UNLIKELY.

## skip_bom()

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

## skip_whitespace()

template<typename BasicJsonType, typename InputAdapterType>

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

inline

Definition at line 7915 of file json.hpp.

## strtof() [1/3]

template<typename BasicJsonType, typename InputAdapterType>

static void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::strtof | ( | float & | f,
|  | const char * | str,
|  | char ** | endptr
| ) |  |

inline static private noexcept

Definition at line 7327 of file json.hpp.

References JSON_HEDLEY_NON_NULL.

## strtof() [2/3]

template<typename BasicJsonType, typename InputAdapterType>

static void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::strtof | ( | double & | f,
|  | const char * | str,
|  | char ** | endptr
| ) |  |

inline static private noexcept

Definition at line 7333 of file json.hpp.

References JSON_HEDLEY_NON_NULL.

## strtof() [3/3]

template<typename BasicJsonType, typename InputAdapterType>

static void nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::strtof | ( | long double & | f,
|  | const char * | str,
|  | char ** | endptr
| ) |  |

inline static private noexcept

Definition at line 7339 of file json.hpp.

## unget()

template<typename BasicJsonType, typename InputAdapterType>

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

inline private

unget current character (read it again on next get)

We implement unget by setting variable next_unget to true. The input is not changed - we just simulate ungetting by modifying chars_read_total, chars_read_current_line, and token_string. The next call to get() will behave as if the unget character is read again.

Definition at line 7789 of file json.hpp.

References JSON_ASSERT, and JSON_HEDLEY_LIKELY.

## Member Data Documentation

## current

template<typename BasicJsonType, typename InputAdapterType>

char_int_type nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::current = std::char_traits<char_type>::eof()

private

the current character

Definition at line 8020 of file json.hpp.

## decimal_point_char

template<typename BasicJsonType, typename InputAdapterType>

const char_int_type nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::decimal_point_char = '.'

private

the decimal point

Definition at line 8043 of file json.hpp.

## error_message

template<typename BasicJsonType, typename InputAdapterType>

const char* nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::error_message = ""

private

a description of occurred lexer errors

Definition at line 8035 of file json.hpp.

## ia

template<typename BasicJsonType, typename InputAdapterType>

InputAdapterType nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::ia

private

input adapter

Definition at line 8014 of file json.hpp.

## ignore_comments

template<typename BasicJsonType, typename InputAdapterType>

const bool nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::ignore_comments = false

private

whether comments should be ignored (true) or signaled as errors (false)

Definition at line 8017 of file json.hpp.

## next_unget

template<typename BasicJsonType, typename InputAdapterType>

bool nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::next_unget = false

private

whether the next get() call should just return current

Definition at line 8023 of file json.hpp.

## position

template<typename BasicJsonType, typename InputAdapterType>

position_t nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::position {}

private

the start position of the current token

Definition at line 8026 of file json.hpp.

## token_buffer

template<typename BasicJsonType, typename InputAdapterType>

string_t nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::token_buffer {}

private

buffer for variable-length tokens (numbers, strings)

Definition at line 8032 of file json.hpp.

## token_string

template<typename BasicJsonType, typename InputAdapterType>

std::vector<char_type> nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::token_string {}

private

raw input token string (for error messages)

Definition at line 8029 of file json.hpp.

## value_float

template<typename BasicJsonType, typename InputAdapterType>

number_float_t nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::value_float = 0

private

Definition at line 8040 of file json.hpp.

## value_integer

template<typename BasicJsonType, typename InputAdapterType>

number_integer_t nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::value_integer = 0

private

Definition at line 8038 of file json.hpp.

## value_unsigned

template<typename BasicJsonType, typename InputAdapterType>

number_unsigned_t nlohmann::detail::lexer< BasicJsonType, InputAdapterType >::value_unsigned = 0

private

Definition at line 8039 of file json.hpp.

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

- json.hpp