tboudreaux/libconfig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
46dce35eaf0fa522d9478f791bdf2c22375555f7
libconfig/docs/html/namespacefourdst_1_1config.html

321 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libconfig: fourdst::config Namespace Reference</title>
<link rel="icon" href="logo.png" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">libconfig<span id="projectnumber">&#160;v2.1.0</span>
</div>
<div id="projectbrief">Reflection based C++ configuration library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespacefourdst_1_1config.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">fourdst::config Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefourdst_1_1config_1_1exceptions.html">exceptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfourdst_1_1config_1_1_config.html">Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper class for managing strongly-typed configuration structures. <a href="classfourdst_1_1config_1_1_config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfourdst_1_1config_1_1_inspect_type.html">InspectType</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfourdst_1_1config_1_1is__config__wrapper.html">is_config_wrapper</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type trait to determine if a type is a <a class="el" href="classfourdst_1_1config_1_1_config.html" title="Wrapper class for managing strongly-typed configuration structures.">Config</a> wrapper. <a href="structfourdst_1_1config_1_1is__config__wrapper.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfourdst_1_1config_1_1is__config__wrapper_3_01_config_3_01_t_01_4_01_4.html">is_config_wrapper&lt; Config&lt; T &gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of <code><a class="el" href="structfourdst_1_1config_1_1is__config__wrapper.html" title="Type trait to determine if a type is a Config wrapper.">is_config_wrapper</a></code> for <code><a class="el" href="classfourdst_1_1config_1_1_config.html" title="Wrapper class for managing strongly-typed configuration structures.">Config</a>&lt;T&gt;</code>. <a href="structfourdst_1_1config_1_1is__config__wrapper_3_01_config_3_01_t_01_4_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="conceptfourdst_1_1config_1_1_is_config_schema.html">IsConfigSchema</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept ensuring a type is suitable for configuration schema. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="conceptfourdst_1_1config_1_1_is_c_l_i_app.html">IsCLIApp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept that defines the requirements for a CLI application class. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a9870cefcd568dac301257ca35b73ab14" id="r_a9870cefcd568dac301257ca35b73ab14"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9870cefcd568dac301257ca35b73ab14">RootNameLoadPolicy</a> { <a class="el" href="#a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729">FROM_FILE</a>
, <a class="el" href="#a9870cefcd568dac301257ca35b73ab14a88b20772e9853307149861fa7e01e918">KEEP_CURRENT</a>
}</td></tr>
<tr class="memdesc:a9870cefcd568dac301257ca35b73ab14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Policies for handling the root name during configuration loading. <a href="#a9870cefcd568dac301257ca35b73ab14">More...</a><br /></td></tr>
<tr class="separator:a9870cefcd568dac301257ca35b73ab14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18da8b2ec98ddd0a28e61644ce795b7e" id="r_a18da8b2ec98ddd0a28e61644ce795b7e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18da8b2ec98ddd0a28e61644ce795b7e">ConfigState</a> { <a class="el" href="#a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee">DEFAULT</a>
, <a class="el" href="#a18da8b2ec98ddd0a28e61644ce795b7eac24435b28cc6d977d5d7804236dca3db">LOADED_FROM_FILE</a>
}</td></tr>
<tr class="memdesc:a18da8b2ec98ddd0a28e61644ce795b7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the current state of a Config object. <a href="#a18da8b2ec98ddd0a28e61644ce795b7e">More...</a><br /></td></tr>
<tr class="separator:a18da8b2ec98ddd0a28e61644ce795b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aeca53bef637c1b60bf5fbccc8526a7a0" id="r_aeca53bef637c1b60bf5fbccc8526a7a0"><td class="memTemplParams" colspan="2">template&lt;typename T, typename CliApp&gt; </td></tr>
<tr class="memitem:aeca53bef637c1b60bf5fbccc8526a7a0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aeca53bef637c1b60bf5fbccc8526a7a0">register_as_cli</a> (T &amp;config, CliApp &amp;app, const std::string &amp;prefix=&quot;&quot;)</td></tr>
<tr class="memdesc:aeca53bef637c1b60bf5fbccc8526a7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers configuration structure fields as CLI options. <br /></td></tr>
<tr class="separator:aeca53bef637c1b60bf5fbccc8526a7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a18da8b2ec98ddd0a28e61644ce795b7e" name="a18da8b2ec98ddd0a28e61644ce795b7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18da8b2ec98ddd0a28e61644ce795b7e">&#9670;&#160;</a></span>ConfigState</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a18da8b2ec98ddd0a28e61644ce795b7e">fourdst::config::ConfigState</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Represents the current state of a <a class="el" href="classfourdst_1_1config_1_1_config.html" title="Wrapper class for managing strongly-typed configuration structures.">Config</a> object. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee" name="a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee"></a>DEFAULT&#160;</td><td class="fielddoc"><p>Configuration contains default values and has not been loaded from a file. </p>
</td></tr>
<tr><td class="fieldname"><a id="a18da8b2ec98ddd0a28e61644ce795b7eac24435b28cc6d977d5d7804236dca3db" name="a18da8b2ec98ddd0a28e61644ce795b7eac24435b28cc6d977d5d7804236dca3db"></a>LOADED_FROM_FILE&#160;</td><td class="fielddoc"><p>Configuration has been successfully populated from a file. </p>
</td></tr>
</table>
</div>
</div>
<a id="a9870cefcd568dac301257ca35b73ab14" name="a9870cefcd568dac301257ca35b73ab14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9870cefcd568dac301257ca35b73ab14">&#9670;&#160;</a></span>RootNameLoadPolicy</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a9870cefcd568dac301257ca35b73ab14">fourdst::config::RootNameLoadPolicy</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Policies for handling the root name during configuration loading. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729" name="a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729"></a>FROM_FILE&#160;</td><td class="fielddoc"><p>Updates the internal root name to match what is found in the file. </p>
</td></tr>
<tr><td class="fieldname"><a id="a9870cefcd568dac301257ca35b73ab14a88b20772e9853307149861fa7e01e918" name="a9870cefcd568dac301257ca35b73ab14a88b20772e9853307149861fa7e01e918"></a>KEEP_CURRENT&#160;</td><td class="fielddoc"><p>Enforces the current internal root name; loading fails if the file's root name differs. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aeca53bef637c1b60bf5fbccc8526a7a0" name="aeca53bef637c1b60bf5fbccc8526a7a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeca53bef637c1b60bf5fbccc8526a7a0">&#9670;&#160;</a></span>register_as_cli()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename CliApp&gt; </div>
<table class="memname">
<tr>
<td class="memname">void fourdst::config::register_as_cli </td>
<td>(</td>
<td class="paramtype">T &amp;</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CliApp &amp;</td> <td class="paramname"><span class="paramname"><em>app</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>prefix</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&quot;&quot;</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers configuration structure fields as CLI options. </p>
<p>This function iterates over the members of the provided configuration object using reflection and registers each member as a command-line option in the provided CLI application.</p>
<p>If the configuration object contains nested structures, field names are flattened using dot notation (e.g., <code>parent.child.field</code>).</p>
<p>If <code>T</code> is a <code><a class="el" href="classfourdst_1_1config_1_1_config.html" title="Wrapper class for managing strongly-typed configuration structures.">Config</a>&lt;U&gt;</code> wrapper, it automatically unwraps the inner value and adds a footer note to the CLI application's help message indicating that options were auto-generated.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of the configuration object. Can be a raw struct or a <code><a class="el" href="classfourdst_1_1config_1_1_config.html" title="Wrapper class for managing strongly-typed configuration structures.">Config</a>&lt;Struct&gt;</code> wrapper. </td></tr>
<tr><td class="paramname">CliApp</td><td>The type of the CLI application object. Must satisfy the <code><a class="el" href="conceptfourdst_1_1config_1_1_is_c_l_i_app.html" title="Concept that defines the requirements for a CLI application class.">IsCLIApp</a></code> concept (e.g., <code>CLI::App</code>). </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>The configuration object to register. </td></tr>
<tr><td class="paramname">app</td><td>The CLI application instance to add options to. </td></tr>
<tr><td class="paramname">prefix</td><td>Optional prefix for option names. Used internally for recursion; usually omitted by the caller.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Examples</dt><dd>Basic usage with CLI11: <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;CLI/CLI.hpp&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="config_8h.html">fourdst/config/config.h</a>&quot;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">struct </span>MyOptions {</div>
<div class="line"> <span class="keywordtype">int</span> verbosity = 0;</div>
<div class="line"> std::string input_file = <span class="stringliteral">&quot;data.txt&quot;</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div>
<div class="line"> <a class="code hl_class" href="classfourdst_1_1config_1_1_config.html">fourdst::config::Config&lt;MyOptions&gt;</a> cfg;</div>
<div class="line"> CLI::App app{<span class="stringliteral">&quot;My Application&quot;</span>};</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Automatically adds flags: --verbosity, --input_file</span></div>
<div class="line"> <a class="code hl_function" href="#aeca53bef637c1b60bf5fbccc8526a7a0">fourdst::config::register_as_cli</a>(cfg, app);</div>
<div class="line"> </div>
<div class="line"> CLI11_PARSE(app, argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// cfg is now populated with values from CLI</span></div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aclassfourdst_1_1config_1_1_config_html"><div class="ttname"><a href="classfourdst_1_1config_1_1_config.html">fourdst::config::Config</a></div><div class="ttdoc">Wrapper class for managing strongly-typed configuration structures.</div><div class="ttdef"><b>Definition</b> base.h:113</div></div>
<div class="ttc" id="aconfig_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Main entry point for the fourdst::config library.</div></div>
<div class="ttc" id="anamespacefourdst_1_1config_html_aeca53bef637c1b60bf5fbccc8526a7a0"><div class="ttname"><a href="#aeca53bef637c1b60bf5fbccc8526a7a0">fourdst::config::register_as_cli</a></div><div class="ttdeci">void register_as_cli(T &amp;config, CliApp &amp;app, const std::string &amp;prefix=&quot;&quot;)</div><div class="ttdoc">Registers configuration structure fields as CLI options.</div><div class="ttdef"><b>Definition</b> cli.h:114</div></div>
</div><!-- fragment --></dd></dl>
<p>Nested structures: </p><div class="fragment"><div class="line"><span class="keyword">struct </span>Server {</div>
<div class="line"> <span class="keywordtype">int</span> port = 8080;</div>
<div class="line"> std::string host = <span class="stringliteral">&quot;localhost&quot;</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keyword">struct </span>AppConfig {</div>
<div class="line"> Server server;</div>
<div class="line"> <span class="keywordtype">bool</span> dry_run = <span class="keyword">false</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// In main...</span></div>
<div class="line"><a class="code hl_class" href="classfourdst_1_1config_1_1_config.html">fourdst::config::Config&lt;AppConfig&gt;</a> cfg;</div>
<div class="line"><span class="comment">// Registers: --server.port, --server.host, --dry_run</span></div>
<div class="line"><a class="code hl_function" href="#aeca53bef637c1b60bf5fbccc8526a7a0">fourdst::config::register_as_cli</a>(cfg, app);</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacefourdst.html">fourdst</a></li><li class="navelem"><a class="el" href="namespacefourdst_1_1config.html">config</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink