leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Built mkdocs

Browse Source
This commit is contained in:
Leonetienne
2021-06-08 14:02:49 +02:00
parent 7db2647d7f
commit 384a72ee15
190 changed files with 3234 additions and 576 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
docs/index.html
View File

@@ -85,7 +85,7 @@ $(function() {
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md1"></a>
Note</h1>
<p>These examples reference exceptions. These are not enabled by default. The default behaviour for user-fault exceptions is to produce output to <code>stderr</code> and kill the process. <br />
To enable exceptions, call this method: </p><div class="fragment"><div class="line">Hazelnupp args;</div>
To enable exceptions, call this method: </p><div class="fragment"><div class="line">CmdArgsInterface args;</div>
<div class="line">args.SetCrashOnFail(<span class="keyword">false</span>);</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md2"></a>
Index</h1>
@@ -141,12 +141,12 @@ What's the concept?</h1>
<p><span id="minimal-working-example"></span> </p>
<h1><a class="anchor" id="autotoc_md5"></a>
Minimal working example</h1>
<p>So what's the simplest way to use Hazelnupp to work with command-line parameters? See: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
<p>So what's the simplest way to use Hazelnupp to work with command-line parameters? See: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args(argc, argv);</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (args.HasParam(<span class="stringliteral">&quot;--force&quot;</span>))</div>
<div class="line"> <span class="comment">// do forced</span></div>
@@ -155,12 +155,12 @@ Minimal working example</h1>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
</div><!-- fragment --><p>Looks super easy! But what about actual values? </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
</div><!-- fragment --><p>Looks super easy! But what about actual values? </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args(argc, argv);</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Either check via HasParam(), or do a try-catch</span></div>
<div class="line"> <span class="keywordflow">try</span></div>
@@ -176,12 +176,12 @@ Minimal working example</h1>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
</div><!-- fragment --><p>What about lists? </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
</div><!-- fragment --><p>What about lists? </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args(argc, argv);</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> <span class="keyword">auto</span>&amp; myList = args[<span class="stringliteral">&quot;--my-list&quot;</span>].GetList(); <span class="comment">// std::vector&lt;Value*&gt;</span></div>
<div class="line"> </div>
@@ -196,20 +196,20 @@ Minimal working example</h1>
</div><!-- fragment --><p><span id="abbreviations"></span> </p>
<h1><a class="anchor" id="autotoc_md6"></a>
Abbreviations</h1>
<p>Abbreviations are a very important part of command line arguments. Like, typing <code>-f</code> instead of <code>--force</code>. Here's how to use them in Hazelnupp: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
<p>Abbreviations are a very important part of command line arguments. Like, typing <code>-f</code> instead of <code>--force</code>. Here's how to use them in Hazelnupp: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args;</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Register abbreviations</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">RegisterAbbreviation</a>(<span class="stringliteral">&quot;-f&quot;</span>, <span class="stringliteral">&quot;--force&quot;</span>);</div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#aaccf591a74408aeb4363033fe8cb2224">RegisterAbbreviation</a>(<span class="stringliteral">&quot;-f&quot;</span>, <span class="stringliteral">&quot;--force&quot;</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Parse</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Parse</a>(argc, argv);</div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19">Parse</a>(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(<span class="stringliteral">&quot;--force&quot;</span>)) <span class="comment">// This key will be present, even if the user passed &#39;-f&#39;</span></div>
<div class="line"> <span class="keywordflow">if</span> (args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24">HasParam</a>(<span class="stringliteral">&quot;--force&quot;</span>)) <span class="comment">// This key will be present, even if the user passed &#39;-f&#39;</span></div>
<div class="line"> <span class="comment">// do forced</span></div>
<div class="line"> <span class="keywordflow">else</span></div>
<div class="line"> <span class="comment">// be gentle</span></div>
@@ -230,19 +230,19 @@ Requiring data</h2>
<li>If a parameter is not present, but has a default value, it will be automatically created.</li>
<li>If a parameter is not present, and has no default value, an exception will be thrown.</li>
</ul>
<p>Minimal working example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
<p>Minimal working example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args;</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Register constraints</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">RegisterConstraint</a>(<span class="stringliteral">&quot;--this-is-required&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">ParamConstraint::Require</a>()); <span class="comment">// This missing throws an exception</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">RegisterConstraint</a>(<span class="stringliteral">&quot;--also-required-but-defaulted&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">ParamConstraint::Require</a>({<span class="stringliteral">&quot;122&quot;</span>})); <span class="comment">// This will default to 122</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2">RegisterConstraint</a>(<span class="stringliteral">&quot;--this-is-required&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">ParamConstraint::Require</a>()); <span class="comment">// This missing throws an exception</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2">RegisterConstraint</a>(<span class="stringliteral">&quot;--also-required-but-defaulted&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">ParamConstraint::Require</a>({<span class="stringliteral">&quot;122&quot;</span>})); <span class="comment">// This will default to 122</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Parse</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Parse</a>(argc, argv);</div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19">Parse</a>(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
@@ -262,18 +262,18 @@ Type safety</h2>
<p>The conversions <code>*-&gt;list</code> just create a list with a single entry (except for <code>void-&gt;list</code> which produces an empty list). <br />
The <code>*-&gt;void</code> conversions just drop their value. <br />
<code>void-&gt;string</code> just produces an empty string.</p>
<p>Minimal working example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>&quot;</span></div>
<p>Minimal working example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;Hazelnupp.h&quot;</span></div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</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">{</div>
<div class="line"> <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args;</div>
<div class="line"> <a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a> args;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Register constraints</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">RegisterConstraint</a>(<span class="stringliteral">&quot;--this-must-be-int&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">ParamConstraint::TypeSafety</a>(<a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92">DATA_TYPE::INT</a>));</div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2">RegisterConstraint</a>(<span class="stringliteral">&quot;--this-must-be-int&quot;</span>, <a class="code" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">ParamConstraint::TypeSafety</a>(<a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92">DATA_TYPE::INT</a>));</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Parse</span></div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Parse</a>(argc, argv);</div>
<div class="line"> args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19">Parse</a>(argc, argv);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
@@ -285,14 +285,14 @@ Type safety</h2>
<div class="line">pc.defaultValue = {}; <span class="comment">// no default value</span></div>
<div class="line">pc.required = <span class="keyword">true</span>;</div>
<div class="line"> </div>
<div class="line">args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">RegisterConstraint</a>(<span class="stringliteral">&quot;--my-key&quot;</span>, pc);</div>
<div class="line">args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2">RegisterConstraint</a>(<span class="stringliteral">&quot;--my-key&quot;</span>, pc);</div>
</div><!-- fragment --><p>What doesn't work is inserting multiple constraints for one key. It will just discard the older one. But that's okay because one can describe all possible constraints for a single key in <b>one</b> struct.</p>
<p><span id="automatic-parameter-documentation"></span> </p>
<h1><a class="anchor" id="autotoc_md11"></a>
Automatic parameter documentation</h1>
<p>Hazelnupp does automatically create a parameter documentation, accessible via <code>--help</code>. <br />
If you want to use <code>--help</code> yourself, just turn it off. </p><div class="fragment"><div class="line">Hazelnupp args;</div>
<div class="line">args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a60e0a51cd92014a87e44322158e45872">SetCatchHelp</a>(<span class="keyword">false</span>);</div>
If you want to use <code>--help</code> yourself, just turn it off. </p><div class="fragment"><div class="line">CmdArgsInterface args;</div>
<div class="line">args.<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#abf553ed4acabf9e1db357715bc10533c">SetCatchHelp</a>(<span class="keyword">false</span>);</div>
</div><!-- fragment --><p>What does this automatically generated documentation look like? </p><div class="fragment"><div class="line">$ a.out --help</div>
<div class="line"> </div>
<div class="line">This is the testing application for Hazelnupp.</div>
@@ -311,9 +311,9 @@ Automatic parameter documentation</h1>
<div class="line"> </div>
<div class="line">--height -h</div>
</div><!-- fragment --><p>This documentation is automatically fed by any information provided on parameters. <br />
You have to set the brief descriptions yourself though. </p><div class="fragment"><div class="line">Hazelnupp args;</div>
You have to set the brief descriptions yourself though. </p><div class="fragment"><div class="line">CmdArgsInterface args;</div>
<div class="line">args.RegisterDescription(<span class="stringliteral">&quot;--force&quot;</span>, <span class="stringliteral">&quot;Just forces it.&quot;</span>);</div>
</div><!-- fragment --><p>Additionally you can provide a brief description of your application to be added right above the parameter list. </p><div class="fragment"><div class="line">Hazelnupp args;</div>
</div><!-- fragment --><p>Additionally you can provide a brief description of your application to be added right above the parameter list. </p><div class="fragment"><div class="line">CmdArgsInterface args;</div>
<div class="line">args.SetBriefDescription(<span class="stringliteral">&quot;This is the testing application for Hazelnupp.&quot;</span>);</div>
</div><!-- fragment --><p>If you want to display this information somewhere else, you can always access it as a string via <code>args.GenerateDocumentation()</code>.</p>
<p><span id="descriptive-error-messages"></span> </p>
@@ -390,21 +390,20 @@ LICENSE</h1>
<div class="line">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</div>
</div><!-- fragment --> </div></div><!-- PageDoc -->
</div><!-- contents -->
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00004">DataType.h:4</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8h_source.html#l00007">CmdArgsInterface.h:7</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html">Hazelnp::CmdArgsInterface</a></div><div class="ttdoc">The main class to interface with.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8h_source.html#l00011">CmdArgsInterface.h:11</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_abf553ed4acabf9e1db357715bc10533c"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#abf553ed4acabf9e1db357715bc10533c">Hazelnp::CmdArgsInterface::SetCatchHelp</a></div><div class="ttdeci">void SetCatchHelp(bool catchHelp)</div><div class="ttdoc">Sets whether the CmdArgsInterface should automatically catch the –help parameter, print the parameter...</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00334">CmdArgsInterface.cpp:334</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppInvalidKeyException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppInvalidKeyException.html">Hazelnp::HazelnuppInvalidKeyException</a></div><div class="ttdoc">Gets thrown when an non-existent key gets dereferenced.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00029">HazelnuppException.h:29</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html">Hazelnp::Hazelnupp</a></div><div class="ttdoc">The main class to interface with.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8h_source.html#l00011">Hazelnupp.h:11</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a60e0a51cd92014a87e44322158e45872"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a60e0a51cd92014a87e44322158e45872">Hazelnp::Hazelnupp::SetCatchHelp</a></div><div class="ttdeci">void SetCatchHelp(bool catchHelp)</div><div class="ttdoc">Sets whether the Hazelnupp should automatically catch the –help parameter, print the parameter docume...</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00334">Hazelnupp.cpp:334</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a8b79a79d40420ae748c108c691111040"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">Hazelnp::Hazelnupp::HasParam</a></div><div class="ttdeci">bool HasParam(const std::string &amp;key) const</div><div class="ttdoc">Will check wether a parameter exists given a key, or not.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00165">Hazelnupp.cpp:165</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1ccb88faca1a8deb77161888479c300b"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Hazelnp::Hazelnupp::Parse</a></div><div class="ttdeci">void Parse(const int argc, const char *const *argv)</div><div class="ttdoc">Will parse command line arguments.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00036">Hazelnupp.cpp:36</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_abf1e0ebf0207ca2327fcde81f7372124"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">Hazelnp::Hazelnupp::RegisterAbbreviation</a></div><div class="ttdeci">void RegisterAbbreviation(const std::string &amp;abbrev, const std::string &amp;target)</div><div class="ttdoc">Will register an abbreviation (like -f for –force)</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00567">Hazelnupp.cpp:567</a></div></div>
<div class="ttc" id="aHazelnupp_8h_html"><div class="ttname"><a href="Hazelnupp_8h.html">Hazelnupp.h</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_add731b65fb0741e4fb0b8fc8a601a11d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">Hazelnp::Hazelnupp::RegisterConstraint</a></div><div class="ttdeci">void RegisterConstraint(const std::string &amp;key, const ParamConstraint &amp;constraint)</div><div class="ttdoc">Will register a constraint for a parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00598">Hazelnupp.cpp:598</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_aa30222df012f357455f90e3620346bb2"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2">Hazelnp::CmdArgsInterface::RegisterConstraint</a></div><div class="ttdeci">void RegisterConstraint(const std::string &amp;key, const ParamConstraint &amp;constraint)</div><div class="ttdoc">Will register a constraint for a parameter.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00598">CmdArgsInterface.cpp:598</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_aaccf591a74408aeb4363033fe8cb2224"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#aaccf591a74408aeb4363033fe8cb2224">Hazelnp::CmdArgsInterface::RegisterAbbreviation</a></div><div class="ttdeci">void RegisterAbbreviation(const std::string &amp;abbrev, const std::string &amp;target)</div><div class="ttdoc">Will register an abbreviation (like -f for –force)</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00567">CmdArgsInterface.cpp:567</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a3a7fa36fe69ee8bf3b400983a21ecd24"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24">Hazelnp::CmdArgsInterface::HasParam</a></div><div class="ttdeci">bool HasParam(const std::string &amp;key) const</div><div class="ttdoc">Will check wether a parameter exists given a key, or not.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00165">CmdArgsInterface.cpp:165</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a1f4845041e08b3335510de44fafaee19"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19">Hazelnp::CmdArgsInterface::Parse</a></div><div class="ttdeci">void Parse(const int argc, const char *const *argv)</div><div class="ttdoc">Will parse command line arguments.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00036">CmdArgsInterface.cpp:36</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a7df61dbc8dbaff4bc596fdf2c0532d5b"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">Hazelnp::ParamConstraint::TypeSafety</a></div><div class="ttdeci">static ParamConstraint TypeSafety(DATA_TYPE requiredType, bool constrainType=true)</div><div class="ttdoc">Constructs a type-safety constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00026">ParamConstraint.h:26</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92">Hazelnp::DATA_TYPE::INT</a></div><div class="ttdeci">@ INT</div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a926e12fcb2fd0d031452c4bcc950bd6c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">Hazelnp::ParamConstraint::Require</a></div><div class="ttdeci">static ParamConstraint Require(const std::vector&lt; std::string &gt; &amp;defaultValue={}, bool required=true)</div><div class="ttdoc">Constructs a require constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00016">ParamConstraint.h:16</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 6 2021 15:32:08 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Tue Jun 8 2021 14:02:40 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>