tclap
1.4.0
|
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... | |
std::string | getDescription (bool required) const |
Returns the argument description. More... | |
virtual bool | isRequired () const |
Indicates whether the argument is required. 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... | |
const std::string & | setBy () const |
Returns the value specified to set this flag (like -a or –all). 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... | |
virtual bool | allowMore () |
Used for MultiArgs 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... | |
virtual void | hideFromHelp (bool hide=true) |
Hide this argument from the help output (e.g., when specifying the –help flag or on error. More... | |
virtual bool | visibleInHelp () const |
Returns true if this Arg is visible in the help output. More... | |
virtual bool | hasLabel () const |
Static Public Member Functions | |
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... | |
const 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... | |
std::string | _setBy |
Indicates the value specified to set this flag (like -a or –all). More... | |
Visitor * | _visitor |
A pointer to a visitor object. More... | |
bool | _ignoreable |
Whether this argument can be ignored, if desired. More... | |
bool | _acceptsMultipleValues |
bool | _visibleInHelp |
Indicates if the argument is visible in the help output (e.g., when specifying –help). More... | |
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. |
Definition at line 446 of file Arg.h.
References _flag, _name, flagStartString(), ignoreNameString(), nameStartString(), and toString().
|
inlineprotected |
Performs the special handling described by the Visitor.
Definition at line 553 of file Arg.h.
References _visitor, and TCLAP::Visitor::visit().
Referenced by TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::MultiSwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), and TCLAP::ValueArg< T >::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 577 of file Arg.h.
References blankChar().
Referenced by TCLAP::UnlabeledMultiArg< T >::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and setBy().
|
inlinevirtual |
Use by output classes to determine whether an Arg accepts multiple values.
Definition at line 593 of file Arg.h.
References _acceptsMultipleValues.
Referenced by TCLAP::DocBookOutput::printShortArg(), and setBy().
|
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 587 of file Arg.h.
Referenced by TCLAP::CmdLine::addToArgList().
|
inlinevirtual |
Used for MultiArgs to determine whether args can still be set.
Reimplemented in TCLAP::MultiArg< T >.
Definition at line 591 of file Arg.h.
Referenced by setBy().
|
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 535 of file Arg.h.
References _flag, _name, flagStartString(), and nameStartString().
Referenced by TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and setBy().
|
inlinestatic |
The char used as a place holder when SwitchArgs are combined.
Currently set to the bell char (ASCII 7).
Definition at line 192 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined(), _hasBlanks(), TCLAP::SwitchArg::combinedSwitchesMatch(), and TCLAP::SwitchArg::SwitchArg().
|
inlinestatic |
The delimiter that separates an argument flag/name from the value.
Definition at line 186 of file Arg.h.
Referenced by TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), shortID(), and trimFlag().
|
inlinestatic |
Definition at line 201 of file Arg.h.
References TCLAP_FLAGSTARTCHAR.
Referenced by TCLAP::CmdLine::_emptyCombined().
|
inlinestatic |
Definition at line 211 of file Arg.h.
References TCLAP_FLAGSTARTSTRING.
Referenced by TCLAP::StdOutput::_shortUsage(), Arg(), argMatches(), TCLAP::CmdLine::CmdLine(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().
|
inline |
Returns the argument description.
Definition at line 262 of file Arg.h.
References getDescription().
Referenced by TCLAP::StdOutput::_longUsage(), getDescription(), TCLAP::UnlabeledMultiArg< T >::operator==(), and TCLAP::UnlabeledValueArg< T >::operator==().
|
inline |
Returns the argument description.
required | if the argument should be treated as required when described. |
Definition at line 270 of file Arg.h.
References _description, isRequired(), isSet(), and isValueRequired().
|
inline |
Returns the argument flag.
Definition at line 523 of file Arg.h.
References _flag.
Referenced by TCLAP::internal::CompareShortID(), TCLAP::internal::IsVisibleLongSwitch(), TCLAP::internal::IsVisibleShortSwitch(), and setDelimiter().
|
inline |
Returns the argument name.
Definition at line 525 of file Arg.h.
References _name.
Referenced by TCLAP::StdOutput::_shortUsage(), TCLAP::internal::IsVisibleLongSwitch(), TCLAP::internal::IsVisibleOption(), TCLAP::internal::IsVisibleShortSwitch(), TCLAP::UnlabeledMultiArg< T >::longID(), TCLAP::UnlabeledValueArg< T >::longID(), TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::UnlabeledValueArg< T >::operator==(), setDelimiter(), TCLAP::UnlabeledMultiArg< T >::shortID(), and TCLAP::UnlabeledValueArg< T >::shortID().
|
inlinevirtual |
Reimplemented in TCLAP::UnlabeledValueArg< T >, and TCLAP::UnlabeledMultiArg< T >.
Definition at line 374 of file Arg.h.
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::internal::IsVisibleOption().
|
inlinevirtual |
|
inlinestatic |
The name used to identify the ignore rest argument.
Definition at line 225 of file Arg.h.
Referenced by TCLAP::StdOutput::_shortUsage(), Arg(), TCLAP::CmdLine::CmdLine(), TCLAP::internal::IsVisibleLongSwitch(), TCLAP::internal::IsVisibleOption(), and TCLAP::internal::IsVisibleShortSwitch().
|
inline |
Indicates whether the argument can be ignored, if desired.
Definition at line 533 of file Arg.h.
References _ignoreable.
Referenced by TCLAP::CmdLine::parse(), and setBy().
|
inlinevirtual |
Indicates whether the argument is required.
Definition at line 527 of file Arg.h.
References _required.
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), TCLAP::ExclusiveArgGroup::add(), TCLAP::CmdLine::addToArgList(), getDescription(), and TCLAP::CmdLine::parse().
|
inline |
Indicates whether the argument has already been set.
Only true if the arg has been matched on the command line.
Definition at line 531 of file Arg.h.
References _alreadySet.
Referenced by getDescription(), and TCLAP::CmdLine::parse().
|
inline |
Indicates whether a value must be specified for argument.
Definition at line 529 of file Arg.h.
References _valueRequired.
Referenced by TCLAP::StdOutput::_shortUsage(), getDescription(), TCLAP::internal::IsVisibleLongSwitch(), TCLAP::internal::IsVisibleOption(), and TCLAP::internal::IsVisibleShortSwitch().
|
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.
Definition at line 498 of file Arg.h.
References _flag, _name, _valueRequired, delimiter(), flagStartString(), and nameStartString().
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::ArgGroup::add(), TCLAP::StandaloneArgs::add(), TCLAP::ExclusiveArgGroup::add(), TCLAP::CmdLine::addToArgList(), TCLAP::MultiSwitchArg::longID(), TCLAP::MultiArg< T >::longID(), TCLAP::ValueArg< T >::longID(), and setBy().
|
inlinestatic |
Definition at line 220 of file Arg.h.
References TCLAP_NAMESTARTSTRING.
Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::StdOutput::failure(), 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 >.
Definition at line 516 of file Arg.h.
Referenced by setDelimiter().
|
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::MultiArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::MultiSwitchArg, and TCLAP::SwitchArg.
Referenced by TCLAP::CmdLine::parse(), and setDelimiter().
|
inlinevirtual |
Clears the Arg object and allows it to be reused by new command lines.
Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::SwitchArg, and TCLAP::MultiSwitchArg.
Definition at line 595 of file Arg.h.
References _alreadySet.
Referenced by TCLAP::SwitchArg::reset(), TCLAP::MultiArg< T >::reset(), TCLAP::ValueArg< T >::reset(), and setBy().
|
inline |
Returns the value specified to set this flag (like -a or –all).
Definition at line 293 of file Arg.h.
References _hasBlanks(), _setBy, acceptsMultipleValues(), allowMore(), argMatches(), isIgnoreable(), longID(), reset(), shortID(), toString(), and trimFlag().
|
inlinestatic |
Sets the delimiter for all arguments.
c | - The character that delimits flags/names from values. |
Definition at line 231 of file Arg.h.
References getFlag(), getName(), operator==(), and processArg().
Referenced by TCLAP::CmdLine::CmdLine().
|
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.
Definition at line 485 of file Arg.h.
References _flag, _name, _valueRequired, delimiter(), flagStartString(), and nameStartString().
Referenced by TCLAP::StdOutput::_shortUsage(), TCLAP::internal::CompareShortID(), TCLAP::DocBookOutput::printShortArg(), setBy(), TCLAP::MultiSwitchArg::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 543 of file Arg.h.
References _flag, _name, flagStartString(), and nameStartString().
Referenced by TCLAP::MultiArg< T >::_extractValue(), TCLAP::ValueArg< T >::_extractValue(), Arg(), TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::SwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), setBy(), 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 560 of file Arg.h.
References delimiter().
Referenced by TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and setBy().
|
inlinevirtual |
Returns true if this Arg is visible in the help output.
Definition at line 372 of file Arg.h.
References _visibleInHelp.
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), TCLAP::internal::IsVisibleLongSwitch(), TCLAP::internal::IsVisibleOption(), and TCLAP::internal::IsVisibleShortSwitch().
|
protected |
Definition at line 141 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 122 of file Arg.h.
Referenced by TCLAP::SwitchArg::combinedSwitchesMatch(), isSet(), TCLAP::MultiSwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and reset().
|
protected |
Description of the argument.
Definition at line 97 of file Arg.h.
Referenced by getDescription(), TCLAP::UnlabeledMultiArg< T >::operator==(), and TCLAP::UnlabeledValueArg< T >::operator==().
|
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 83 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 139 of file Arg.h.
Referenced by isIgnoreable(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
protected |
A single word namd identifying 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 92 of file Arg.h.
Referenced by Arg(), argMatches(), getName(), longID(), TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::UnlabeledValueArg< T >::operator==(), operator==(), shortID(), and toString().
|
protected |
Indicating whether the argument is required.
Definition at line 102 of file Arg.h.
Referenced by isRequired().
|
protected |
|
protected |
Indicates the value specified to set this flag (like -a or –all).
Definition at line 126 of file Arg.h.
Referenced by TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and setBy().
|
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 115 of file Arg.h.
Referenced by isValueRequired(), longID(), and shortID().
|
protected |
Indicates if the argument is visible in the help output (e.g., when specifying –help).
Definition at line 147 of file Arg.h.
Referenced by visibleInHelp().
|
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 134 of file Arg.h.
Referenced by _checkWithVisitor().