Library Configuration module

Preprocessor macros for configuring library functionality.

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

Defines

#define TOML_API: An annotation to add to public symbols.
#define TOML_ASSERT(expr): Sets the assert function used by the library.
#define TOML_CONFIG_HEADER: An additional header to include before any other toml++ header files.
#define TOML_ENABLE_FORMATTERS: Sets whether the various formatter classes are enabled.
#define TOML_ENABLE_PARSER: Sets whether the parser-related parts of the library are included.
#define TOML_ENABLE_UNRELEASED_FEATURES: Enables support for unreleased TOML language features not yet part of a numbered version.
#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.
#define TOML_EXCEPTIONS: Sets whether the library uses exceptions to report parsing failures.
#define TOML_HEADER_ONLY: Sets whether the library is entirely inline.
#define TOML_IMPLEMENTATION: Enables the library's implementation when TOML_HEADER_ONLY is disabled.
#define TOML_OPTIONAL_TYPE: Overrides the optional<T> type used by the library.
#define TOML_SMALL_FLOAT_TYPE: If your codebase has an additional 'small' float type (e.g. half-precision), this tells toml++ about it.
#define TOML_SMALL_INT_TYPE: If your codebase has an additional 'small' integer type (e.g. 24-bits), this tells toml++ about it.

Define documentation

#define TOML_API

An annotation to add to public symbols.

Not defined by default.

#define TOML_ASSERT(expr)

Sets the assert function used by the library.

Defaults to the standard C assert().

#define TOML_CONFIG_HEADER

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

Not defined by default.

#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_HEADER_ONLY

Sets whether the library is entirely inline.

Defaults to 1.

Remark

Disabling this means that you must define TOML_IMPLEMENTATION in exactly one translation unit in your project:

// global_header_that_includes_toml++.h
#define TOML_HEADER_ONLY 0
#include <toml.hpp>

// some_code_file.cpp
#define TOML_IMPLEMENTATION 
#include "global_header_that_includes_toml++.h"

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