#include <Arg.h>
Inheritance diagram for TCLAP::Arg:
Public Member Functions | |
virtual | ~Arg () |
Destructor. | |
virtual void | addToList (std::list< Arg * > &argList) const |
Overridden by Args that need to added to the end of the list. | |
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. | |
virtual bool | operator== (const Arg &a) const |
Operator ==. | |
const std::string & | getFlag () const |
Returns the argument flag. | |
const std::string & | getName () const |
Returns the argument name. | |
std::string | getDescription () const |
Returns the argument description. | |
virtual bool | isRequired () const |
Indicates whether the argument is required. | |
void | forceRequired () |
Sets _required to true. | |
void | xorSet () |
Sets the _alreadySet value to true. | |
bool | isValueRequired () const |
Indicates whether a value must be specified for argument. | |
bool | isSet () const |
Indicates whether the argument has already been set. | |
bool | isIgnoreable () const |
Indicates whether the argument can be ignored, if desired. | |
virtual bool | argMatches (const std::string &s) const |
A method that tests whether a string matches this argument. | |
virtual std::string | toString () const |
Returns a simple string representation of the argument. | |
virtual std::string | shortID (const std::string &valueId="val") const |
Returns a short ID for the usage. | |
virtual std::string | longID (const std::string &valueId="val") const |
Returns a long ID for the usage. | |
virtual void | trimFlag (std::string &flag, std::string &value) const |
Implementation of trimFlag. | |
bool | _hasBlanks (const std::string &s) const |
Implementation of _hasBlanks. | |
void | setRequireLabel (const std::string &s) |
Sets the requireLabel. | |
virtual bool | allowMore () |
Used for MultiArgs and XorHandler to determine whether args can still be set. | |
virtual bool | acceptsMultipleValues () |
Use by output classes to determine whether an Arg accepts multiple values. | |
virtual void | reset () |
Clears the Arg object and allows it to be reused by new command lines. | |
Static Public Member Functions | |
void | beginIgnoring () |
Begin ignoring arguments since the "--" argument was specified. | |
bool | ignoreRest () |
Whether to ignore the rest. | |
char | delimiter () |
The delimiter that separates an argument flag/name from the value. | |
char | blankChar () |
The char used as a place holder when SwitchArgs are combined. | |
char | flagStartChar () |
The char that indicates the beginning of a flag. | |
const std::string | flagStartString () |
The sting that indicates the beginning of a flag. | |
const std::string | nameStartString () |
The sting that indicates the beginning of a name. | |
const std::string | ignoreNameString () |
The name used to identify the ignore rest argument. | |
void | setDelimiter (char c) |
Sets the delimiter for all arguments. | |
Protected Member Functions | |
void | _checkWithVisitor () const |
Performs the special handling described by the Vistitor. | |
Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL) | |
Primary constructor. | |
Protected Attributes | |
std::string | _flag |
The single char flag used to identify the argument. | |
std::string | _name |
A single work namd indentifying the argument. | |
std::string | _description |
Description of the argument. | |
bool | _required |
Indicating whether the argument is required. | |
std::string | _requireLabel |
Label to be used in usage description. | |
bool | _valueRequired |
Indicates whether a value is required for the argument. | |
bool | _alreadySet |
Indicates whether the argument has been set. | |
Visitor * | _visitor |
A pointer to a vistitor object. | |
bool | _ignoreable |
Whether this argument can be ignored, if desired. | |
bool | _xorSet |
Indicates that the arg was set as part of an XOR and not on the command line. | |
bool | _acceptsMultipleValues |
This class, or one of its existing children, must be subclassed to do anything.
Definition at line 64 of file Arg.h.
|
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.
Definition at line 442 of file Arg.h. References _flag, _name, ignoreNameString(), and toString(). |
Here is the call graph for this function:
|
Destructor.
|
|
Performs the special handling described by the Vistitor.
Definition at line 591 of file Arg.h. References _visitor, and TCLAP::Visitor::visit(). Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::MultiArg< T >::processArg(). |
Here is the call graph for this function:
|
Implementation of _hasBlanks. If so, return true, otherwise return false.
Definition at line 621 of file Arg.h. Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::UnlabeledMultiArg< T >::processArg(), and TCLAP::MultiArg< T >::processArg(). |
|
Use by output classes to determine whether an Arg accepts multiple values.
Definition at line 654 of file Arg.h. Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::ZshCompletionOutput::printArg(), and TCLAP::DocBookOutput::printShortArg(). |
|
Overridden by Args that need to added to the end of the list.
Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >. Definition at line 644 of file Arg.h. Referenced by TCLAP::CmdLine::add(). |
|
Used for MultiArgs and XorHandler to determine whether args can still be set.
Reimplemented in TCLAP::MultiArg< T >. |
|
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.
Definition at line 570 of file Arg.h. References _flag. Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::MultiArg< T >::processArg(). |
|
Begin ignoring arguments since the "--" argument was specified.
|
|
The char used as a place holder when SwitchArgs are combined. Currently set to the bell char (ASCII 7). |
|
The delimiter that separates an argument flag/name from the value.
|
|
The char that indicates the beginning of a flag. Currently '-'. Definition at line 213 of file Arg.h. Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
The sting that indicates the beginning of a flag. Currently "-". Should be identical to flagStartChar. |
|
Sets _required to true. This is used by the XorHandler. You really have no reason to ever use it. Definition at line 630 of file Arg.h. References _required. |
|
Returns the argument description.
Definition at line 534 of file Arg.h. References _requireLabel. Referenced by TCLAP::UnlabeledValueArg< T >::operator==(), TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::DocBookOutput::printLongArg(), and TCLAP::ZshCompletionOutput::printOption(). |
|
Returns the argument flag.
Definition at line 547 of file Arg.h. Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
Returns the argument name.
Definition at line 549 of file Arg.h. Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::UnlabeledValueArg< T >::operator==(), TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::ZshCompletionOutput::printArg(), TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
The name used to identify the ignore rest argument.
Definition at line 230 of file Arg.h. Referenced by Arg(). |
|
Whether to ignore the rest.
|
|
Indicates whether the argument can be ignored, if desired.
|
|
Indicates whether the argument is required.
Reimplemented in TCLAP::MultiArg< T >. Definition at line 551 of file Arg.h. Referenced by TCLAP::CmdLine::add(), TCLAP::XorHandler::check(), TCLAP::ZshCompletionOutput::printArg(), and TCLAP::DocBookOutput::printShortArg(). |
|
Indicates whether the argument has already been set. Only true if the arg has been matched on the command line. Definition at line 555 of file Arg.h. References _alreadySet. |
|
Indicates whether a value must be specified for argument.
Definition at line 553 of file Arg.h. Referenced by TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
Returns a long ID for the usage.
Reimplemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >. Definition at line 503 of file Arg.h. References _flag. Referenced by TCLAP::CmdLine::add(). |
|
The sting that indicates the beginning of a name. Currently "--". Should be flagStartChar twice. Definition at line 225 of file Arg.h. Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
Operator ==. Equality operator. Must be virtual to handle unlabeled args.
Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >. |
|
Pure virtual method meant to handle the parsing and value assignment of the string on the command line.
Implemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::SwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >. |
|
Clears the Arg object and allows it to be reused by new command lines.
Reimplemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::SwitchArg, and TCLAP::ValueArg< T >. Definition at line 659 of file Arg.h. References _alreadySet, and _xorSet. |
|
Sets the delimiter for all arguments.
|
|
Sets the requireLabel. Used by XorHandler. You shouldn't ever use this.
Definition at line 565 of file Arg.h. References _requireLabel. |
|
Returns a short ID for the usage.
Reimplemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >. Definition at line 485 of file Arg.h. References _flag. Referenced by TCLAP::DocBookOutput::printLongArg(), TCLAP::ZshCompletionOutput::printOption(), and TCLAP::DocBookOutput::printShortArg(). |
|
Returns a simple string representation of the argument. Primarily for debugging. Definition at line 579 of file Arg.h. Referenced by TCLAP::ValueArg< T >::_extractValue(), TCLAP::MultiArg< T >::_extractValue(), Arg(), TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg(). |
|
Implementation of trimFlag.
Definition at line 600 of file Arg.h. Referenced by TCLAP::ValueArg< T >::processArg(), and TCLAP::MultiArg< T >::processArg(). |
|
Sets the _alreadySet value to true. This is used by the XorHandler. You really have no reason to ever use it. Definition at line 635 of file Arg.h. References _alreadySet, and _xorSet. |
|
|
|
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. |
|
Description of the argument.
|
|
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 89 of file Arg.h. Referenced by Arg(), argMatches(), longID(), operator==(), shortID(), and toString(). |
|
Whether this argument can be ignored, if desired.
|
|
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 98 of file Arg.h. Referenced by Arg(), operator==(), and toString(). |
|
Indicating whether the argument is required.
Definition at line 108 of file Arg.h. Referenced by forceRequired(). |
|
Label to be used in usage description. Normally set to "required", but can be changed when necessary. Definition at line 114 of file Arg.h. Referenced by getDescription(), and setRequireLabel(). |
|
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. |
|
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 136 of file Arg.h. Referenced by _checkWithVisitor(). |
|
Indicates that the arg was set as part of an XOR and not on the command line.
|