#include <Arg.h>

Inheritance diagram for TCLAP::Arg:

Public Member Functions
bool	_hasBlanks (const std::string &s) const
virtual bool	acceptsMultipleValues ()
virtual void	addToList (std::list< Arg * > &argList) const
virtual bool	allowMore ()
virtual bool	argMatches (const std::string &s) const
void	forceRequired ()
std::string	getDescription () const
const std::string &	getFlag () const
const std::string &	getName () const
bool	isIgnoreable () const
virtual bool	isRequired () const
bool	isSet () const
bool	isValueRequired () const
virtual std::string	longID (const std::string &valueId="val") const
virtual bool	operator== (const Arg &a) const
virtual bool	processArg (int *i, std::vector< std::string > &args)=0
virtual void	reset ()
void	setRequireLabel (const std::string &s)
virtual std::string	shortID (const std::string &valueId="val") const
virtual std::string	toString () const
virtual void	trimFlag (std::string &flag, std::string &value) const
void	xorSet ()
virtual	~Arg ()
Static Public Member Functions
static void	beginIgnoring ()
static char	blankChar ()
static char	delimiter ()
static char	flagStartChar ()
static const std::string	flagStartString ()
static const std::string	ignoreNameString ()
static bool	ignoreRest ()
static const std::string	nameStartString ()
static void	setDelimiter (char c)
Protected Member Functions
void	_checkWithVisitor () const
	Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)
Protected Attributes
bool	_acceptsMultipleValues
bool	_alreadySet
std::string	_description
std::string	_flag
bool	_ignoreable
std::string	_name
bool	_required
std::string	_requireLabel
bool	_valueRequired
Visitor *	_visitor
bool	_xorSet
Static Private Member Functions
static char &	delimiterRef ()
static bool &	ignoreRestRef ()

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

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

Here is the call graph for this function:

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

Destructor.

Definition at line 483 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 591 of file Arg.h.

References _visitor, and TCLAP::Visitor::visit().

Referenced by TCLAP::SwitchArg::processArg(), and TCLAP::MultiSwitchArg::processArg().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. If so, return true, otherwise return false.

Parameters:

s	- string to be checked.

Implementation of _hasBlanks.

Definition at line 621 of file Arg.h.

References blankChar().

Here is the call graph for this function:

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

Use by output classes to determine whether an Arg accepts multiple values.

Definition at line 654 of file Arg.h.

References _acceptsMultipleValues.

Referenced by TCLAP::ZshCompletionOutput::getMutexList(), TCLAP::ZshCompletionOutput::printArg(), and TCLAP::DocBookOutput::printShortArg().

Here is the caller graph for this function:

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

Adds this to the specified list of Args.

Parameters:

argList - The list to add this to.

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

Here is the caller graph for this function:

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

Used for MultiArgs and XorHandler to determine whether args can still be set.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 649 of file Arg.h.

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

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

Referenced by TCLAP::SwitchArg::processArg(), and TCLAP::MultiSwitchArg::processArg().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Definition at line 191 of file Arg.h.

References ignoreRestRef().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

The char used as a place holder when SwitchArgs are combined. Currently set to the bell char (ASCII 7).

Definition at line 208 of file Arg.h.

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

Here is the caller graph for this function:

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

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

Definition at line 202 of file Arg.h.

References delimiterRef().

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

Here is the call graph for this function:

Here is the caller graph for this function:

static char& TCLAP::Arg::delimiterRef ( ) [inline, static, private]

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

Definition at line 77 of file Arg.h.

Referenced by delimiter(), and setDelimiter().

Here is the caller graph for this function:

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

The char that indicates the beginning of a flag. Currently '-'.

Definition at line 213 of file Arg.h.

Referenced by TCLAP::CmdLine::_emptyCombined(), TCLAP::ZshCompletionOutput::getMutexList(), and TCLAP::ZshCompletionOutput::printOption().

Here is the caller graph for this function:

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

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

Here is the caller graph for this function:

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

References _required.

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

Returns the argument description.

Definition at line 534 of file Arg.h.

References _description, _required, and _requireLabel.

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

Here is the caller graph for this function:

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

Returns the argument flag.

Definition at line 547 of file Arg.h.

References _flag.

Referenced by TCLAP::ZshCompletionOutput::getMutexList(), and TCLAP::ZshCompletionOutput::printOption().

Here is the caller graph for this function:

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

Returns the argument name.

Definition at line 549 of file Arg.h.

References _name.

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

Here is the caller graph for this function:

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

The name used to identify the ignore rest argument.

Definition at line 230 of file Arg.h.

Referenced by TCLAP::CmdLine::_constructor(), and Arg().

Here is the caller graph for this function:

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

Whether to ignore the rest.

Definition at line 196 of file Arg.h.

References ignoreRestRef().

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

Here is the call graph for this function:

Here is the caller graph for this function:

static bool& TCLAP::Arg::ignoreRestRef ( ) [inline, static, private]

Indicates whether the rest of the arguments should be ignored.

Definition at line 71 of file Arg.h.

Referenced by beginIgnoring(), and ignoreRest().

Here is the caller graph for this function:

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

Indicates whether the argument can be ignored, if desired.

Definition at line 563 of file Arg.h.

References _ignoreable.

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

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 551 of file Arg.h.

References _required.

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

Here is the caller graph for this function:

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

References _valueRequired.

Referenced by TCLAP::ZshCompletionOutput::printOption().

Here is the caller graph for this function:

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Here is the caller graph for this function:

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

References _flag, and _name.

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

void TCLAP::Arg::reset ( ) [inline, virtual]

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.

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

Here is the caller graph for this function:

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

References delimiterRef().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

References _requireLabel.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns a simple string representation of the argument. Primarily for debugging.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Trims a value off of the flag.

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.

Implementation of trimFlag.

Definition at line 600 of file Arg.h.

References delimiter().

Here is the call graph for this function:

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

References _alreadySet, and _xorSet.

Member Data Documentation

bool TCLAP::Arg::_acceptsMultipleValues [protected]

Definition at line 149 of file Arg.h.

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

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

Referenced by isSet(), TCLAP::SwitchArg::processArg(), TCLAP::MultiSwitchArg::processArg(), reset(), and xorSet().

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

Description of the argument.

Definition at line 103 of file Arg.h.

Referenced by getDescription().

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

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

bool TCLAP::Arg::_ignoreable [protected]

Whether this argument can be ignored, if desired.

Definition at line 141 of file Arg.h.

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

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

Referenced by Arg(), argMatches(), getName(), longID(), operator==(), shortID(), and toString().

bool TCLAP::Arg::_required [protected]

Indicating whether the argument is required.

Definition at line 108 of file Arg.h.

Referenced by forceRequired(), getDescription(), 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 114 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 121 of file Arg.h.

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

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

Referenced by _checkWithVisitor().

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

Referenced by isSet(), reset(), and xorSet().

The documentation for this class was generated from the following file:

Arg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation