toml++

toml++

Preprocessor macros for configuring library functionality.

Define these before including toml++ to alter the way it functions.

Define documentation

#define TOML_ASSERT(expr)

Sets the assert function used by the library.

Defaults to the standard C assert().

#define TOML_CALLCONV

Calling convention to apply to exported free/static functions.

Not defined by default (let the compiler decide).

#define TOML_CONFIG_HEADER

An additional header to include before any other toml++ header files.

Not defined by default.

#define TOML_DISABLE_CONDITIONAL_NOEXCEPT_LAMBDA

Disable using noexcept(<condition>) in lambda definitions within the toml++ library implementation.

This macro offers a workaround to a bug in the old "legacy lambda processor" of Visual C++, which caused compile errors like "error C2057: expected constant expression", when it encountered such lambda's. These compile errors were reported by Kevin Dick, Jan 19, 2024, at https://github.com/marzer/tomlplusplus/issues/219

#define TOML_DISABLE_NOEXCEPT_NOEXCEPT

Disable using noexcept(noexcept(<expression>)) within the toml++ library implementation.

This macro offers a workaround to a bug in Visual C++ (Visual Studio 2022), which caused compile errors, saying: "error C3878: syntax error: unexpected token ',' following 'simple-type-specifier'"

#define TOML_ENABLE_FLOAT16

Enable support for the built-in _Float16 type.

Defaults to 0.

#define TOML_ENABLE_FORMATTERS

Sets whether the various formatter classes are enabled.

Defaults to 1.

#define TOML_ENABLE_PARSER

Sets whether the parser-related parts of the library are included.

Defaults to 1.

#define TOML_ENABLE_UNRELEASED_FEATURES

Enables support for unreleased TOML language features not yet part of a numbered version.

Defaults to 0.

#define TOML_ENABLE_WINDOWS_COMPAT

Enables the use of wide strings (wchar_t, std::wstring) in various places throughout the library when building for Windows.

Defaults to 1 when building for Windows, 0 otherwise. Has no effect when building for anything other than Windows.

#define TOML_EXCEPTIONS

Sets whether the library uses exceptions to report parsing failures.

Defaults to 1 or 0 according to your compiler's exception mode.

#define TOML_EXPORTED_CLASS

An 'export' annotation to add to classes.

Not defined by default.

#define TOML_EXPORTED_FREE_FUNCTION

An 'export' annotation to add to free functions.

Not defined by default.

#define TOML_EXPORTED_MEMBER_FUNCTION

An 'export' annotation to add to non-static class member functions.

Not defined by default.

#define TOML_EXPORTED_STATIC_FUNCTION

An 'export' annotation to add to static class member functions.

Not defined by default.

#define TOML_HEADER_ONLY

Sets whether the library is entirely inline.

Defaults to 1.

#define TOML_IMPLEMENTATION

Enables the library's implementation when TOML_HEADER_ONLY is disabled.

Not defined by default. Meaningless when TOML_HEADER_ONLY is enabled.

#define TOML_OPTIONAL_TYPE

Overrides the optional<T> type used by the library.

Not defined by default (use std::optional).

#define TOML_SMALL_FLOAT_TYPE

If your codebase has an additional 'small' float type (e.g. half-precision), this tells toml++ about it.

Not defined by default.

#define TOML_SMALL_INT_TYPE

If your codebase has an additional 'small' integer type (e.g. 24-bits), this tells toml++ about it.

Not defined by default.