TCLAP::Arg Class Reference

A virtual base class that defines the essential data for all arguments. More...

#include <Arg.h>

Inheritance diagram for TCLAP::Arg:

TCLAP::MultiArg< T > TCLAP::SwitchArg TCLAP::ValueArg< T > TCLAP::UnlabeledMultiArg< T > TCLAP::MultiSwitchArg TCLAP::UnlabeledValueArg< T > List of all members.

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 ()
virtual bool acceptsMultipleValues ()

Static Public Member Functions

static void beginIgnoring ()
 Begin ignoring arguments since the "--" argument was specified.
static bool ignoreRest ()
 Whether to ignore the rest.
static char delimiter ()
 The delimiter that separates an argument flag/name from the value.
static const char blankChar ()
 The char used as a place holder when SwitchArgs are combined.
static const char flagStartChar ()
 The char that indicates the beginning of a flag.
static const std::string flagStartString ()
 The sting that indicates the beginning of a flag.
static const std::string nameStartString ()
 The sting that indicates the beginning of a name.
static const std::string ignoreNameString ()
 The name used to identify the ignore rest argument.
static 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

Detailed Description

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.

Definition at line 43 of file Arg.h.


Constructor & Destructor Documentation

TCLAP::Arg::Arg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
bool  valreq,
Visitor v = NULL 
) [inline, protected]

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.

Parameters:
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 359 of file Arg.h.

References _flag, _name, flagStartString(), ignoreNameString(), nameStartString(), and toString().

TCLAP::Arg::~Arg (  )  [inline, virtual]

Destructor.

Definition at line 400 of file Arg.h.


Member Function Documentation

void TCLAP::Arg::_checkWithVisitor (  )  const [inline, protected]

Performs the special handling described by the Vistitor.

Definition at line 511 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().

void TCLAP::Arg::addToList ( std::list< Arg * > &  argList  )  const [inline, virtual]

Overridden by Args that need to added to the end of the list.

Parameters:
argList - The list to add this to.

Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.

Definition at line 564 of file Arg.h.

Referenced by TCLAP::CmdLine::add().

static void TCLAP::Arg::beginIgnoring (  )  [inline, static]

Begin ignoring arguments since the "--" argument was specified.

Definition at line 170 of file Arg.h.

Referenced by TCLAP::IgnoreRestVisitor::visit().

static bool TCLAP::Arg::ignoreRest (  )  [inline, static]

Whether to ignore the rest.

Definition at line 175 of file Arg.h.

Referenced by TCLAP::CmdLine::parse(), TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::MultiArg< T >::processArg().

static char TCLAP::Arg::delimiter (  )  [inline, static]

The delimiter that separates an argument flag/name from the value.

Definition at line 181 of file Arg.h.

Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::MultiArg< T >::processArg(), shortID(), and trimFlag().

static const char TCLAP::Arg::blankChar (  )  [inline, static]

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 188 of file Arg.h.

Referenced by TCLAP::CmdLine::_emptyCombined(), _hasBlanks(), and TCLAP::SwitchArg::combinedSwitchesMatch().

static const char TCLAP::Arg::flagStartChar (  )  [inline, static]

The char that indicates the beginning of a flag.

Currently '-'.

Definition at line 193 of file Arg.h.

Referenced by TCLAP::CmdLine::_emptyCombined().

static const std::string TCLAP::Arg::flagStartString (  )  [inline, static]

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

Definition at line 199 of file Arg.h.

Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().

static const std::string TCLAP::Arg::nameStartString (  )  [inline, static]

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

Definition at line 205 of file Arg.h.

Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().

static const std::string TCLAP::Arg::ignoreNameString (  )  [inline, static]

The name used to identify the ignore rest argument.

Definition at line 210 of file Arg.h.

Referenced by Arg().

static void TCLAP::Arg::setDelimiter ( char  c  )  [inline, static]

Sets the delimiter for all arguments.

Parameters:
c - The character that delimits flags/names from values.

Definition at line 216 of file Arg.h.

virtual bool TCLAP::Arg::processArg ( int *  i,
std::vector< std::string > &  args 
) [pure virtual]

Pure virtual method meant to handle the parsing and value assignment of the string on the command line.

Parameters:
i - Pointer the the current argument in the list.
args - Mutable list of strings. What is passed in from main.

Implemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::SwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

bool TCLAP::Arg::operator== ( const Arg a  )  const [inline, virtual]

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters:
a - The Arg to be compared to this.

Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.

Definition at line 446 of file Arg.h.

References _flag, and _name.

const std::string & TCLAP::Arg::getFlag (  )  const [inline]

Returns the argument flag.

Definition at line 467 of file Arg.h.

References _flag.

const std::string & TCLAP::Arg::getName (  )  const [inline]

Returns the argument name.

Definition at line 469 of file Arg.h.

References _name.

Referenced by TCLAP::UnlabeledValueArg< T >::operator==(), and TCLAP::UnlabeledMultiArg< T >::operator==().

std::string TCLAP::Arg::getDescription (  )  const [inline]

Returns the argument description.

Definition at line 454 of file Arg.h.

References _description, _required, and _requireLabel.

Referenced by TCLAP::UnlabeledValueArg< T >::operator==(), TCLAP::UnlabeledMultiArg< T >::operator==(), and TCLAP::DocBookOutput::printLongArg().

bool TCLAP::Arg::isRequired (  )  const [inline, virtual]

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 471 of file Arg.h.

References _required.

Referenced by TCLAP::CmdLine::add(), TCLAP::XorHandler::check(), and TCLAP::DocBookOutput::printShortArg().

void TCLAP::Arg::forceRequired (  )  [inline]

Sets _required to true.

This is used by the XorHandler. You really have no reason to ever use it.

Definition at line 550 of file Arg.h.

References _required.

