#include "preprocessor.hpp"
#include "array.hpp"
#include "date_time.hpp"
#include "parse_error.hpp"
#include "parser.hpp"
#include "source_region.hpp"
#include "std_optional.hpp"
#include "table.hpp"
#include "unicode.hpp"
#include "value.hpp"
#include <fstream>
#include <istream>
#include <sstream>
#include <iomanip>
#include "header_start.hpp"
#include "header_end.hpp"

Include dependency graph for parser.inl:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	utf8_byte_stream< std::basic_string_view< Char > >

class	utf8_byte_stream< std::istream >

struct	utf8_codepoint

struct	utf8_reader_interface

class	utf8_reader< T >

class	utf8_buffered_reader

struct	parse_integer_traits< 2 >

struct	parse_integer_traits< 8 >

struct	parse_integer_traits< 10 >

struct	parse_integer_traits< 16 >

struct	escaped_codepoint

struct	error_builder

struct	parse_scope

struct	parse_key_buffer

struct	depth_counter_scope

struct	parsed_string

struct	table_vector_scope

class	parser

Macros
#define	utf8_reader_error(...) err_.emplace(__VA_ARGS__)

#define	utf8_reader_return_after_error(...) return __VA_ARGS__

#define	utf8_reader_error_check(...)

#define	TOML_OVERALIGNED alignas(32)

#define	utf8_buffered_reader_error_check(...)

#define	TOML_RETURNS_BY_THROWING

#define	push_parse_scope_2(scope, line) parse_scope ps_##line(current_scope, scope)

#define	push_parse_scope_1(scope, line) push_parse_scope_2(scope, line)

#define	push_parse_scope(scope) push_parse_scope_1(scope, __LINE__)

#define	is_eof() !cp

#define	assert_not_eof() TOML_ASSERT_ASSUME(cp != nullptr)

#define	return_if_eof(...)

#define	is_error() !!err

#define	return_after_error(...) return __VA_ARGS__

#define	assert_not_error() TOML_ASSERT(!is_error())

#define	return_if_error(...)

#define	return_if_error_or_eof(...)

#define	parse_error_break() static_assert(true)

#define	set_error_and_return(ret, ...)

#define	set_error_and_return_default(...) set_error_and_return({}, __VA_ARGS__)

#define	set_error_and_return_if_eof(...)

#define	advance_and_return_if_error(...)

#define	advance_and_return_if_error_or_eof(...)

#define	TOML_PARSE_FILE_ERROR(msg, path)

Functions
template<typename Char >
	utf8_reader (std::basic_string_view< Char >, std::string_view) -> utf8_reader< std::basic_string_view< Char > >

template<typename Char >
	utf8_reader (std::basic_string_view< Char >, std::string &&) -> utf8_reader< std::basic_string_view< Char > >

template<typename Char >
	utf8_reader (std::basic_istream< Char > &, std::string_view) -> utf8_reader< std::basic_istream< Char > >

template<typename Char >
	utf8_reader (std::basic_istream< Char > &, std::string &&) -> utf8_reader< std::basic_istream< Char > >

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view	to_sv (node_type val) noexcept

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view	to_sv (const std::string &str) noexcept

TOML_CONST_GETTER TOML_INTERNAL_LINKAGE std::string_view	to_sv (bool val) noexcept

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view	to_sv (const utf8_codepoint &cp) noexcept

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view	to_sv (const utf8_codepoint *cp) noexcept

template<typename T >
TOML_INTERNAL_LINKAGE void	concatenate (char &write_pos, char const buf_end, const T &arg) noexcept

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::string_view doc, std::string_view source_path)
	Parses a TOML document from a string view.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::string_view doc, std::string &&source_path)
	Parses a TOML document from a string view.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::istream &doc, std::string_view source_path)
	Parses a TOML document from a stream.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::istream &doc, std::string &&source_path)
	Parses a TOML document from a stream.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse_file (std::string_view file_path)
	Parses a TOML document from a file.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::string_view doc, std::wstring_view source_path)
	Parses a TOML document from a string view.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse (std::istream &doc, std::wstring_view source_path)
	Parses a TOML document from a stream.

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV	parse_file (std::wstring_view file_path)
	Parses a TOML document from a file.

Variables
	TOML_DISABLE_WARNINGS

	TOML_ENABLE_WARNINGS

	TOML_ANON_NAMESPACE_START

TOML_INTERNAL_LINKAGE constexpr auto	utf8_byte_order_mark = "\xEF\xBB\xBF"sv

	TOML_ANON_NAMESPACE_END

	TOML_IMPL_NAMESPACE_START

	TOML_ABI_NAMESPACE_END

	TOML_IMPL_NAMESPACE_END

	TOML_NAMESPACE_START

	TOML_NAMESPACE_END

Macro Definition Documentation

◆ advance_and_return_if_error

#define advance_and_return_if_error ( ... )

Value:

  do {                                   \
    assert_not_eof();                    \
    advance();                           \
    return_if_error(__VA_ARGS__);        \
  } while (false)

Definition at line 867 of file parser.inl.

◆ advance_and_return_if_error_or_eof

#define advance_and_return_if_error_or_eof ( ... )

Value:

  do {                                          \
    assert_not_eof();                           \
    advance();                                  \
    return_if_error(__VA_ARGS__);               \
    set_error_and_return_if_eof(__VA_ARGS__);   \
  } while (false)

Definition at line 874 of file parser.inl.

◆ assert_not_eof

#define assert_not_eof ( ) TOML_ASSERT_ASSUME(cp != nullptr)

Definition at line 809 of file parser.inl.

◆ assert_not_error

#define assert_not_error ( ) TOML_ASSERT(!is_error())

Definition at line 824 of file parser.inl.

◆ is_eof

#define is_eof ( ) !cp

Definition at line 808 of file parser.inl.

◆ is_error

#define is_error ( ) !!err

Definition at line 822 of file parser.inl.

◆ parse_error_break

#define parse_error_break ( ) static_assert(true)

Definition at line 851 of file parser.inl.

◆ push_parse_scope

#define push_parse_scope ( scope ) push_parse_scope_1(scope, __LINE__)

Definition at line 726 of file parser.inl.

◆ push_parse_scope_1

#define push_parse_scope_1	(	scope,
		line
	)	push_parse_scope_2(scope, line)

Definition at line 725 of file parser.inl.

◆ push_parse_scope_2

#define push_parse_scope_2	(	scope,
		line
	)	parse_scope ps_##line(current_scope, scope)

Definition at line 724 of file parser.inl.

◆ return_after_error

#define return_after_error ( ... ) return __VA_ARGS__

Definition at line 823 of file parser.inl.

◆ return_if_eof

#define return_if_eof ( ... )

Value:

  do {                                              \
    if TOML_UNLIKELY (is_eof()) return __VA_ARGS__; \
  } while (false)

Definition at line 810 of file parser.inl.

◆ return_if_error

#define return_if_error ( ... )

Value:

  do {                                                \
    if TOML_UNLIKELY (is_error()) return __VA_ARGS__; \
  } while (false)

Definition at line 825 of file parser.inl.

◆ return_if_error_or_eof

#define return_if_error_or_eof ( ... )

Value:

  do {                                                            \
    if TOML_UNLIKELY (is_eof() || is_error()) return __VA_ARGS__; \
  } while (false)

Definition at line 829 of file parser.inl.

◆ set_error_and_return

#define set_error_and_return	(	ret,
		...
	)

Value:

  do {                                       \
    if (!is_error()) set_error(__VA_ARGS__); \
    return_after_error(ret);                 \
  } while (false)

Definition at line 854 of file parser.inl.

◆ set_error_and_return_default

#define set_error_and_return_default ( ... ) set_error_and_return({}, __VA_ARGS__)

Definition at line 860 of file parser.inl.

◆ set_error_and_return_if_eof

#define set_error_and_return_if_eof ( ... )

Value:

  do {                                                                                          \
    if TOML_UNLIKELY (is_eof()) set_error_and_return(__VA_ARGS__, "encountered end-of-file"sv); \
  } while (false)

Definition at line 862 of file parser.inl.

◆ TOML_OVERALIGNED

#define TOML_OVERALIGNED alignas(32)

Definition at line 192 of file parser.inl.

◆ TOML_PARSE_FILE_ERROR

#define TOML_PARSE_FILE_ERROR	(	msg,
		path
	)

Value:

  return parse_result {                                                            \
    parse_error {                                                                  \
      msg, source_position{}, std::make_shared<const std::string>(std::move(path)) \
    }                                                                              \
  }

◆ TOML_RETURNS_BY_THROWING

#define TOML_RETURNS_BY_THROWING

Definition at line 505 of file parser.inl.

◆ utf8_buffered_reader_error_check

#define utf8_buffered_reader_error_check ( ... )

Value:

  do {                                                     \
    if TOML_UNLIKELY (reader_.error()) return __VA_ARGS__; \
  } while (false)

Definition at line 407 of file parser.inl.

◆ utf8_reader_error

#define utf8_reader_error ( ... ) err_.emplace(__VA_ARGS__)

Definition at line 180 of file parser.inl.

◆ utf8_reader_error_check

#define utf8_reader_error_check ( ... )

Value:

  do {                                          \
    if TOML_UNLIKELY (err_) return __VA_ARGS__; \
  } while (false)

Definition at line 182 of file parser.inl.

◆ utf8_reader_return_after_error

#define utf8_reader_return_after_error ( ... ) return __VA_ARGS__

Definition at line 181 of file parser.inl.

Function Documentation

◆ concatenate()

template<typename T >

TOML_INTERNAL_LINKAGE void concatenate	(	char *&	write_pos,
		char *const	buf_end,
		const T &	arg
	)

noexcept

Definition at line 601 of file parser.inl.

◆ parse() [1/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::istream &	doc,
		std::string &&	source_path
	)

Parses a TOML document from a stream.

\detail \cpp std::stringstream ss; ss << "a = 3"sv;

auto tbl = toml::parse(ss, "foo.toml"); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3441 of file parser.inl.

◆ parse() [2/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::istream &	doc,
		std::string_view	source_path = `{}`
	)

Parses a TOML document from a stream.

\detail \cpp std::stringstream ss; ss << "a = 3"sv;

auto tbl = toml::parse(ss); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3436 of file parser.inl.

◆ parse() [3/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::istream &	doc,
		std::wstring_view	source_path
	)

Parses a TOML document from a stream.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

\detail \cpp std::stringstream ss; ss << "a = 3"sv;

auto tbl = toml::parse(ss); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3483 of file parser.inl.

◆ parse() [4/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::string_view	doc,
		std::string &&	source_path
	)

Parses a TOML document from a string view.

\detail \cpp auto tbl = toml::parse("a = 3"sv, "foo.toml"); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3430 of file parser.inl.

◆ parse() [5/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::string_view	doc,
		std::string_view	source_path = `{}`
	)

Parses a TOML document from a string view.

\detail \cpp auto tbl = toml::parse("a = 3"sv); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3425 of file parser.inl.

◆ parse() [6/6]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse	(	std::string_view	doc,
		std::wstring_view	source_path
	)

Parses a TOML document from a string view.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

\detail \cpp auto tbl = toml::parse("a = 3"sv, L"foo.toml"); std::cout << tbl["a"] << "\n"; \ecpp

\out 3 \eout

Parameters

doc	The TOML document to parse. Must be valid UTF-8.
source_path	The path used to initialize each node's `source().path`. If you don't have a path (or you have no intention of using paths in diagnostics) then this parameter can safely be left blank.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3477 of file parser.inl.

◆ parse_file() [1/2]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse_file ( std::string_view file_path )

Parses a TOML document from a file.

\detail \cpp toml::parse_result get_foo_toml() { return toml::parse_file("foo.toml"); } \ecpp

Parameters

file_path The TOML document to parse. Must be valid UTF-8.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3447 of file parser.inl.

◆ parse_file() [2/2]

TOML_EXTERNAL_LINKAGE parse_result TOML_CALLCONV parse_file ( std::wstring_view file_path )

Parses a TOML document from a file.

\availability This overload is only available when TOML_ENABLE_WINDOWS_COMPAT is enabled.

\detail \cpp toml::parse_result get_foo_toml() { return toml::parse_file(L"foo.toml"); } \ecpp

Parameters

file_path The TOML document to parse. Must be valid UTF-8.

Returns: \conditional_return{With exceptions} A toml::table. \conditional_return{Without exceptions} A toml::parse_result.

Definition at line 3489 of file parser.inl.

◆ to_sv() [1/5]

TOML_CONST_GETTER TOML_INTERNAL_LINKAGE std::string_view to_sv ( bool val )

noexcept

Definition at line 571 of file parser.inl.

◆ to_sv() [2/5]

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view to_sv ( const std::string & str )

noexcept

Definition at line 565 of file parser.inl.

◆ to_sv() [3/5]

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view to_sv ( const utf8_codepoint & cp )

noexcept

Definition at line 579 of file parser.inl.

◆ to_sv() [4/5]

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view to_sv ( const utf8_codepoint * cp )

noexcept

Definition at line 590 of file parser.inl.

◆ to_sv() [5/5]

TOML_PURE_GETTER TOML_INTERNAL_LINKAGE std::string_view to_sv ( node_type val )

noexcept

Definition at line 559 of file parser.inl.

◆ utf8_reader() [1/4]

template<typename Char >

utf8_reader	(	std::basic_istream< Char > &	,
		std::string &&
	)		-> utf8_reader< std::basic_istream< Char > >

◆ utf8_reader() [2/4]

template<typename Char >

