tclap
1.2.2
|
A virtual base class that defines the essential data for all arguments. More...
#include <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 () |
Used for MultiArgs and XorHandler to determine whether args can still be set. More... | |
virtual bool | acceptsMultipleValues () |
Use by output classes to determine whether an Arg accepts multiple values. More... | |
virtual void | reset () |
Clears the Arg object and allows it to be reused by new command lines. More... | |
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 () |
static const std::string | flagStartString () |
static const std::string | nameStartString () |
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 Visitor. 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 word namd identifying 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 visitor 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 |
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.
|
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. |
|
inlineprotected |
Performs the special handling described by the Visitor.
Definition at line 632 of file Arg.h.
Referenced by TCLAP::MultiSwitchArg::MultiSwitchArg().
|
inline |
|
inlinevirtual |
|
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 >.
|
inlinevirtual |
Used for MultiArgs and XorHandler to determine whether args can still be set.
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 611 of file Arg.h.
References _visitor, and TCLAP::Visitor::visit().
|
inlinestatic |
|
inlinestatic |
The char used as a place holder when SwitchArgs are combined.
Currently set to the bell char (ASCII 7).
Definition at line 258 of file Arg.h.
Referenced by TCLAP::SwitchArg::combinedSwitchesMatch().
|
inlinestatic |
The delimiter that separates an argument flag/name from the value.
Definition at line 252 of file Arg.h.
Referenced by TCLAP::MultiArg< T >::MultiArg(), and shortID().
|
inlinestatic |
Definition at line 277 of file Arg.h.
Referenced by isRequired(), and shortID().
|
inline |
Sets _required to true.
This is used by the XorHandler. You really have no reason to ever use it.
|
inline |
Returns the argument description.
Definition at line 575 of file Arg.h.
References _alreadySet, and _xorSet.
Referenced by TCLAP::UnlabeledValueArg< T >::shortID().
|
inline |
|
inline |
Returns the argument name.
Definition at line 590 of file Arg.h.
Referenced by TCLAP::ZshCompletionOutput::printArg(), and TCLAP::UnlabeledValueArg< T >::shortID().
|
inlinestatic |
|
inlinestatic |
Whether to ignore the rest.
Definition at line 246 of file Arg.h.
References TCLAP_NAMESTARTSTRING.
Referenced by TCLAP::MultiArg< T >::MultiArg().
|
inline |
|
inlinevirtual |
Indicates whether the argument is required.
Reimplemented in TCLAP::MultiArg< T >.
Definition at line 592 of file Arg.h.
References _flag, and flagStartString().
|
inline |
|
inline |
|
inlinevirtual |
Returns a long ID for the usage.
valueId | - The value used in the id. |
Reimplemented in TCLAP::ValueArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::MultiArg< T >, and TCLAP::MultiSwitchArg.
|
inlinestatic |
Definition at line 286 of file Arg.h.
Referenced by TCLAP::StdOutput::usage().
|
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 >.
Definition at line 567 of file Arg.h.
References _flag.
|
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::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::SwitchArg, TCLAP::MultiSwitchArg, and TCLAP::MultiArg< T >.
|
inlinevirtual |
Clears the Arg object and allows it to be reused by new command lines.
Reimplemented in TCLAP::ValueArg< T >, TCLAP::SwitchArg, TCLAP::MultiSwitchArg, and TCLAP::MultiArg< T >.
|
inlinestatic |
|
inline |
Sets the requireLabel.
Used by XorHandler. You shouldn't ever use this.
s | - Set the requireLabel to this value. |
|
inlinevirtual |
Returns a short ID for the usage.
valueId | - The value used in the id. |
Reimplemented in TCLAP::ValueArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::MultiArg< T >, and TCLAP::MultiSwitchArg.
Definition at line 526 of file Arg.h.
References _flag, _valueRequired, delimiter(), and flagStartString().
Referenced by TCLAP::DocBookOutput::removeChar().
|
inlinevirtual |
Returns a simple string representation of the argument.
Primarily for debugging.
Definition at line 620 of file Arg.h.
Referenced by TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
inlinevirtual |
|
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 676 of file Arg.h.
References _acceptsMultipleValues.
|
protected |
Definition at line 199 of file Arg.h.
Referenced by TCLAP::MultiArg< T >::end(), TCLAP::MultiArg< T >::MultiArg(), and xorSet().
|
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 178 of file Arg.h.
Referenced by getDescription(), and TCLAP::MultiSwitchArg::MultiSwitchArg().
|
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 139 of file Arg.h.
Referenced by isRequired(), operator==(), and shortID().
|
protected |
Whether this argument can be ignored, if desired.
Definition at line 191 of file Arg.h.
Referenced by TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
A pointer to a visitor 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 186 of file Arg.h.
Referenced by argMatches().
|
protected |
Indicates that the arg was set as part of an XOR and not on the command line.
Definition at line 197 of file Arg.h.
Referenced by getDescription().