Describe a mode in the program arguments. More...

#include <OptionMode.h>

Collaboration diagram for OptionMode:

Public Member Functions
void	addOption (const Option &option)
	Add an option into the OptionMode. More...

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

void	clearOption ()
	Remove all the options of the OptionMode. More...

const PString &	getExtraArgument () const
	Get Extra argument. More...

PString &	getName ()
	Get the name of the OptionMode. More...

const PString &	getName () const
	Get the name of the OptionMode. More...

void	getPossibleMode (PString &possibleOption, const PString &cursorOption) const
	Get the possible mode. More...

void	getPossibleOption (PString &possibleOption, const PString &cursorOption) const
	Get the possible options for the bash completion. More...

template<typename T >
bool	getValue (T &value, const PString &optionName) const
	Get the value of the option. More...

VecOption &	getVecOption ()
	Get the vector of options of the OptionMode. More...

const VecOption &	getVecOption () const
	Get the vector of options of the OptionMode. More...

bool	isCurrentlyParsed () const
	Say if the OptionMode is currently parsed (but maybe not totally) More...

bool	isOptionExist (const PString &optionName) const
	Say if the given option has been passed to the program. More...

bool	isParsed () const
	Say if the OptionMode contains option which are parsed. More...

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

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

	OptionMode (const PString &name="")
	Default constructeur of OptionMode. More...

bool	parseOption (ArgParser &parser)
	Parse the options in the current OptionMode. More...

bool	parseOption (ArgParser &parser, Option *&partialOption)
	Parse the options in the current OptionMode. More...

void	print () const
	Print the option of the mode. More...

void	setEnableHelpOption (bool b)
	Set the attribtue which enables help option. More...

void	setName (const PString &name)
	Set the name of the OptionMode. More...

void	setProgramVersion (const PString &programVersion)
	Set the program version. More...

void	setVecOption (const VecOption &vecOption)
	Set the vector of options of the OptionMode. More...

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

Protected Member Functions
void	copyOptionMode (const OptionMode &other)
	Copy function of OptionMode. More...

Private Member Functions
bool	getOption (Option &option, const PString &optionName) const
	Get the option with its name. More...

void	initialisationOptionMode ()
	Initialisation function of the class OptionMode. More...

void	iterGetPossibleOption (PString &possibleOption, const PString &cursorOption) const
	Iterates over the possible options of the current mode. More...

Private Attributes
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_extraArgument
	Extra argument passed to the OptionMode. More...

bool	p_isCurrentlyParsed
	True if the OptionMode is currently parsed but not totally. More...

bool	p_isParsed
	Say if the mode contains options which are parsed. More...

PString	p_name
	name of the OptionMode More...

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

VecOption	p_vecOption
	Vector of all the options of the OptionMode. More...

Detailed Description

Describe a mode in the program arguments.

Definition at line 13 of file OptionMode.h.

Constructor & Destructor Documentation

◆ OptionMode() [1/2]

OptionMode::OptionMode ( const PString & name = "" )

Default constructeur of OptionMode.

Parameters

name	: name of the mode

Definition at line 12 of file OptionMode.cpp.

         :p_name(name)
 {
         initialisationOptionMode();
 }

References initialisationOptionMode().

Here is the call graph for this function:

◆ OptionMode() [2/2]

OptionMode::OptionMode ( const OptionMode & other )

Copy constructor of OptionMode.

Parameters

other : class to copy

Definition at line 21 of file OptionMode.cpp.

                                               {
         copyOptionMode(other);
 }

References copyOptionMode().

Here is the call graph for this function:

◆ ~OptionMode()

OptionMode::~OptionMode ( )

virtual

Destructeur of OptionMode.

Definition at line 26 of file OptionMode.cpp.

                        {
         
 }

Member Function Documentation

◆ addOption()

void OptionMode::addOption ( const Option & option )

Add an option into the OptionMode.

Parameters

option option to be added into the OptionMode

Definition at line 136 of file OptionMode.cpp.

136 {p_vecOption.push_back(option);}

OptionMode::p_vecOption

VecOption p_vecOption

Vector of all the options of the OptionMode.

Definition: OptionMode.h:62

References p_vecOption.

◆ checkArgument()

bool OptionMode::checkArgument ( ) const

Check the argument of the parser.

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

Definition at line 174 of file OptionMode.cpp.

                                     {
         if(!p_isParsed){return true;}
         bool isArgOk(true);
         VecOption::const_iterator it(p_vecOption.begin());
         while(it != p_vecOption.end() && isArgOk){
                 isArgOk = it->checkArgument();
                 ++it;
         }
         return isArgOk;
 }

References p_isParsed, and p_vecOption.

◆ clearOption()

void OptionMode::clearOption ( )

Remove all the options of the OptionMode.

Definition at line 139 of file OptionMode.cpp.

139 {p_vecOption.clear();}

References p_vecOption.

◆ copyOptionMode()

void OptionMode::copyOptionMode ( const OptionMode & other )

protected

Copy function of OptionMode.

Parameters

other : class to copy

Definition at line 251 of file OptionMode.cpp.

                                                        {
         p_name = other.p_name;
         p_vecOption = other.p_vecOption;
         p_isCurrentlyParsed = other.p_isCurrentlyParsed;
         p_isParsed = other.p_isParsed;
         p_enableHelpOption = other.p_enableHelpOption;
         p_programVersion = other.p_programVersion;
         p_extraArgument = other.p_extraArgument;
 }

References p_enableHelpOption, p_extraArgument, p_isCurrentlyParsed, p_isParsed, p_name, p_programVersion, and p_vecOption.

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

Here is the caller graph for this function:

◆ getExtraArgument()

const PString & OptionMode::getExtraArgument ( ) const

Get Extra argument.

Returns: get the extra arguments of the OptionMode

Definition at line 202 of file OptionMode.cpp.

                                                   {
         return p_extraArgument;
 }

References p_extraArgument.

◆ getName() [1/2]

PString & OptionMode::getName ( )

Get the name of the OptionMode.

Returns: name of the OptionMode

Definition at line 159 of file OptionMode.cpp.

159 {return p_name;}

References p_name.

◆ getName() [2/2]

const PString & OptionMode::getName ( ) const

Get the name of the OptionMode.

Returns: name of the OptionMode

Definition at line 154 of file OptionMode.cpp.

154 {return p_name;}

References p_name.

Referenced by OptionParser::parseArgumentNormalUse().

Here is the caller graph for this function:

◆ getOption()

bool OptionMode::getOption	(	Option &	option,
		const PString &	optionName
	)		const

private

Get the option with its name.

Parameters

[out]	option	: option if it has been found
	optionName	: name of the option to be searched

Returns: true if the option has been found, false otherwise

Definition at line 273 of file OptionMode.cpp.

                                                                            {
         VecOption::const_iterator it(p_vecOption.begin());
         while(it != p_vecOption.end()){
                 if(it->getLongName() == optionName || it->getShortName() == optionName){
                         option = *it;
                         return true;
                 }
                 ++it;
         }
         return false;
 }

References p_vecOption.

Referenced by getValue().

Here is the caller graph for this function:

◆ getPossibleMode()

void OptionMode::getPossibleMode	(	PString &	possibleOption,
		const PString &	cursorOption
	)		const

Get the possible mode.

Parameters

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

Definition at line 240 of file OptionMode.cpp.

                                                                                             {
         if(p_name != ""){
                 if(p_name.isSameBegining(cursorOption)){
                         possibleOption += p_name + " ";
                 }
         }
 }

References PString::isSameBegining(), and p_name.

Here is the call graph for this function:

◆ getPossibleOption()

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

Get the possible options for the bash completion.

Parameters

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

Definition at line 225 of file OptionMode.cpp.

                                                                                               {
         if(p_name != ""){
                 if(!p_isCurrentlyParsed){
                         if(p_name.isSameBegining(cursorOption)){
                                 possibleOption += p_name + " ";
                         }
                 }
         }
         iterGetPossibleOption(possibleOption, cursorOption);
 }

