Puma Reference Manual | Puma::OptsParser Class Reference |
The Options Parser searches command line parameters for options and handles their option arguments, if applicable. More...
#include <OptsParser.h>
Classes | |
struct | Option |
Public Types | |
enum | { NOARG = -4, ERR = -3, NOOPTION = -2, UNKNOWN = -1, FINISH = 0 } |
enum | ArgType { AT_NONE = 0, AT_MANDATORY = 1, AT_OPTIONAL = 2 } |
Public Member Functions | |
OptsParser (int argc, char **argv, const Option *opts) | |
Constructor of OptsParser. | |
OptsParser (const string &line, const Option *opts) | |
Constructor of OptsParser. | |
int | getRawOption () |
Get next parameter without modification. | |
int | getOption () |
Get next option. | |
int | getResult () const |
Get result of last processed parameter. | |
const string & | getArgument () const |
Get option argument of last processed parameter. | |
const string & | getOptionName () const |
Get option name of last processed parameter. | |
int | getCurrentArgNum () const |
Get position of current argument. | |
int | getNextArgNum () const |
Get position of next argument. |
Additional Inherited Members | |
![]() | |
static string | strip (const string &str) |
Remove enclosing double-quotes from a string. | |
static int | tokenize (const string &str, vector< string > &tokens, const string &delimiters=" ") |
Splits a given string into tokens recognized by the given delimiters. |
The Options Parser searches command line parameters for options and handles their option arguments, if applicable.
anonymous enum |
Puma::OptsParser::OptsParser | ( | int | argc, |
char ** | argv, | ||
const Option * | opts | ||
) |
Constructor of OptsParser.
argc | Number of parameters to be analyzed |
argv | Parameters to be analyzed |
opts | Pointer to array of options which shall be recognized by the options parser |
Puma::OptsParser::OptsParser | ( | const string & | line, |
const Option * | opts | ||
) |
Constructor of OptsParser.
line | Reference to string with parameters to analyse The paramaters are extracted from the string by splitting it up into tokens at:
|
opts | Pointer to array of options which shall be recognized by the options parser |
const string& Puma::OptsParser::getArgument | ( | ) | const |
Get option argument of last processed parameter.
This function returns the argument of the option processed during OptsParser::getOption. If the option does not provide any argument the string will be empty.
If OptsParser::getOption or respectively OptsParser::getResult returns with OptsParser::NOOPTION this function (OptsParser::getArgument) returns the last processed parameter, which is no option, of course.
int Puma::OptsParser::getCurrentArgNum | ( | ) | const |
Get position of current argument.
int Puma::OptsParser::getNextArgNum | ( | ) | const |
Get position of next argument.
int Puma::OptsParser::getOption | ( | ) |
Get next option.
This function processes the next parameter passed to the constructor OptsParser::OptsParser(). That is, search for options and eventually process option and option arguement.
const string& Puma::OptsParser::getOptionName | ( | ) | const |
Get option name of last processed parameter.
If the last processed parameter did not contain an option the string returned by this function is empty.
int Puma::OptsParser::getRawOption | ( | ) |
Get next parameter without modification.
No option parsing is done
int Puma::OptsParser::getResult | ( | ) | const |
Get result of last processed parameter.
The number returned by this function is identical to the number returned by the last call of OptsParser::getOption