Virtual parent for all the different argument classes. More...

#include <arg.hpp>

Inheritance diagram for ecl::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

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 std::string	flagStartString ()

static std::string	ignoreNameString ()

static bool	ignoreRest ()

static 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

Virtual parent for all the different argument classes.

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 39 of file arg.hpp.

Constructor & Destructor Documentation

◆ Arg()

ecl::Arg::Arg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		bool	valreq,
		Visitor *	v = `NULL`
	)

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.

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 355 of file arg.hpp.

◆ ~Arg()

ecl::Arg::~Arg ( )

inlinevirtual

Destructor.

Definition at line 396 of file arg.hpp.

Member Function Documentation

◆ _checkWithVisitor()

void ecl::Arg::_checkWithVisitor ( ) const

inlineprotected

Performs the special handling described by the Vistitor.

Definition at line 507 of file arg.hpp.

◆ _hasBlanks()

bool ecl::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 537 of file arg.hpp.

◆ acceptsMultipleValues()

bool ecl::Arg::acceptsMultipleValues ( )

inlinevirtual

Definition at line 570 of file arg.hpp.

◆ addToList()

void ecl::Arg::addToList ( std::list< Arg * > & argList ) const

inlinevirtual

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.

Definition at line 560 of file arg.hpp.

◆ allowMore()

bool ecl::Arg::allowMore ( )

inlinevirtual

Definition at line 565 of file arg.hpp.

◆ argMatches()

bool ecl::Arg::argMatches ( const std::string & s ) const

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.

Parameters

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

Definition at line 486 of file arg.hpp.

◆ beginIgnoring()

static void ecl::Arg::beginIgnoring ( )

inlinestatic

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

Definition at line 168 of file arg.hpp.

◆ blankChar()

static char ecl::Arg::blankChar ( )

inlinestatic

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 186 of file arg.hpp.

◆ delimiter()

static char ecl::Arg::delimiter ( )

inlinestatic

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

Definition at line 179 of file arg.hpp.

◆ delimiterRef()

static char& ecl::Arg::delimiterRef ( )

inlinestaticprivate

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

Definition at line 54 of file arg.hpp.

◆ flagStartChar()

static char ecl::Arg::flagStartChar ( )

inlinestatic

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

Definition at line 191 of file arg.hpp.

◆ flagStartString()

static std::string ecl::Arg::flagStartString ( )

inlinestatic

The sting that indicates the beginning of a flag. Currently "-". Should be identical to flagStartChar.

Definition at line 197 of file arg.hpp.

◆ forceRequired()

void ecl::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 546 of file arg.hpp.

◆ getDescription()

std::string ecl::Arg::getDescription ( ) const

inline

Returns the argument description.

Definition at line 450 of file arg.hpp.

◆ getFlag()

const std::string & ecl::Arg::getFlag ( ) const

inline

Returns the argument flag.

Definition at line 463 of file arg.hpp.

◆ getName()

const std::string & ecl::Arg::getName ( ) const

inline

Returns the argument name.

Definition at line 465 of file arg.hpp.

◆ ignoreNameString()

static std::string ecl::Arg::ignoreNameString ( )

inlinestatic

The name used to identify the ignore rest argument.

Definition at line 208 of file arg.hpp.

◆ ignoreRest()

static bool ecl::Arg::ignoreRest ( )

inlinestatic

Whether to ignore the rest.

Definition at line 173 of file arg.hpp.

◆ ignoreRestRef()

static bool& ecl::Arg::ignoreRestRef ( )

inlinestaticprivate

Indicates whether the rest of the arguments should be ignored.

Definition at line 48 of file arg.hpp.

◆ isIgnoreable()

bool ecl::Arg::isIgnoreable ( ) const

inline

Indicates whether the argument can be ignored, if desired.

Definition at line 479 of file arg.hpp.

◆ isRequired()

bool ecl::Arg::isRequired ( ) const

inlinevirtual

Indicates whether the argument is required.

Definition at line 467 of file arg.hpp.

◆ isSet()

bool ecl::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 471 of file arg.hpp.

◆ isValueRequired()

bool ecl::Arg::isValueRequired ( ) const

inline

Indicates whether a value must be specified for argument.

Definition at line 469 of file arg.hpp.

◆ longID()

