wibble::commandline::SingleOption< T > Class Template Reference

#include <options.h>

Inheritance diagram for wibble::commandline::SingleOption< T >:

Collaboration diagram for wibble::commandline::SingleOption< T >:

Public Member Functions
void	setValue (const typename T::value_type &a)
T::value_type	value () const
bool	boolValue () const
int	intValue () const
std::string	stringValue () const
Public Member Functions inherited from wibble::commandline::Option
	Option ()
virtual	~Option ()
bool	isSet () const
const std::string &	name () const
void	addAlias (char c)
void	addAlias (const std::string &str)
const std::string &	fullUsage () const
	Return a full usage message including all the aliases for this option. More...
std::string	fullUsageForMan () const
Public Member Functions inherited from wibble::commandline::Managed
virtual	~Managed ()

Protected Member Functions
	SingleOption (const std::string &name)
	SingleOption (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
ArgList::iterator	parse (ArgList &list, ArgList::iterator begin)
	Parse the next commandline parameter after the short form of the command has been found. More...
bool	parse (const std::string &param)
	Parse the commandline parameter of a long commandline switch. More...
void	parse_noarg ()
	Notify that the option is present in the command line, but has no arguments. More...
Protected Member Functions inherited from wibble::commandline::Option
	Option (const std::string &name)
	Option (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
virtual bool	arg_is_optional () const
	Return true if the argument to this function can be omitted. More...

Protected Attributes
T::value_type	m_value
Protected Attributes inherited from wibble::commandline::Option
bool	m_isset

Friends
class	OptionGroup
class	Engine

Additional Inherited Members
Public Attributes inherited from wibble::commandline::Option
std::vector< char >	shortNames
std::vector< std::string >	longNames
std::string	usage
std::string	description
bool	hidden

Constructor & Destructor Documentation

template<typename T >

wibble::commandline::SingleOption< T >::SingleOption ( const std::string &  name )

inlineprotected

References wibble::commandline::Option::usage.

template<typename T >

wibble::commandline::SingleOption< T >::SingleOption ( const std::string &  name, char  shortName, const std::string &  longName, const std::string &  usage = std::string(), const std::string &  description = std::string()  )

inlineprotected

References wibble::commandline::Option::usage.

Member Function Documentation

template<typename T >

bool wibble::commandline::SingleOption< T >::boolValue ( ) const

inline

References wibble::commandline::SingleOption< T >::m_value.

Referenced by TestCommandlineEngine::longOptsWithDashes(), TestCommandlineEngine::optsOnly(), and withCommands().

template<typename T >

int wibble::commandline::SingleOption< T >::intValue ( ) const

inline

References wibble::commandline::SingleOption< T >::m_value.

template<typename T >

ArgList::iterator wibble::commandline::SingleOption< T >::parse ( ArgList &  list, ArgList::iterator  begin  )

inlineprotectedvirtual

Parse the next commandline parameter after the short form of the command has been found.

It may or may not remove the parameter from the list, depending on if the option wants a value or not.

Signal that the option has been found, with the given argument (or 0 if no argument).

Returns

true if it used the argument, else false

Implements wibble::commandline::Option.

References wibble::commandline::ArgList::eraseAndAdvance(), wibble::commandline::Option::m_isset, and wibble::commandline::SingleOption< T >::m_value.

template<typename T >

bool wibble::commandline::SingleOption< T >::parse ( const std::string &  param )

inlineprotectedvirtual

Parse the commandline parameter of a long commandline switch.

Returns

true if the parameter has been used

Implements wibble::commandline::Option.

References wibble::commandline::Option::m_isset, and wibble::commandline::SingleOption< T >::m_value.

template<typename T >

void wibble::commandline::SingleOption< T >::parse_noarg ( )

inlineprotectedvirtual

Notify that the option is present in the command line, but has no arguments.

Implements wibble::commandline::Option.

template<typename T >

void wibble::commandline::SingleOption< T >::setValue ( const typename T::value_type &  a )

inline

References wibble::commandline::SingleOption< T >::m_value.

template<typename T >

std::string wibble::commandline::SingleOption< T >::stringValue ( ) const

inline

References wibble::commandline::SingleOption< T >::m_value.

Referenced by TestCommandlineEngine::clusteredShortOpts(), TestCommandlineEngine::commandsWithoutCommand(), TestCommandlineEngine::commandsWithOverlappingArgs(), TestCommandlineEngine::commandWithArg(), TestCommandlineEngine::longOptsWithArgs(), TestCommandlineEngine::noSwitchesAfterFirstArg(), and TestCommandlineEngine::optsAndArgs().

template<typename T >

T::value_type wibble::commandline::SingleOption< T >::value ( ) const

inline

References wibble::commandline::SingleOption< T >::m_value.

Friends And Related Function Documentation

template<typename T >

friend class Engine

friend

template<typename T >

friend class OptionGroup

friend

Member Data Documentation

template<typename T >

T::value_type wibble::commandline::SingleOption< T >::m_value

protected

Referenced by wibble::commandline::SingleOption< T >::boolValue(), wibble::commandline::SingleOption< T >::intValue(), wibble::commandline::SingleOption< T >::parse(), wibble::commandline::SingleOption< T >::setValue(), wibble::commandline::SingleOption< T >::stringValue(), and wibble::commandline::SingleOption< T >::value().

---

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

• options.h