DtCmdLine::CmdLineInterface Class Reference

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

Inheritance diagram for DtCmdLine::CmdLineInterface:

Public Member Functions
virtual	~CmdLineInterface ()
	Destructor.
virtual void	add (Arg &a)=0
	Adds an argument to the list of arguments to be parsed.
virtual void	add (Arg *a)=0
	An alternative add.
virtual void	xorAdd (Arg &a, Arg &b)=0
	Add two Args that will be xor'd.
virtual void	xorAdd (std::vector< Arg * > &xors)=0
	Add a list of Args that will be xor'd.
virtual void	parse (int argc, char **argv, bool printOnError=true)=0
	Parses the command line.
virtual CmdLineOutput *	getOutput ()=0
	Returns the CmdLineOutput object.
virtual void	setOutput (CmdLineOutput *co)=0
virtual std::string &	getVersion ()=0
	Returns the version string.
virtual std::string &	getProgramName ()=0
	Returns the program name string.
virtual std::list< Arg * > &	getArgList ()=0
	Returns the argList.
virtual XorHandler &	getXorHandler ()=0
	Returns the XorHandler.
virtual char	getDelimiter ()=0
	Returns the delimiter string.
virtual std::string &	getMessage ()=0
	Returns the message string.

Detailed Description

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

Constructor & Destructor Documentation

virtual DtCmdLine::CmdLineInterface::~CmdLineInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual void DtCmdLine::CmdLineInterface::add ( Arg &  a )

pure virtual

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

Parameters

a	- Argument to be added.

Implemented in DtCmdLine::CmdLine.

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

virtual void DtCmdLine::CmdLineInterface::add ( Arg *  a )

pure virtual

An alternative add.

Functionally identical.

Parameters

a	- Argument to be added.

Implemented in DtCmdLine::CmdLine.

virtual std::list<Arg*>& DtCmdLine::CmdLineInterface::getArgList ( )

pure virtual

Returns the argList.

Implemented in DtCmdLine::CmdLine.

Referenced by DtCmdLine::StdOutput::_longUsage(), DtCmdLine::StdOutput::_shortUsage(), and DtCmdLine::DocBookOutput::usage().

virtual char DtCmdLine::CmdLineInterface::getDelimiter ( )

pure virtual

Returns the delimiter string.

Implemented in DtCmdLine::CmdLine.

virtual std::string& DtCmdLine::CmdLineInterface::getMessage ( )

pure virtual

Returns the message string.

Implemented in DtCmdLine::CmdLine.

Referenced by DtCmdLine::StdOutput::_longUsage().

virtual CmdLineOutput* DtCmdLine::CmdLineInterface::getOutput ( )

pure virtual

Returns the CmdLineOutput object.

Implemented in DtCmdLine::CmdLine.

virtual std::string& DtCmdLine::CmdLineInterface::getProgramName ( )

pure virtual

Returns the program name string.

Implemented in DtCmdLine::CmdLine.

Referenced by DtCmdLine::StdOutput::_shortUsage(), DtCmdLine::StdOutput::failure(), DtCmdLine::DocBookOutput::usage(), and DtCmdLine::StdOutput::version().

virtual std::string& DtCmdLine::CmdLineInterface::getVersion ( )

pure virtual

Returns the version string.

Implemented in DtCmdLine::CmdLine.

Referenced by DtCmdLine::DocBookOutput::version(), and DtCmdLine::StdOutput::version().

virtual XorHandler& DtCmdLine::CmdLineInterface::getXorHandler ( )

pure virtual

Returns the XorHandler.

Implemented in DtCmdLine::CmdLine.

Referenced by DtCmdLine::StdOutput::_longUsage(), DtCmdLine::StdOutput::_shortUsage(), and DtCmdLine::DocBookOutput::usage().

virtual void DtCmdLine::CmdLineInterface::parse ( int  argc, char **  argv, bool  printOnError = true  )

pure virtual

Parses the command line.

Parameters

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

Implemented in DtCmdLine::CmdLine.

virtual void DtCmdLine::CmdLineInterface::setOutput ( CmdLineOutput *  co )

pure virtual

Parameters

co	- CmdLineOutput object that we want to use instead.

Implemented in DtCmdLine::CmdLine.

virtual void DtCmdLine::CmdLineInterface::xorAdd ( Arg &  a, Arg &  b  )

pure virtual

Add two Args that will be xor'd.

If this method is used, add does not need to be called.

Parameters

a	- Argument to be added and xor'd.
b	- Argument to be added and xor'd.

Implemented in DtCmdLine::CmdLine.

virtual void DtCmdLine::CmdLineInterface::xorAdd ( std::vector< Arg * > &  xors )

pure virtual

Add a list of Args that will be xor'd.

If this method is used, add does not need to be called.

Parameters

xors	- List of Args to be added and xor'd.

Implemented in DtCmdLine::CmdLine.

---

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

• cmdLineInterface.h