Engine2 Class Reference

#include <engine.test.h>

Inheritance diagram for Engine2:

Collaboration diagram for Engine2:

Public Member Functions
	Engine2 ()
Public Member Functions inherited from Public< Engine >
	Public (MemoryManager *mman=0, const std::string &name=std::string(), const std::string &usage=std::string(), const std::string &description=std::string(), const std::string &longDescription=std::string())
ArgList::iterator	parseList (ArgList &list)
ArgList::iterator	parse (ArgList &list, ArgList::iterator begin)
Public Member Functions inherited from wibble::commandline::Engine
const std::string &	name () const
Option *	add (Option *o)
	Add an Option to this engine.
OptionGroup *	add (OptionGroup *group)
	Add an OptionGroup to this engine.
Engine *	add (Engine *o)
	Add a Engine to this engine.
template<typename T >
T *	create (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
	Create an option.
template<typename T >
T *	add (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
	Create an option and add to this engine.
OptionGroup *	createGroup (const std::string &description)
	Create an OptionGroup.
OptionGroup *	addGroup (const std::string &description)
	Create an OptionGroup and add it to this engine.
Engine *	createEngine (const std::string &name, const std::string &usage=std::string(), const std::string &description=std::string(), const std::string &longDescription=std::string())
	Create a Engine.
Engine *	addEngine (const std::string &name, const std::string &usage=std::string(), const std::string &description=std::string(), const std::string &longDescription=std::string())
	Create a Engine and add it to this engine as a command.
const std::vector< OptionGroup * > &	groups () const
	Get the OptionGroups that have been added to this engine.
const std::vector< Option * > &	options () const
	Get the Options that have been added to this engine.
const std::vector< Engine * > &	commands () const
	Get the Engines that have been added to this engine.
Engine *	command (const std::string &name) const
bool	hasOptions () const
	Returns true if this Engine has options to parse.
Engine *	foundCommand () const
	Return the command that has been found in the commandline, or NULL if none have been found.
void	dump (std::ostream &out, const std::string &prefix=std::string())
Public Member Functions inherited from wibble::commandline::Managed
virtual	~Managed ()

Public Attributes
BoolOption *	help
Engine *	scramble
BoolOption *	scramble_random
StringOption *	scramble_yell
Engine *	fix
BoolOption *	fix_quick
StringOption *	fix_yell
Public Attributes inherited from wibble::commandline::Engine
std::string	primaryAlias
std::vector< std::string >	aliases
std::string	usage
std::string	description
std::string	longDescription
std::string	examples
bool	hidden
bool	no_switches_after_first_arg

Additional Inherited Members
Protected Member Functions inherited from wibble::commandline::Engine
void	addWithoutAna (Option *o)
void	addWithoutAna (const std::vector< Option * > &o)
void	add (const std::string &alias, Engine *o)
void	rebuild ()
std::pair< ArgList::iterator, bool >	parseFirstIfKnown (ArgList &list, ArgList::iterator begin)
	Handle the commandline switch at 'begin'.
ArgList::iterator	parseKnownSwitches (ArgList &list, ArgList::iterator begin)
	Parse all known Options and leave the rest in list.
ArgList::iterator	parseList (ArgList &list)
	Parse the list of arguments, starting at the beginning and removing the arguments it successfully parses.
ArgList::iterator	parse (ArgList &list, ArgList::iterator begin)
	Parse all the switches in list, leaving only the non-switch arguments or the arguments following "--".
	Engine (MemoryManager *mman=0, const std::string &name=std::string(), const std::string &usage=std::string(), const std::string &description=std::string(), const std::string &longDescription=std::string())
Protected Attributes inherited from wibble::commandline::Engine
std::vector< OptionGroup * >	m_groups
std::vector< Option * >	m_options
std::vector< Engine * >	m_commands
std::map< char, Option * >	m_short
std::map< std::string, Option * >	m_long
std::map< std::string, Engine * >	m_aliases
Engine *	m_found_command

Constructor & Destructor Documentation

Engine2()

Engine2::Engine2 ( )

inline

References wibble::commandline::Engine::add(), wibble::commandline::Engine::addEngine(), wibble::commandline::Engine::aliases, fix, fix_quick, fix_yell, help, scramble, scramble_random, and scramble_yell.

Member Data Documentation

fix

Engine* Engine2::fix

Referenced by Engine2().

fix_quick

BoolOption* Engine2::fix_quick

Referenced by Engine2().

fix_yell

StringOption* Engine2::fix_yell

Referenced by Engine2().

help

BoolOption* Engine2::help

Referenced by Engine2().

scramble

Engine* Engine2::scramble

Referenced by Engine2().

scramble_random

BoolOption* Engine2::scramble_random

Referenced by Engine2().

scramble_yell

StringOption* Engine2::scramble_yell

Referenced by Engine2().

---

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

• engine.test.h