Puma::OptsParser Class Reference

#include <OptsParser.h>

Inheritance diagram for Puma::OptsParser:

List of all members.

---

Detailed Description

The Options Parser searches command line parameters for options and handles their option arguments, if applicable.

Public Types
enum	{   NOARG = -4,   ERR = -3,   NOOPTION = -2,   UNKNOWN = -1,   FINISH = 0 }
enum	ArgType {   AT_NONE = 0,   AT_MANDATORY = 1,   AT_OPTIONAL = 2 }
Public Member Functions
	OptsParser (int argc, char **argv, const Option *opts)
	Constructor of OptsParser.
	OptsParser (const string &line, const Option *opts)
	Constructor of OptsParser.
int	getRawOption ()
	Get next parameter without modification.
int	getOption ()
	Get next option.
int	getResult () const
	Get result of last processed parameter.
const string &	getArgument () const
	Get option argument of last processed parameter.
const string &	getOptionName () const
	Get option name of last processed parameter.
int	getCurrentArgNum () const
	Get position of current argument.
int	getNextArgNum () const
	Get position of next argument.
Classes
struct	Option

---

Member Enumeration Documentation

anonymous enum

Enumerator:

NOARG	Option has no argument
ERR	Error when parsing option.
NOOPTION	Command line parameter is not an option.
UNKNOWN	Parameter is an unknown option.
FINISH	All options are handled.

enum Puma::OptsParser::ArgType

Enumerator:

AT_NONE	Option receives no argument
AT_MANDATORY	Option requires an argument
AT_OPTIONAL	Option has optionally an argument

---

Constructor & Destructor Documentation

Puma::OptsParser::OptsParser	(	int	argc,
		char **	argv,
		const Option *	opts
	)

Constructor of OptsParser.

Parameters:

	argc	Number of parameters to be analyzed
	argv	Parameters to be analyzed
	opts	Pointer to array of options which shall be recognized by the options parser

Puma::OptsParser::OptsParser	(	const string &	line,
		const Option *	opts
	)

Constructor of OptsParser.

Parameters:

	line	Reference to string with parameters to analyse The paramaters are extracted from the string by splitting it up into tokens at: space character tabs newline carriage return
	opts	Pointer to array of options which shall be recognized by the options parser

---

Member Function Documentation

int Puma::OptsParser::getRawOption

(

)

Get next parameter without modification.

No option parsing is done

Returns:

OptsParser::NOOPTION or OptsParser::FINISH

int Puma::OptsParser::getOption

(

)

Get next option.

This function processes the next parameter passed to the constructor OptsParser::OptsParser(). That is, search for options and eventually process option and option arguement.

Returns:

Number of option recognized by the options parser or OptsParser::NOARG, OptsParser::ERR, OptsParser::NOOPTION, OptsParser::UNKNOWN or OptsParser::FINISH.

int Puma::OptsParser::getResult

(

)

const

Get result of last processed parameter.

The number returned by this function is identical to the number returned by the last call of OptsParser::getOption

Returns:

Number of option recognized by the options parser or OptsParser::NOARG, OptsParser::ERR, OptsParser::NOOPTION, OptsParser::UNKNOWN or OptsParser::FINISH.

const string& Puma::OptsParser::getArgument

(

)

const

Get option argument of last processed parameter.

This function returns the argument of the option processed during OptsParser::getOption. If the option does not provide any argument the string will be empty.

If OptsParser::getOption or respectively OptsParser::getResult returns with OptsParser::NOOPTION this function (OptsParser::getArgument) returns the last processed parameter, which is no option, of course.

Returns:

Argument of last processed parameter

const string& Puma::OptsParser::getOptionName

(

)

const

Get option name of last processed parameter.

If the last processed parameter did not contain an option the string returned by this function is empty.

Returns:

Name of last processed parameter

int Puma::OptsParser::getCurrentArgNum

(

)

const

Get position of current argument.

Returns:

Position of currently processed parameter previously passed to OptsParser::OptsParser()

int Puma::OptsParser::getNextArgNum

(

)

const

Get position of next argument.

Returns:

Position of next parameter which will be processed by the Options Parser