|
|
| Arguments (Context &context, const PString &rawLine) |
|
|
Context & | WriteUsage () |
| Write to the CLI output channel the usage for the current command. More...
|
|
Context & | WriteError (const PString &error=PString::Empty()) |
| Write an error to the CLI output channel. More...
|
|
|
Context & | GetContext () const |
| Get the CLI context supplying the command line arguments. More...
|
|
| PArgList (const char *theArgPtr=NULL, const char *argumentSpecPtr=NULL, PBoolean optionsBeforeParams=true) |
| Create an argument list. More...
|
|
| PArgList (const PString &theArgStr, const char *argumentSpecPtr=NULL, PBoolean optionsBeforeParams=true) |
| Create an argument list. More...
|
|
| PArgList (const PString &theArgStr, const PString &argumentSpecStr, PBoolean optionsBeforeParams=true) |
| Create an argument list. More...
|
|
| PArgList (int theArgc, char **theArgv, const char *argumentSpecPtr=NULL, PBoolean optionsBeforeParams=true) |
| Create an argument list. More...
|
|
| PArgList (int theArgc, char **theArgv, const PString &argumentSpecStr, PBoolean optionsBeforeParams=true) |
| Create an argument list. More...
|
|
virtual void | PrintOn (ostream &strm) const |
| Output the string to the specified stream. More...
|
|
virtual void | ReadFrom (istream &strm) |
| Input the string from the specified stream. More...
|
|
void | SetArgs (const PString &theArgStr) |
| Set the internal copy of the program arguments. More...
|
|
void | SetArgs (int theArgc, char **theArgv) |
| Set the internal copy of the program arguments. More...
|
|
void | SetArgs (const PStringArray &theArgs) |
| Set the internal copy of the program arguments. More...
|
|
virtual PBoolean | Parse (const char *theArgumentSpec, PBoolean optionsBeforeParams=true) |
| Parse the arguments. More...
|
|
virtual PBoolean | Parse (const PString &theArgumentStr, PBoolean optionsBeforeParams=true) |
| Parse the arguments. More...
|
|
virtual PINDEX | GetOptionCount (char optionChar) const |
| Get the count of the number of times the option was specified on the command line. More...
|
|
virtual PINDEX | GetOptionCount (const char *optionStr) const |
| Get the count of option. More...
|
|
virtual PINDEX | GetOptionCount (const PString &optionName) const |
| Get the count of option. More...
|
|
PBoolean | HasOption (char optionChar) const |
| Get if option present. More...
|
|
PBoolean | HasOption (const char *optionStr) const |
| Get if option present. More...
|
|
PBoolean | HasOption (const PString &optionName) const |
| Get if option present. More...
|
|
virtual PString | GetOptionString (char optionChar, const char *dflt=NULL) const |
| Get option string. More...
|
|
virtual PString | GetOptionString (const char *optionStr, const char *dflt=NULL) const |
| Get option string. More...
|
|
virtual PString | GetOptionString (const PString &optionName, const char *dflt=NULL) const |
| Get option string. More...
|
|
PINDEX | GetCount () const |
| Get the argument count. More...
|
|
PStringArray | GetParameters (PINDEX first=0, PINDEX last=P_MAX_INDEX) const |
| Get the parameters that were parsed in the argument list. More...
|
|
PString | GetParameter (PINDEX num) const |
| Get the parameter that was parsed in the argument list. More...
|
|
PString | operator[] (PINDEX num) const |
| Get the parameter that was parsed in the argument list. More...
|
|
void | Shift (int sh) |
| Shift the parameters by the specified amount. More...
|
|
PArgList & | operator<< (int sh) |
| Shift the parameters by the specified amount. More...
|
|
PArgList & | operator>> (int sh) |
| Shift the parameters by the specified amount. More...
|
|
virtual void | IllegalArgumentIndex (PINDEX idx) const |
| This function is called when access to illegal parameter index is made in the GetParameter function. More...
|
|
virtual void | UnknownOption (const PString &option) const |
| This function is called when an unknown option was specified on the command line. More...
|
|
virtual void | MissingArgument (const PString &option) const |
| This function is called when an option that requires an associated string was specified on the command line but no associated string was provided. More...
|
|
virtual | ~PObject () |
|
virtual PObject * | Clone () const |
| Create a copy of the class on the heap. More...
|
|
virtual PINDEX | HashFunction () const |
| This function yields a hash value required by the PDictionary class. More...
|
|
virtual Comparison | Compare (const PObject &obj) const |
| Compare the two objects and return their relative rank. More...
|
|
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects. More...
|
|
bool | operator== (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator!= (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator< (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator> (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator<= (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator>= (const PObject &obj) const |
| Compare the two objects. More...
|
|
virtual const char * | GetClass (unsigned ancestor=0) const |
| Get the current dynamic type of the object instance. More...
|
|
PBoolean | IsClass (const char *cls) const |
|
virtual PBoolean | InternalIsDescendant (const char *clsName) const |
| Determine if the dynamic type of the current instance is a descendent of the specified class. More...
|
|
This class is an enhancement to PArgList to add context.