<ahref="Hazelnupp_8h.html">Go to the documentation of this file.</a><divclass="fragment"><divclass="line"><aname="l00001"></a><spanclass="lineno"> 1</span> <spanclass="preprocessor">#pragma once</span></div>
<divclass="line"><aname="l00022"></a><spanclass="lineno"> 22</span> <spanclass="comment"> //! Will return argv[0], the name of the executable.</span></div>
<divclass="line"><aname="l00028"></a><spanclass="lineno"> 28</span> <spanclass="comment"> //! Will check wether a parameter exists given a key, or not</span></div>
<divclass="line"><aname="l00032"></a><spanclass="lineno"> 32</span> <spanclass="comment"> //! Will register an abbreviation (like -f for --force)</span></div>
<divclass="line"><aname="l00035"></a><spanclass="lineno"> 35</span> <spanclass="comment"> //! Will return the long form of an abbreviation (like --force for -f)</span></div>
<divclass="line"><aname="l00038"></a><spanclass="lineno"> 38</span> <spanclass="comment"> //! Will check wether or not an abbreviation is registered</span></div>
<divclass="line"><aname="l00050"></a><spanclass="lineno"> 50</span> <spanclass="comment"> //! Sets whether to crash the application, and print to stderr, when an exception is </span></div>
<divclass="line"><aname="l00051"></a><spanclass="lineno"> 51</span> <spanclass="comment"> //! raised whilst parsing, or not.</span></div>
<divclass="line"><aname="l00054"></a><spanclass="lineno"> 54</span> <spanclass="comment"> //! Gets whether the application crashes on an exception whilst parsing, and prints to stderr.</span></div>
<divclass="line"><aname="l00057"></a><spanclass="lineno"> 57</span> <spanclass="comment"> //! Sets whether the Hazelnupp should automatically catch the --help parameter, print the parameter documentation to stdout, and exit or not.</span></div>
<divclass="line"><aname="l00060"></a><spanclass="lineno"> 60</span> <spanclass="comment"> //! Retruns whether the Hazelnupp should automatically catch the --help parameter, print the parameter documentation to stdout, and exit or not.</span></div>
<divclass="line"><aname="l00063"></a><spanclass="lineno"> 63</span> <spanclass="comment"> //! Sets a brief description of the application to be automatically added to the documentation.</span></div>
<divclass="line"><aname="l00066"></a><spanclass="lineno"> 66</span> <spanclass="comment"> //! Returns the brief description of the application to be automatically added to the documentation.</span></div>
<divclass="line"><aname="l00069"></a><spanclass="lineno"> 69</span> <spanclass="comment"> //! Willl register a short description for a parameter. </span></div>
<divclass="line"><aname="l00070"></a><spanclass="lineno"> 70</span> <spanclass="comment"> //! Will overwrite existing descriptions for that parameter.</span></div>
<divclass="line"><aname="l00073"></a><spanclass="lineno"> 73</span> <spanclass="comment"> //! Will return a short description for a parameter, if it exists. </span></div>
<divclass="line"><aname="l00074"></a><spanclass="lineno"> 74</span> <spanclass="comment"> //! Empty string if it does not exist.</span></div>
<divclass="line"><aname="l00077"></a><spanclass="lineno"> 77</span> <spanclass="comment"> //! Will delete the description of a parameter if it exists.</span></div>
<divclass="line"><aname="l00080"></a><spanclass="lineno"> 80</span> <spanclass="comment"> //! Will generate a text-based documentation suited to show the user, for example on --help.</span></div>
<divclass="line"><aname="l00084"></a><spanclass="lineno"> 84</span> <spanclass="comment"> //! Will translate the c-like args to an std::vector</span></div>
<divclass="line"><aname="l00087"></a><spanclass="lineno"> 87</span> <spanclass="comment"> //! Will replace all args matching an abbreviation with their long form (like -f for --force)</span></div>
<divclass="line"><aname="l00090"></a><spanclass="lineno"> 90</span> <spanclass="comment"> //! Will parse the next parameter. Returns the index of the next parameter.</span></div>
<divclass="line"><aname="l00093"></a><spanclass="lineno"> 93</span> <spanclass="comment"> //! Will convert a vector of string-values to an actual Value</span></div>
<divclass="line"><aname="l00096"></a><spanclass="lineno"> 96</span> <spanclass="comment"> //! Will apply the loaded constraints on the loaded values, exluding types.</span></div>
<divclass="line"><aname="l00099"></a><spanclass="lineno"> 99</span> <spanclass="comment"> //! Will return a pointer to a paramConstraint given a key. If there is no, it returns nullptr</span></div>
<divclass="line"><aname="l00102"></a><spanclass="lineno"> 102</span>  std::string executableName; <spanclass="comment">//! The path of the executable. Always argv[0]</span></div>
<divclass="line"><aname="l00105"></a><spanclass="lineno"> 105</span> <spanclass="comment"> //! These are abbreviations. Like, -f for --force.</span></div>
<divclass="line"><aname="l00117"></a><spanclass="lineno"> 117</span> <spanclass="comment"> //! A brief description of the application to be added to the generated documentation. Optional.</span></div>
<divclass="line"><aname="l00120"></a><spanclass="lineno"> 120</span> <spanclass="comment"> //! If set to true, Hazelnupp will automatically catch the --help parameter, print the parameter documentation to stdout and exit.</span></div>
<divclass="line"><aname="l00123"></a><spanclass="lineno"> 123</span> <spanclass="comment"> //! If set to true, Hazelnupp will crash the application with output to stderr when an exception is thrown whilst parsing.</span></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a1d32c3047a8c58650476d1ae7e9fb582"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a1d32c3047a8c58650476d1ae7e9fb582">Hazelnp::Hazelnupp::GetBriefDescription</a></div><divclass="ttdeci">const std::string & GetBriefDescription()</div><divclass="ttdoc">Returns the brief description of the application to be automatically added to the documentation.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00312">Hazelnupp.cpp:312</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a3970b74583def49c6632fe08a4499809"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a3970b74583def49c6632fe08a4499809">Hazelnp::Hazelnupp::ClearConstraints</a></div><divclass="ttdeci">void ClearConstraints()</div><divclass="ttdoc">Will delete all constraints.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00542">Hazelnupp.cpp:542</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_af6bb41fb079131f8b91fe981f63f7469"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#af6bb41fb079131f8b91fe981f63f7469">Hazelnp::Hazelnupp::GetExecutableName</a></div><divclass="ttdeci">const std::string & GetExecutableName() const</div><divclass="ttdoc">Will return argv[0], the name of the executable.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00485">Hazelnupp.cpp:485</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a7b1bf5e700d8a0d8e90c5750e54749de"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">Hazelnp::Hazelnupp::GenerateDocumentation</a></div><divclass="ttdeci">std::string GenerateDocumentation() const</div><divclass="ttdoc">Will generate a text-based documentation suited to show the user, for example on –help.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00342">Hazelnupp.cpp:342</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a419ccdc6bad00b0fc3e17ed9b41f5dc5"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5">Hazelnp::Hazelnupp::operator[]</a></div><divclass="ttdeci">const Value & operator[](const std::string &key) const</div><divclass="ttdoc">Will return the value given a key.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00490">Hazelnupp.cpp:490</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html">Hazelnp::Hazelnupp</a></div><divclass="ttdoc">The main class to interface with.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8h_source.html#l00011">Hazelnupp.h:11</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a5175869b025468324cefad487081e91d"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a5175869b025468324cefad487081e91d">Hazelnp::Hazelnupp::ClearAbbreviations</a></div><divclass="ttdeci">void ClearAbbreviations()</div><divclass="ttdoc">Will delete all abbreviations.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00515">Hazelnupp.cpp:515</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a037f84b32c7a2420c387dd46445291ac"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a037f84b32c7a2420c387dd46445291ac">Hazelnp::Hazelnupp::SetBriefDescription</a></div><divclass="ttdeci">void SetBriefDescription(const std::string &description)</div><divclass="ttdoc">Sets a brief description of the application to be automatically added to the documentation.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00306">Hazelnupp.cpp:306</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Value_html"><divclass="ttname"><ahref="classHazelnp_1_1Value.html">Hazelnp::Value</a></div><divclass="ttdoc">Abstract class for values.</div><divclass="ttdef"><b>Definition:</b><ahref="Value_8h_source.html#l00010">Value.h:10</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a1b810cc7db2cf64aecaa70c686b14bb7"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7">Hazelnp::Hazelnupp::GetCrashOnFail</a></div><divclass="ttdeci">bool GetCrashOnFail() const</div><divclass="ttdoc">Gets whether the application crashes on an exception whilst parsing, and prints to stderr.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00290">Hazelnupp.cpp:290</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a60e0a51cd92014a87e44322158e45872"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a60e0a51cd92014a87e44322158e45872">Hazelnp::Hazelnupp::SetCatchHelp</a></div><divclass="ttdeci">void SetCatchHelp(bool catchHelp)</div><divclass="ttdoc">Sets whether the Hazelnupp should automatically catch the –help parameter, print the parameter docume...</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00295">Hazelnupp.cpp:295</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a05a3d112bcc00cdeade76f3643ba9e94"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a05a3d112bcc00cdeade76f3643ba9e94">Hazelnp::Hazelnupp::GetCatchHelp</a></div><divclass="ttdeci">bool GetCatchHelp() const</div><divclass="ttdoc">Retruns whether the Hazelnupp should automatically catch the –help parameter, print the parameter doc...</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00301">Hazelnupp.cpp:301</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a8b79a79d40420ae748c108c691111040"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">Hazelnp::Hazelnupp::HasParam</a></div><divclass="ttdeci">bool HasParam(const std::string &key) const</div><divclass="ttdoc">Will check wether a parameter exists given a key, or not.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00164">Hazelnupp.cpp:164</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a579e78129f19cb9f17a6075366ababe5"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a579e78129f19cb9f17a6075366ababe5">Hazelnp::Hazelnupp::GetAbbreviation</a></div><divclass="ttdeci">const std::string & GetAbbreviation(const std::string &abbrev) const</div><divclass="ttdoc">Will return the long form of an abbreviation (like –force for -f)</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00505">Hazelnupp.cpp:505</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a8490e0b10feee0b815c043e7cad454cb"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a8490e0b10feee0b815c043e7cad454cb">Hazelnp::Hazelnupp::ClearDescription</a></div><divclass="ttdeci">void ClearDescription(const std::string &parameter)</div><divclass="ttdoc">Will delete the description of a parameter if it exists.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00335">Hazelnupp.cpp:335</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a46df7d396fb56e30351c9a7308792200"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200">Hazelnp::Hazelnupp::HasAbbreviation</a></div><divclass="ttdeci">bool HasAbbreviation(const std::string &abbrev) const</div><divclass="ttdoc">Will check wether or not an abbreviation is registered.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00510">Hazelnupp.cpp:510</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a17845623ca686caa51f3c8254e85551e"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a17845623ca686caa51f3c8254e85551e">Hazelnp::Hazelnupp::SetCrashOnFail</a></div><divclass="ttdeci">void SetCrashOnFail(bool crashOnFail)</div><divclass="ttdoc">Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00548">Hazelnupp.cpp:548</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a17883db87e97caad4a0f114f9f850f5e"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a17883db87e97caad4a0f114f9f850f5e">Hazelnp::Hazelnupp::RegisterDescription</a></div><divclass="ttdeci">void RegisterDescription(const std::string &parameter, const std::string &description)</div><divclass="ttdoc">Willl register a short description for a parameter.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00317">Hazelnupp.cpp:317</a></div></div>
<divclass="ttc"id="aclassHazelnp_1_1Hazelnupp_html_a6637dc4b78871d7ecba1f2e1c8c28fb0"><divclass="ttname"><ahref="classHazelnp_1_1Hazelnupp.html#a6637dc4b78871d7ecba1f2e1c8c28fb0">Hazelnp::Hazelnupp::GetDescription</a></div><divclass="ttdeci">const std::string GetDescription(const std::string &parameter) const</div><divclass="ttdoc">Will return a short description for a parameter, if it exists.</div><divclass="ttdef"><b>Definition:</b><ahref="Hazelnupp_8cpp_source.html#l00323">Hazelnupp.cpp:323</a></div></div>
