#include <Puma/OptsParser.h>

Inheritance diagram for Puma::OptsParser:

Description

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

Classes
struct	Option
	Type for specifying an array of options recognized by the Option Parser. More...

Public Types
enum	{ NOARG = -4 , ERR = -3 , NOOPTION = -2 , UNKNOWN = -1 , FINISH = 0 }
	Return codes for OptsParser::getOption() and OptsParser::getArgument(). More...

enum	ArgType { AT_NONE = 0 , AT_MANDATORY = 1 , AT_OPTIONAL = 2 }
	Type of argument associated to an option. More...

Public Member Functions
	OptsParser (int argc, char *argv, const Option opts)
	Constructor. More...

	OptsParser (const std::string &line, const Option *opts)
	Constructor. More...

int	getRawOption ()
	Get next parameter without modification. More...

int	getOption ()
	Get next option. More...

int	getResult () const
	Get result of last processed parameter. More...

const std::string &	getArgument ()
	Get option argument of last processed parameter. More...

const std::string &	getUnstrippedArgument () const
	Get option argument of last processed parameter without stripping. More...

const std::string &	getOptionName () const
	Get option name of last processed parameter. More...

int	getCurrentArgNum () const
	Get position of current argument. More...

int	getNextArgNum () const
	Get position of next argument. More...

Additional Inherited Members
Static Public Member Functions inherited from Puma::SimpleParser
static std::string	strip (const std::string &str)
	Remove enclosing double-quotes from a string. More...

static int	tokenize (const std::string &str, std::vector< std::string > &tokens, const std::string &delimiters=" ")
	Splits a given string into tokens recognized by the given delimiters. More...

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Return codes for OptsParser::getOption() and OptsParser::getArgument().

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.

◆ ArgType

enum Puma::OptsParser::ArgType

Type of argument associated to an option.

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

Constructor & Destructor Documentation

◆ OptsParser() [1/2]

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

Constructor.

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.

◆ OptsParser() [2/2]

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

Constructor.

Parameters

line	Reference to string with parameters to analyze. The parameters 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

◆ getArgument()

const std::string & Puma::OptsParser::getArgument ( )

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

◆ getCurrentArgNum()

int Puma::OptsParser::getCurrentArgNum ( ) const

Get position of current argument.

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

◆ getNextArgNum()

int Puma::OptsParser::getNextArgNum ( ) const

Get position of next argument.

Returns: Position of next parameter which will be processed by the options parser

◆ getOption()

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 argument.

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

◆ getOptionName()

const std::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

◆ getRawOption()

int Puma::OptsParser::getRawOption ( )

Get next parameter without modification.

No option parsing is done.

Returns: OptsParser::NOOPTION or OptsParser::FINISH.

◆ getResult()

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 options recognized by the options parser or OptsParser::NOARG, OptsParser::ERR, OptsParser::NOOPTION, OptsParser::UNKNOWN or OptsParser::FINISH.

◆ getUnstrippedArgument()

const std::string & Puma::OptsParser::getUnstrippedArgument ( ) const

Get option argument of last processed parameter without stripping.