<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>apt: apt-pkg/contrib/cmndline.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">apt
 <span id="projectnumber">1.4.6</span>
</div>
<div id="projectbrief">commandline package manager</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_18f22d4be2ca84c350e120b6506056ca.xhtml">apt-pkg</a></li><li class="navelem"><a class="el" href="dir_c6ef23f15b074dcedf6810e24f2a7676.xhtml">contrib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cmndline.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- mode: cpp; mode: fold -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Description /*{{{*/</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// $Id: cmndline.h,v 1.7 1999/10/31 06:32:28 jgg Exp $</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* ######################################################################</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Command Line Class - Sophisticated command line parser</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 class provides a unified command line parser/option handliner/</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> configuration mechanism. It allows the caller to specify the option</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> set and map the option set into the configuration class or other</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> special functioning.</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"> Filenames are stripped from the option stream and put into their</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> own array.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> </span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> The argument descriptor array can be initialized as:</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> </span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> CommandLine::Args Args[] = </span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> {{'q',"quiet","apt::get::quiet",CommandLine::IntLevel},</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> {0,0,0,0}};</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> </span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> The flags mean,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> HasArg - Means the argument has a value</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> IntLevel - Means the argument is an integer level indication, the</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> following -qqqq (+3) -q5 (=5) -q=5 (=5) are valid</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> Boolean - Means it is true/false or yes/no. </span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> -d (true) --no-d (false) --yes-d (true)</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> --long (true) --no-long (false) --yes-long (true)</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> -d=yes (true) -d=no (false) Words like enable, disable,</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> true false, yes no and on off are recognized in logical </span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> places.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> InvBoolean - Same as boolean but the case with no specified sense</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> (first case) is set to false.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> ConfigFile - Means this flag should be interprited as the name of </span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> a config file to read in at this point in option processing.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> Implies HasArg.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> ArbItem - Means the item is an arbitrary configuration string of</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> the form item=value, where item is passed directly</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> to the configuration class.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> The default, if the flags are 0 is to use Boolean</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> </span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> ##################################################################### */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifndef PKGLIB_CMNDLINE_H</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define PKGLIB_CMNDLINE_H</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#include <apt-pkg/configuration.h></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">class </span><a class="code" href="classConfiguration.xhtml">Configuration</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classCommandLine.xhtml"> 55</a></span> <span class="keyword">class </span><a class="code" href="classCommandLine.xhtml">CommandLine</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">struct </span><a class="code" href="structCommandLine_1_1Args.xhtml">Args</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">struct </span><a class="code" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">struct </span>DispatchWithHelp;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="structCommandLine_1_1Args.xhtml">Args</a> *ArgList;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classConfiguration.xhtml">Configuration</a> *Conf;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> HandleOpt(<span class="keywordtype">int</span> &I,<span class="keywordtype">int</span> argc,<span class="keyword">const</span> <span class="keywordtype">char</span> *argv[],</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *&Opt,<a class="code" href="structCommandLine_1_1Args.xhtml">Args</a> *A,<span class="keywordtype">bool</span> PreceedeMatch = <span class="keyword">false</span>);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> <span class="keyword">static</span> SaveInConfig(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> &argc, <span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> * <span class="keyword">const</span> argv);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">enum</span> AFlags </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  HasArg = (1 << 0),</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  IntLevel = (1 << 1),</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  Boolean = (1 << 2),</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  InvBoolean = (1 << 3),</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ConfigFile = (1 << 4) | HasArg,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  ArbItem = (1 << 5) | HasArg</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **FileList;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">bool</span> Parse(<span class="keywordtype">int</span> argc,<span class="keyword">const</span> <span class="keywordtype">char</span> **argv);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> ShowHelp();</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FileSize() <span class="keyword">const</span> APT_PURE;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// FIXME: merge on next ABI break</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">bool</span> <a class="code" href="classCommandLine.xhtml#a9d8af7a43d9909e23d48528f9cf4f00e">DispatchArg</a>(<a class="code" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> *List,<span class="keywordtype">bool</span> NoMatch = <span class="keyword">true</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> <a class="code" href="classCommandLine.xhtml#a9d8af7a43d9909e23d48528f9cf4f00e">DispatchArg</a>(<a class="code" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> <span class="keyword">const</span> * <span class="keyword">const</span> List,<span class="keywordtype">bool</span> NoMatch = <span class="keyword">true</span>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">static</span> <span class="keywordtype">char</span> <span class="keyword">const</span> * <a class="code" href="classCommandLine.xhtml#ae95847c73c63fe09a42b29bb0525c14c">GetCommand</a>(<a class="code" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> <span class="keyword">const</span> * <span class="keyword">const</span> Map,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> argc, <span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> * <span class="keyword">const</span> argv) APT_PURE;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">static</span> <a class="code" href="structCommandLine_1_1Args.xhtml">CommandLine::Args</a> MakeArgs(<span class="keywordtype">char</span> ShortOpt, <span class="keywordtype">char</span> <span class="keyword">const</span> *LongOpt,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">char</span> <span class="keyword">const</span> *ConfName, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Flags) APT_CONST;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classCommandLine.xhtml">CommandLine</a>();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classCommandLine.xhtml">CommandLine</a>(<a class="code" href="structCommandLine_1_1Args.xhtml">Args</a> *AList,<a class="code" href="classConfiguration.xhtml">Configuration</a> *Conf);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ~<a class="code" href="classCommandLine.xhtml">CommandLine</a>();</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="structCommandLine_1_1Args.xhtml"> 102</a></span> <span class="keyword">struct </span><a class="code" href="structCommandLine_1_1Args.xhtml">CommandLine::Args</a></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">char</span> ShortOpt;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *LongOpt;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *ConfName;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Flags;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> end() {<span class="keywordflow">return</span> ShortOpt == 0 && LongOpt == 0;};</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsBoolean() {<span class="keywordflow">return</span> Flags == 0 || (Flags & (Boolean|InvBoolean)) != 0;};</div><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> </div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="structCommandLine_1_1Dispatch.xhtml"> 113</a></span> <span class="keyword">struct </span><a class="code" href="structCommandLine_1_1Dispatch.xhtml">CommandLine::Dispatch</a></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *Match;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  bool (*Handler)(<a class="code" href="classCommandLine.xhtml">CommandLine</a> &);</div><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> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structCommandLine_1_1Args_xhtml"><div class="ttname"><a href="structCommandLine_1_1Args.xhtml">CommandLine::Args</a></div><div class="ttdef"><b>Definition:</b> cmndline.h:102</div></div>
<div class="ttc" id="classCommandLine_xhtml"><div class="ttname"><a href="classCommandLine.xhtml">CommandLine</a></div><div class="ttdef"><b>Definition:</b> cmndline.h:55</div></div>
<div class="ttc" id="classCommandLine_xhtml_ae95847c73c63fe09a42b29bb0525c14c"><div class="ttname"><a href="classCommandLine.xhtml#ae95847c73c63fe09a42b29bb0525c14c">CommandLine::GetCommand</a></div><div class="ttdeci">static char const * GetCommand(Dispatch const *const Map, unsigned int const argc, char const *const *const argv) APT_PURE</div><div class="ttdef"><b>Definition:</b> cmndline.cc:50</div></div>
<div class="ttc" id="structCommandLine_1_1Dispatch_xhtml"><div class="ttname"><a href="structCommandLine_1_1Dispatch.xhtml">CommandLine::Dispatch</a></div><div class="ttdef"><b>Definition:</b> cmndline.h:113</div></div>
<div class="ttc" id="classConfiguration_xhtml"><div class="ttname"><a href="classConfiguration.xhtml">Configuration</a></div><div class="ttdef"><b>Definition:</b> configuration.h:43</div></div>
<div class="ttc" id="classCommandLine_xhtml_a9d8af7a43d9909e23d48528f9cf4f00e"><div class="ttname"><a href="classCommandLine.xhtml#a9d8af7a43d9909e23d48528f9cf4f00e">CommandLine::DispatchArg</a></div><div class="ttdeci">bool DispatchArg(Dispatch *List, bool NoMatch=true)</div><div class="ttdef"><b>Definition:</b> cmndline.cc:385</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
