DtCmdLine::Arg Class Reference

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

Inheritance diagram for DtCmdLine::Arg:

Collaboration diagram for DtCmdLine::Arg:

List of all members.

Public Member Functions
virtual	~Arg ()
	Destructor.
virtual void	addToList (std::list< Arg * > &argList) const
	Adds this to the specified list of Args.
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)
	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
	Trims a value off of the flag.
bool	_hasBlanks (const std::string &s) const
	Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.
void	setRequireLabel (const std::string &s)
	Sets the requireLabel.
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.
Static Private Member Functions
static bool &	ignoreRestRef ()
	Indicates whether the rest of the arguments should be ignored.
static char &	delimiterRef ()
	The delimiter that separates an argument flag/name from the value.

---

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.

---

Constructor & Destructor Documentation

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

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

DtCmdLine::Arg::~Arg

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

void DtCmdLine::Arg::_checkWithVisitor

(

)

const [inline, protected]

Performs the special handling described by the Vistitor.

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

Referenced by DtCmdLine::SwitchArg::processArg().

bool DtCmdLine::Arg::_hasBlanks

(

const std::string &

s

)

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

Parameters:

s	- string to be checked.

References blankChar().

void DtCmdLine::Arg::addToList

(

std::list< Arg * > &

argList

)

const [inline, virtual]

Adds this to the specified list of Args.

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

Parameters:

argList

- The list to add this to.

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

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

bool DtCmdLine::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.

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

Referenced by DtCmdLine::SwitchArg::processArg().

static void DtCmdLine::Arg::beginIgnoring

(

)

[inline, static]

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

static const char DtCmdLine::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.

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

static char DtCmdLine::Arg::delimiter

(

)

[inline, static]

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

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

static char& DtCmdLine::Arg::delimiterRef

(

)

[inline, static, private]

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

static const char DtCmdLine::Arg::flagStartChar

(

)

[inline, static]

The char that indicates the beginning of a flag.

Currently '-'.

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

static const std::string DtCmdLine::Arg::flagStartString

(

)

[inline, static]

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

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

void DtCmdLine::Arg::forceRequired

(

)

[inline]

Sets _required to true.

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

References _required.

std::string DtCmdLine::Arg::getDescription

(

)

const [inline]

Returns the argument description.

References _description, _required, and _requireLabel.

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

const std::string & DtCmdLine::Arg::getFlag

(

)

const [inline]

Returns the argument flag.

References _flag.

const std::string & DtCmdLine::Arg::getName

(

)

const [inline]

Returns the argument name.

References _name.

Referenced by DtCmdLine::UnlabeledMultiArg< T >::operator==(), DtCmdLine::UnlabeledValueArg< T >::operator==(), and DtMtlEnvironment::registerCmdLineVar().

static const std::string DtCmdLine::Arg::ignoreNameString

(

)

[inline, static]

The name used to identify the ignore rest argument.

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

static bool DtCmdLine::Arg::ignoreRest

(

)

[inline, static]

Whether to ignore the rest.

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

static bool& DtCmdLine::Arg::ignoreRestRef

(

)

[inline, static, private]

Indicates whether the rest of the arguments should be ignored.

bool DtCmdLine::Arg::isIgnoreable

(

)

const [inline]

Indicates whether the argument can be ignored, if desired.

References _ignoreable.

bool DtCmdLine::Arg::isRequired

(

)

const [inline, virtual]

Indicates whether the argument is required.

Reimplemented in DtCmdLine::MultiArg< T >.

References _required.

Referenced by DtCmdLine::CmdLine::add(), and DtCmdLine::XorHandler::check().

bool DtCmdLine::Arg::isSet

(

)

const [inline]

Indicates whether the argument has already been set.

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

References _alreadySet, and _xorSet.

bool DtCmdLine::Arg::isValueRequired

(

)

const [inline]

Indicates whether a value must be specified for argument.

References _valueRequired.

std::string DtCmdLine::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 DtCmdLine::MultiArg< T >, DtCmdLine::ValueArg< T >, DtCmdLine::UnlabeledValueArg< T >, and DtCmdLine::UnlabeledMultiArg< T >.

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

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

static const std::string DtCmdLine::Arg::nameStartString

(

)

[inline, static]

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

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

bool DtCmdLine::Arg::operator==

(

const Arg &

a

)

[inline, virtual]

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters:

a	- The Arg to be compared to this.

References _flag, and _name.

virtual bool DtCmdLine::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 DtCmdLine::MultiArg< T >, DtCmdLine::UnlabeledValueArg< T >, DtCmdLine::ValueArg< T >, DtCmdLine::UnlabeledMultiArg< T >, and DtCmdLine::SwitchArg.

static void DtCmdLine::Arg::setDelimiter

(

char

c

)

[inline, static]

Sets the delimiter for all arguments.

Parameters:

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

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

void DtCmdLine::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.

References _requireLabel.

std::string DtCmdLine::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 DtCmdLine::MultiArg< T >, DtCmdLine::ValueArg< T >, DtCmdLine::UnlabeledValueArg< T >, and DtCmdLine::UnlabeledMultiArg< T >.

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

Referenced by DtCmdLine::MultiArg< T >::shortID().

std::string DtCmdLine::Arg::toString

(

)

const [inline, virtual]

Returns a simple string representation of the argument.

Primarily for debugging.

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

Referenced by Arg(), and DtCmdLine::SwitchArg::processArg().

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

Trims a value off of the flag.

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.

References delimiter().

void DtCmdLine::Arg::xorSet

(

)

[inline]

Sets the _alreadySet value to true.

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

References _alreadySet, and _xorSet.

---

Member Data Documentation

bool DtCmdLine::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.

Referenced by isSet(), DtCmdLine::SwitchArg::processArg(), and xorSet().

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

Description of the argument.

Referenced by getDescription().

std::string DtCmdLine::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.

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

bool DtCmdLine::Arg::_ignoreable [protected]

Whether this argument can be ignored, if desired.

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

std::string DtCmdLine::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.

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

bool DtCmdLine::Arg::_required [protected]

Indicating whether the argument is required.

Referenced by forceRequired(), getDescription(), isRequired(), and shortID().

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

Label to be used in usage description.

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

Referenced by getDescription(), and setRequireLabel().

bool DtCmdLine::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.

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

Visitor* DtCmdLine::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.

Referenced by _checkWithVisitor().

bool DtCmdLine::Arg::_xorSet [protected]

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

Referenced by isSet(), and xorSet().

---

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

• cmdArg.h