os::OptionParser Class Reference

Command line option parser. More...

Classes
struct	argmap
struct	option
class	Private

Public Member Functions
	OptionParser (int argc, const char *const *argv)
	~OptionParser ()
void	AddArgMap (const argmap *pasMap)
void	AddArgMap (const String &cLongArg, char nShortArg, const String &cDesc)
void	ParseOptions (const char *pzOptions)
int	GetOptionCount () const
int	GetFileCount () const
const option *	FindOption (char nOpt) const
const option *	FindOption (const String &cLongName) const
const option *	GetNextOption ()
void	RewindOptions ()
const option *	GetOption (uint nIndex) const
const std::vector< String > &	GetArgs () const
const std::vector< String > &	GetFileArgs () const
String	GetHelpText (int nWidth=0) const
void	PrintHelpText (int nWidth=0) const
void	PrintHelpText (StreamableIO *pcStream, int nWidth=0) const
String	operator[] (int nIndex) const

Detailed Description

Description:

os::OptionParser is a utility class that can help you parse command line options. It also have members for automatic generation of a help text suitable for the "–help" option available in most command line commands. The help text feature will format the text according to the current terminal widht (or optionally a suplied with) performing necessarry word-wrapping to make the text as readable as possible.

The rules for option parsing is mostly compatible with the GNU getopt() function. There is two kind of options. Short-options or flag start with a single "-" and ends with a single letter. Long options start with "–" and end with a string. Both short-options and long-options can have additional arguments. If a short-option take an additional argument it the next option will be used as the argument value. If a long-option take an additional argument it must be specified as "–opt=arg". All arguments that are not recognized as options will be added to a "file-list" that can later be iterated. If one of the arguments is "–" the option parsing will stop there and the rest of the arguments will be added unconditionally to the "file-list".

Since

0.3.7

Author

Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Constructor & Destructor Documentation

OptionParser::OptionParser	(	int	argc,
		const char *const *	argv
	)

References os::OptionParser::Private::m_cArgs, and os::OptionParser::Private::m_nCurrentOption.

OptionParser::~OptionParser

(

)

Member Function Documentation

void OptionParser::AddArgMap

(

const argmap *

pasMap

)

References os::OptionParser::argmap::long_name, and os::OptionParser::Private::m_cOptionMap.

void OptionParser::AddArgMap	(	const String &	cLongArg,
		char	nShortArg,
		const String &	cDesc
	)

References os::OptionParser::Private::m_cOptionMap.

const OptionParser::option * OptionParser::FindOption

(

char

nOpt

)

const

References os::OptionParser::Private::m_cOptionList.

const OptionParser::option * OptionParser::FindOption

(

const String &

cLongName

)

const

References os::OptionParser::Private::m_cOptionList.

const std::vector< String > & OptionParser::GetArgs

(

)

const

References os::OptionParser::Private::m_cArgs.

const std::vector< String > & OptionParser::GetFileArgs

(

)

const

References os::OptionParser::Private::m_cFileArgs.

int OptionParser::GetFileCount

(

)

const

References os::OptionParser::Private::m_cFileArgs.

String OptionParser::GetHelpText

(

int

nWidth = 0

)

const

References os::String::begin(), os::String::end(), os::OptionParser::Private::m_cOptionMap, os::String::resize(), os::String::size(), and os::String::str().

Referenced by PrintHelpText().

const OptionParser::option * OptionParser::GetNextOption

(

)

References os::OptionParser::Private::m_cOptionList, and os::OptionParser::Private::m_nCurrentOption.

const OptionParser::option * OptionParser::GetOption

(

uint

nIndex

)

const

References os::OptionParser::Private::m_cOptionList.

int OptionParser::GetOptionCount

(

)

const

References os::OptionParser::Private::m_cOptionList.

String OptionParser::operator[]

(

int

nIndex

)

const

References os::OptionParser::Private::m_cFileArgs.

void OptionParser::ParseOptions

(

const char *

pzOptions

)

References os::String::begin(), os::String::c_str(), os::String::const_str(), os::String::end(), os::OptionParser::option::has_value, os::OptionParser::option::long_name, os::OptionParser::Private::m_cArgs, os::OptionParser::Private::m_cFileArgs, os::OptionParser::Private::m_cOptionList, os::String::npos, os::OptionParser::option::opt, os::OptionParser::option::raw_opt, os::String::size(), and os::OptionParser::option::value.

void OptionParser::PrintHelpText

(

int

nWidth = 0

)

const

References GetHelpText().

void OptionParser::PrintHelpText	(	StreamableIO *	pcStream,
		int	nWidth = 0
	)		const

References os::String::c_str(), os::String::CountChars(), GetHelpText(), and os::StreamableIO::Write().

void OptionParser::RewindOptions

(

)

References os::OptionParser::Private::m_nCurrentOption.