📄 classparglist.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PArgList class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PArgList Class Reference</h1><code>#include <<a class="el" href="args_8h-source.html">args.h</a>></code><p><p>Inheritance diagram for PArgList:<p><center><img src="classPArgList.png" usemap="#PArgList_map" border="0" alt=""></center><map name="PArgList_map"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,84,24"><area href="classPConfigArgs.html" alt="PConfigArgs" shape="rect" coords="0,112,84,136"></map><a href="classPArgList-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPArgList.html#z3_0">PArgList</a> (const char *theArgPtr=NULL, const char *argumentSpecPtr=NULL, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPArgList.html#z3_1">PArgList</a> (const <a class="el" href="classPString.html">PString</a> &theArgStr, const char *argumentSpecPtr=NULL, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPArgList.html#z3_2">PArgList</a> (const <a class="el" href="classPString.html">PString</a> &theArgStr, const <a class="el" href="classPString.html">PString</a> &argumentSpecStr, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPArgList.html#z3_3">PArgList</a> (int theArgc, char **theArgv, const char *argumentSpecPtr=NULL, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPArgList.html#z3_4">PArgList</a> (int theArgc, char **theArgv, const <a class="el" href="classPString.html">PString</a> &argumentSpecStr, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td colspan="2"><div class="groupHeader">Overrides from class PObject</div></td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPArgList.html#z5_0">PrintOn</a> (ostream &strm) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPArgList.html#z5_1">ReadFrom</a> (istream &strm)</td></tr><tr><td colspan="2"><div class="groupHeader">Setting & Parsing</div></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPArgList.html#z7_0">SetArgs</a> (const <a class="el" href="classPString.html">PString</a> &theArgStr)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPArgList.html#z7_1">SetArgs</a> (int theArgc, char **theArgv)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPArgList.html#z7_2">SetArgs</a> (const <a class="el" href="classPStringArray.html">PStringArray</a> &theArgs)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPArgList.html#z7_3">Parse</a> (const char *theArgumentSpec, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPArgList.html#z7_4">Parse</a> (const <a class="el" href="classPString.html">PString</a> &theArgumentStr, BOOL optionsBeforeParams=TRUE)</td></tr><tr><td colspan="2"><div class="groupHeader">Getting parsed arguments</div></td></tr><tr><td nowrap align=right valign=top>virtual PINDEX </td><td valign=bottom><a class="el" href="classPArgList.html#z9_0">GetOptionCount</a> (char optionChar) const</td></tr><tr><td nowrap align=right valign=top>virtual PINDEX </td><td valign=bottom><a class="el" href="classPArgList.html#z9_1">GetOptionCount</a> (const char *optionStr) const</td></tr><tr><td nowrap align=right valign=top>virtual PINDEX </td><td valign=bottom><a class="el" href="classPArgList.html#z9_2">GetOptionCount</a> (const <a class="el" href="classPString.html">PString</a> &optionName) const</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPArgList.html#z9_3">HasOption</a> (char optionChar) const</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPArgList.html#z9_4">HasOption</a> (const char *optionStr) const</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPArgList.html#z9_5">HasOption</a> (const <a class="el" href="classPString.html">PString</a> &optionName) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_6">GetOptionString</a> (char optionChar, const char *dflt=NULL) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_7">GetOptionString</a> (const char *optionStr, const char *dflt=NULL) const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_8">GetOptionString</a> (const <a class="el" href="classPString.html">PString</a> &optionName, const char *dflt=NULL) const</td></tr><tr><td nowrap align=right valign=top>PINDEX </td><td valign=bottom><a class="el" href="classPArgList.html#z9_9">GetCount</a> () const</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPStringArray.html">PStringArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_10">GetParameters</a> (PINDEX first=0, PINDEX last=P_MAX_INDEX) const</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_11">GetParameter</a> (PINDEX num) const</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#z9_12">operator[]</a> (PINDEX num) const</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPArgList.html#z9_13">Shift</a> (int sh)</td></tr><tr><td nowrap align=right valign=top>PArgList & </td><td valign=bottom><a class="el" href="classPArgList.html#z9_14">operator<<</a> (int sh)</td></tr><tr><td nowrap align=right valign=top>PArgList & </td><td valign=bottom><a class="el" href="classPArgList.html#z9_15">operator>></a> (int sh)</td></tr><tr><td colspan="2"><div class="groupHeader">Errors</div></td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPArgList.html#z11_0">IllegalArgumentIndex</a> (PINDEX idx) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPArgList.html#z11_1">UnknownOption</a> (const <a class="el" href="classPString.html">PString</a> &option) const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPArgList.html#z11_2">MissingArgument</a> (const <a class="el" href="classPString.html">PString</a> &option) const</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPStringArray.html">PStringArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n0">argumentArray</a></td></tr><tr><td> </td><td><font size=-1><em>The original program arguments.</em> <a href="#n0"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n1">optionLetters</a></td></tr><tr><td> </td><td><font size=-1><em>The specification letters for options.</em> <a href="#n1"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPStringArray.html">PStringArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n2">optionNames</a></td></tr><tr><td> </td><td><font size=-1><em>The specification strings for options.</em> <a href="#n2"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPIntArray.html">PIntArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n3">optionCount</a></td></tr><tr><td> </td><td><font size=-1><em>The count of the number of times an option appeared in the command line.</em> <a href="#n3"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPStringArray.html">PStringArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n4">optionString</a></td></tr><tr><td> </td><td><font size=-1><em>The array of associated strings to options.</em> <a href="#n4"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPIntArray.html">PIntArray</a> </td><td valign=bottom><a class="el" href="classPArgList.html#n5">parameterIndex</a></td></tr><tr><td> </td><td><font size=-1><em>The index of each .</em> <a href="#n5"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPArgList.html#n6">shift</a></td></tr><tr><td> </td><td><font size=-1><em>Shift count for the parameters in the argument list.</em> <a href="#n6"></a><em></em></font><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class allows the parsing of a set of program arguments. This translates the standard argc/argv style variables passed into the main() function into a set of options (preceded by a '-' character) and parameters. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="z3_0" doxytag="PArgList::PArgList"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PArgList::PArgList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>theArgPtr</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>argumentSpecPtr</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>optionsBeforeParams</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create an argument list. An argument list is created given the standard arguments and a specification for options. The program arguments are parsed from this into options and parameters.<p>The specification string consists of case significant letters for each option. If the letter is followed by the ':' character then the option has an associated string. This string must be in the argument or in the next argument. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>argumentSpecPtr</em> </td><td>A string constituting the arguments </td></tr><tr><td valign=top><em>optionsBeforeParams</em> </td><td>The specification C string for argument options. See description for details. Parse options only before parameters </td></tr></table></dl> </td> </tr></table><a name="z3_1" doxytag="PArgList::PArgList"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PArgList::PArgList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>theArgStr</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>argumentSpecPtr</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>optionsBeforeParams</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create an argument list. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>argumentSpecPtr</em> </td><td>A string constituting the arguments </td></tr><tr><td valign=top><em>optionsBeforeParams</em> </td><td>The specification C string for argument options. See description for details. Parse options only before parameters </td></tr></table></dl> </td> </tr></table><a name="z3_2" doxytag="PArgList::PArgList"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PArgList::PArgList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>theArgStr</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>argumentSpecStr</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>optionsBeforeParams</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create an argument list. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>argumentSpecStr</em> </td><td>A string constituting the arguments </td></tr><tr><td valign=top><em>optionsBeforeParams</em> </td><td>The specification string for argument options. See description for details. Parse options only before parameters </td></tr></table></dl> </td> </tr></table><a name="z3_3" doxytag="PArgList::PArgList"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PArgList::PArgList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname" nowrap> <em>theArgc</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>char ** </td> <td class="mdname" nowrap> <em>theArgv</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>argumentSpecPtr</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>optionsBeforeParams</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create an argument list. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>theArgv</em> </td><td>Count of argument strings in theArgv </td></tr><tr><td valign=top><em>argumentSpecPtr</em> </td><td>An array of strings constituting the arguments </td></tr><tr><td valign=top><em>optionsBeforeParams</em> </td><td>The specification C string for argument options. See description for details. Parse options only before parameters </td></tr></table></dl> </td> </tr></table><a name="z3_4" doxytag="PArgList::PArgList"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PArgList::PArgList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname" nowrap> <em>theArgc</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>char ** </td> <td class="mdname" nowrap> <em>theArgv</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>argumentSpecStr</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>optionsBeforeParams</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create an argument list. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>theArgv</em> </td><td>Count of argument strings in theArgv </td></tr><tr><td valign=top><em>argumentSpecStr</em> </td><td>An array of strings constituting the arguments </td></tr><tr><td valign=top><em>optionsBeforeParams</em> </td><td>The specification string for argument options. See description for details. Parse options only before parameters </td></tr></table></dl> </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="z9_9" doxytag="PArgList::GetCount"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PINLINE PINDEX PArgList::GetCount </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get the argument count. Get the number of parameters that may be obtained via the <a class="el" href="classPArgList.html#z9_11">GetParameter()</a># function. Note that this does not include options and option strings.<p><dl compact><dt><b>Returns: </b></dt><dd>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -