<!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: CommandLine 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="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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classCommandLine-members.xhtml">List of all members</a> </div>
<div class="headertitle">
<div class="title">CommandLine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCommandLine_1_1Args.xhtml">Args</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a144de1a623e5aca8544e4a18f56b1718"><td class="memItemLeft" align="right" valign="top"><a id="a144de1a623e5aca8544e4a18f56b1718"></a>enum  </td><td class="memItemRight" valign="bottom"><b>AFlags</b> { <br />
  <b>HasArg</b> = (1 << 0),
<b>IntLevel</b> = (1 << 1),
<b>Boolean</b> = (1 << 2),
<b>InvBoolean</b> = (1 << 3),
<br />
  <b>ConfigFile</b> = (1 << 4) | HasArg,
<b>ArbItem</b> = (1 << 5) | HasArg
<br />
}</td></tr>
<tr class="separator:a144de1a623e5aca8544e4a18f56b1718"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a126fb7c56c821d027a99fb1ae87d9684"><td class="memItemLeft" align="right" valign="top"><a id="a126fb7c56c821d027a99fb1ae87d9684"></a>
bool </td><td class="memItemRight" valign="bottom"><b>Parse</b> (int argc, const char **argv)</td></tr>
<tr class="separator:a126fb7c56c821d027a99fb1ae87d9684"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab180efaa64feefae6244d2c4b4eb7809"><td class="memItemLeft" align="right" valign="top"><a id="ab180efaa64feefae6244d2c4b4eb7809"></a>
void </td><td class="memItemRight" valign="bottom"><b>ShowHelp</b> ()</td></tr>
<tr class="separator:ab180efaa64feefae6244d2c4b4eb7809"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00e0059cbef4abb607519d5b5ac27d4e"><td class="memItemLeft" align="right" valign="top"><a id="a00e0059cbef4abb607519d5b5ac27d4e"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>FileSize</b> () const APT_PURE</td></tr>
<tr class="separator:a00e0059cbef4abb607519d5b5ac27d4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d8af7a43d9909e23d48528f9cf4f00e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommandLine.xhtml#a9d8af7a43d9909e23d48528f9cf4f00e">DispatchArg</a> (<a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> *List, bool NoMatch=true)</td></tr>
<tr class="separator:a9d8af7a43d9909e23d48528f9cf4f00e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16668aeee366c58432bcaf495415641d"><td class="memItemLeft" align="right" valign="top"><a id="a16668aeee366c58432bcaf495415641d"></a>
bool </td><td class="memItemRight" valign="bottom"><b>DispatchArg</b> (<a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> const *const List, bool NoMatch=true)</td></tr>
<tr class="separator:a16668aeee366c58432bcaf495415641d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adde3c1db729b33fd853f7323181fe26c"><td class="memItemLeft" align="right" valign="top"><a id="adde3c1db729b33fd853f7323181fe26c"></a>
 </td><td class="memItemRight" valign="bottom"><b>CommandLine</b> (<a class="el" href="structCommandLine_1_1Args.xhtml">Args</a> *AList, <a class="el" href="classConfiguration.xhtml">Configuration</a> *Conf)</td></tr>
<tr class="separator:adde3c1db729b33fd853f7323181fe26c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae95847c73c63fe09a42b29bb0525c14c"><td class="memItemLeft" align="right" valign="top">static char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommandLine.xhtml#ae95847c73c63fe09a42b29bb0525c14c">GetCommand</a> (<a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> const *const Map, unsigned int const argc, char const *const *const argv) APT_PURE</td></tr>
<tr class="separator:ae95847c73c63fe09a42b29bb0525c14c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17eab98e809d614e1db289be3967a9f2"><td class="memItemLeft" align="right" valign="top"><a id="a17eab98e809d614e1db289be3967a9f2"></a>
static <a class="el" href="structCommandLine_1_1Args.xhtml">CommandLine::Args</a> </td><td class="memItemRight" valign="bottom"><b>MakeArgs</b> (char ShortOpt, char const *LongOpt, char const *ConfName, unsigned long Flags) APT_CONST</td></tr>
<tr class="separator:a17eab98e809d614e1db289be3967a9f2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a006171d2d73c40a3e756a94bc6ae491b"><td class="memItemLeft" align="right" valign="top"><a id="a006171d2d73c40a3e756a94bc6ae491b"></a>
const char ** </td><td class="memItemRight" valign="bottom"><b>FileList</b></td></tr>
<tr class="separator:a006171d2d73c40a3e756a94bc6ae491b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af155ad04a75d5eaac1d4c4d78c3ca35e"><td class="memItemLeft" align="right" valign="top"><a id="af155ad04a75d5eaac1d4c4d78c3ca35e"></a>
bool </td><td class="memItemRight" valign="bottom"><b>HandleOpt</b> (int &I, int argc, const char *argv[], const char *&Opt, <a class="el" href="structCommandLine_1_1Args.xhtml">Args</a> *A, bool PreceedeMatch=false)</td></tr>
<tr class="separator:af155ad04a75d5eaac1d4c4d78c3ca35e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a62f4c88a6fc106c1575dd38f5715084a"><td class="memItemLeft" align="right" valign="top"><a id="a62f4c88a6fc106c1575dd38f5715084a"></a>
static void </td><td class="memItemRight" valign="bottom"><b>SaveInConfig</b> (unsigned int const &argc, char const *const *const argv)</td></tr>
<tr class="separator:a62f4c88a6fc106c1575dd38f5715084a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6eac0dd981baa63b7ae17bcb4f4a94af"><td class="memItemLeft" align="right" valign="top"><a id="a6eac0dd981baa63b7ae17bcb4f4a94af"></a>
<a class="el" href="structCommandLine_1_1Args.xhtml">Args</a> * </td><td class="memItemRight" valign="bottom"><b>ArgList</b></td></tr>
<tr class="separator:a6eac0dd981baa63b7ae17bcb4f4a94af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafe4ebd997311e3d02ae67430910f03e"><td class="memItemLeft" align="right" valign="top"><a id="aafe4ebd997311e3d02ae67430910f03e"></a>
<a class="el" href="classConfiguration.xhtml">Configuration</a> * </td><td class="memItemRight" valign="bottom"><b>Conf</b></td></tr>
<tr class="separator:aafe4ebd997311e3d02ae67430910f03e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9d8af7a43d9909e23d48528f9cf4f00e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d8af7a43d9909e23d48528f9cf4f00e">◆ </a></span>DispatchArg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DispatchArg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> * </td>
<td class="paramname"><em>List</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>NoMatch</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000036">Todo:</a></b></dt><dd>merge on next ABI break </dd></dl>
<p class="reference">Referenced by <a class="el" href="classCommandLine.xhtml#ae95847c73c63fe09a42b29bb0525c14c">GetCommand()</a>.</p>
</div>
</div>
<a id="ae95847c73c63fe09a42b29bb0525c14c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae95847c73c63fe09a42b29bb0525c14c">◆ </a></span>GetCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char const * GetCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCommandLine_1_1Dispatch.xhtml">Dispatch</a> const *const </td>
<td class="paramname"><em>Map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int const </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *const *const </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000035">Todo:</a></b></dt><dd>How like is it that an option parameter will be also a valid Match ? </dd></dl>
<p class="reference">References <a class="el" href="classCommandLine.xhtml#a9d8af7a43d9909e23d48528f9cf4f00e">DispatchArg()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>apt-pkg/contrib/<a class="el" href="cmndline_8h_source.xhtml">cmndline.h</a></li>
<li>apt-pkg/contrib/cmndline.cc</li>
</ul>
</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>
