A virtual base class that defines the essential data for all arguments.
This class, or one of its existing children, must be subclassed to do anything.
#include <mrpt/otherlibs/tclap/Arg.h>
Public Member Functions | |
virtual | ~Arg () |
Destructor. More... | |
virtual void | addToList (std::list< Arg *> &argList) const |
Adds this to the specified list of Args. More... | |
virtual bool | processArg (int *i, std::vector< std::string > &args)=0 |
Pure virtual method meant to handle the parsing and value assignment of the string on the command line. More... | |
virtual bool | operator== (const Arg &a) const |
Operator ==. More... | |
const std::string & | getFlag () const |
Returns the argument flag. More... | |
const std::string & | getName () const |
Returns the argument name. More... | |
std::string | getDescription () const |
Returns the argument description. More... | |
virtual bool | isRequired () const |
Indicates whether the argument is required. More... | |
void | forceRequired () |
Sets _required to true. More... | |
void | xorSet () |
Sets the _alreadySet value to true. More... | |
bool | isValueRequired () const |
Indicates whether a value must be specified for argument. More... | |
bool | isSet () const |
Indicates whether the argument has already been set. More... | |
bool | isIgnoreable () const |
Indicates whether the argument can be ignored, if desired. More... | |
virtual bool | argMatches (const std::string &s) const |
A method that tests whether a string matches this argument. More... | |
virtual std::string | toString () const |
Returns a simple string representation of the argument. More... | |
virtual std::string | shortID (const std::string &valueId="val") const |
Returns a short ID for the usage. More... | |
virtual std::string | longID (const std::string &valueId="val") const |
Returns a long ID for the usage. More... | |
virtual void | trimFlag (std::string &flag, std::string &value) const |
Trims a value off of the flag. More... | |
bool | _hasBlanks (const std::string &s) const |
Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. More... | |
void | setRequireLabel (const std::string &s) |
Sets the requireLabel. More... | |
virtual bool | allowMore () |
virtual bool | acceptsMultipleValues () |
Static Public Member Functions | |
static void | beginIgnoring () |
Begin ignoring arguments since the "--" argument was specified. More... | |
static bool | ignoreRest () |
Whether to ignore the rest. More... | |
static char | delimiter () |
The delimiter that separates an argument flag/name from the value. More... | |
static char | blankChar () |
The char used as a place holder when SwitchArgs are combined. More... | |
static char | flagStartChar () |
The char that indicates the beginning of a flag. More... | |
static const std::string | flagStartString () |
The sting that indicates the beginning of a flag. More... | |
static const std::string | nameStartString () |
The sting that indicates the beginning of a name. More... | |
static const std::string | ignoreNameString () |
The name used to identify the ignore rest argument. More... | |
static void | setDelimiter (char c) |
Sets the delimiter for all arguments. More... | |
Protected Member Functions | |
void | _checkWithVisitor () const |
Performs the special handling described by the Vistitor. More... | |
Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL) | |
Primary constructor. More... | |
Protected Attributes | |
std::string | _flag |
The single char flag used to identify the argument. More... | |
std::string | _name |
A single work namd indentifying the argument. More... | |
std::string | _description |
Description of the argument. More... | |
bool | _required |
Indicating whether the argument is required. More... | |
std::string | _requireLabel |
Label to be used in usage description. More... | |
bool | _valueRequired |
Indicates whether a value is required for the argument. More... | |
bool | _alreadySet |
Indicates whether the argument has been set. More... | |
Visitor * | _visitor |
A pointer to a vistitor object. More... | |
bool | _ignoreable |
Whether this argument can be ignored, if desired. More... | |
bool | _xorSet |
Indicates that the arg was set as part of an XOR and not on the command line. More... | |
bool | _acceptsMultipleValues |
Static Private Member Functions | |
static bool & | ignoreRestRef () |
Indicates whether the rest of the arguments should be ignored. More... | |
static char & | delimiterRef () |
The delimiter that separates an argument flag/name from the value. More... | |
|
inlineprotected |
Primary constructor.
YOU (yes you) should NEVER construct an Arg directly, this is a base class that is extended by various children that are meant to be used. Use SwitchArg, ValueArg, MultiArg, UnlabeledValueArg, or UnlabeledMultiArg instead.
flag | - The flag identifying the argument. |
name | - The name identifying the argument. |
desc | - The description of the argument, used in the usage. |
req | - Whether the argument is required. |
valreq | - Whether the a value is required for the argument. |
v | - The visitor checked by the argument. Defaults to NULL. |
Definition at line 367 of file Arg.h.
References _flag, _name, flagStartString(), ignoreNameString(), nameStartString(), and toString().
|
inlineprotected |
Performs the special handling described by the Vistitor.
Definition at line 519 of file Arg.h.
References _visitor, and TCLAP::Visitor::visit().
Referenced by TCLAP::SwitchArg::processArg().
|
inline |
Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.
Implementation of _hasBlanks.
If so, return true, otherwise return false.
s | - string to be checked. |
Definition at line 549 of file Arg.h.
References blankChar().
|
inlinevirtual |
Definition at line 582 of file Arg.h.
References _acceptsMultipleValues.
Referenced by TCLAP::DocBookOutput::printShortArg().
|
inlinevirtual |
Adds this to the specified list of Args.
Overridden by Args that need to added to the end of the list.
argList | - The list to add this to. |
Reimplemented in TCLAP::UnlabeledValueArg< T >, and TCLAP::UnlabeledMultiArg< T >.
Definition at line 572 of file Arg.h.
Referenced by TCLAP::CmdLine::add().
|
inlinevirtual |
Reimplemented in TCLAP::MultiArg< T >.
|
inlinevirtual |
A method that tests whether a string matches this argument.
This is generally called by the processArg() method. This method could be re-implemented by a child to change how arguments are specified on the command line.
s | - The string to be compared to the flag/name to determine whether the arg matches. |
Definition at line 498 of file Arg.h.
References _flag, _name, flagStartString(), and nameStartString().
Referenced by TCLAP::SwitchArg::processArg().
|
inlinestatic |
Begin ignoring arguments since the "--" argument was specified.
Definition at line 178 of file Arg.h.
References ignoreRestRef().
Referenced by TCLAP::IgnoreRestVisitor::visit().
|
inlinestatic |
The char used as a place holder when SwitchArgs are combined.
Currently set to '*', which shouldn't cause many problems since *'s are expanded by most shells on the command line.
Definition at line 196 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined(), _hasBlanks(), and TCLAP::SwitchArg::combinedSwitchesMatch().
|
inlinestatic |
The delimiter that separates an argument flag/name from the value.
Definition at line 189 of file Arg.h.
References delimiterRef().
Referenced by TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), shortID(), and trimFlag().
|
inlinestaticprivate |
The delimiter that separates an argument flag/name from the value.
Definition at line 64 of file Arg.h.
Referenced by delimiter(), and setDelimiter().
|
inlinestatic |
The char that indicates the beginning of a flag.
Currently '-'.
Definition at line 201 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined().
|
inlinestatic |
The sting that indicates the beginning of a flag.
Currently "-". Should be identical to flagStartChar.
Definition at line 207 of file Arg.h.
Referenced by TCLAP::CmdLine::_constructor(), Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().
|
inline |
Sets _required to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 558 of file Arg.h.
References _required.
|
inline |
Returns the argument description.
Definition at line 462 of file Arg.h.
References _description, _required, and _requireLabel.
Referenced by TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::UnlabeledValueArg< T >::operator==(), and TCLAP::DocBookOutput::printLongArg().
|
inline |
|
inline |
Returns the argument name.
Definition at line 477 of file Arg.h.
References _name.
Referenced by TCLAP::UnlabeledMultiArg< T >::operator==(), and TCLAP::UnlabeledValueArg< T >::operator==().
|
inlinestatic |
The name used to identify the ignore rest argument.
Definition at line 218 of file Arg.h.
Referenced by TCLAP::CmdLine::_constructor(), and Arg().
|
inlinestatic |
Whether to ignore the rest.
Definition at line 183 of file Arg.h.
References ignoreRestRef().
Referenced by TCLAP::CmdLine::parse(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg< DUMMY >::processArg(), TCLAP::MultiArg< T >::processArg(), and TCLAP::ValueArg< T >::processArg().
|
inlinestaticprivate |
Indicates whether the rest of the arguments should be ignored.
Definition at line 58 of file Arg.h.
Referenced by beginIgnoring(), and ignoreRest().
|
inline |
Indicates whether the argument can be ignored, if desired.
Definition at line 491 of file Arg.h.
References _ignoreable.
|
inlinevirtual |
Indicates whether the argument is required.
Reimplemented in TCLAP::MultiArg< T >.
Definition at line 479 of file Arg.h.
References _required.
Referenced by TCLAP::CmdLine::add(), TCLAP::XorHandler::check(), and TCLAP::DocBookOutput::printShortArg().
|
inline |
Indicates whether the argument has already been set.
Only true if the arg has been matched on the command line.
Definition at line 483 of file Arg.h.
References _alreadySet, and _xorSet.
|
inline |
Indicates whether a value must be specified for argument.
Definition at line 481 of file Arg.h.
References _valueRequired.
|
inlinevirtual |
Returns a long ID for the usage.
valueId | - The value used in the id. |
Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg< DUMMY >.
Definition at line 431 of file Arg.h.
References _flag, _name, _valueRequired, flagStartString(), and nameStartString().
Referenced by TCLAP::CmdLine::add(), TCLAP::MultiSwitchArg< DUMMY >::longID(), TCLAP::MultiArg< T >::longID(), TCLAP::ValueArg< T >::longID(), and TCLAP::DocBookOutput::printLongArg().
|
inlinestatic |
The sting that indicates the beginning of a name.
Currently "--". Should be flagStartChar twice.
Definition at line 213 of file Arg.h.
Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().
|
inlinevirtual |
Operator ==.
Equality operator. Must be virtual to handle unlabeled args.
a | - The Arg to be compared to this. |
Reimplemented in TCLAP::UnlabeledValueArg< T >, and TCLAP::UnlabeledMultiArg< T >.
|
pure virtual |
Pure virtual method meant to handle the parsing and value assignment of the string on the command line.
i | - Pointer the the current argument in the list. |
args | - Mutable list of strings. What is passed in from main. |
Implemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::MultiSwitchArg< DUMMY >, and TCLAP::SwitchArg.
|
inlinestatic |
Sets the delimiter for all arguments.
c | - The character that delimits flags/names from values. |
Definition at line 224 of file Arg.h.
References delimiterRef().
Referenced by TCLAP::CmdLine::_constructor().
|
inline |
Sets the requireLabel.
Used by XorHandler. You shouldn't ever use this.
s | - Set the requireLabel to this value. |
Definition at line 493 of file Arg.h.
References _requireLabel.
|
inlinevirtual |
Returns a short ID for the usage.
valueId | - The value used in the id. |
Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg< DUMMY >.
Definition at line 410 of file Arg.h.
References _flag, _name, _required, _valueRequired, delimiter(), flagStartString(), and nameStartString().
Referenced by TCLAP::DocBookOutput::printShortArg(), TCLAP::MultiSwitchArg< DUMMY >::shortID(), TCLAP::MultiArg< T >::shortID(), and TCLAP::ValueArg< T >::shortID().
|
inlinevirtual |
Returns a simple string representation of the argument.
Primarily for debugging.
Definition at line 507 of file Arg.h.
References _flag, _name, flagStartString(), and nameStartString().
Referenced by Arg(), TCLAP::SwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
inlinevirtual |
Trims a value off of the flag.
Implementation of trimFlag.
flag | - The string from which the flag and value will be trimmed. Contains the flag once the value has been trimmed. |
value | - Where the value trimmed from the string will be stored. |
Definition at line 528 of file Arg.h.
References delimiter().
|
inline |
Sets the _alreadySet value to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 563 of file Arg.h.
References _alreadySet, and _xorSet.
|
protected |
Definition at line 136 of file Arg.h.
Referenced by acceptsMultipleValues(), and TCLAP::MultiArg< T >::MultiArg().
|
protected |
Indicates whether the argument has been set.
Indicates that a value on the command line has matched the name/flag of this argument and the values have been set accordingly.
Definition at line 115 of file Arg.h.
Referenced by isSet(), TCLAP::SwitchArg::processArg(), and xorSet().
|
protected |
|
protected |
The single char flag used to identify the argument.
This value (preceded by a dash {-}), can be used to identify an argument on the command line. The _flag can be blank, in fact this is how unlabeled args work. Unlabeled args must override appropriate functions to get correct handling. Note that the _flag does NOT include the dash as part of the flag.
Definition at line 76 of file Arg.h.
Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), getFlag(), longID(), operator==(), shortID(), and toString().
|
protected |
Whether this argument can be ignored, if desired.
Definition at line 128 of file Arg.h.
Referenced by isIgnoreable(), TCLAP::SwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
protected |
A single work namd indentifying the argument.
This value (preceded by two dashed {–}) can also be used to identify an argument on the command line. Note that the _name does NOT include the two dashes as part of the _name. The _name cannot be blank.
Definition at line 85 of file Arg.h.
Referenced by Arg(), argMatches(), getName(), longID(), operator==(), shortID(), and toString().
|
protected |
Indicating whether the argument is required.
Definition at line 95 of file Arg.h.
Referenced by forceRequired(), getDescription(), isRequired(), and shortID().
|
protected |
Label to be used in usage description.
Normally set to "required", but can be changed when necessary.
Definition at line 101 of file Arg.h.
Referenced by getDescription(), and setRequireLabel().
|
protected |
Indicates whether a value is required for the argument.
Note that the value may be required but the argument/value combination may not be, as specified by _required.
Definition at line 108 of file Arg.h.
Referenced by isValueRequired(), longID(), and shortID().
|
protected |
A pointer to a vistitor object.
The visitor allows special handling to occur as soon as the argument is matched. This defaults to NULL and should not be used unless absolutely necessary.
Definition at line 123 of file Arg.h.
Referenced by _checkWithVisitor().
Page generated by Doxygen 1.8.14 for MRPT 1.4.0 SVN: at Mon Mar 5 22:51:34 UTC 2018 |