wibble::commandline::StandardParser Class Reference

#include <parser.h>

Inheritance diagram for wibble::commandline::StandardParser:

[legend]

Collaboration diagram for wibble::commandline::StandardParser:

[legend]

List of all members.

---

Detailed Description

Parser for commandline arguments, with builting help functions.

Public Member Functions
	StandardParser (const std::string &appname, const std::string &version)
void	outputHelp (std::ostream &out)
bool	parse (int argc, const char *argv[])
	Parse the commandline.
Public Attributes
OptionGroup *	helpGroup
BoolOption *	help
BoolOption *	version
Protected Attributes
std::string	m_version

---

Constructor & Destructor Documentation

wibble::commandline::StandardParser::StandardParser	(	const std::string &	appname,
		const std::string &	version
	)			[inline]

References wibble::commandline::OptionGroup::add(), wibble::commandline::Option::addAlias(), wibble::commandline::Engine::addGroup(), help, and helpGroup.

---

Member Function Documentation

void wibble::commandline::StandardParser::outputHelp

(

std::ostream &

out

)

References wibble::commandline::Engine::foundCommand(), help, m_version, wibble::commandline::Engine::name(), and wibble::commandline::Help::outputHelp().

Referenced by parse(), and withCommands().

bool wibble::commandline::StandardParser::parse	(	int	argc,
		const char *	argv[]
	)

Parse the commandline.

Returns:

true if it also took care of performing the action requested by the user, or false if the caller should do it instead.

Reimplemented from wibble::commandline::Parser.

Reimplemented in wibble::commandline::StandardParserWithManpage, and wibble::commandline::StandardParserWithMandatoryCommand.

References wibble::commandline::BoolOption::boolValue(), help, m_version, wibble::commandline::Engine::name(), outputHelp(), wibble::commandline::Help::outputVersion(), wibble::commandline::Parser::parse(), and version.

Referenced by wibble::commandline::StandardParserWithManpage::parse().

---

Member Data Documentation

std::string wibble::commandline::StandardParser::m_version [protected]

Referenced by outputHelp(), wibble::commandline::StandardParserWithMandatoryCommand::parse(), wibble::commandline::StandardParserWithManpage::parse(), and parse().

OptionGroup* wibble::commandline::StandardParser::helpGroup

Referenced by StandardParser(), and wibble::commandline::StandardParserWithManpage::StandardParserWithManpage().

BoolOption* wibble::commandline::StandardParser::help

Referenced by outputHelp(), wibble::commandline::StandardParserWithMandatoryCommand::parse(), parse(), StandardParser(), and withCommands().

BoolOption* wibble::commandline::StandardParser::version

Referenced by parse(), and withCommands().

---

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

• parser.h
• parser.cpp