utf8_reader	(	std::basic_istream< Char > &	,
		std::string_view
	)		-> utf8_reader< std::basic_istream< Char > >

◆ utf8_reader() [3/4]

template<typename Char >

utf8_reader	(	std::basic_string_view< Char >	,
		std::string &&
	)		-> utf8_reader< std::basic_string_view< Char > >

◆ utf8_reader() [4/4]

template<typename Char >

utf8_reader	(	std::basic_string_view< Char >	,
		std::string_view
	)		-> utf8_reader< std::basic_string_view< Char > >

Variable Documentation

◆ TOML_ABI_NAMESPACE_END

TOML_ABI_NAMESPACE_END

Definition at line 3330 of file parser.inl.

◆ TOML_ANON_NAMESPACE_END

TOML_ANON_NAMESPACE_END

Definition at line 496 of file parser.inl.

◆ TOML_ANON_NAMESPACE_START

TOML_ANON_NAMESPACE_START

Initial value:

{
  template <typename T>
  class utf8_byte_stream

Definition at line 43 of file parser.inl.

◆ TOML_DISABLE_WARNINGS

TOML_DISABLE_WARNINGS

Definition at line 24 of file parser.inl.

◆ TOML_ENABLE_WARNINGS

TOML_ENABLE_WARNINGS

Definition at line 36 of file parser.inl.

◆ TOML_IMPL_NAMESPACE_END

TOML_IMPL_NAMESPACE_END

Definition at line 3332 of file parser.inl.

◆ TOML_IMPL_NAMESPACE_START

TOML_IMPL_NAMESPACE_START

Initial value:

{

TOML_ABI_NAMESPACE_BOOL(TOML_EXCEPTIONS, impl_ex, impl_noex)

TOML_EXCEPTIONS

#define TOML_EXCEPTIONS

Sets whether the library uses exceptions to report parsing failures. \detail Defaults to 1 or 0 accor...

Definition preprocessor.hpp:1109

TOML_ABI_NAMESPACE_BOOL

#define TOML_ABI_NAMESPACE_BOOL(cond, T, F)

Definition preprocessor.hpp:1309

Definition at line 884 of file parser.inl.

◆ TOML_NAMESPACE_END

TOML_NAMESPACE_END

Definition at line 3507 of file parser.inl.

◆ TOML_NAMESPACE_START

TOML_NAMESPACE_START

Initial value:

{

TOML_ABI_NAMESPACE_BOOL(TOML_EXCEPTIONS, ex, noex)

Definition at line 3421 of file parser.inl.

◆ utf8_byte_order_mark

TOML_INTERNAL_LINKAGE constexpr auto utf8_byte_order_mark = "\xEF\xBB\xBF"sv

constexpr

Definition at line 48 of file parser.inl.

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ advance_and_return_if_error

◆ advance_and_return_if_error_or_eof

◆ assert_not_eof

◆ assert_not_error

◆ is_eof

◆ is_error

◆ parse_error_break

◆ push_parse_scope

◆ push_parse_scope_1

◆ push_parse_scope_2

◆ return_after_error

◆ return_if_eof

◆ return_if_error

◆ return_if_error_or_eof

◆ set_error_and_return

◆ set_error_and_return_default

◆ set_error_and_return_if_eof

◆ TOML_OVERALIGNED

◆ TOML_PARSE_FILE_ERROR

◆ TOML_RETURNS_BY_THROWING

◆ utf8_buffered_reader_error_check

◆ utf8_reader_error

◆ utf8_reader_error_check

◆ utf8_reader_return_after_error

Function Documentation

◆ concatenate()

◆ parse() [1/6]

◆ parse() [2/6]

◆ parse() [3/6]

◆ parse() [4/6]

◆ parse() [5/6]

◆ parse() [6/6]

◆ parse_file() [1/2]

◆ parse_file() [2/2]

◆ to_sv() [1/5]

◆ to_sv() [2/5]

◆ to_sv() [3/5]

◆ to_sv() [4/5]

◆ to_sv() [5/5]

◆ utf8_reader() [1/4]

◆ utf8_reader() [2/4]

◆ utf8_reader() [3/4]

◆ utf8_reader() [4/4]

Variable Documentation

◆ TOML_ABI_NAMESPACE_END

◆ TOML_ANON_NAMESPACE_END

◆ TOML_ANON_NAMESPACE_START

◆ TOML_DISABLE_WARNINGS

◆ TOML_ENABLE_WARNINGS

◆ TOML_IMPL_NAMESPACE_END

◆ TOML_IMPL_NAMESPACE_START

◆ TOML_NAMESPACE_END

◆ TOML_NAMESPACE_START

◆ utf8_byte_order_mark