References PString::isSameBegining(), iterGetPossibleOption(), p_isCurrentlyParsed, and p_name.

Referenced by OptionParser::getPossibleOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValue()

template<typename T >

bool OptionMode::getValue	(	T &	value,
		const PString &	optionName
	)		const

Get the value of the option.

Parameters

[out]	value	: value of the option
	optionName	: name of option to get the option

Returns: true on success, false otherwise

Definition at line 18 of file OptionMode_impl.h.

                                                                     {
         Option option;
         if(!getOption(option, optionName)){return false;}
         if(!option.isParsed() && option.isRequired()){
                 return false;
         }
         OptionValue & optionValue = option.getValue();
         optionValue.getValue(value, option.isParsed());
         return true;
 }

References getOption(), Option::getValue(), OptionValue::getValue(), Option::isParsed(), and Option::isRequired().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVecOption() [1/2]

VecOption & OptionMode::getVecOption ( )

Get the vector of options of the OptionMode.

Returns: vector of options of the OptionMode

Definition at line 169 of file OptionMode.cpp.

169 {return p_vecOption;}

References p_vecOption.

◆ getVecOption() [2/2]

const VecOption & OptionMode::getVecOption ( ) const

Get the vector of options of the OptionMode.

Returns: vector of options of the OptionMode

Definition at line 164 of file OptionMode.cpp.

164 {return p_vecOption;}

References p_vecOption.

◆ initialisationOptionMode()

void OptionMode::initialisationOptionMode ( )

private

Initialisation function of the class OptionMode.

Definition at line 262 of file OptionMode.cpp.

                                          {
         p_isCurrentlyParsed = false;
         p_isParsed = false;
         p_enableHelpOption = false;
 }

References p_enableHelpOption, p_isCurrentlyParsed, and p_isParsed.

Referenced by OptionMode().

Here is the caller graph for this function:

◆ isCurrentlyParsed()

bool OptionMode::isCurrentlyParsed ( ) const

Say if the OptionMode is currently parsed (but maybe not totally)

Returns: true if the OptionMode is currently parsed (but maybe not totally), false otherwise

Definition at line 188 of file OptionMode.cpp.

                                         {
         return p_isCurrentlyParsed;
 }

References p_isCurrentlyParsed.

◆ isOptionExist()

bool OptionMode::isOptionExist ( const PString & optionName ) const

Say if the given option has been passed to the program.

Parameters

[out] optionName : name of the option to be checked

Returns: true if hte option has been passed to the program, false if not

Definition at line 210 of file OptionMode.cpp.

                                                               {
         VecOption::const_iterator it(p_vecOption.begin());
         while(it != p_vecOption.end()){
                 if(it->getLongName() == optionName || it->getShortName() == optionName){
                         return it->isParsed();
                 }
                 ++it;
         }
         return false;
 }

References p_vecOption.

Referenced by main().

Here is the caller graph for this function:

◆ isParsed()

bool OptionMode::isParsed ( ) const

Say if the OptionMode contains option which are parsed.

Returns: true if the OptionMode contains option which are parsed, false otherwise

Definition at line 195 of file OptionMode.cpp.

                                {
         return p_isParsed;
 }

References p_isParsed.

Referenced by main().

Here is the caller graph for this function:

◆ iterGetPossibleOption()

void OptionMode::iterGetPossibleOption	(	PString &	possibleOption,
		const PString &	cursorOption
	)		const

private

Iterates over the possible options of the current mode.

Parameters

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

Definition at line 289 of file OptionMode.cpp.

                                                                                                   {
         for(VecOption::const_iterator it(p_vecOption.begin()); it != p_vecOption.end(); ++it){
                 it->getPossibleOption(possibleOption, cursorOption);
         }
 }

References p_vecOption.

Referenced by getPossibleOption().

Here is the caller graph for this function:

◆ operator=()

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

Definition of equal operator of OptionMode.

Parameters

other : class to copy

Returns: copied class

