general/tomlplusplus
2
0
Fork 0
mirror of https://github.com/marzer/tomlplusplus.git synced 2026-02-14 01:12:13 +00:00
Code Issues Projects Releases Wiki Activity
Files
cfeeb586bf4606d9e013eb8b2603f7958e2e5967
tomlplusplus/group__configuration.html
marzer 36b1777dd2 deploy: 12f9c67bd7
2022-10-16 10:27:43 +00:00

334 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en"><head>
<meta charset="utf-8"/>
<title>Library Configuration module | toml++ TOML for C++</title>
<link href="favicon.ico" rel="icon" type="image/vnd.microsoft.icon"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta content="#22272e" name="theme-color"/>
<link href="poxy/poxy.css" referrerpolicy="no-referrer" rel="stylesheet"/>
<script src="poxy/poxy.js"></script>
<script>initialize_theme("dark");</script>
<meta content="toml++" name="twitter:title"/>
<meta content="toml++" property="og:title"/>
<meta content="toml++" itemprop="name"/>
<meta content="Mark Gillard" name="author"/>
<meta content="Mark Gillard" property="article:author"/>
<meta content="TOML for C++" name="description"/>
<meta content="TOML for C++" name="twitter:description"/>
<meta content="TOML for C++" property="og:description"/>
<meta content="TOML for C++" itemprop="description"/>
<meta content="telephone=no" name="format-detection"/>
<meta content="Poxy v0.10.2" name="generator"/>
<meta content="strict-origin-when-cross-origin" name="referrer"/>
<meta content="gbtcNgKlNiPSMKkYMw4zWFVWGPH_oU93m9n_-nb4qK8" name="google-site-verification"/>
</head>
<body class="poxy-has-toc">
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a class="m-col-t-8 m-col-m-none m-left-m" href="index.html" id="m-navbar-brand"><svg class="poxy-injected-svg" id="poxy-injected-svg-0" version="1.1" viewBox="0 0 306 306" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><polygon fill="currentColor" points="0 0 0 306 67.79 306 67.79 273.09 35.1 273.09 35.1 33.62 67.79 33.62 67.79 0 0 0"></polygon><polygon fill="currentColor" points="237.62 0 237.62 33.62 270.3 33.62 270.3 273.09 237.62 273.09 237.62 306 306 306 306 0 237.62 0"></polygon><polygon fill="currentColor" points="127.3 247.43 127.3 109.37 172.72 109.37 172.72 77.69 48.41 77.69 48.41 109.37 94.43 109.37 94.43 247.43 127.3 247.43"></polygon><polygon fill="currentColor" points="256.69 163.46 241.45 163.46 241.45 148.22 222.33 148.22 222.33 163.46 207.09 163.46 207.09 182.58 222.33 182.58 222.33 197.82 241.45 197.82 241.45 182.58 256.69 182.58 256.69 163.46"></polygon><polygon fill="currentColor" points="192.74 163.46 177.5 163.46 177.5 148.22 158.38 148.22 158.38 163.46 143.14 163.46 143.14 182.58 158.38 182.58 158.38 197.82 177.5 197.82 177.5 182.58 192.74 182.58 192.74 163.46"></polygon></svg>toml++ <span class="m-thin">TOML for C++</span></a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z" id="m-doc-search-icon-path"></path>
</svg></a>
<a href="#navigation" id="m-navbar-show" title="Show navigation"></a>
<a href="#" id="m-navbar-hide" title="Hide navigation"></a>
</div>
<div class="m-col-t-12 m-show-m m-col-m-none m-right-m" id="m-navbar-collapse">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a class="poxy-icon repo github poxy-external" href="https://github.com/marzer/tomlplusplus" target="_blank" title="View on GitHub"><svg id="poxy-repo-icon" version="1.1" viewBox="0 0 50 50" xmlns="http://www.w3.org/2000/svg"><path d="M25,1.23a24.37,24.37,0,0,0-7.7,47.5C18.51,49,19,48.2,19,47.56s0-2.12,0-4.15c-6.78,1.47-8.21-3.27-8.21-3.27C9.61,37.33,8,36.58,8,36.58c-2.21-1.51.17-1.48.17-1.48a5.12,5.12,0,0,1,3.73,2.51c2.17,3.72,5.7,2.65,7.09,2a5.25,5.25,0,0,1,1.55-3.26c-5.41-.61-11.1-2.7-11.1-12A9.41,9.41,0,0,1,12,17.79a8.75,8.75,0,0,1,.24-6.45s2-.66,6.7,2.49a23.1,23.1,0,0,1,12.2,0c4.66-3.15,6.7-2.49,6.7-2.49A8.75,8.75,0,0,1,38,17.79a9.41,9.41,0,0,1,2.51,6.54c0,9.36-5.7,11.42-11.13,12a5.83,5.83,0,0,1,1.65,4.51c0,3.26,0,5.89,0,6.69,0,.65.44,1.41,1.68,1.17A24.38,24.38,0,0,0,25,1.23Z" fill="currentColor"></path></svg></a></li>
<li><a class="poxy-icon theme" href="javascript:void(null);" id="poxy-theme-switch" onclick="toggle_theme(); return false;" role="button" title="Toggle dark and light themes"><svg id="poxy-theme-switch-img" version="1.1" viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><circle cx="185.6708" cy="183.8122" fill="currentColor" r="65.625"></circle><path d="M185.6708,87.5622a13.1256,13.1256,0,0,0,13.125-13.125V52.5622a13.125,13.125,0,1,0-26.25,0v21.875A13.1257,13.1257,0,0,0,185.6708,87.5622Z" fill="currentColor"></path><path d="M99.051,115.7519a13.1236,13.1236,0,1,0,18.56-18.56L102.1442,81.726a13.1236,13.1236,0,0,0-18.5595,18.56Z" fill="currentColor"></path><path d="M89.4208,183.8122a13.1257,13.1257,0,0,0-13.125-13.125H54.4208a13.125,13.125,0,0,0,0,26.25h21.875A13.1256,13.1256,0,0,0,89.4208,183.8122Z" fill="currentColor"></path><path d="M99.051,251.8725,83.5847,267.3431a13.1236,13.1236,0,1,0,18.56,18.56l15.4663-15.4706a13.1236,13.1236,0,1,0-18.5595-18.56Z" fill="currentColor"></path><path d="M185.6708,280.0622a13.1258,13.1258,0,0,0-13.125,13.125v21.875a13.125,13.125,0,0,0,26.25,0v-21.875A13.1257,13.1257,0,0,0,185.6708,280.0622Z" fill="currentColor"></path><path d="M272.2907,251.8725a13.1236,13.1236,0,1,0-18.56,18.56l15.4663,15.4706a13.1236,13.1236,0,1,0,18.56-18.56Z" fill="currentColor"></path><path d="M330.0458,183.8122a13.1257,13.1257,0,0,0-13.125-13.125h-21.875a13.125,13.125,0,0,0,0,26.25h21.875A13.1256,13.1256,0,0,0,330.0458,183.8122Z" fill="currentColor"></path><path d="M263.0109,119.5971a13.0824,13.0824,0,0,0,9.28-3.8452l15.4663-15.4663a13.1236,13.1236,0,1,0-18.56-18.56L253.7312,97.1923a13.125,13.125,0,0,0,9.28,22.4048Z" fill="currentColor"></path><path d="M456.9379,401.6714a63.97,63.97,0,0,1-14.9963,7.2055c-19.6448,6.5283-41.8787,2.9566-58.1439-9.8523a68.9311,68.9311,0,0,1-10.835-10.8339c-12.8088-16.2663-16.3806-38.5-9.8523-58.1471a63.8444,63.8444,0,0,1,7.2077-14.9931,8.8036,8.8036,0,0,0-10.1172-13.3034,87.5188,87.5188,0,1,0,110.0372,110.04A8.8,8.8,0,0,0,456.9379,401.6714Z" fill="currentColor"></path></svg></a></li>
<li class="m-show-m"><a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path"></use>
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
Library Configuration <span class="m-thin">module</span></h1>
<p>Preprocessor macros for configuring library functionality.</p>
<nav class="m-block m-default poxy-toc" id="poxy-toc">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#define-members">Defines</a></li>
</ul>
</li>
</ul>
</nav>
<p>Define these before including toml++ to alter the way it functions.</p><aside class="m-note m-default"><h4>Remark</h4><p>Some of these options have ABI implications; inline namespaces are used to prevent you from trying to link incompatible combinations together.</p></aside>
<section id="define-members">
<h2><a href="#define-members">Defines</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga8c407a8f6fe52a795db35be3f00393f8">TOML_ASSERT</a>(</span><span class="m-doc-wrap">expr)</span>
</dt>
<dd>Sets the assert function used by the library.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga2bfc7ae4747f15378d92249aadce019e">TOML_CALLCONV</a></span>
</dt>
<dd>Calling convention to apply to exported free/static functions.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga09204feb4a3ff5534623c2bd052dcec0">TOML_CONFIG_HEADER</a></span>
</dt>
<dd>An additional header to include before any other toml++ header files.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga9fc77582d9de77f59d2ddc9ae1f748ca">TOML_ENABLE_FORMATTERS</a></span>
</dt>
<dd>Sets whether the various formatter classes are enabled.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga121912d75d4624de6ab6854e41d8a852">TOML_ENABLE_PARSER</a></span>
</dt>
<dd>Sets whether the parser-related parts of the library are included.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga1110ff7d189a7738b9109d120f568b6b">TOML_ENABLE_UNRELEASED_FEATURES</a></span>
</dt>
<dd>Enables support for unreleased TOML language features not yet part of a <a class="poxy-external" href="https://github.com/toml-lang/toml/releases" target="_blank">numbered version</a>.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga94867db67c98e0e9d4fbb70690951fbf">TOML_ENABLE_WINDOWS_COMPAT</a></span>
</dt>
<dd>Enables the use of wide strings (<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">wchar_t</a>, <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>wstring</a>) in various places throughout the library when building for Windows.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga93097ecd88ca4bca393f60a78bda643b">TOML_EXCEPTIONS</a></span>
</dt>
<dd>Sets whether the library uses exceptions to report parsing failures.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga3d7aebf91431575688d573f09a17559a">TOML_EXPORTED_CLASS</a></span>
</dt>
<dd>An 'export' annotation to add to classes.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#gac40a454cde06de4e76df3d6d460a3544">TOML_EXPORTED_FREE_FUNCTION</a></span>
</dt>
<dd>An 'export' annotation to add to free functions.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#gadf515bb7a6b8ce6b14bf86c8961a63cb">TOML_EXPORTED_MEMBER_FUNCTION</a></span>
</dt>
<dd>An 'export' annotation to add to non-static class member functions.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga8436c6f378c73f3446a3b6f1e2c5e81c">TOML_EXPORTED_STATIC_FUNCTION</a></span>
</dt>
<dd>An 'export' annotation to add to <code>static</code> class member functions.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga8219bfd7e75587516385b6022b28abc2">TOML_HEADER_ONLY</a></span>
</dt>
<dd>Sets whether the library is entirely inline.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga27ee69835a1ddff9dbaf3015b4b08a11">TOML_IMPLEMENTATION</a></span>
</dt>
<dd>Enables the library's implementation when <a class="m-doc" href="group__configuration.html#ga8219bfd7e75587516385b6022b28abc2">TOML_<wbr/>HEADER_<wbr/>ONLY</a> is disabled.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga9c2c03f867eb6d76a5f65b06eeb1186e">TOML_OPTIONAL_TYPE</a></span>
</dt>
<dd>Overrides the <code>optional&lt;T&gt;</code> type used by the library.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga11a3368da40938a6b5cfd898320706f7">TOML_SMALL_FLOAT_TYPE</a></span>
</dt>
<dd>If your codebase has an additional 'small' float type (e.g. half-precision), this tells toml++ about it.</dd>
<dt>
<span class="m-doc-wrap-bumper">#define <a class="m-doc" href="#ga0722fa2c57da6360c7f2ba08c60e1a81">TOML_SMALL_INT_TYPE</a></span>
</dt>
<dd>If your codebase has an additional 'small' integer type (e.g. 24-bits), this tells toml++ about it.</dd>
</dl>
</section>
<section>
<h2>Define documentation</h2>
<section class="m-doc-details" id="ga8c407a8f6fe52a795db35be3f00393f8"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga8c407a8f6fe52a795db35be3f00393f8">TOML_ASSERT</a>(</span><span class="m-doc-wrap">expr)</span>
</h3>
<p>Sets the assert function used by the library.</p>
<p>Defaults to the standard C <code>assert()</code>.</p>
</div></section>
<section class="m-doc-details" id="ga2bfc7ae4747f15378d92249aadce019e"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga2bfc7ae4747f15378d92249aadce019e">TOML_CALLCONV</a></span>
</h3>
<p>Calling convention to apply to exported free/static functions.</p>
<p>Not defined by default (let the compiler decide).</p>
</div></section>
<section class="m-doc-details" id="ga09204feb4a3ff5534623c2bd052dcec0"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga09204feb4a3ff5534623c2bd052dcec0">TOML_CONFIG_HEADER</a></span>
</h3>
<p>An additional header to include before any other toml++ header files.</p>
<p>Not defined by default.</p>
</div></section>
<section class="m-doc-details" id="ga9fc77582d9de77f59d2ddc9ae1f748ca"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga9fc77582d9de77f59d2ddc9ae1f748ca">TOML_ENABLE_FORMATTERS</a></span>
</h3>
<p>Sets whether the various formatter classes are enabled.</p>
<p>Defaults to <code>1</code>.</p><aside class="m-note m-default"><h4>Remark</h4><p>If you don't need to re-serialize TOML data, setting <code>TOML_ENABLE_FORMATTERS</code> to <code>0</code> can improve compilation speed and reduce binary size.</p></aside><aside class="m-note m-default"><h4>See also</h4><ul><li><a class="m-doc" href="classtoml_1_1toml__formatter.html">toml::<wbr/>toml_formatter</a></li><li><a class="m-doc" href="classtoml_1_1json__formatter.html">toml::<wbr/>json_formatter</a></li><li><a class="m-doc" href="classtoml_1_1yaml__formatter.html">toml::<wbr/>yaml_formatter</a></li></ul></aside>
</div></section>
<section class="m-doc-details" id="ga121912d75d4624de6ab6854e41d8a852"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga121912d75d4624de6ab6854e41d8a852">TOML_ENABLE_PARSER</a></span>
</h3>
<p>Sets whether the parser-related parts of the library are included.</p>
<p>Defaults to <code>1</code>.</p><aside class="m-note m-default"><h4>Remark</h4><p>If you don't parse any TOML from files or strings, setting <code>TOML_ENABLE_PARSER</code> to <code>0</code> can improve compilation speed and reduce binary size.</p></aside>
</div></section>
<section class="m-doc-details" id="ga1110ff7d189a7738b9109d120f568b6b"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga1110ff7d189a7738b9109d120f568b6b">TOML_ENABLE_UNRELEASED_FEATURES</a></span>
</h3>
<p>Enables support for unreleased TOML language features not yet part of a <a class="poxy-external" href="https://github.com/toml-lang/toml/releases" target="_blank">numbered version</a>.</p>
<p>Defaults to <code>0</code>.</p><aside class="m-note m-default"><h4>See also</h4><p><a class="poxy-external" href="https://github.com/marzer/tomlplusplus/blob/master/README.md#toml-language-support" target="_blank">TOML Language Support</a></p></aside>
</div></section>
<section class="m-doc-details" id="ga94867db67c98e0e9d4fbb70690951fbf"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga94867db67c98e0e9d4fbb70690951fbf">TOML_ENABLE_WINDOWS_COMPAT</a></span>
</h3>
<p>Enables the use of wide strings (<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/language/types#Character_types" target="_blank">wchar_t</a>, <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>wstring</a>) in various places throughout the library when building for Windows.</p>
<p>Defaults to <code>1</code> when building for Windows, <code>0</code> otherwise. Has no effect when building for anything other than Windows.</p><aside class="m-note m-default"><h4>Remark</h4><p>This <strong>does not</strong> change the underlying string type used to represent TOML keys and string values; that will still be <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>. This setting simply enables some narrow &lt;=&gt; wide string conversions when necessary at various interface boundaries.<br/><br/>If you're building for Windows and you have no need for Windows' "Pretends-to-be-unicode" wide strings, you can safely set this to <code>0</code>.</p></aside>
</div></section>
<section class="m-doc-details" id="ga93097ecd88ca4bca393f60a78bda643b"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga93097ecd88ca4bca393f60a78bda643b">TOML_EXCEPTIONS</a></span>
</h3>
<p>Sets whether the library uses exceptions to report parsing failures.</p>
<p>Defaults to <code>1</code> or <code>0</code> according to your compiler's exception mode.</p>
</div></section>
<section class="m-doc-details" id="ga3d7aebf91431575688d573f09a17559a"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga3d7aebf91431575688d573f09a17559a">TOML_EXPORTED_CLASS</a></span>
</h3>
<p>An 'export' annotation to add to classes.</p>
<p>Not defined by default.</p><aside class="m-note m-default"><h4>Remark</h4><p>You might override this with <code>__declspec(dllexport)</code> if you were building the library into the public API of a DLL on Windows.</p></aside>
</div></section>
<section class="m-doc-details" id="gac40a454cde06de4e76df3d6d460a3544"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#gac40a454cde06de4e76df3d6d460a3544">TOML_EXPORTED_FREE_FUNCTION</a></span>
</h3>
<p>An 'export' annotation to add to free functions.</p>
<p>Not defined by default.</p><aside class="m-note m-default"><h4>Remark</h4><p>You might override this with <code>__declspec(dllexport)</code> if you were building the library into the public API of a DLL on Windows.</p></aside>
</div></section>
<section class="m-doc-details" id="gadf515bb7a6b8ce6b14bf86c8961a63cb"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#gadf515bb7a6b8ce6b14bf86c8961a63cb">TOML_EXPORTED_MEMBER_FUNCTION</a></span>
</h3>
<p>An 'export' annotation to add to non-static class member functions.</p>
<p>Not defined by default.</p><aside class="m-note m-default"><h4>Remark</h4><p>You might override this with <code>__declspec(dllexport)</code> if you were building the library into the public API of a DLL on Windows.</p></aside>
</div></section>
<section class="m-doc-details" id="ga8436c6f378c73f3446a3b6f1e2c5e81c"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga8436c6f378c73f3446a3b6f1e2c5e81c">TOML_EXPORTED_STATIC_FUNCTION</a></span>
</h3>
<p>An 'export' annotation to add to <code>static</code> class member functions.</p>
<p>Not defined by default.</p><aside class="m-note m-default"><h4>Remark</h4><p>You might override this with <code>__declspec(dllexport)</code> if you were building the library into the public API of a DLL on Windows.</p></aside>
</div></section>
<section class="m-doc-details" id="ga8219bfd7e75587516385b6022b28abc2"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga8219bfd7e75587516385b6022b28abc2">TOML_HEADER_ONLY</a></span>
</h3>
<p>Sets whether the library is entirely inline.</p>
<p>Defaults to <code>1</code>.</p><aside class="m-note m-default"><h4>Remark</h4><p>Disabling this means that you must define <a class="m-doc" href="group__configuration.html#ga27ee69835a1ddff9dbaf3015b4b08a11">TOML_<wbr/>IMPLEMENTATION</a> in <strong><em>exactly one</em></strong> translation unit in your project:</p><pre class="m-code"><span class="c1">// global_header_that_includes_toml++.h</span>
<span class="cp">#define </span><span class="fm">TOML_HEADER_ONLY</span><span class="cp"> 0</span>
<span class="cp">#include</span> <span class="cpf">&lt;toml.hpp&gt;</span>
<span class="c1">// some_code_file.cpp</span>
<span class="cp">#define </span><span class="fm">TOML_IMPLEMENTATION</span>
<span class="cp">#include</span> <span class="cpf">"global_header_that_includes_toml++.h"</span></pre></aside>
</div></section>
<section class="m-doc-details" id="ga27ee69835a1ddff9dbaf3015b4b08a11"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga27ee69835a1ddff9dbaf3015b4b08a11">TOML_IMPLEMENTATION</a></span>
</h3>
<p>Enables the library's implementation when <a class="m-doc" href="group__configuration.html#ga8219bfd7e75587516385b6022b28abc2">TOML_<wbr/>HEADER_<wbr/>ONLY</a> is disabled.</p>
<p>Not defined by default. Meaningless when <a class="m-doc" href="group__configuration.html#ga8219bfd7e75587516385b6022b28abc2">TOML_<wbr/>HEADER_<wbr/>ONLY</a> is enabled.</p>
</div></section>
<section class="m-doc-details" id="ga9c2c03f867eb6d76a5f65b06eeb1186e"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga9c2c03f867eb6d76a5f65b06eeb1186e">TOML_OPTIONAL_TYPE</a></span>
</h3>
<p>Overrides the <code>optional&lt;T&gt;</code> type used by the library.</p>
<p>Not defined by default (use <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/utility/optional.html" target="_blank">std::<wbr/>optional</a>).</p><aside class="m-note m-danger"><h4>Warning</h4><p>The library uses optionals internally in a few places; if you choose to replace the optional type it must be with something that is still API-compatible with <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/utility/optional.html" target="_blank">std::<wbr/>optional</a> (e.g. <a class="poxy-external" href="https://github.com/TartanLlama/optional" target="_blank">tl::<wbr/>optional</a>).</p></aside>
</div></section>
<section class="m-doc-details" id="ga11a3368da40938a6b5cfd898320706f7"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga11a3368da40938a6b5cfd898320706f7">TOML_SMALL_FLOAT_TYPE</a></span>
</h3>
<p>If your codebase has an additional 'small' float type (e.g. half-precision), this tells toml++ about it.</p>
<p>Not defined by default.</p><aside class="m-note m-default"><h4>Remark</h4><p>If you're building for a platform that has <code><a class="m-doc poxy-injected poxy-external" href="https://gcc.gnu.org/onlinedocs/gcc/Half-Precision.html" target="_blank">_Float16</a></code> and/or <code><a class="m-doc poxy-injected poxy-external" href="https://gcc.gnu.org/onlinedocs/gcc/Half-Precision.html" target="_blank">__fp16</a></code>, you don't need to use this configuration option to make toml++ aware of them. The library comes with that built-in.</p></aside>
</div></section>
<section class="m-doc-details" id="ga0722fa2c57da6360c7f2ba08c60e1a81"><div>
<h3>
<span class="m-doc-wrap-bumper">#define <a class="m-doc-self" href="#ga0722fa2c57da6360c7f2ba08c60e1a81">TOML_SMALL_INT_TYPE</a></span>
</h3>
<p>If your codebase has an additional 'small' integer type (e.g. 24-bits), this tells toml++ about it.</p>
<p>Not defined by default.</p>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form>
<input autocomplete="off" autofocus="autofocus" disabled="disabled" id="search-input" name="q" placeholder="Loading …" spellcheck="false" type="search"/>
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
<div class="m-text m-dim m-text-center" id="search-help">
<p class="m-noindent">Search for symbols, directories, files, pages or
modules. You can omit any prefix from the symbol or file path; adding a
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
/ <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
copy a link to the result using <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
</div>
<div class="m-text m-warning m-text-center" id="search-notfound">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v2.js"></script>
<script async="async" src="searchdata-v2.js"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus" target="_blank">GitHub</a>
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/issues" target="_blank">Report an issue</a>
• <a href="md_poxy_changelog.html">Changelog</a>
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/blob/master/LICENSE" target="_blank">License</a>
• <a download="" href="toml++.tagfile.xml" target="_blank" type="text/xml">Doxygen tagfile</a>
<br/><br/>
Site generated using <a class="poxy-external" href="https://github.com/marzer/poxy/" target="_blank">Poxy</a>
</div>
</div>
</div>
</nav></footer>
</body></html>
Reference in New Issue View Git Blame Copy Permalink