Parse the options passed to a program. More...

#include <OptionParser.h>

Collaboration diagram for OptionParser:

Public Member Functions
void	addMode (const PString &modeName)
	Add a mode in the option. More...

template<typename T >
void	addOption (const PString &longOption, const PString &shortOption, const T defaultValue, const PString &docString)
	Add an option in the OptionParser. More...

template<typename T >
void	addOption (const PString &longOption, const PString &shortOption, const T defaultValue, OptionType::OptionType optionType, const PString &docString)
	Add an option in the OptionParser. More...

void	addOption (const PString &longOption, const PString &shortOption, OptionType::OptionType optionType, bool isRequired, bool isAllowEmpty, const PString &docString)
	Add an option in the OptionParser. More...

void	addOption (const PString &longOption, const PString &shortOption, OptionType::OptionType optionType, bool isRequired, bool isAllowEmpty, const PVecString &vecPossibleValue, const PString &docString)
	Add an option in the OptionParser. More...

void	addOption (const PString &longOption, const PString &shortOption, OptionType::OptionType optionType, bool isRequired, const PString &docString)
	Add an option in the OptionParser. More...

void	closeMode ()
	Close the current mode and go back to be default one. More...

OptionMode &	getDefaultMode ()
	Get default mode. More...

const OptionMode &	getDefaultMode () const
	Get default mode. More...

OptionMode &	getMode (const PString &name)
	Get mode by name. More...

const OptionMode &	getMode (const PString &name) const
	Get mode by name. More...

bool	isModeExist (const PString &name) const
	Check if the given mode name does exist. More...

OptionParser &	operator= (const OptionParser &other)
	Definition of equal operator of OptionParser. More...

	OptionParser (bool enableHelpOption=true, const PString &programVersion="")
	Default constructeur of OptionParser. More...

	OptionParser (const OptionParser &other)
	Copy constructor of OptionParser. More...

void	parseArgument (int argc, char **argv)
	Parse the arguments passed to the program. More...

void	print () const
	Print all the options. More...

void	setExampleLongOption (const PString &example)
	Set the example usage of the program. More...

void	setExampleShortOption (const PString &example)
	Set the example usage of the program. More...

virtual	~OptionParser ()
	Destructeur of OptionParser. More...

Protected Member Functions
void	copyOptionParser (const OptionParser &other)
	Copy function of OptionParser. More...

Private Member Functions
bool	checkArgument () const
	Check the argument of the parser. More...

template<typename T >
void	checkOptionType (OptionType::OptionType optionType)
	Check the given option type. More...

bool	completeOptionValue (PString &possibleValue, const PString &cursorOption, const PString &prevCursorOption) const
	Complete the possible value of an option (FILENAME, DIRECTORY, FILE_OR_DIR) More...

const OptionMode *	getCurrentlyParsedMode () const
	Get the currently parsed OptionMode. More...

const Option *	getLongOptionValue (PString &valueToBeCompleted, const PString &cursorOption) const
	Get the long option value to be completed. More...

OptionMode &	getParserMode (ArgParser &parser)
	Get a mode if it exist. More...

void	getPossibleOption (PString &possibleOption, const PString &cursorOption) const
	Get the possible options which can be used. More...

void	getPossibleOtherOption (PString &possibleOption, const PString &cursorOption) const
	Get the possible other options which can be used. More...

const Option *	getSplitOptionValue (PString &valueToBeCompleted, const PString &cursorOption, const PString &prevCursorOption) const
	Get the split option (without =) value to be completed. More...

void	initialisationOptionParser ()
	Initialisation function of the class OptionParser. More...

void	parseArgumentBashCompletion (ArgParser &parser)
	Bash completion argument parsing mode. More...

void	parseArgumentNormalUse (ArgParser &parser)
	Classical argument parsing mode. More...

Private Attributes
size_t	p_currentMode
	Index of the current mode in the OptionParser. More...

OptionMode *	p_currentParserMode
	Current mode parsed. More...

bool	p_enableHelpOption
	True to enable automatically the printing of the help option when the program is called with –help or -h. More...

PString	p_exempleLongOption
	Usage example with long options. More...

PString	p_exempleShortOption
	Usage example with short options. More...

PString	p_programVersion
	Program version to be printed on –version or -v option. More...

VecMode	p_vecMode
	Vector of all the defined mode in the OptionParser. More...

Detailed Description

Parse the options passed to a program.

When you define an option, you do not have to pass the '-' of the option name exampe : –longoption or -shortoption you pass only longoption and shortoption

Definition at line 15 of file OptionParser.h.

Constructor & Destructor Documentation

◆ OptionParser() [1/2]

OptionParser::OptionParser	(	bool	enableHelpOption = `true`,
		const PString &	programVersion = `""`
	)

Default constructeur of OptionParser.

Parameters

enableHelpOption	: True to enable automatically the printing of the help option when the program is called with –help or -h
programVersion	: version of the program to be printed on –version or -v options

Definition at line 13 of file OptionParser.cpp.

         :p_enableHelpOption(enableHelpOption), p_programVersion(programVersion)
 {
         initialisationOptionParser();
 }

References initialisationOptionParser().

Here is the call graph for this function:

◆ OptionParser() [2/2]

OptionParser::OptionParser ( const OptionParser & other )

Copy constructor of OptionParser.

Parameters

other : class to copy

Definition at line 22 of file OptionParser.cpp.

                                                     {
         copyOptionParser(other);
 }

References copyOptionParser().

Here is the call graph for this function:

◆ ~OptionParser()

OptionParser::~OptionParser ( )

virtual

Destructeur of OptionParser.

Definition at line 27 of file OptionParser.cpp.

                            {
         
 }

Member Function Documentation

◆ addMode()

void OptionParser::addMode ( const PString & modeName )

Add a mode in the option.

Parameters

modeName : name of the new mode to be added

Definition at line 53 of file OptionParser.cpp.

                                                   {
         OptionMode mode(modeName);
         mode.setEnableHelpOption(p_enableHelpOption);
         mode.setProgramVersion(p_programVersion);
         p_vecMode.push_back(mode);
         p_currentMode = p_vecMode.size() - 1lu;
 }

References p_currentMode, p_enableHelpOption, p_programVersion, p_vecMode, OptionMode::setEnableHelpOption(), and OptionMode::setProgramVersion().

Referenced by createOptionParser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addOption() [1/5]

template<typename T >

void OptionParser::addOption	(	const PString &	longOption,
		const PString &	shortOption,
		const T	defaultValue,
		const PString &	docString
	)

Add an option in the OptionParser.

Parameters

longOption	: long option (start with –) as –version
shortOption	: short option (start with -) as -v
defaultValue	: default value of the option
docString	: documentation string of the option The type of the option will be automatically determined with the type of the default value

Definition at line 21 of file OptionParser_impl.h.

                                                                                                                                     {
         OptionType::OptionType optionType = getOptionTypeFromType<T>();
         OptionValue value;
         value.setType(optionType);
         value.setDefaultValue(defaultValue);
         Option option(longOption, shortOption, value, false, docString);
         p_vecMode.back().addOption(option);
 }

References p_vecMode, OptionValue::setDefaultValue(), and OptionValue::setType().

Here is the call graph for this function:

◆ addOption() [2/5]

template<typename T >

void OptionParser::addOption	(	const PString &	longOption,
		const PString &	shortOption,
		const T	defaultValue,
		OptionType::OptionType	optionType,
		const PString &	docString
	)

Add an option in the OptionParser.

Parameters

longOption	: long option (start with –) as –version
shortOption	: short option (start with -) as -v
defaultValue	: default value of the option
optionType	: type of the data of the option (int, float, double, string, etc)
docString	: documentation string of the option The function will check if the given optionType is relevant with the type of the default value

Definition at line 39 of file OptionParser_impl.h.

 {
         checkOptionType<T>(optionType);
         OptionValue value;
         value.setType(optionType);
         value.setDefaultValue(defaultValue);
         Option option(longOption, shortOption, value, false, docString);
         p_vecMode.back().addOption(option);
 }

References p_vecMode, OptionValue::setDefaultValue(), and OptionValue::setType().

Here is the call graph for this function:

◆ addOption() [3/5]

void OptionParser::addOption	(	const PString &	longOption,
		const PString &	shortOption,
		OptionType::OptionType	optionType,
		bool	isRequired,
		bool	isAllowEmpty,
		const PString &	docString
	)

Add an option in the OptionParser.

Parameters

longOption	: long option (start with –) as –version
shortOption	: short option (start with -) as -v
optionType	: type of the value to be parsed (INT, BOOL_ CHAR, FLOAT, STRING, FILENAME, DIRECTORY, etc)
isRequired	: true if the option is required, false if it is optionnal
isAllowEmpty	: the given value can be empty
docString	: documentation string of the option

Definition at line 91 of file OptionParser.cpp.

 {
         OptionValue value;
         value.setType(optionType);
         Option option(longOption, shortOption, value, isRequired, docString);
         option.setIsAllowEmpty(isAllowEmpty);
         p_vecMode[p_currentMode].addOption(option);
 }

References p_currentMode, p_vecMode, Option::setIsAllowEmpty(), and OptionValue::setType().

Here is the call graph for this function:

◆ addOption() [4/5]

void OptionParser::addOption	(	const PString &	longOption,
		const PString &	shortOption,
		OptionType::OptionType	optionType,
		bool	isRequired,
		bool	isAllowEmpty,
		const PVecString &	vecPossibleValue,
		const PString &	docString
	)

Add an option in the OptionParser.

Parameters

longOption	: long option (start with –) as –version
shortOption	: short option (start with -) as -v
optionType	: type of the value to be parsed (INT, BOOL_ CHAR, FLOAT, STRING, FILENAME, DIRECTORY, etc)
isRequired	: true if the option is required, false if it is optionnal
isAllowEmpty	: the given value can be empty
vecPossibleValue	: vector of possible values for this option
docString	: documentation string of the option

Definition at line 110 of file OptionParser.cpp.

 {
         OptionValue value;
         value.setType(optionType);
         value.setVecPossibleValue(vecPossibleValue);
         Option option(longOption, shortOption, value, isRequired, docString);
         option.setIsAllowEmpty(isAllowEmpty);
         p_vecMode[p_currentMode].addOption(option);
 }

References p_currentMode, p_vecMode, Option::setIsAllowEmpty(), OptionValue::setType(), and OptionValue::setVecPossibleValue().

Here is the call graph for this function:

◆ addOption() [5/5]

void OptionParser::addOption	(	const PString &	longOption,
		const PString &	shortOption,
		OptionType::OptionType	optionType,
		bool	isRequired,
		const PString &	docString
	)

Add an option in the OptionParser.

Parameters

longOption	: long option (start with –) as –version
shortOption	: short option (start with -) as -v
optionType	: type of the value to be parsed (INT, BOOL_ CHAR, FLOAT, STRING, FILENAME, DIRECTORY, etc)
isRequired	: true if the option is required, false if it is optionnal
docString	: documentation string of the option

Definition at line 73 of file OptionParser.cpp.

 {
         OptionValue value;
         value.setType(optionType);
         Option option(longOption, shortOption, value, isRequired, docString);
         option.setIsAllowEmpty(false);
         p_vecMode[p_currentMode].addOption(option);
 }

References p_currentMode, p_vecMode, Option::setIsAllowEmpty(), and OptionValue::setType().

Referenced by createOptionParser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkArgument()

bool OptionParser::checkArgument ( ) const

private

Check the argument of the parser.

Returns: true if all the required arguments are set, false otherwise

Definition at line 309 of file OptionParser.cpp.

                                       {
         bool isArgOk(true);
         VecMode::const_iterator it(p_vecMode.begin());
         while(it != p_vecMode.end() && isArgOk){
                 isArgOk = it->checkArgument();
                 ++it;
         }
         return isArgOk;
 }

References p_vecMode.

Referenced by parseArgumentNormalUse().

Here is the caller graph for this function:

◆ checkOptionType()

template<typename T >

void OptionParser::checkOptionType ( OptionType::OptionType optionType )

private

Check the given option type.

Parameters

optionType : type of the option to be checked Throw an exception if there is a problem

Definition at line 55 of file OptionParser_impl.h.

                                                                  {
         OptionType::OptionType optionTypeFromDefault = getOptionTypeFromType<T>();
         if(!isOptionTypeCompatible(optionType, optionTypeFromDefault)){
                 std::stringstream strError;
                 strError << "OptionParser::checkOptionType : Incompatible types from parameters (" << convertOptionTypeToString(optionType) << ") ad for default type ("<<convertOptionTypeToString(optionTypeFromDefault)<<")";
                 throw std::runtime_error(strError.str());
         }
 }

References convertOptionTypeToString(), and isOptionTypeCompatible().

Here is the call graph for this function:

◆ closeMode()

void OptionParser::closeMode ( )

Close the current mode and go back to be default one.

