The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...

#include <CmdLine.h>

Inheritance diagram for TCLAP::CmdLine:

[legend]

Collaboration diagram for TCLAP::CmdLine:

[legend]

Classes
struct	MessageTranslator
	Optional callback used to localize user-facing strings. More...

struct	MessageTranslatorImpl

class	Registration

Public Member Functions
	CmdLine (const std::string &message, const char delimiter=' ', const std::string &version="none", bool helpAndVersion=true)
	Command line constructor.

virtual	~CmdLine ()
	Deletes any resources allocated by a CmdLine object.

ArgContainer &	add (Arg &a)
	Adds an argument to the list of arguments to be parsed.

ArgContainer &	add (Arg *a)
	An alternative add.

ArgContainer &	add (ArgGroup &args)
	Adds an argument group to the list of arguments to be parsed.

void	addToArgList (Arg *a)

void	xorAdd (Arg &a, Arg &b)

void	xorAdd (const std::vector< Arg * > &xors)

void	parse (int argc, const char const argv)
	Parses the command line.

void	parse (std::vector< std::string > &args)
	Parses the command line.

void	setOutput (CmdLineOutput *co)

std::string	getVersion () const
	Returns the version string.

std::string	getProgramName () const
	Returns the program name string.

std::list< Arg * >	getArgList () const

std::list< ArgGroup * >	getArgGroups ()
	Returns the list of ArgGroups.

char	getDelimiter () const
	Returns the delimiter string.

std::string	getMessage () const
	Returns the message string.

bool	hasHelpAndVersion () const
	Indicates whether or not the help and version switches were created automatically.

void	setExceptionHandling (const bool state)
	Disables or enables CmdLine's internal parsing exception handling.

bool	hasExceptionHandling () const
	Returns the current state of the internal exception handling.

void	reset ()
	Allows the CmdLine object to be reused.

void	ignoreUnmatched (const bool ignore)
	Allows unmatched args to be ignored.

template<typename T >
void	setMessageTranslator (const T &translator)
	Sets an optional message translator callback.

std::string	translateMessage (const std::string &messageId, const std::string &fallback) const
	Translates a built-in message.

void	beginIgnoring ()
	Begin ignoring arguments since the "--" argument was specified.

bool	ignoreRest ()
	Whether to ignore the rest.

Public Member Functions inherited from TCLAP::CmdLineInterface
virtual	~CmdLineInterface ()
	Destructor.

void	parse (std::vector< std::string > &args)
	Parses the command line.

Public Member Functions inherited from TCLAP::ArgContainer
virtual	~ArgContainer ()

Protected Member Functions
bool	attachGroup (ArgGroup &group)

void	missingArgsException (const std::list< ArgGroup * > &missing)
	Throws an exception listing the missing args.

bool	_emptyCombined (const std::string &s)
	Checks whether a name/flag string matches entirely matches the Arg::blankChar.

Protected Attributes
std::list< Arg * >	_argList
	The list of arguments that will be tested against the command line.

StandaloneArgs	_standaloneArgs

StandaloneArgs	_autoArgs

