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

220 lines
20 KiB
HTML
Raw Normal View History

Built doxygen
2021-06-03 12:22:37 +02:00
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Leonetienne/Hazelnupp: Hazelnupp/main.cpp File Reference</title>
<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>
<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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="nupp_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Leonetienne/Hazelnupp
</div>
<div id="projectbrief">Simple, easy to use, command line parameter interface</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0202e1e26df2e040f4dc3d434eecf04c.html">Hazelnupp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">main.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;iostream&gt;</code><br />
<code>#include &quot;<a class="el" href="Hazelnupp_8h_source.html">Hazelnupp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="IntValue_8h_source.html">IntValue.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for main.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="main_8cpp__incl.png" border="0" usemap="#Hazelnupp_2main_8cpp" alt=""/></div>
<map name="Hazelnupp_2main_8cpp" id="Hazelnupp_2main_8cpp">
<area shape="rect" title=" " alt="" coords="76,5,231,32"/>
<area shape="rect" title=" " alt="" coords="5,80,85,107"/>
<area shape="rect" href="Hazelnupp_8h.html" title=" " alt="" coords="278,80,381,107"/>
<area shape="rect" href="IntValue_8h.html" title=" " alt="" coords="110,80,197,107"/>
<area shape="rect" href="Parameter_8h.html" title=" " alt="" coords="134,155,234,181"/>
<area shape="rect" title=" " alt="" coords="353,304,415,331"/>
<area shape="rect" href="ParamConstraint_8h.html" title=" " alt="" coords="258,155,401,181"/>
<area shape="rect" title=" " alt="" coords="477,155,601,181"/>
<area shape="rect" href="Value_8h.html" title=" " alt="" coords="142,229,213,256"/>
<area shape="rect" title=" " alt="" coords="83,304,159,331"/>
<area shape="rect" title=" " alt="" coords="237,229,296,256"/>
<area shape="rect" href="DataType_8h.html" title=" " alt="" coords="217,304,311,331"/>
</map>
</div>
</div>
<p><a href="main_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
<tr class="separator:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3c04138a5bfe5d72780bb7e82a18e627"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c04138a5bfe5d72780bb7e82a18e627">&#9670;&nbsp;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **&#160;</td>
<td class="paramname"><em>argv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00005">5</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;{</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <span class="keywordflow">while</span> (1)</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; {</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="comment">// Mock command-line params</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; std::vector&lt;const char*&gt; testArgv = {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="stringliteral">&quot;meinpfad&quot;</span>,</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="stringliteral">&quot;-w&quot;</span>,</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="stringliteral">&quot;-99&quot;</span>,</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="stringliteral">&quot;--alfred&quot;</span>,</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="stringliteral">&quot;apfel&quot;</span>,</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="stringliteral">&quot;banane&quot;</span>,</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="stringliteral">&quot;triangle&quot;</span>,</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="stringliteral">&quot;--numbers&quot;</span>,</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="stringliteral">&quot;1&quot;</span>,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="stringliteral">&quot;2&quot;</span>,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="stringliteral">&quot;3&quot;</span>,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="stringliteral">&quot;4&quot;</span>,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="stringliteral">&quot;5&quot;</span>,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; };</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; argc = testArgv.size();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; argv = <span class="keyword">const_cast&lt;</span><span class="keywordtype">char</span>**<span class="keyword">&gt;</span>(testArgv.data());</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// Prepare Hazelnupp parser</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="classHazelnupp.html">Hazelnupp</a> args;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="structParamConstraint.html">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; pc.<a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> = <span class="stringliteral">&quot;--alfredo&quot;</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; pc.<a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; pc.<a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> = <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba298cb25408234de02baf2085803a464a">DATA_TYPE::LIST</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; pc.<a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; pc.<a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> = { <span class="stringliteral">&quot;coca cola&quot;</span>, <span class="stringliteral">&quot;fanta&quot;</span> };</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; args.<a class="code" href="classHazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5">RegisterConstraints</a>({</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; pc</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; });</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; args.<a class="code" href="classHazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">RegisterAbbreviation</a>(<span class="stringliteral">&quot;-w&quot;</span>, <span class="stringliteral">&quot;--word&quot;</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Parse</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; args.<a class="code" href="classHazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Parse</a>(argc, argv);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// Use</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (args.<a class="code" href="classHazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(<span class="stringliteral">&quot;--alfredo&quot;</span>))</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::cout &lt;&lt; args[<span class="stringliteral">&quot;--alfredo&quot;</span>].GetInt32() &lt;&lt; std::endl;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; std::cout &lt;&lt; <span class="stringliteral">&quot;No --alfredo!&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="aclassHazelnupp_html_abf1e0ebf0207ca2327fcde81f7372124"><div class="ttname"><a href="classHazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">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#l00330">Hazelnupp.cpp:330</a></div></div>
<div class="ttc" id="astructParamConstraint_html_a5c451d5ade6c548af7de0a978964a09d"><div class="ttname"><a href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">ParamConstraint::required</a></div><div class="ttdeci">bool required</div><div class="ttdoc">If set to true, and no default value set, an error will be produced if this parameter is not supplied...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00064">ParamConstraint.h:64</a></div></div>
<div class="ttc" id="aclassHazelnupp_html_a8a3331836b9ea1f920e77f6d332019d5"><div class="ttname"><a href="classHazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5">Hazelnupp::RegisterConstraints</a></div><div class="ttdeci">void RegisterConstraints(const std::vector&lt; ParamConstraint &gt; &amp;constraints)</div><div class="ttdoc">Will register parameter constraints.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00352">Hazelnupp.cpp:352</a></div></div>
<div class="ttc" id="aDataType_8h_html_aa082c000e4eff6ed512714ea0a33d27ba298cb25408234de02baf2085803a464a"><div class="ttname"><a href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba298cb25408234de02baf2085803a464a">DATA_TYPE::LIST</a></div><div class="ttdeci">@ LIST</div></div>
<div class="ttc" id="astructParamConstraint_html_af2832fa007abaabc05784d5f978aeeff"><div class="ttname"><a href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">ParamConstraint::defaultValue</a></div><div class="ttdeci">std::vector&lt; std::string &gt; defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00060">ParamConstraint.h:60</a></div></div>
<div class="ttc" id="astructParamConstraint_html_aa3bd052bbaebdc795f0922731c666648"><div class="ttname"><a href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">ParamConstraint::key</a></div><div class="ttdeci">std::string key</div><div class="ttdoc">The key of the parameter to constrain.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00048">ParamConstraint.h:48</a></div></div>
<div class="ttc" id="aclassHazelnupp_html_a8b79a79d40420ae748c108c691111040"><div class="ttname"><a href="classHazelnupp.html#a8b79a79d40420ae748c108c691111040">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#l00151">Hazelnupp.cpp:151</a></div></div>
<div class="ttc" id="astructParamConstraint_html_ab35444d2957439bc52c2056a829145a2"><div class="ttname"><a href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00052">ParamConstraint.h:52</a></div></div>
<div class="ttc" id="astructParamConstraint_html_ae8875e054a074241f0c0bf3328a0915a"><div class="ttname"><a href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">ParamConstraint::wantedType</a></div><div class="ttdeci">DATA_TYPE wantedType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00055">ParamConstraint.h:55</a></div></div>
<div class="ttc" id="aclassHazelnupp_html"><div class="ttname"><a href="classHazelnupp.html">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#l00009">Hazelnupp.h:9</a></div></div>
<div class="ttc" id="astructParamConstraint_html"><div class="ttname"><a href="structParamConstraint.html">ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00006">ParamConstraint.h:6</a></div></div>
<div class="ttc" id="aclassHazelnupp_html_a1ccb88faca1a8deb77161888479c300b"><div class="ttname"><a href="classHazelnupp.html#a1ccb88faca1a8deb77161888479c300b">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#l00033">Hazelnupp.cpp:33</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 3 2021 12:21:21 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>
</body>
</html>
Reference in New Issue Copy Permalink