Definition at line 62 of file OptionParser.cpp.

                             {
         p_currentMode = 0lu;
 }

References p_currentMode.

Referenced by createOptionParser().

Here is the caller graph for this function:

◆ completeOptionValue()

bool OptionParser::completeOptionValue	(	PString &	possibleValue,
		const PString &	cursorOption,
		const PString &	prevCursorOption
	)		const

private

Complete the possible value of an option (FILENAME, DIRECTORY, FILE_OR_DIR)

Parameters

[out]	possibleValue	: possible value
	cursorOption	: option of the cursor which is currently completed
	prevCursorOption	: previous option of the cursor

Definition at line 355 of file OptionParser.cpp.

                                                                                                                                    {
 //      std::cerr << "OptionParser::completeOptionValue : cursorOption = '"<<cursorOption<<"', prevCursorOption = '"<<prevCursorOption<<"'" << std::endl;
         PString valueToBeCompleted("");
         //Check is the cursor option starts with a long option (--option=value) because the value can be completed
         const Option * op = getLongOptionValue(valueToBeCompleted, cursorOption);
         if(op == NULL){         //Check is the previous option corresponds to an existing option, to complete the value given by the current option
                 op = getSplitOptionValue(valueToBeCompleted, cursorOption, prevCursorOption);
         }
         if(op != NULL){
                 op->getPossibleValue(possibleValue, valueToBeCompleted);
 //              std::cerr << "OptionParser::completeOptionValue : possibleValue = '"<<possibleValue<<"'" << std::endl;
                 return true;
         }
         return false;
 }

References getLongOptionValue(), Option::getPossibleValue(), and getSplitOptionValue().

Referenced by parseArgumentBashCompletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyOptionParser()

void OptionParser::copyOptionParser ( const OptionParser & other )

protected

Copy function of OptionParser.

Parameters

other : class to copy

Definition at line 208 of file OptionParser.cpp.

                                                              {
         p_vecMode = other.p_vecMode;
         p_currentMode = other.p_currentMode;
         p_exempleShortOption = other.p_exempleShortOption;
         p_exempleLongOption = other.p_exempleLongOption;
         p_programVersion = other.p_programVersion;
         p_enableHelpOption = other.p_enableHelpOption;
 }

References p_currentMode, p_enableHelpOption, p_exempleLongOption, p_exempleShortOption, p_programVersion, and p_vecMode.

Referenced by operator=(), and OptionParser().

Here is the caller graph for this function:

◆ getCurrentlyParsedMode()

const OptionMode * OptionParser::getCurrentlyParsedMode ( ) const

private

Get the currently parsed OptionMode.

Returns: pointer to the currently parsed OptionMode, it there is one, or NULL is there is not

Definition at line 338 of file OptionParser.cpp.

                                                              {
         const OptionMode * mode = NULL;
         VecMode::const_iterator it(p_vecMode.begin());
         while(it != p_vecMode.end() && mode == NULL){
                 if(it->isCurrentlyParsed() && it->getName() != ""){
                         mode = &(*it);
                 }
                 ++it;
         }
         return mode;
 }

References p_vecMode.

Referenced by getPossibleOption().

Here is the caller graph for this function:

◆ getDefaultMode() [1/2]

OptionMode & OptionParser::getDefaultMode ( )

Get default mode.

Returns: default mode

Definition at line 161 of file OptionParser.cpp.

                                          {
         return p_vecMode[0lu];
 }

References p_vecMode.

◆ getDefaultMode() [2/2]

const OptionMode & OptionParser::getDefaultMode ( ) const

Get default mode.

Returns: default mode

Definition at line 154 of file OptionParser.cpp.

                                                      {
         return p_vecMode[0lu];
 }

References p_vecMode.

Referenced by getMode(), main(), and printConstParser().

Here is the caller graph for this function:

◆ getLongOptionValue()

const Option * OptionParser::getLongOptionValue	(	PString &	valueToBeCompleted,
		const PString &	cursorOption
	)		const

private

Get the long option value to be completed.

Parameters

[out]	valueToBeCompleted	: base of the value to be completed
	cursorOption	: option of the cursor which is currently completed

Returns: pointer to the Option to be completed or NULL if there is not

Definition at line 376 of file OptionParser.cpp.

                                                                                                                {
         if(cursorOption == ""){return NULL;}
         const Option * op = NULL;
         VecMode::const_iterator itMode(p_vecMode.begin());
         while(itMode != p_vecMode.end() && op == NULL){
                 if(itMode->isCurrentlyParsed()){
                         const VecOption & vecOp = itMode->getVecOption();
                         VecOption::const_iterator itOp(vecOp.begin());
                         while(itOp != vecOp.end() && op == NULL){
                                 PString fullOp("--" + itOp->getLongName() + "=");
                                 if(cursorOption.isSameBegining(fullOp)){
                                         op = &(*itOp);
                                         valueToBeCompleted = cursorOption.substr(fullOp.size());
                                 }
                                 ++itOp;
                         }
                 }
                 ++itMode;
         }
         return op;
 }

References PString::isSameBegining(), and p_vecMode.

Referenced by completeOptionValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode() [1/2]

OptionMode & OptionParser::getMode ( const PString & name )

Get mode by name.

Parameters

name	: name of the mode to be returned

Returns: corresponding mode if the mode exists or the default mode otherwise

Definition at line 182 of file OptionParser.cpp.

                                                       {
         for(VecMode::iterator it(p_vecMode.begin()); it != p_vecMode.end(); ++it){
                 if(it->getName() == name){
                         return *it;
                 }
         }
         return getDefaultMode();
 }

References getDefaultMode(), and p_vecMode.

Here is the call graph for this function:

◆ getMode() [2/2]

const OptionMode & OptionParser::getMode ( const PString & name ) const

Get mode by name.

Parameters

name	: name of the mode to be returned

Returns: corresponding mode if the mode exists or the default mode otherwise

Definition at line 169 of file OptionParser.cpp.

                                                                   {
         for(VecMode::const_iterator it(p_vecMode.begin()); it != p_vecMode.end(); ++it){
                 if(it->getName() == name){
                         return *it;
                 }
         }
         return getDefaultMode();
 }

References getDefaultMode(), and p_vecMode.

Referenced by getParserMode(), main(), and printConstParser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParserMode()

OptionMode & OptionParser::getParserMode ( ArgParser & parser )

private

Get a mode if it exist.

Parameters

parser : parser to be used

Returns: corresponding mode

Definition at line 323 of file OptionParser.cpp.

                                                           {
         PString currentOption(parser.getCurrentOption());
         if(isModeExist(currentOption)){
                 OptionMode & mode = getMode(currentOption);
                 p_currentParserMode = &mode;
                 parser.getNextOption();
                 return mode;
         }else{
                 return *p_currentParserMode;
         }
 }

References ArgParser::getCurrentOption(), getMode(), ArgParser::getNextOption(), isModeExist(), and p_currentParserMode.

Referenced by parseArgumentNormalUse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleOption()

void OptionParser::getPossibleOption	(	PString &	possibleOption,
		const PString &	cursorOption
	)		const

private

Get the possible options which can be used.

Parameters

[out]	possibleOption	: possible options for the bash completion
	cursorOption	: option of the cursor which is currently completed

Definition at line 433 of file OptionParser.cpp.

                                                                                                 {
         if(p_vecMode.size() == 1lu){
                 p_vecMode.front().getPossibleOption(possibleOption, cursorOption);
         }else{
                 const OptionMode * currentlyParsedMode = getCurrentlyParsedMode();
                 if(currentlyParsedMode != NULL){
                         currentlyParsedMode->getPossibleOption(possibleOption, cursorOption);
                 }else{
                         for(VecMode::const_iterator itMode = p_vecMode.begin(); itMode != p_vecMode.end(); ++itMode){
                                 itMode->getPossibleMode(possibleOption, cursorOption);
                         }
                 }
         }
 }

References getCurrentlyParsedMode(), OptionMode::getPossibleOption(), and p_vecMode.

Referenced by parseArgumentBashCompletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleOtherOption()

void OptionParser::getPossibleOtherOption	(	PString &	possibleOption,
		const PString &	cursorOption
	)		const

private

Get the possible other options which can be used.

Parameters

[out]	possibleOption	: possible options for the bash completion
	cursorOption	: option of the cursor which is currently completed

Definition at line 452 of file OptionParser.cpp.

                                                                                                      {
         std::vector<PString> vecOtherOption;
         vecOtherOption.push_back("--help");
         vecOtherOption.push_back("-h");
         vecOtherOption.push_back("--version");
         vecOtherOption.push_back("-v");
         
         for(std::vector<PString>::iterator it(vecOtherOption.begin()); it != vecOtherOption.end(); ++it){
                 PString optionStr(*it);
                 if(cursorOption == ""){
                         possibleOption += optionStr + " ";
                 }else{
                         if(optionStr.isSameBegining(cursorOption)){
                                 possibleOption += optionStr + " ";
                         }
                 }
         }
 }

References PString::isSameBegining().

Referenced by parseArgumentBashCompletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSplitOptionValue()

const Option * OptionParser::getSplitOptionValue	(	PString &	valueToBeCompleted,
		const PString &	cursorOption,
		const PString &	prevCursorOption
	)		const

private

Get the split option (without =) value to be completed.

Parameters

[out]	valueToBeCompleted	: base of the value to be completed
	cursorOption	: option of the cursor which is currently completed
	prevCursorOption	: previous option of the cursor

Returns: pointer to the Option to be completed or NULL if there is not

Definition at line 404 of file OptionParser.cpp.

                                                                                                                                                   {
         if(prevCursorOption == ""){return NULL;}
         const Option * op = NULL;
         VecMode::const_iterator itMode(p_vecMode.begin());
         while(itMode != p_vecMode.end() && op == NULL){
                 if(itMode->isCurrentlyParsed()){                //Search only in the mode which is currently parsed
                         const VecOption & vecOp = itMode->getVecOption();
                         VecOption::const_iterator itOp(vecOp.begin());
                         while(itOp != vecOp.end() && op == NULL){
                                 PString fullLongOp("--" + itOp->getLongName()), fullShortOption("-" + itOp->getShortName());
                                 if(fullLongOp == prevCursorOption){
                                         op = &(*itOp);
                                         valueToBeCompleted = cursorOption;
                                 }else if(fullShortOption == prevCursorOption){
                                         op = &(*itOp);
                                         valueToBeCompleted = cursorOption;
                                 }
                                 ++itOp;
                         }
                 }
                 ++itMode;
         }
         return op;
 }

References p_vecMode.

Referenced by completeOptionValue().

Here is the caller graph for this function:

◆ initialisationOptionParser()

void OptionParser::initialisationOptionParser ( )

private

Initialisation function of the class OptionParser.

Definition at line 218 of file OptionParser.cpp.

                                              {
         p_currentMode = 0lu;
         p_currentParserMode = NULL;
         OptionMode defaultMode;
         p_vecMode.push_back(defaultMode);
 }

References p_currentMode, p_currentParserMode, and p_vecMode.

Referenced by OptionParser().

Here is the caller graph for this function:

◆ isModeExist()

bool OptionParser::isModeExist ( const PString & name ) const

Check if the given mode name does exist.

Parameters

name	: name of the mode

Returns: true if the given mode name does exist, false otherwise

Definition at line 195 of file OptionParser.cpp.

                                                         {
         bool isSearch(true);
         VecMode::const_iterator it(p_vecMode.begin());
         while(isSearch && it != p_vecMode.end()){
                 isSearch &= it->getName() != name;
                 ++it;
         }
         return !isSearch;
 }

References p_vecMode.

Referenced by getParserMode().

Here is the caller graph for this function:

◆ operator=()

OptionParser & OptionParser::operator= ( const OptionParser & other )

Definition of equal operator of OptionParser.

Parameters

other : class to copy

Returns: copied class

Definition at line 35 of file OptionParser.cpp.

                                                                   {
         copyOptionParser(other);
         return *this;
 }

References copyOptionParser().

Here is the call graph for this function:

◆ parseArgument()

void OptionParser::parseArgument	(	int	argc,
		char **	argv
	)

Parse the arguments passed to the program.

Parameters

argc	: number of parameters passed to the program
argv	: list of arguments passed to the program

Definition at line 142 of file OptionParser.cpp.

                                                      {
         ArgParser parser(argc, argv);
         if(parser.isBashCompletionMode()){
                 parseArgumentBashCompletion(parser);
         }else{
                 parseArgumentNormalUse(parser);
         }
 }

References ArgParser::isBashCompletionMode(), parseArgumentBashCompletion(), and parseArgumentNormalUse().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseArgumentBashCompletion()

void OptionParser::parseArgumentBashCompletion ( ArgParser & parser )

private

Bash completion argument parsing mode.

Parameters

parser : parser to be used

Definition at line 261 of file OptionParser.cpp.

                                                                 {
         //First step, we parse normally the existing arguments
         PString cursorOption(parser.getCursorOption());
         PString prevCursorOption(parser.getPrevCursorOption());
         Option * partialOption = NULL;
         while(!parser.isEndOfOption()){         //We loop to find the option which has not been parsed well
                 bool isSearch(true);
                 VecMode::iterator itMode = p_vecMode.begin();
                 while(!parser.isEndOfOption() && itMode != p_vecMode.end() && isSearch){
                         isSearch = !itMode->parseOption(parser, partialOption);
                         ++itMode;
                 }
                 if(isSearch){           //If no option matches, we go to the next argument
                         parser.getNextOption();
                 }
         }
         //Complete the ongoing option (filename, directory, enum value, etc)
 //      if(partialOption != NULL){              //The option name has no ambiguity but we expect a value
 //              PString possibleValue("");
 //              partialOption->getPossibleValue(possibleValue, cursorOption);
 //              cout << possibleValue << endl;
 //      }else{
                 //Let's get the mode which is currently parsed
                 //If all the options are fine, we have to show the remaning options. That's the following
                 PString possibleValue("");
                 if(completeOptionValue(possibleValue, cursorOption, prevCursorOption)){
 //                      saveFileContent("listPossibleValues.txt", possibleValue);
                         std::cout << possibleValue << std::endl;
                 }else{
                         //Then, get the remaning arguments (not parsed yet)
                         PString possibleOption("");
                         getPossibleOption(possibleOption, cursorOption);
                         getPossibleOtherOption(possibleOption, cursorOption);
                         
 //                      saveFileContent("listPossibleOption.txt", possibleOption);
                         std::cout << possibleOption << std::endl;
                 }
 //      }
         exit(0);
 //      La marche a suivre est assez simple
 //              On renvoie une ligne par argument possible
 //              Si il y en a qu'une seule, elle sera ajouté à la fin de la ligne de commande
 //      DONE : mettre en place un méchanisme pour générer le bash qui appellera le programme différemment
 }

References completeOptionValue(), ArgParser::getCursorOption(), ArgParser::getNextOption(), getPossibleOption(), getPossibleOtherOption(), ArgParser::getPrevCursorOption(), ArgParser::isEndOfOption(), and p_vecMode.

Referenced by parseArgument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseArgumentNormalUse()

void OptionParser::parseArgumentNormalUse ( ArgParser & parser )

private

Classical argument parsing mode.

Parameters

parser : parser to be used

Definition at line 228 of file OptionParser.cpp.

                                                            {
         p_currentParserMode = &p_vecMode.front();
         while(!parser.isEndOfOption()){
                 if(p_enableHelpOption){
                         if(parser.getCurrentOption() == "--help" || parser.getCurrentOption() == "-h"){
                                 print();
                                 exit(0);
                         }
                 }
                 if(p_programVersion != ""){
                         if(parser.getCurrentOption() == "--version" || parser.getCurrentOption() == "-v"){
                                 std::cout << "Program version : " << p_programVersion << std::endl;
                                 exit(0);
                         }
                 }
                 OptionMode & currentMode = getParserMode(parser);
                 if(!currentMode.parseOption(parser)){
                         PString modeName(currentMode.getName());
                         PString modeError("");
                         if(modeName != ""){
                                 modeError = " in mode '"+modeName+"' ";
                         }
                         throw std::runtime_error("OptionParser::parseArgument : unknown option '"+parser.getCurrentOption()+"'" + modeError);
                 }
         }
         if(!checkArgument()){
                 throw std::runtime_error("OptionParser::parseArgument : missing argument");
         }
 }

References checkArgument(), ArgParser::getCurrentOption(), OptionMode::getName(), getParserMode(), ArgParser::isEndOfOption(), p_currentParserMode, p_enableHelpOption, p_programVersion, p_vecMode, OptionMode::parseOption(), and print().

Referenced by parseArgument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void OptionParser::print ( ) const

Print all the options.

Definition at line 122 of file OptionParser.cpp.

                               {
         if(p_exempleLongOption != "" || p_exempleShortOption != ""){
                 std::cout << "Usage :" << std::endl;
                 if(p_exempleLongOption != ""){std::cout << "\t" << p_exempleLongOption << std::endl;}
                 if(p_exempleShortOption != ""){std::cout << "\t" << p_exempleShortOption << std::endl;}
         }
         std::cout << "Parameters :" << std::endl;
         VecMode::const_iterator it(p_vecMode.begin());
         it->print();
         ++it;
         while(it != p_vecMode.end()){
                 it->print();
                 ++it;
         }
 }

References p_exempleLongOption, p_exempleShortOption, and p_vecMode.

Referenced by main(), and parseArgumentNormalUse().

Here is the caller graph for this function:

◆ setExampleLongOption()

void OptionParser::setExampleLongOption ( const PString & example )

Set the example usage of the program.

Parameters

example : example of usage

Definition at line 43 of file OptionParser.cpp.

43 {p_exempleLongOption = example;}

References p_exempleLongOption.

Referenced by createOptionParser().

Here is the caller graph for this function:

◆ setExampleShortOption()

void OptionParser::setExampleShortOption ( const PString & example )

Set the example usage of the program.

Parameters

example : example of usage

Definition at line 48 of file OptionParser.cpp.

48 {p_exempleShortOption = example;}

References p_exempleShortOption.

Referenced by createOptionParser().

Here is the caller graph for this function:

Member Data Documentation

◆ p_currentMode

size_t OptionParser::p_currentMode

private

Index of the current mode in the OptionParser.

Definition at line 80 of file OptionParser.h.

Referenced by addMode(), addOption(), closeMode(), copyOptionParser(), and initialisationOptionParser().

◆ p_currentParserMode

OptionMode* OptionParser::p_currentParserMode

private

Current mode parsed.

Definition at line 76 of file OptionParser.h.

Referenced by getParserMode(), initialisationOptionParser(), and parseArgumentNormalUse().

◆ p_enableHelpOption

bool OptionParser::p_enableHelpOption

private

True to enable automatically the printing of the help option when the program is called with –help or -h.

Definition at line 86 of file OptionParser.h.

Referenced by addMode(), copyOptionParser(), and parseArgumentNormalUse().

◆ p_exempleLongOption

PString OptionParser::p_exempleLongOption

private

Usage example with long options.

Definition at line 82 of file OptionParser.h.

Referenced by copyOptionParser(), print(), and setExampleLongOption().

◆ p_exempleShortOption

PString OptionParser::p_exempleShortOption

private

Usage example with short options.

Definition at line 84 of file OptionParser.h.

Referenced by copyOptionParser(), print(), and setExampleShortOption().

◆ p_programVersion

PString OptionParser::p_programVersion

private

Program version to be printed on –version or -v option.

Definition at line 88 of file OptionParser.h.

Referenced by addMode(), copyOptionParser(), and parseArgumentNormalUse().

◆ p_vecMode

VecMode OptionParser::p_vecMode

private

Vector of all the defined mode in the OptionParser.

Definition at line 78 of file OptionParser.h.

Referenced by addMode(), addOption(), checkArgument(), copyOptionParser(), getCurrentlyParsedMode(), getDefaultMode(), getLongOptionValue(), getMode(), getPossibleOption(), getSplitOptionValue(), initialisationOptionParser(), isModeExist(), parseArgumentBashCompletion(), parseArgumentNormalUse(), and print().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionParser.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionParser.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionParser_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptionParser() [1/2]

◆ OptionParser() [2/2]

◆ ~OptionParser()

Member Function Documentation

◆ addMode()

◆ addOption() [1/5]

◆ addOption() [2/5]

◆ addOption() [3/5]

◆ addOption() [4/5]

◆ addOption() [5/5]

◆ checkArgument()

◆ checkOptionType()

◆ closeMode()

◆ completeOptionValue()

◆ copyOptionParser()

◆ getCurrentlyParsedMode()

◆ getDefaultMode() [1/2]

◆ getDefaultMode() [2/2]

◆ getLongOptionValue()

◆ getMode() [1/2]

◆ getMode() [2/2]

◆ getParserMode()

◆ getPossibleOption()

◆ getPossibleOtherOption()

◆ getSplitOptionValue()

◆ initialisationOptionParser()

◆ isModeExist()

◆ operator=()

◆ parseArgument()

◆ parseArgumentBashCompletion()

◆ parseArgumentNormalUse()

◆ print()

◆ setExampleLongOption()

◆ setExampleShortOption()

Member Data Documentation

◆ p_currentMode

◆ p_currentParserMode

◆ p_enableHelpOption

◆ p_exempleLongOption

◆ p_exempleShortOption

◆ p_programVersion

◆ p_vecMode