Definition at line 34 of file OptionMode.cpp.

                                                             {
         copyOptionMode(other);
         return *this;
 }

References copyOptionMode().

Here is the call graph for this function:

◆ parseOption() [1/2]

bool OptionMode::parseOption ( ArgParser & parser )

Parse the options in the current OptionMode.

Parameters

[out] parser : parser of option to be used

Returns: true on success, false otherwise This function, is called, knowing, the current OptionMode has to be parsed

Definition at line 44 of file OptionMode.cpp.

                                               {
         p_isParsed = true;
         if(parser.isEndOfOption()){return true;}
         
         if(p_vecOption.size() == 0lu){  //If the OptionMode does not have Option we get the rest of passed extra arguments, they could be used later
                 p_extraArgument = parser.getRemainingArgument();
                 return true;
         }
         
         p_isCurrentlyParsed = true;
         bool isSearch(true);
         VecOption::iterator it(p_vecOption.begin());
         while(isSearch && it != p_vecOption.end() && !parser.isEndOfOption()){
                 if(parser.getCurrentOption() == "--"){  //If we get a --, then the other arguments do not concern us
                         parser.getNextOption();         //Let's get the ext option, because we do not care about --
                         //Let's put them in the p_extraArgument
                         p_extraArgument = parser.getRemainingArgument();
                 }
                 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);
                         }
                 }
                 
                 isSearch = !it->parseOption(parser);
                 ++it;
         }
         p_isParsed |= !isSearch;
         return !isSearch;
 }

References ArgParser::getCurrentOption(), ArgParser::getNextOption(), ArgParser::getRemainingArgument(), ArgParser::isEndOfOption(), p_enableHelpOption, p_extraArgument, p_isCurrentlyParsed, p_isParsed, p_programVersion, p_vecOption, and print().

Referenced by OptionParser::parseArgumentNormalUse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseOption() [2/2]

bool OptionMode::parseOption	(	ArgParser &	parser,
		Option *&	partialOption
	)

Parse the options in the current OptionMode.

Parameters

[out]	parser	: parser of option to be used
[out]	partialOption	: pointer to an option partially parsed

Returns: true on success, false otherwise

Definition at line 87 of file OptionMode.cpp.

                                                                        {
         if(parser.isEndOfOption()){return true;}
         if(p_name != ""){       //If the mode has no name, it is the default mode
                 if(p_name != parser.getCurrentOption()){return false;}
                 p_isParsed = true;
                 parser.getNextOption();
         }
         p_isCurrentlyParsed = true;
         partialOption = NULL;
         bool isSearch(true);
         VecOption::iterator it(p_vecOption.begin());
         while(isSearch && it != p_vecOption.end() && !parser.isEndOfOption()){
                 try{
                         isSearch = !it->parseOption(parser);
                 }catch(const std::runtime_error & e){
                         partialOption = &(*it);
                         isSearch = false;
                 }
                 ++it;
         }
         p_isParsed |= !isSearch;
         return !isSearch;
 }

References ArgParser::getCurrentOption(), ArgParser::getNextOption(), ArgParser::isEndOfOption(), p_isCurrentlyParsed, p_isParsed, p_name, and p_vecOption.

Here is the call graph for this function:

◆ print()

void OptionMode::print ( ) const

Print the option of the mode.

Definition at line 112 of file OptionMode.cpp.

                             {
         PString indentation("\t");
         if(p_name != ""){
                 std::cout << "\tMode '" << p_name << "' :" << std::endl;
                 indentation += "\t";
         }
         for(VecOption::const_iterator it(p_vecOption.begin()); it != p_vecOption.end(); ++it){
                 it->print(indentation);
         }
 }

References p_name, and p_vecOption.

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

Here is the caller graph for this function:

◆ setEnableHelpOption()

void OptionMode::setEnableHelpOption ( bool b )

Set the attribtue which enables help option.

Parameters

b	: true to enable help option, false otherwise

Definition at line 144 of file OptionMode.cpp.

144 {p_enableHelpOption = b;}