std::string ecl::Arg::longID ( const std::string & valueId = "val" ) const

inlinevirtual

Returns a long ID for the usage.

Parameters

valueId - The value used in the id.

Reimplemented in ecl::MultiSwitchArg.

Definition at line 419 of file arg.hpp.

◆ nameStartString()

static std::string ecl::Arg::nameStartString ( )

inlinestatic

The sting that indicates the beginning of a name. Currently "--". Should be flagStartChar twice.

Definition at line 203 of file arg.hpp.

◆ operator==()

bool ecl::Arg::operator== ( const Arg & a ) const

inlinevirtual

Operator ==. Equality operator. Must be virtual to handle unlabeled args.

Parameters

a	- The Arg to be compared to this.

Definition at line 442 of file arg.hpp.

◆ processArg()

virtual bool ecl::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 ecl::MultiSwitchArg, and ecl::SwitchArg.

◆ setDelimiter()

static void ecl::Arg::setDelimiter ( char c )

inlinestatic

Sets the delimiter for all arguments.

Parameters

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

Definition at line 214 of file arg.hpp.

◆ setRequireLabel()

void ecl::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 481 of file arg.hpp.

◆ shortID()

std::string ecl::Arg::shortID ( const std::string & valueId = "val" ) const

inlinevirtual

Returns a short ID for the usage.

Parameters

valueId - The value used in the id.

Reimplemented in ecl::MultiSwitchArg.

Definition at line 398 of file arg.hpp.

◆ toString()

std::string ecl::Arg::toString ( ) const

inlinevirtual

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

Definition at line 495 of file arg.hpp.

◆ trimFlag()

void ecl::Arg::trimFlag	(	std::string &	flag,
		std::string &	value
	)		const

inlinevirtual

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 516 of file arg.hpp.

◆ xorSet()

void ecl::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 551 of file arg.hpp.

Member Data Documentation

◆ _acceptsMultipleValues

bool ecl::Arg::_acceptsMultipleValues

protected

Definition at line 126 of file arg.hpp.

◆ _alreadySet

bool ecl::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 105 of file arg.hpp.

◆ _description

std::string ecl::Arg::_description

protected

Description of the argument.

Definition at line 80 of file arg.hpp.

◆ _flag

std::string ecl::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 66 of file arg.hpp.

◆ _ignoreable

bool ecl::Arg::_ignoreable

protected

Whether this argument can be ignored, if desired.

Definition at line 118 of file arg.hpp.

◆ _name

std::string ecl::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 75 of file arg.hpp.

◆ _required

bool ecl::Arg::_required

protected

Indicating whether the argument is required.

Definition at line 85 of file arg.hpp.

◆ _requireLabel

std::string ecl::Arg::_requireLabel

protected

Label to be used in usage description. Normally set to "required", but can be changed when necessary.

Definition at line 91 of file arg.hpp.

◆ _valueRequired

bool ecl::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 98 of file arg.hpp.

◆ _visitor

Visitor* ecl::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 113 of file arg.hpp.

◆ _xorSet

bool ecl::Arg::_xorSet

protected

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

Definition at line 124 of file arg.hpp.

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

arg.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Arg()

◆ ~Arg()

Member Function Documentation

◆ _checkWithVisitor()

◆ _hasBlanks()

◆ acceptsMultipleValues()

◆ addToList()

◆ allowMore()

◆ argMatches()

◆ beginIgnoring()

◆ blankChar()

◆ delimiter()

◆ delimiterRef()

◆ flagStartChar()

◆ flagStartString()

◆ forceRequired()

◆ getDescription()

◆ getFlag()

◆ getName()

◆ ignoreNameString()

◆ ignoreRest()

◆ ignoreRestRef()

◆ isIgnoreable()

◆ isRequired()

◆ isSet()

◆ isValueRequired()

◆ longID()

◆ nameStartString()

◆ operator==()

◆ processArg()

◆ setDelimiter()

◆ setRequireLabel()

◆ shortID()

◆ toString()

◆ trimFlag()

◆ xorSet()

Member Data Documentation

◆ _acceptsMultipleValues

◆ _alreadySet

◆ _description

◆ _flag

◆ _ignoreable

◆ _name

◆ _required

◆ _requireLabel

◆ _valueRequired

◆ _visitor

◆ _xorSet