| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: CommandLineParser Class 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <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> |
| </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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_command_line_parser.xhtml','');}); |
| /* @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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">CommandLineParser Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Class to parse command line arguments. |
| <a href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a169ae39f7c9da9fee21c577ae5d7954f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#a169ae39f7c9da9fee21c577ae5d7954f">CommandLineParser</a> ()=default</td></tr> |
| <tr class="memdesc:a169ae39f7c9da9fee21c577ae5d7954f"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a169ae39f7c9da9fee21c577ae5d7954f">More...</a><br /></td></tr> |
| <tr class="separator:a169ae39f7c9da9fee21c577ae5d7954f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a68e2f681ec6686a130c4af96caf4d9fc"><td class="memTemplParams" colspan="2">template<typename T , typename... As> </td></tr> |
| <tr class="memitem:a68e2f681ec6686a130c4af96caf4d9fc"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#a68e2f681ec6686a130c4af96caf4d9fc">add_option</a> (const std::string &name, As &&... args)</td></tr> |
| <tr class="memdesc:a68e2f681ec6686a130c4af96caf4d9fc"><td class="mdescLeft"> </td><td class="mdescRight">Function to add a new option to the parser. <a href="#a68e2f681ec6686a130c4af96caf4d9fc">More...</a><br /></td></tr> |
| <tr class="separator:a68e2f681ec6686a130c4af96caf4d9fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abe52559b86ae874453f5a80b0828ec1c"><td class="memTemplParams" colspan="2">template<typename T , typename... As> </td></tr> |
| <tr class="memitem:abe52559b86ae874453f5a80b0828ec1c"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#abe52559b86ae874453f5a80b0828ec1c">add_positional_option</a> (As &&... args)</td></tr> |
| <tr class="memdesc:abe52559b86ae874453f5a80b0828ec1c"><td class="mdescLeft"> </td><td class="mdescRight">Function to add a new positional argument to the parser. <a href="#abe52559b86ae874453f5a80b0828ec1c">More...</a><br /></td></tr> |
| <tr class="separator:abe52559b86ae874453f5a80b0828ec1c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a66fa8f960eac1bf561ba2cb8be0cc58a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#a66fa8f960eac1bf561ba2cb8be0cc58a">parse</a> (int argc, char **argv)</td></tr> |
| <tr class="memdesc:a66fa8f960eac1bf561ba2cb8be0cc58a"><td class="mdescLeft"> </td><td class="mdescRight">Parses the command line arguments and updates the options accordingly. <a href="#a66fa8f960eac1bf561ba2cb8be0cc58a">More...</a><br /></td></tr> |
| <tr class="separator:a66fa8f960eac1bf561ba2cb8be0cc58a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3566e1a9ec7fedc6e4fc47fab7c18532"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#a3566e1a9ec7fedc6e4fc47fab7c18532">validate</a> () const</td></tr> |
| <tr class="memdesc:a3566e1a9ec7fedc6e4fc47fab7c18532"><td class="mdescLeft"> </td><td class="mdescRight">Validates the previously parsed command line arguments. <a href="#a3566e1a9ec7fedc6e4fc47fab7c18532">More...</a><br /></td></tr> |
| <tr class="separator:a3566e1a9ec7fedc6e4fc47fab7c18532"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5da3e535faa6847a0da40fe7fb28383"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml#aa5da3e535faa6847a0da40fe7fb28383">print_help</a> (const std::string &program_name) const</td></tr> |
| <tr class="memdesc:aa5da3e535faa6847a0da40fe7fb28383"><td class="mdescLeft"> </td><td class="mdescRight">Prints a help message for all configured options. <a href="#aa5da3e535faa6847a0da40fe7fb28383">More...</a><br /></td></tr> |
| <tr class="separator:aa5da3e535faa6847a0da40fe7fb28383"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Class to parse command line arguments. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00044">44</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a169ae39f7c9da9fee21c577ae5d7954f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a169ae39f7c9da9fee21c577ae5d7954f">◆ </a></span>CommandLineParser()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml">CommandLineParser</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default constructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a68e2f681ec6686a130c4af96caf4d9fc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a68e2f681ec6686a130c4af96caf4d9fc">◆ </a></span>add_option()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T * add_option </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">As &&... </td> |
| <td class="paramname"><em>args</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Function to add a new option to the parser. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. Will be available under –name=VALUE. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">args</td><td><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml" title="Abstract base class for a command line option.">Option</a> specific configuration arguments.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Pointer to the option. The option is owned by the parser. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00103">103</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">auto</span> result = _options.emplace(name, support::cpp14::make_unique<T>(name, std::forward<As>(<a class="code" href="namespace_gemm_tuner.xhtml#a8187411843a6284ffb964ef3fb9fcab3">args</a>)...));</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">return</span> static_cast<T *>(result.first->second.get());</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> }</div><div class="ttc" id="namespace_gemm_tuner_xhtml_a8187411843a6284ffb964ef3fb9fcab3"><div class="ttname"><a href="namespace_gemm_tuner.xhtml#a8187411843a6284ffb964ef3fb9fcab3">GemmTuner.args</a></div><div class="ttdeci">args</div><div class="ttdef"><b>Definition:</b> <a href="_gemm_tuner_8py_source.xhtml#l00555">GemmTuner.py:555</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_gemm_tuner_8py_source.xhtml#l00555">GemmTuner::args</a>.</p> |
| |
| </div> |
| </div> |
| <a id="abe52559b86ae874453f5a80b0828ec1c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abe52559b86ae874453f5a80b0828ec1c">◆ </a></span>add_positional_option()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T * add_positional_option </td> |
| <td>(</td> |
| <td class="paramtype">As &&... </td> |
| <td class="paramname"><em>args</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Function to add a new positional argument to the parser. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">args</td><td><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml" title="Abstract base class for a command line option.">Option</a> specific configuration arguments.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Pointer to the option. The option is owned by the parser. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00110">110</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  _positional_options.emplace_back(support::cpp14::make_unique<T>(std::forward<As>(<a class="code" href="namespace_gemm_tuner.xhtml#a8187411843a6284ffb964ef3fb9fcab3">args</a>)...));</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">return</span> static_cast<T *>(_positional_options.back().get());</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> }</div><div class="ttc" id="namespace_gemm_tuner_xhtml_a8187411843a6284ffb964ef3fb9fcab3"><div class="ttname"><a href="namespace_gemm_tuner.xhtml#a8187411843a6284ffb964ef3fb9fcab3">GemmTuner.args</a></div><div class="ttdeci">args</div><div class="ttdef"><b>Definition:</b> <a href="_gemm_tuner_8py_source.xhtml#l00555">GemmTuner.py:555</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_gemm_tuner_8py_source.xhtml#l00555">GemmTuner::args</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a66fa8f960eac1bf561ba2cb8be0cc58a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a66fa8f960eac1bf561ba2cb8be0cc58a">◆ </a></span>parse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void parse </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>argc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char ** </td> |
| <td class="paramname"><em>argv</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses the command line arguments and updates the options accordingly. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">argc</td><td>Number of arguments. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">argv</td><td>Arguments. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00116">116</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">const</span> std::regex option_regex{ <span class="stringliteral">"--((?:no-)?)([^=]+)(?:=(.*))?"</span> };</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> <span class="keyword">auto</span> set_option = [&](<span class="keyword">const</span> std::string & option, <span class="keyword">const</span> std::string & name, <span class="keyword">const</span> std::string & value)</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">if</span>(_options.find(name) == _options.end())</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  _unknown_options.push_back(option);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> success = _options[name]->parse(value);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">if</span>(!success)</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  _invalid_options.push_back(option);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  };</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> positional_index = 0;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 1; i < argc; ++i)</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  {</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  std::string mixed_case_opt{ argv[i] };</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">int</span> equal_sign = mixed_case_opt.find(<span class="charliteral">'='</span>);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">int</span> pos = (equal_sign == -1) ? strlen(argv[i]) : equal_sign;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">const</span> std::string option = <a class="code" href="namespacearm__compute_1_1utility.xhtml#abb96ad5c7071ec3a47ea5f07e817a636">arm_compute::utility::tolower</a>(mixed_case_opt.substr(0, pos)) + mixed_case_opt.substr(pos);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  std::smatch option_matches;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordflow">if</span>(std::regex_match(option, option_matches, option_regex))</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// Boolean option</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">if</span>(option_matches.str(3).empty())</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  {</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  set_option(option, option_matches.str(2), option_matches.str(1).empty() ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  }</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  {</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// Can't have "no-" and a value</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">if</span>(!option_matches.str(1).empty())</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  {</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  _invalid_options.emplace_back(option);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  {</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  set_option(option, option_matches.str(2), option_matches.str(3));</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  }</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  {</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">if</span>(positional_index >= _positional_options.size())</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  {</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  _invalid_options.push_back(mixed_case_opt);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  {</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  _positional_options[positional_index]->parse(mixed_case_opt);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  ++positional_index;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  }</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  }</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> }</div><div class="ttc" id="namespacearm__compute_1_1utility_xhtml_abb96ad5c7071ec3a47ea5f07e817a636"><div class="ttname"><a href="namespacearm__compute_1_1utility.xhtml#abb96ad5c7071ec3a47ea5f07e817a636">arm_compute::utility::tolower</a></div><div class="ttdeci">std::string tolower(std::string string)</div><div class="ttdoc">Convert string to lower case.</div><div class="ttdef"><b>Definition:</b> <a href="_utility_8h_source.xhtml#l00203">Utility.h:203</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aa5da3e535faa6847a0da40fe7fb28383"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5da3e535faa6847a0da40fe7fb28383">◆ </a></span>print_help()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void print_help </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>program_name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prints a help message for all configured options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">program_name</td><td>Name of the program to be used in the help message. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00217">217</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> {</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  std::cout << <span class="stringliteral">"usage: "</span> << program_name << <span class="stringliteral">" \n"</span>;</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _options)</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  {</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  std::cout << option.second->help() << <span class="stringliteral">"\n"</span>;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  }</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _positional_options)</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  {</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  std::string help_to_print;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// Extract help sub-string</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keyword">const</span> std::string help_str = option->help();</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> help_pos = help_str.find(<span class="stringliteral">" - "</span>);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">if</span>(help_pos != std::string::npos)</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  {</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  help_to_print = help_str.substr(help_pos);</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  }</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  std::cout << option->name() << help_to_print << <span class="stringliteral">"\n"</span>;</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  }</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a3566e1a9ec7fedc6e4fc47fab7c18532"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3566e1a9ec7fedc6e4fc47fab7c18532">◆ </a></span>validate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool validate </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validates the previously parsed command line arguments. </p> |
| <p>Validation fails if not all required options are provided. Additionally warnings are generated for options that have illegal values or unknown options.</p> |
| <dl class="section return"><dt>Returns</dt><dd>True if all required options have been provided. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_command_line_parser_8h_source.xhtml#l00182">182</a> of file <a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> {</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">bool</span> is_valid = <span class="keyword">true</span>;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _options)</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  {</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">if</span>(option.second->is_required() && !option.second->is_set())</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  {</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  is_valid = <span class="keyword">false</span>;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  std::cerr << <span class="stringliteral">"ERROR: Option '"</span> << option.second->name() << <span class="stringliteral">"' is required but not given!\n"</span>;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  }</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _positional_options)</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  {</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">if</span>(option->is_required() && !option->is_set())</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  {</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  is_valid = <span class="keyword">false</span>;</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  std::cerr << <span class="stringliteral">"ERROR: Option '"</span> << option->name() << <span class="stringliteral">"' is required but not given!\n"</span>;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  }</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _unknown_options)</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  {</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  std::cerr << <span class="stringliteral">"WARNING: Skipping unknown option '"</span> << option << <span class="stringliteral">"'!\n"</span>;</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  }</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &option : _invalid_options)</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  {</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  std::cerr << <span class="stringliteral">"WARNING: Skipping invalid option '"</span> << option << <span class="stringliteral">"'!\n"</span>;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  }</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keywordflow">return</span> is_valid;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>utils/command_line/<a class="el" href="_command_line_parser_8h_source.xhtml">CommandLineParser.h</a></li> |
| </ul> |
| </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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1utils.xhtml">utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1utils_1_1_command_line_parser.xhtml">CommandLineParser</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:07:20 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