std::list< ArgGroup * >	_argGroups
	Some args have set constraints on them (i.e., exactly or at most one must be specified.

std::string	_progName
	The name of the program.

std::string	_message
	A message used to describe the program.

std::string	_version
	The version to be displayed with the –version switch.

int	_numRequired
	The number of arguments that are required to be present on the command line.

char	_delimiter
	The character that is used to separate the argument flag/name from the value.

bool	_hasOptionalUnlabeledArg

bool	_registrationActive

DeferDelete	_deleteOnExit
	Add pointers that should be deleted as part of cleanup when this object is destroyed.

StdOutput	_defaultOutput
	Default output handler if nothing is specified.

CmdLineOutput *	_output
	Object that handles all output for the CmdLine.

bool	_handleExceptions
	Should CmdLine handle parsing exceptions internally?

MessageTranslator *	_messageTranslator

SwitchArg *	_ignoreArg
	Built-in arguments whose descriptions may need refreshing when the translator changes.

SwitchArg *	_helpArg

SwitchArg *	_versionArg

Detailed Description

The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes.

Definition at line 85 of file CmdLine.h.

Constructor & Destructor Documentation

◆ CmdLine()

TCLAP::CmdLine::CmdLine	(	const std::string &	message,
		const char	delimiter = `' '`,
		const std::string &	version = `"none"`,
		bool	helpAndVersion = `true`
	)

inline

Command line constructor.

Defines how the arguments will be parsed.

Parameters

message	- The message to be used in the usage output.
delimiter	- The character that is used to separate the argument flag/name from the value. Defaults to ' ' (space).
version	- The version number to be used in the –version switch.
helpAndVersion	- Whether or not to create the Help and Version switches. Defaults to true.

Definition at line 392 of file CmdLine.h.

◆ ~CmdLine()

virtual TCLAP::CmdLine::~CmdLine ( )

inlinevirtual

Deletes any resources allocated by a CmdLine object.

Definition at line 260 of file CmdLine.h.

References _messageTranslator.

Member Function Documentation

◆ _emptyCombined()

bool TCLAP::CmdLine::_emptyCombined ( const std::string & s )

inlineprotected

Checks whether a name/flag string matches entirely matches the Arg::blankChar.

Used when multiple switches are combined into a single argument.

Parameters

s	- The message to be used in the usage.

Definition at line 719 of file CmdLine.h.

References TCLAP::Arg::blankChar(), and TCLAP::Arg::flagStartChar().

Here is the call graph for this function:

◆ add() [1/3]

ArgContainer & TCLAP::CmdLine::add ( Arg & a )

inlinevirtual

Adds an argument to the list of arguments to be parsed.

Parameters

a	- Argument to be added.

Return values

A	reference to this so that add calls can be chained

Implements TCLAP::CmdLineInterface.

Definition at line 587 of file CmdLine.h.

References add().

Referenced by add(), and attachGroup().

Here is the call graph for this function:

◆ add() [2/3]

ArgContainer & TCLAP::CmdLine::add ( Arg * a )

inlinevirtual

An alternative add.

Functionally identical.

Parameters

a	- Argument to be added.

Return values

A	reference to this so that add calls can be chained

Implements TCLAP::CmdLineInterface.

Definition at line 595 of file CmdLine.h.

References TCLAP::ArgGroup::_args, _standaloneArgs, TCLAP::CmdLine::Registration::add(), and TCLAP::CmdLine::Registration::commit().

Here is the call graph for this function:

◆ add() [3/3]

ArgContainer & TCLAP::CmdLine::add ( ArgGroup & args )

inlinevirtual

Adds an argument group to the list of arguments to be parsed.

All arguments in the group are added and the ArgGroup object will validate that the input matches its constraints.

Parameters

args	- Argument group to be added.

Return values

A	reference to this so that add calls can be chained

Implements TCLAP::CmdLineInterface.

Definition at line 573 of file CmdLine.h.

References _argGroups, TCLAP::ArgGroup::_parser, TCLAP::CmdLine::Registration::add(), TCLAP::ArgGroup::begin(), TCLAP::CmdLine::Registration::commit(), and TCLAP::ArgGroup::end().

Here is the call graph for this function:

◆ addToArgList()

void TCLAP::CmdLine::addToArgList ( Arg * a )

inlinevirtual

Implements TCLAP::CmdLineInterface.

Definition at line 589 of file CmdLine.h.

References TCLAP::CmdLine::Registration::add(), and TCLAP::CmdLine::Registration::commit().

Here is the call graph for this function:

◆ attachGroup()

bool TCLAP::CmdLine::attachGroup ( ArgGroup & group )

inlineprotectedvirtual

Reimplemented from TCLAP::CmdLineInterface.

Definition at line 134 of file CmdLine.h.

References add().

Here is the call graph for this function:

◆ beginIgnoring()

void TCLAP::CmdLine::beginIgnoring ( )

inlinevirtual

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

Implements TCLAP::CmdLineInterface.

Definition at line 384 of file CmdLine.h.

◆ getArgGroups()

std::list< ArgGroup * > TCLAP::CmdLine::getArgGroups ( )

inlinevirtual

Returns the list of ArgGroups.

Implements TCLAP::CmdLineInterface.

Definition at line 325 of file CmdLine.h.

References _argGroups, and _autoArgs.

◆ getArgList()

std::list< Arg * > TCLAP::CmdLine::getArgList ( ) const

inlinevirtual

Implements TCLAP::CmdLineInterface.

Definition at line 324 of file CmdLine.h.

References _argList.

◆ getDelimiter()

char TCLAP::CmdLine::getDelimiter ( ) const

inlinevirtual

Returns the delimiter string.

Implements TCLAP::CmdLineInterface.

Definition at line 331 of file CmdLine.h.

References _delimiter.

◆ getMessage()

std::string TCLAP::CmdLine::getMessage ( ) const

inlinevirtual

Returns the message string.

Implements TCLAP::CmdLineInterface.

Definition at line 332 of file CmdLine.h.

References _message.

◆ getProgramName()

std::string TCLAP::CmdLine::getProgramName ( ) const

inlinevirtual

Returns the program name string.

Implements TCLAP::CmdLineInterface.

Definition at line 321 of file CmdLine.h.

References _progName.

◆ getVersion()

std::string TCLAP::CmdLine::getVersion ( ) const

inlinevirtual

Returns the version string.

Implements TCLAP::CmdLineInterface.

Definition at line 319 of file CmdLine.h.

References _version.

◆ hasExceptionHandling()

bool TCLAP::CmdLine::hasExceptionHandling ( ) const

inline

Returns the current state of the internal exception handling.

Return values

true	Parsing exceptions are handled internally.
false	Parsing exceptions are propagated to the caller.

Definition at line 348 of file CmdLine.h.

References _handleExceptions.

◆ hasHelpAndVersion()

bool TCLAP::CmdLine::hasHelpAndVersion ( ) const

inlinevirtual

Indicates whether or not the help and version switches were created automatically.

Implements TCLAP::CmdLineInterface.

Definition at line 333 of file CmdLine.h.

◆ ignoreRest()

bool TCLAP::CmdLine::ignoreRest ( )

inlinevirtual

Whether to ignore the rest.

Implements TCLAP::CmdLineInterface.

Definition at line 385 of file CmdLine.h.

◆ ignoreUnmatched()

void TCLAP::CmdLine::ignoreUnmatched ( const bool ignore )

inline

Allows unmatched args to be ignored.

By default false.

Parameters

ignore If true the cmdline will ignore any unmatched args and if false it will behave as normal.

Definition at line 777 of file CmdLine.h.

◆ missingArgsException()

void TCLAP::CmdLine::missingArgsException ( const std::list< ArgGroup * > & missing )

inlineprotected

Throws an exception listing the missing args.

Definition at line 728 of file CmdLine.h.

References _argList, and translateMessage().

Here is the call graph for this function:

◆ parse() [1/2]

void TCLAP::CmdLine::parse	(	int	argc,
		const char const	argv
	)

inlinevirtual

Parses the command line.

Parameters

argc	- Number of arguments.
argv	- Array of arguments.

Implements TCLAP::CmdLineInterface.

Definition at line 605 of file CmdLine.h.

References parse().

Referenced by parse().

Here is the call graph for this function:

◆ parse() [2/2]

void TCLAP::CmdLine::parse ( std::vector< std::string > & args )

inline

Parses the command line.

Parameters

args	- A vector of strings representing the args. args[0] is still the program name.

Definition at line 614 of file CmdLine.h.

References _handleExceptions, _output, TCLAP::CmdLineOutput::failure(), and TCLAP::ExitException::getExitStatus().

Here is the call graph for this function:

◆ reset()

void TCLAP::CmdLine::reset ( )

inlinevirtual

Allows the CmdLine object to be reused.

Implements TCLAP::CmdLineInterface.

Definition at line 769 of file CmdLine.h.

References _argList, and _progName.

◆ setExceptionHandling()

void TCLAP::CmdLine::setExceptionHandling ( const bool state )

inline

Disables or enables CmdLine's internal parsing exception handling.

Parameters

state Should CmdLine handle parsing exceptions internally?

Definition at line 765 of file CmdLine.h.

References _handleExceptions.

◆ setMessageTranslator()

template<typename T >

void TCLAP::CmdLine::setMessageTranslator ( const T & translator )

inline

Sets an optional message translator callback.

Definition at line 367 of file CmdLine.h.

References _messageTranslator.

◆ setOutput()

void TCLAP::CmdLine::setOutput ( CmdLineOutput * co )

inlinevirtual

Parameters

co	- CmdLineOutput object that we want to use instead.

Implements TCLAP::CmdLineInterface.

Definition at line 763 of file CmdLine.h.

References _output.

◆ translateMessage()

std::string TCLAP::CmdLine::translateMessage	(	const std::string &	messageId,
		const std::string &	fallback
	)		const

inlinevirtual

Translates a built-in message.

Implements TCLAP::CmdLineInterface.

Definition at line 376 of file CmdLine.h.

References _messageTranslator, and TCLAP::CmdLine::MessageTranslator::translate().

Referenced by missingArgsException().

Here is the call graph for this function:

◆ xorAdd() [1/2]

void TCLAP::CmdLine::xorAdd	(	Arg &	a,
		Arg &	b
	)

inlinevirtual

Deprecated:: Use OneOf instead.

Implements TCLAP::CmdLineInterface.

Definition at line 496 of file CmdLine.h.

References xorAdd().

Referenced by xorAdd().

Here is the call graph for this function:

◆ xorAdd() [2/2]

void TCLAP::CmdLine::xorAdd ( const std::vector< Arg * > & xors )

inlinevirtual

Deprecated:: Use OneOf instead.

Implements TCLAP::CmdLineInterface.

Definition at line 486 of file CmdLine.h.

References _deleteOnExit, and TCLAP::ExclusiveArgGroup::add().

Here is the call graph for this function:

Member Data Documentation

◆ _argGroups

std::list<ArgGroup *> TCLAP::CmdLine::_argGroups

protected

Some args have set constraints on them (i.e., exactly or at most one must be specified.

Definition at line 100 of file CmdLine.h.

Referenced by add(), and getArgGroups().

◆ _argList

std::list<Arg *> TCLAP::CmdLine::_argList

protected

The list of arguments that will be tested against the command line.

Definition at line 91 of file CmdLine.h.

Referenced by TCLAP::CmdLine::Registration::commit(), getArgList(), missingArgsException(), and reset().

◆ _autoArgs

StandaloneArgs TCLAP::CmdLine::_autoArgs

protected

Definition at line 94 of file CmdLine.h.

Referenced by getArgGroups().

◆ _defaultOutput

StdOutput TCLAP::CmdLine::_defaultOutput

protected

Default output handler if nothing is specified.

Definition at line 149 of file CmdLine.h.

◆ _deleteOnExit

DeferDelete TCLAP::CmdLine::_deleteOnExit

protected

Add pointers that should be deleted as part of cleanup when this object is destroyed.

Definition at line 144 of file CmdLine.h.

Referenced by xorAdd().

◆ _delimiter

char TCLAP::CmdLine::_delimiter

protected

The character that is used to separate the argument flag/name from the value.

Defaults to ' ' (space).

Definition at line 128 of file CmdLine.h.

Referenced by TCLAP::CmdLine::Registration::add(), and getDelimiter().

◆ _handleExceptions

bool TCLAP::CmdLine::_handleExceptions

protected

Should CmdLine handle parsing exceptions internally?

Definition at line 159 of file CmdLine.h.

Referenced by hasExceptionHandling(), parse(), and setExceptionHandling().

◆ _hasOptionalUnlabeledArg

bool TCLAP::CmdLine::_hasOptionalUnlabeledArg

protected

Definition at line 131 of file CmdLine.h.

Referenced by TCLAP::CmdLine::Registration::commit().

◆ _helpArg

SwitchArg* TCLAP::CmdLine::_helpArg

protected

Definition at line 187 of file CmdLine.h.

◆ _ignoreArg

SwitchArg* TCLAP::CmdLine::_ignoreArg

protected

Built-in arguments whose descriptions may need refreshing when the translator changes.

Definition at line 186 of file CmdLine.h.

◆ _message

std::string TCLAP::CmdLine::_message

protected

A message used to describe the program.

Used in the usage output.

Definition at line 110 of file CmdLine.h.

Referenced by getMessage().

◆ _messageTranslator

MessageTranslator* TCLAP::CmdLine::_messageTranslator

protected

Definition at line 180 of file CmdLine.h.

Referenced by setMessageTranslator(), translateMessage(), and ~CmdLine().

◆ _numRequired

int TCLAP::CmdLine::_numRequired

protected

The number of arguments that are required to be present on the command line.

This is set dynamically, based on the Args added to the CmdLine object.

Definition at line 122 of file CmdLine.h.

Referenced by TCLAP::CmdLine::Registration::commit().

◆ _output

CmdLineOutput* TCLAP::CmdLine::_output

protected

Object that handles all output for the CmdLine.

Definition at line 154 of file CmdLine.h.

Referenced by parse(), and setOutput().

◆ _progName

std::string TCLAP::CmdLine::_progName

protected

The name of the program.

Set to argv[0].

Definition at line 105 of file CmdLine.h.

Referenced by getProgramName(), and reset().

◆ _registrationActive

bool TCLAP::CmdLine::_registrationActive

protected

Definition at line 132 of file CmdLine.h.

Referenced by TCLAP::CmdLine::Registration::Registration(), and TCLAP::CmdLine::Registration::~Registration().

◆ _standaloneArgs

StandaloneArgs TCLAP::CmdLine::_standaloneArgs

protected

Definition at line 93 of file CmdLine.h.

Referenced by add().

◆ _version

std::string TCLAP::CmdLine::_version

protected

The version to be displayed with the –version switch.

Definition at line 115 of file CmdLine.h.

Referenced by getVersion().

◆ _versionArg

SwitchArg* TCLAP::CmdLine::_versionArg

protected

Definition at line 188 of file CmdLine.h.

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

CmdLine.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CmdLine()

◆ ~CmdLine()

Member Function Documentation

◆ _emptyCombined()

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ addToArgList()

◆ attachGroup()

◆ beginIgnoring()

◆ getArgGroups()

◆ getArgList()

◆ getDelimiter()

◆ getMessage()

◆ getProgramName()

◆ getVersion()

◆ hasExceptionHandling()

◆ hasHelpAndVersion()

◆ ignoreRest()

◆ ignoreUnmatched()

◆ missingArgsException()

◆ parse() [1/2]

◆ parse() [2/2]

◆ reset()

◆ setExceptionHandling()

◆ setMessageTranslator()

◆ setOutput()

◆ translateMessage()

◆ xorAdd() [1/2]

◆ xorAdd() [2/2]

Member Data Documentation

◆ _argGroups

◆ _argList

◆ _autoArgs

◆ _defaultOutput

◆ _deleteOnExit

◆ _delimiter

◆ _handleExceptions

◆ _hasOptionalUnlabeledArg

◆ _helpArg

◆ _ignoreArg

◆ _message

◆ _messageTranslator

◆ _numRequired

◆ _output

◆ _progName

◆ _registrationActive

◆ _standaloneArgs

◆ _version

◆ _versionArg