References p_enableHelpOption.

Referenced by OptionParser::addMode().

Here is the caller graph for this function:

◆ setName()

void OptionMode::setName ( const PString & name )

Set the name of the OptionMode.

Parameters

name	: name of the OptionMode

Definition at line 126 of file OptionMode.cpp.

126 {p_name = name;}

References p_name.

◆ setProgramVersion()

void OptionMode::setProgramVersion ( const PString & programVersion )

Set the program version.

Parameters

programVersion : version of the program

Definition at line 149 of file OptionMode.cpp.

149 {p_programVersion = programVersion;}

References p_programVersion.

Referenced by OptionParser::addMode().

Here is the caller graph for this function:

◆ setVecOption()

void OptionMode::setVecOption ( const VecOption & vecOption )

Set the vector of options of the OptionMode.

Parameters

vecOption : vector of options of the OptionMode

Definition at line 131 of file OptionMode.cpp.

131 {p_vecOption = vecOption;}

References p_vecOption.

Member Data Documentation

◆ p_enableHelpOption

bool OptionMode::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 68 of file OptionMode.h.

Referenced by copyOptionMode(), initialisationOptionMode(), parseOption(), and setEnableHelpOption().

◆ p_extraArgument

PString OptionMode::p_extraArgument

private

Extra argument passed to the OptionMode.

Definition at line 72 of file OptionMode.h.

Referenced by copyOptionMode(), getExtraArgument(), and parseOption().

◆ p_isCurrentlyParsed

bool OptionMode::p_isCurrentlyParsed

private

True if the OptionMode is currently parsed but not totally.

Definition at line 64 of file OptionMode.h.

Referenced by copyOptionMode(), getPossibleOption(), initialisationOptionMode(), isCurrentlyParsed(), and parseOption().

◆ p_isParsed

bool OptionMode::p_isParsed

private

Say if the mode contains options which are parsed.

Definition at line 66 of file OptionMode.h.

Referenced by checkArgument(), copyOptionMode(), initialisationOptionMode(), isParsed(), and parseOption().

◆ p_name

PString OptionMode::p_name

private

name of the OptionMode

Definition at line 60 of file OptionMode.h.

Referenced by copyOptionMode(), getName(), getPossibleMode(), getPossibleOption(), parseOption(), print(), and setName().

◆ p_programVersion

PString OptionMode::p_programVersion

private

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

Definition at line 70 of file OptionMode.h.

Referenced by copyOptionMode(), parseOption(), and setProgramVersion().

◆ p_vecOption

VecOption OptionMode::p_vecOption

private

Vector of all the options of the OptionMode.

Definition at line 62 of file OptionMode.h.

Referenced by addOption(), checkArgument(), clearOption(), copyOptionMode(), getOption(), getVecOption(), isOptionExist(), iterGetPossibleOption(), parseOption(), print(), and setVecOption().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionMode.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionMode.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixOptionParser/src/OptionMode_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptionMode() [1/2]

◆ OptionMode() [2/2]

◆ ~OptionMode()

Member Function Documentation

◆ addOption()

◆ checkArgument()

◆ clearOption()

◆ copyOptionMode()

◆ getExtraArgument()

◆ getName() [1/2]

◆ getName() [2/2]

◆ getOption()

◆ getPossibleMode()

◆ getPossibleOption()

◆ getValue()

◆ getVecOption() [1/2]

◆ getVecOption() [2/2]

◆ initialisationOptionMode()

◆ isCurrentlyParsed()

◆ isOptionExist()

◆ isParsed()

◆ iterGetPossibleOption()

◆ operator=()

◆ parseOption() [1/2]

◆ parseOption() [2/2]

◆ print()

◆ setEnableHelpOption()

◆ setName()

◆ setProgramVersion()

◆ setVecOption()

Member Data Documentation

◆ p_enableHelpOption

◆ p_extraArgument

◆ p_isCurrentlyParsed

◆ p_isParsed

◆ p_name

◆ p_programVersion

◆ p_vecOption