<!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.5"/> <title>GNU CommonC++: cmdoptns.h 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="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 style="padding-left: 0.5em;"> <div id="projectname">GNU CommonC++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_6b3e09e31d3da6038137f0238e9fb19b.html">cc++</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">cmdoptns.h</div> </div> </div><!--header--> <div class="contents"> <a href="cmdoptns_8h.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="comment">// Copyright (C) 2001-2010 Gianni Mariani</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// This program is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// (at your option) any later version.</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// GNU General Public License for more details.</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// along with this program; if not, write to the Free Software</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// As a special exception, you may use this file as part of a free software</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// library without restriction. Specifically, if other files instantiate</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// templates or use macros or inline functions from this file, or you compile</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// this file and link it with other files to produce an executable, this</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// file does not by itself cause the resulting executable to be covered by</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// the GNU General Public License. This exception does not however</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// invalidate any other reasons why the executable file might be covered by</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// the GNU General Public License.</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// This exception applies only to the code released under the name GNU</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Common C++. If you copy code from other releases into a copy of GNU</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Common C++, as the General Public License permits, the exception does</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// not apply to the code that you add in this way. To avoid misleading</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// anyone as to the status of such modified files, you must delete</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// this exception notice from them.</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">//</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// If you write modifications of your own for GNU Common C++, it is your choice</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// whether to permit this exception to apply to your modifications.</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// If you do not wish that, delete this exception notice.</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef CCXX_CMDOPTNS_H_</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#define CCXX_CMDOPTNS_H_</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifndef CCXX_STRING_H_</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="string_8h.html">cc++/string.h</a>></span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="keyword">namespace </span>ost {</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">class </span>CommandOption;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">class </span>CommandOptionParse;</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">extern</span> <a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> CommandOption * <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a>;</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html"> 76</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option.html">CommandOption</a> {</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#a3cf7d6f9d1943e981d29c38e2e188231"> 83</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="classost_1_1_command_option.html#a3cf7d6f9d1943e981d29c38e2e188231">optionName</a>;</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ac894a27c5aeeb70ff07387bb721bd7c6"> 89</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="classost_1_1_command_option.html#ac894a27c5aeeb70ff07387bb721bd7c6">optionLetter</a>;</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> <div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ae7c1ad2ef21198b1bef933847ff5d197"> 96</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="classost_1_1_command_option.html#ae7c1ad2ef21198b1bef933847ff5d197">description</a>;</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493"> 103</a></span>  <span class="keyword">enum</span> <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">OptionType</a> {</div> <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a51afdccef3c1eefa378b4ea79872fb9f"> 107</a></span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a51afdccef3c1eefa378b4ea79872fb9f">hasArg</a>,</div> <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a206297cbdc29de03edfa0e24d589b227"> 111</a></span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a206297cbdc29de03edfa0e24d589b227">noArg</a>,</div> <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a4fbaf902c23f48a6d217585297f3afb5"> 115</a></span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a4fbaf902c23f48a6d217585297f3afb5">trailing</a>,</div> <div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a9ebaee9fbe6ef1338347908f6e410095"> 119</a></span>  collect</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  };</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#a2e5f9f895bda7cf7dbe48e0106866368"> 125</a></span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">OptionType</a> <a class="code" href="classost_1_1_command_option.html#a2e5f9f895bda7cf7dbe48e0106866368">optionType</a>; <span class="comment">// HasArg, NoArg or Trailing</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> <div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#a05f8b1439cbf0cf33f47707a33baad57"> 131</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classost_1_1_command_option.html#a05f8b1439cbf0cf33f47707a33baad57">required</a>; <span class="comment">// Option is required - fail without it</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classost_1_1_command_option.html#a0dd94d805913bf11cd188de53baaf27c"> 137</a></span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> * <a class="code" href="classost_1_1_command_option.html#a0dd94d805913bf11cd188de53baaf27c">next</a>;</div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_command_option.html">CommandOption</a>();</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a>(</div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">OptionType</a> inOptionType,</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></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> </div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> foundOption( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop, <span class="keyword">const</span> <span class="keywordtype">char</span> * value = 0 );</div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> foundOption( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop, <span class="keyword">const</span> <span class="keywordtype">char</span> ** value, <span class="keywordtype">int</span> num );</div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> parseDone( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop );</div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> performTask( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop );</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> hasValue();</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> </div> <div class="line"><a name="l00214"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_with_arg.html"> 214</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_command_option.html">CommandOption</a> {</div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div> <div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_with_arg.html#a5ccc2d9deb4a248d8414193385a1fc09"> 220</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> ** <a class="code" href="classost_1_1_command_option_with_arg.html#a5ccc2d9deb4a248d8414193385a1fc09">values</a>;</div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div> <div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_with_arg.html#a1fdb4121e6a385dd52e6599338019ce7"> 225</a></span>  <span class="keywordtype">int</span> <a class="code" href="classost_1_1_command_option_with_arg.html#a1fdb4121e6a385dd52e6599338019ce7">numValue</a>;</div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a>(</div> <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <a class="code" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">OptionType</a> inOptionType,</div> <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  );</div> <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div> <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a>();</div> <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> foundOption( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop, <span class="keyword">const</span> <span class="keywordtype">char</span> * value = 0 );</div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> foundOption( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop, <span class="keyword">const</span> <span class="keywordtype">char</span> ** value, <span class="keywordtype">int</span> num );</div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> hasValue();</div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> };</div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div> <div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_arg.html"> 257</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_arg.html">CommandOptionArg</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> {</div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div> <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <a class="code" href="classost_1_1_command_option_arg.html">CommandOptionArg</a>(</div> <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  );</div> <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_command_option_arg.html">CommandOptionArg</a>();</div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div> <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div> <div class="line"><a name="l00281"></a><span class="lineno"> 281</span> };</div> <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div> <div class="line"><a name="l00292"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_rest.html"> 292</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> {</div> <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> </div> <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <a class="code" href="classost_1_1_command_option_rest.html">CommandOptionRest</a>(</div> <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  );</div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> };</div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div> <div class="line"><a name="l00322"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_collect.html"> 322</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_collect.html">CommandOptionCollect</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> {</div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <a class="code" href="classost_1_1_command_option_collect.html">CommandOptionCollect</a>(</div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  );</div> <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> </div> <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> };</div> <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div> <div class="line"><a name="l00348"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_no_arg.html"> 348</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_no_arg.html">CommandOptionNoArg</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_command_option.html">CommandOption</a> {</div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> </div> <div class="line"><a name="l00354"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_no_arg.html#a34ad5c00e41da5cb4b113e5f5c989436"> 354</a></span>  <span class="keywordtype">int</span> <a class="code" href="classost_1_1_command_option_no_arg.html#a34ad5c00e41da5cb4b113e5f5c989436">numSet</a>; <span class="comment">// The number of times this argument is set</span></div> <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> </div> <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <a class="code" href="classost_1_1_command_option_no_arg.html">CommandOptionNoArg</a>(</div> <div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionName,</div> <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inOptionLetter,</div> <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * inDescription,</div> <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keywordtype">bool</span> inRequired = <span class="keyword">false</span>,</div> <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> ** ppNext = & <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  );</div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> </div> <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> foundOption( <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * cop, <span class="keyword">const</span> <span class="keywordtype">char</span> * value = 0 );</div> <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> </div> <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> };</div> <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> </div> <div class="line"><a name="l00390"></a><span class="lineno"><a class="line" href="classost_1_1_command_option_parse.html"> 390</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> {</div> <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> </div> <div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a>() = 0;</div> <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> </div> <div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> argsHaveError() = 0;</div> <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> </div> <div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * printErrors() = 0;</div> <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> </div> <div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * printUsage() = 0;</div> <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> </div> <div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> registerError( <span class="keyword">const</span> <span class="keywordtype">char</span> * errMsg ) = 0;</div> <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> </div> <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> performTask() = 0;</div> <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> </div> <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> };</div> <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div> <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * <a class="code" href="namespaceost.html#a282d97c4c4323467d6e8b82cb93ec89d">makeCommandOptionParse</a>(</div> <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="keywordtype">int</span> argc,</div> <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  <span class="keywordtype">char</span> ** argv,</div> <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * comment,</div> <div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <a class="code" href="classost_1_1_command_option.html">CommandOption</a> * options = <a class="code" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></div> <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> );</div> <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> </div> <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div> <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="preprocessor"></span></div> <div class="ttc" id="classost_1_1_command_option_no_arg_html_a34ad5c00e41da5cb4b113e5f5c989436"><div class="ttname"><a href="classost_1_1_command_option_no_arg.html#a34ad5c00e41da5cb4b113e5f5c989436">ost::CommandOptionNoArg::numSet</a></div><div class="ttdeci">int numSet</div><div class="ttdoc">The number of times this value has been set. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:354</div></div> <div class="ttc" id="classost_1_1_command_option_html_ae7c1ad2ef21198b1bef933847ff5d197"><div class="ttname"><a href="classost_1_1_command_option.html#ae7c1ad2ef21198b1bef933847ff5d197">ost::CommandOption::description</a></div><div class="ttdeci">const char * description</div><div class="ttdoc">A short description of the option for Usage messages. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:96</div></div> <div class="ttc" id="classost_1_1_command_option_html_ab56f222627bb3843d2b055d42ceaa493a4fbaf902c23f48a6d217585297f3afb5"><div class="ttname"><a href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a4fbaf902c23f48a6d217585297f3afb5">ost::CommandOption::trailing</a></div><div class="ttdoc">Remaining of the command line arguments. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:115</div></div> <div class="ttc" id="classost_1_1_command_option_parse_html"><div class="ttname"><a href="classost_1_1_command_option_parse.html">ost::CommandOptionParse</a></div><div class="ttdoc">This is the CommandOptionParse interface class. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:390</div></div> <div class="ttc" id="string_8h_html"><div class="ttname"><a href="string_8h.html">string.h</a></div><div class="ttdoc">Common C++ generic string class. </div></div> <div class="ttc" id="classost_1_1_command_option_rest_html"><div class="ttname"><a href="classost_1_1_command_option_rest.html">ost::CommandOptionRest</a></div><div class="ttdoc">It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:292</div></div> <div class="ttc" id="classost_1_1_command_option_html_a05f8b1439cbf0cf33f47707a33baad57"><div class="ttname"><a href="classost_1_1_command_option.html#a05f8b1439cbf0cf33f47707a33baad57">ost::CommandOption::required</a></div><div class="ttdeci">bool required</div><div class="ttdoc">True if this parameter is required. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:131</div></div> <div class="ttc" id="config_8h_html_ad10ef148ba8327bd530fc6c32c1e181c"><div class="ttname"><a href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a></div><div class="ttdeci">#define __EXPORT</div><div class="ttdef"><b>Definition:</b> config.h:980</div></div> <div class="ttc" id="classost_1_1_command_option_html_a0dd94d805913bf11cd188de53baaf27c"><div class="ttname"><a href="classost_1_1_command_option.html#a0dd94d805913bf11cd188de53baaf27c">ost::CommandOption::next</a></div><div class="ttdeci">CommandOption * next</div><div class="ttdoc">This next CommandOption in this list of options or nil if no more options exist. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:137</div></div> <div class="ttc" id="namespaceost_html_a282d97c4c4323467d6e8b82cb93ec89d"><div class="ttname"><a href="namespaceost.html#a282d97c4c4323467d6e8b82cb93ec89d">ost::makeCommandOptionParse</a></div><div class="ttdeci">__EXPORT CommandOptionParse * makeCommandOptionParse(int argc, char **argv, const char *comment, CommandOption *options=defaultCommandOptionList)</div><div class="ttdoc">makeCommandOptionParse will create an implementation of a CommandOptionParse object. </div></div> <div class="ttc" id="classost_1_1_command_option_with_arg_html"><div class="ttname"><a href="classost_1_1_command_option_with_arg.html">ost::CommandOptionWithArg</a></div><div class="ttdoc">Derived class of CommandOption for options that have a value associated with them. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:214</div></div> <div class="ttc" id="classost_1_1_command_option_arg_html"><div class="ttname"><a href="classost_1_1_command_option_arg.html">ost::CommandOptionArg</a></div><div class="ttdoc">Class for options with an argument e.g. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:257</div></div> <div class="ttc" id="classost_1_1_command_option_html_ab56f222627bb3843d2b055d42ceaa493a206297cbdc29de03edfa0e24d589b227"><div class="ttname"><a href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a206297cbdc29de03edfa0e24d589b227">ost::CommandOption::noArg</a></div><div class="ttdoc">This option is a flag only. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:111</div></div> <div class="ttc" id="classost_1_1_command_option_html_a2e5f9f895bda7cf7dbe48e0106866368"><div class="ttname"><a href="classost_1_1_command_option.html#a2e5f9f895bda7cf7dbe48e0106866368">ost::CommandOption::optionType</a></div><div class="ttdeci">OptionType optionType</div><div class="ttdoc">This command option&#39;s OptionType. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:125</div></div> <div class="ttc" id="classost_1_1_command_option_with_arg_html_a5ccc2d9deb4a248d8414193385a1fc09"><div class="ttname"><a href="classost_1_1_command_option_with_arg.html#a5ccc2d9deb4a248d8414193385a1fc09">ost::CommandOptionWithArg::values</a></div><div class="ttdeci">const char ** values</div><div class="ttdoc">Array of list of values collected for this option. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:220</div></div> <div class="ttc" id="classost_1_1_command_option_html"><div class="ttname"><a href="classost_1_1_command_option.html">ost::CommandOption</a></div><div class="ttdoc">CommandOption is the base class for all command line options. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:76</div></div> <div class="ttc" id="classost_1_1_command_option_no_arg_html"><div class="ttname"><a href="classost_1_1_command_option_no_arg.html">ost::CommandOptionNoArg</a></div><div class="ttdoc">CommandOption type for flags. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:348</div></div> <div class="ttc" id="classost_1_1_command_option_with_arg_html_a1fdb4121e6a385dd52e6599338019ce7"><div class="ttname"><a href="classost_1_1_command_option_with_arg.html#a1fdb4121e6a385dd52e6599338019ce7">ost::CommandOptionWithArg::numValue</a></div><div class="ttdeci">int numValue</div><div class="ttdoc">Number of values in the values array. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:225</div></div> <div class="ttc" id="classost_1_1_command_option_html_a3cf7d6f9d1943e981d29c38e2e188231"><div class="ttname"><a href="classost_1_1_command_option.html#a3cf7d6f9d1943e981d29c38e2e188231">ost::CommandOption::optionName</a></div><div class="ttdeci">const char * optionName</div><div class="ttdoc">Long option name, these will be preceded with &quot;--&quot; on the command line. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:83</div></div> <div class="ttc" id="classost_1_1_command_option_html_ab56f222627bb3843d2b055d42ceaa493"><div class="ttname"><a href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">ost::CommandOption::OptionType</a></div><div class="ttdeci">OptionType</div><div class="ttdoc">OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing a...</div><div class="ttdef"><b>Definition:</b> cmdoptns.h:103</div></div> <div class="ttc" id="namespaceost_html_a3b701311bbf7cf16f954820e316f5766"><div class="ttname"><a href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">ost::defaultCommandOptionList</a></div><div class="ttdeci">__EXPORT CommandOption * defaultCommandOptionList</div><div class="ttdoc">This defines a linked list head pointer for all the command line options that use the default list...</div></div> <div class="ttc" id="classost_1_1_command_option_html_ab56f222627bb3843d2b055d42ceaa493a51afdccef3c1eefa378b4ea79872fb9f"><div class="ttname"><a href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493a51afdccef3c1eefa378b4ea79872fb9f">ost::CommandOption::hasArg</a></div><div class="ttdoc">This option is associated with a value. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:107</div></div> <div class="ttc" id="classost_1_1_command_option_collect_html"><div class="ttname"><a href="classost_1_1_command_option_collect.html">ost::CommandOptionCollect</a></div><div class="ttdoc">It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest...</div><div class="ttdef"><b>Definition:</b> cmdoptns.h:322</div></div> <div class="ttc" id="classost_1_1_command_option_html_ac894a27c5aeeb70ff07387bb721bd7c6"><div class="ttname"><a href="classost_1_1_command_option.html#ac894a27c5aeeb70ff07387bb721bd7c6">ost::CommandOption::optionLetter</a></div><div class="ttdeci">const char * optionLetter</div><div class="ttdoc">option letter, these will be preceded with &quot;-&quot; on the command line. </div><div class="ttdef"><b>Definition:</b> cmdoptns.h:89</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 17 2013 23:24:56 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>