168 lines
19 KiB
HTML
168 lines
19 KiB
HTML
<!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 Source File</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&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&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="headertitle">
|
||
<div class="title">main.cpp</div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<a href="main_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#include <iostream></span></div>
|
||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "<a class="code" href="Hazelnupp_8h.html">Hazelnupp.h</a>"</span></div>
|
||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "<a class="code" href="IntValue_8h.html">IntValue.h</a>"</span></div>
|
||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">using namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a>;</div>
|
||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
||
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627"> 7</a></span> <span class="keywordtype">int</span> <a class="code" href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv)</div>
|
||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> {</div>
|
||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  <span class="keywordflow">while</span> (1)</div>
|
||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  {</div>
|
||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="comment">// Mock command-line params</span></div>
|
||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  std::vector<const char*> testArgv = {</div>
|
||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="stringliteral">"meinpfad"</span>,</div>
|
||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="stringliteral">"-w"</span>,</div>
|
||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="stringliteral">"-99"</span>,</div>
|
||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="stringliteral">"--alfred"</span>,</div>
|
||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="stringliteral">"apfel"</span>,</div>
|
||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="stringliteral">"banane"</span>,</div>
|
||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="stringliteral">"triangle"</span>,</div>
|
||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="stringliteral">"--numbers"</span>,</div>
|
||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="stringliteral">"1"</span>,</div>
|
||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="stringliteral">"2"</span>,</div>
|
||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="stringliteral">"3"</span>,</div>
|
||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="stringliteral">"4"</span>,</div>
|
||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="stringliteral">"5"</span>,</div>
|
||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  };</div>
|
||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  argc = testArgv.size();</div>
|
||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  argv = <span class="keyword">const_cast<</span><span class="keywordtype">char</span>**<span class="keyword">></span>(testArgv.data());</div>
|
||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// Prepare Hazelnupp parser</span></div>
|
||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a> args;</div>
|
||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
|
||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> = <span class="stringliteral">"--alfredo"</span>;</div>
|
||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">true</span>;</div>
|
||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa298cb25408234de02baf2085803a464a">DATA_TYPE::LIST</a>;</div>
|
||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">true</span>;</div>
|
||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = { <span class="stringliteral">"coca cola"</span>, <span class="stringliteral">"fanta"</span> };</div>
|
||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5">RegisterConstraints</a>({</div>
|
||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  pc</div>
|
||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  });</div>
|
||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">RegisterAbbreviation</a>(<span class="stringliteral">"-w"</span>, <span class="stringliteral">"--word"</span>);</div>
|
||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// Parse</span></div>
|
||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Parse</a>(argc, argv);</div>
|
||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Use</span></div>
|
||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">if</span> (args.<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(<span class="stringliteral">"--alfredo"</span>))</div>
|
||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div>
|
||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::cout << args[<span class="stringliteral">"--alfredo"</span>].GetInt32() << std::endl;</div>
|
||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div>
|
||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">else</span></div>
|
||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div>
|
||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::cout << <span class="stringliteral">"No --alfredo!"</span> << std::endl;</div>
|
||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
|
||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
|
||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> 0;</div>
|
||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div>
|
||
</div><!-- fragment --></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#l00003">DataType.h:3</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="aIntValue_8h_html"><div class="ttname"><a href="IntValue_8h.html">IntValue.h</a></div></div>
|
||
<div class="ttc" id="amain_8cpp_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="main_8cpp_source.html#l00007">main.cpp:7</a></div></div>
|
||
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa298cb25408234de02baf2085803a464a"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa298cb25408234de02baf2085803a464a">Hazelnp::DATA_TYPE::LIST</a></div><div class="ttdeci">@ LIST</div></div>
|
||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ac07a0c0555431d4b1e0bc6afdba41329"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">Hazelnp::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#l00057">ParamConstraint.h:57</a></div></div>
|
||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html">Hazelnp::ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00008">ParamConstraint.h:8</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 &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#l00153">Hazelnupp.cpp:153</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#l00035">Hazelnupp.cpp:35</a></div></div>
|
||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">Hazelnp::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#l00054">ParamConstraint.h:54</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 &abbrev, const std::string &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#l00332">Hazelnupp.cpp:332</a></div></div>
|
||
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a8a3331836b9ea1f920e77f6d332019d5"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5">Hazelnp::Hazelnupp::RegisterConstraints</a></div><div class="ttdeci">void RegisterConstraints(const std::vector< ParamConstraint > &constraints)</div><div class="ttdoc">Will register parameter constraints.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00354">Hazelnupp.cpp:354</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="astructHazelnp_1_1ParamConstraint_html_aac148076c5e0ab91c666f3343c30bd15"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">Hazelnp::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#l00050">ParamConstraint.h:50</a></div></div>
|
||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a8ccf3ebecc2d9d0105e181814af2943c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">Hazelnp::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#l00066">ParamConstraint.h:66</a></div></div>
|
||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a1d3a627b3a23fe0db3a368e51dbcd5a7"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">Hazelnp::ParamConstraint::defaultValue</a></div><div class="ttdeci">std::vector< std::string > defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00062">ParamConstraint.h:62</a></div></div>
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
Generated on Thu Jun 3 2021 16:39:51 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
</a> 1.8.17
|
||
</small></address>
|
||
</body>
|
||
</html>
|