void TCLAP::Arg::xorSet (  )  [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 555 of file Arg.h.

References _alreadySet, and _xorSet.

bool TCLAP::Arg::isValueRequired (  )  const [inline]

Indicates whether a value must be specified for argument.

Definition at line 473 of file Arg.h.

References _valueRequired.

bool TCLAP::Arg::isSet (  )  const [inline]

Indicates whether the argument has already been set.

Only true if the arg has been matched on the command line.

Definition at line 475 of file Arg.h.

References _alreadySet, and _xorSet.

bool TCLAP::Arg::isIgnoreable (  )  const [inline]

Indicates whether the argument can be ignored, if desired.

Definition at line 483 of file Arg.h.

References _ignoreable.

bool TCLAP::Arg::argMatches ( const std::string &  s  )  const [inline, virtual]

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.

Parameters:
s - The string to be compared to the flag/name to determine whether the arg matches.

Definition at line 490 of file Arg.h.

References _flag, _name, flagStartString(), and nameStartString().

Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::MultiArg< T >::processArg().

std::string TCLAP::Arg::toString (  )  const [inline, virtual]

Returns a simple string representation of the argument.

Primarily for debugging.

Definition at line 499 of file Arg.h.

References _flag, _name, flagStartString(), and nameStartString().

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().

std::string TCLAP::Arg::shortID ( const std::string &  valueId = "val"  )  const [inline, virtual]

Returns a short ID for the usage.

Parameters:
valueId - The value used in the id.

Reimplemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

Definition at line 402 of file Arg.h.

References _flag, _name, _required, _valueRequired, delimiter(), flagStartString(), and nameStartString().

Referenced by TCLAP::DocBookOutput::printShortArg(), TCLAP::ValueArg< T >::shortID(), TCLAP::MultiSwitchArg::shortID(), and TCLAP::MultiArg< T >::shortID().

std::string TCLAP::Arg::longID ( const std::string &  valueId = "val"  )  const [inline, virtual]

Returns a long ID for the usage.

Parameters:
valueId - The value used in the id.

Reimplemented in TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

Definition at line 423 of file Arg.h.

References _flag, _name, _valueRequired, flagStartString(), and nameStartString().

Referenced by TCLAP::CmdLine::add(), TCLAP::ValueArg< T >::longID(), TCLAP::MultiSwitchArg::longID(), TCLAP::MultiArg< T >::longID(), and TCLAP::DocBookOutput::printLongArg().

void TCLAP::Arg::trimFlag ( std::string &  flag,
std::string &  value 
) const [inline, virtual]

Implementation of trimFlag.

Parameters:
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 520 of file Arg.h.

References delimiter().

Referenced by TCLAP::ValueArg< T >::processArg(), and TCLAP::MultiArg< T >::processArg().

bool TCLAP::Arg::_hasBlanks ( const std::string &  s  )  const [inline]

Implementation of _hasBlanks.

If so, return true, otherwise return false.

Parameters:
s - string to be checked.

Definition at line 541 of file Arg.h.

References blankChar().

Referenced by TCLAP::ValueArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::UnlabeledMultiArg< T >::processArg(), and TCLAP::MultiArg< T >::processArg().

void TCLAP::Arg::setRequireLabel ( const std::string &  s  )  [inline]

Sets the requireLabel.

Used by XorHandler. You shouldn't ever use this.

Parameters:
s - Set the requireLabel to this value.

Definition at line 485 of file Arg.h.

References _requireLabel.

bool TCLAP::Arg::allowMore (  )  [inline, virtual]

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 569 of file Arg.h.

bool TCLAP::Arg::acceptsMultipleValues (  )  [inline, virtual]

Definition at line 574 of file Arg.h.

References _acceptsMultipleValues.

Referenced by TCLAP::DocBookOutput::printShortArg().


Member Data Documentation

std::string TCLAP::Arg::_flag [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 68 of file Arg.h.

Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), getFlag(), longID(), operator==(), shortID(), and toString().

std::string TCLAP::Arg::_name [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 77 of file Arg.h.

Referenced by Arg(), argMatches(), getName(), longID(), TCLAP::UnlabeledValueArg< T >::operator==(), TCLAP::UnlabeledMultiArg< T >::operator==(), operator==(), shortID(), and toString().

std::string TCLAP::Arg::_description [protected]

Description of the argument.

Definition at line 82 of file Arg.h.

Referenced by getDescription(), TCLAP::UnlabeledValueArg< T >::operator==(), and TCLAP::UnlabeledMultiArg< T >::operator==().

bool TCLAP::Arg::_required [protected]

Indicating whether the argument is required.

Definition at line 87 of file Arg.h.

Referenced by forceRequired(), getDescription(), TCLAP::MultiArg< T >::isRequired(), isRequired(), and shortID().

std::string TCLAP::Arg::_requireLabel [protected]

Label to be used in usage description.

Normally set to "required", but can be changed when necessary.

Definition at line 93 of file Arg.h.

Referenced by getDescription(), and setRequireLabel().

bool TCLAP::Arg::_valueRequired [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 100 of file Arg.h.

Referenced by isValueRequired(), longID(), and shortID().

bool TCLAP::Arg::_alreadySet [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 107 of file Arg.h.

Referenced by isSet(), TCLAP::ValueArg< T >::processArg(), TCLAP::UnlabeledValueArg< T >::processArg(), TCLAP::UnlabeledMultiArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), and xorSet().

Visitor* TCLAP::Arg::_visitor [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 115 of file Arg.h.

Referenced by _checkWithVisitor().

bool TCLAP::Arg::_ignoreable [protected]

Whether this argument can be ignored, if desired.

Definition at line 120 of file Arg.h.

Referenced by isIgnoreable(), TCLAP::ValueArg< T >::processArg(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), TCLAP::MultiArg< T >::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().

bool TCLAP::Arg::_xorSet [protected]

Indicates that the arg was set as part of an XOR and not on the command line.

Definition at line 126 of file Arg.h.

Referenced by isSet(), and xorSet().

bool TCLAP::Arg::_acceptsMultipleValues [protected]

Definition at line 128 of file Arg.h.

Referenced by acceptsMultipleValues(), and TCLAP::MultiArg< T >::MultiArg().


The documentation for this class was generated from the following file:
Generated on Thu Dec 14 23:01:53 2006 for tclap by  doxygen 1.5.1