Describe the value of an option passed to a program. More...

#include <OptionValue.h>

Public Member Functions
void	addValue (const PString &value)
	Add value of the OptionValue. More...

void	bashCompletionValue (PString &strBashCompletion, const PString &cursorOption) const
	Print the possible value to the bash completion. More...

PVecString &	getDefaultValue ()
	Get the default value of the OptionValue. More...

const PVecString &	getDefaultValue () const
	Get the default value of the OptionValue. More...

PVecString &	getPossibleValue ()
	Get the possible values of the OptionValue. More...

const PVecString &	getPossibleValue () const
	Get the possible values of the OptionValue. More...

OptionType::OptionType &	getType ()
	Get the type of the OptionValue. More...

OptionType::OptionType	getType () const
	Get the type of the OptionValue. More...

PVecString &	getValue ()
	Get the vector of values. More...

const PVecString &	getValue () const
	Get the vector of values. More...

template<typename T >
void	getValue (std::vector< T > &vecValue, bool isParsed) const
	Get the value of the option. More...

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

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

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

	OptionValue (const PString &value, OptionType::OptionType type, const PVecString &vecDefaultValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const PString &value, OptionType::OptionType type, const PVecString &vecDefaultValue, const PVecString &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const PString &value, OptionType::OptionType type=OptionType::STRING)
	Initialisation function of the class OptionValue. More...

	OptionValue (const PVecString &vecValue, OptionType::OptionType type, const PVecString &vecDefaultValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const PVecString &vecValue, OptionType::OptionType type, const PVecString &vecDefaultValue, const PVecString &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const PVecString &vecValue, OptionType::OptionType type=OptionType::STRING)
	Initialisation function of the class OptionValue. More...

	OptionValue (OptionType::OptionType type=OptionType::STRING)
	Default constructeur of OptionValue. More...

template<typename T >
void	setDefaultValue (const std::vector< T > &value)
	Set the value in the OptionValue. More...

template<typename T >
void	setDefaultValue (const T &value)
	Set the value in the OptionValue. More...

void	setType (OptionType::OptionType type)
	Set the type of the OptionValue. More...

void	setValue (const PString &value)
	Set the value of the OptionValue. More...

void	setValue (const PVecString &value)
	Set the value of the OptionValue. More...

void	setVecPossibleValue (const PVecString &vecPossibleValue)
	Set the vector of possible values. More...

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

Protected Member Functions
void	copyOptionValue (const OptionValue &other)
	Copy function of OptionValue. More...

Private Member Functions
template<typename T >
void	checkTypeFromTemplate () const
	Check the type from the template. More...

void	initialisationOptionValue (const PVecString &vecValue, OptionType::OptionType type, const PVecString &vecDefaultValue, const PVecString &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

Private Attributes
OptionType::OptionType	p_type
	Type of the OptionValue. More...

PVecString	p_vecDefaultValue
	Default value of the OptionValue. More...

PVecString	p_vecPossibleValue
	Vector of the possible value for the OptionValue. More...

PVecString	p_vecValue
	Vector of the values of the OptionValue. More...

Detailed Description

Describe the value of an option passed to a program.

Definition at line 16 of file OptionValue.h.

Constructor & Destructor Documentation

◆ OptionValue() [1/8]

OptionValue::OptionValue ( OptionType::OptionType type = OptionType::STRING )

Default constructeur of OptionValue.

Parameters

type	: type of the OptionValue

Definition at line 14 of file OptionValue.cpp.

                                                  {
         PVecString vecValue, vecDefaultValue, vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [2/8]

OptionValue::OptionValue	(	const PString &	value,
		OptionType::OptionType	type = `OptionType::STRING`
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue

Definition at line 23 of file OptionValue.cpp.

                                                                         {
         PVecString vecValue, vecDefaultValue, vecPossibleValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [3/8]

OptionValue::OptionValue	(	const PVecString &	vecValue,
		OptionType::OptionType	type = `OptionType::STRING`
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue

Definition at line 33 of file OptionValue.cpp.

                                                                               {
         PVecString vecDefaultValue, vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [4/8]

OptionValue::OptionValue	(	const PString &	value,
		OptionType::OptionType	type,
		const PVecString &	vecDefaultValue
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue

Definition at line 43 of file OptionValue.cpp.

                                                                                                             {
         PVecString vecValue, vecPossibleValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [5/8]

OptionValue::OptionValue	(	const PVecString &	vecValue,
		OptionType::OptionType	type,
		const PVecString &	vecDefaultValue
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue

Definition at line 54 of file OptionValue.cpp.

                                                                                                                   {
         PVecString vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [6/8]

OptionValue::OptionValue	(	const PString &	value,
		OptionType::OptionType	type,
		const PVecString &	vecDefaultValue,
		const PVecString &	vecPossibleValue
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 65 of file OptionValue.cpp.

                                                                                                                                                  {
         PVecString vecValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [7/8]

OptionValue::OptionValue	(	const PVecString &	vecValue,
		OptionType::OptionType	type,
		const PVecString &	vecDefaultValue,
		const PVecString &	vecPossibleValue
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 77 of file OptionValue.cpp.

                                                                                                                                                        {
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue().

Here is the call graph for this function:

◆ OptionValue() [8/8]

OptionValue::OptionValue ( const OptionValue & other )

Copy constructor of OptionValue.

Parameters

other : class to copy

Definition at line 85 of file OptionValue.cpp.

                                                  {
         copyOptionValue(other);
 }

References copyOptionValue().

Here is the call graph for this function:

◆ ~OptionValue()

OptionValue::~OptionValue ( )

virtual

Destructeur of OptionValue.

Definition at line 90 of file OptionValue.cpp.

                          {
         
 }

Member Function Documentation

◆ addValue()

void OptionValue::addValue ( const PString & value )

Add value of the OptionValue.

Parameters

value : value to be added

Definition at line 127 of file OptionValue.cpp.

127 {p_vecValue.push_back(value);}

OptionValue::p_vecValue

PVecString p_vecValue

Vector of the values of the OptionValue.

Definition: OptionValue.h:73

References p_vecValue.

Referenced by Option::parsePartOption().

Here is the caller graph for this function:

◆ bashCompletionValue()

void OptionValue::bashCompletionValue	(	PString &	strBashCompletion,
		const PString &	cursorOption
	)		const

Print the possible value to the bash completion.

Parameters

[out]	strBashCompletion	: string of all possible choices
	cursorOption	: option of the cursor which is currently completed

Definition at line 178 of file OptionValue.cpp.

                                                                                                     {
 //      std::cerr << "OptionValue::bashCompletionValue : cursorOption = '"<<cursorOption<<"'" << std::endl;
         if(p_vecPossibleValue.size() != 0lu){   //If there is some possible values, we print them
                 strBashCompletion += value_completion(cursorOption, p_vecPossibleValue);
         }else{
                 //Now, we can complete by respect to the expected type
                 if(p_type == OptionType::FILE_OR_DIR || p_type == OptionType::FILENAME){
                         strBashCompletion += path_completion_all(cursorOption);
                 }else if(p_type == OptionType::DIRECTORY){
                         strBashCompletion += path_completion_dirOnly(cursorOption);
                 }else{
                         strBashCompletion += convertOptionTypeToString(p_type);
                 }
         }
 }

References convertOptionTypeToString(), OptionType::DIRECTORY, OptionType::FILE_OR_DIR, OptionType::FILENAME, p_type, p_vecPossibleValue, path_completion_all(), path_completion_dirOnly(), and value_completion().

Referenced by Option::getPossibleValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTypeFromTemplate()

template<typename T >

void OptionValue::checkTypeFromTemplate

private

Check the type from the template.

Throw exception if there is an incompatibility

Definition at line 76 of file OptionValue_impl.h.

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

References convertOptionTypeToString(), isOptionTypeCompatible(), and p_type.

Here is the call graph for this function:

◆ copyOptionValue()

void OptionValue::copyOptionValue ( const OptionValue & other )

protected

Copy function of OptionValue.

Parameters

other : class to copy

Definition at line 197 of file OptionValue.cpp.

                                                           {
         p_vecValue = other.p_vecValue;
         p_type = other.p_type;
         p_vecDefaultValue = other.p_vecDefaultValue;
         p_vecPossibleValue = other.p_vecPossibleValue;
 }

References p_type, p_vecDefaultValue, p_vecPossibleValue, and p_vecValue.

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

Here is the caller graph for this function:

◆ getDefaultValue() [1/2]

PVecString & OptionValue::getDefaultValue ( )

Get the default value of the OptionValue.

Returns: default value of the OptionValue

Definition at line 162 of file OptionValue.cpp.

162 {return p_vecDefaultValue;}

References p_vecDefaultValue.

◆ getDefaultValue() [2/2]

const PVecString & OptionValue::getDefaultValue ( ) const

Get the default value of the OptionValue.

Returns: default value of the OptionValue

Definition at line 157 of file OptionValue.cpp.

157 {return p_vecDefaultValue;}

References p_vecDefaultValue.

Referenced by Option::print(), and testOptionValue().

Here is the caller graph for this function:

◆ getPossibleValue() [1/2]

PVecString & OptionValue::getPossibleValue ( )

Get the possible values of the OptionValue.

Returns: possible values of the OptionValue

Definition at line 172 of file OptionValue.cpp.

172 {return p_vecPossibleValue;}

References p_vecPossibleValue.

◆ getPossibleValue() [2/2]

const PVecString & OptionValue::getPossibleValue ( ) const

Get the possible values of the OptionValue.

Returns: possible values of the OptionValue

Definition at line 167 of file OptionValue.cpp.

167 {return p_vecPossibleValue;}

References p_vecPossibleValue.

Referenced by Option::print(), and testOptionValue().

Here is the caller graph for this function:

◆ getType() [1/2]

OptionType::OptionType & OptionValue::getType ( )

Get the type of the OptionValue.

Returns: type of the OptionValue

Definition at line 152 of file OptionValue.cpp.

152 {return p_type;}

References p_type.

◆ getType() [2/2]

OptionType::OptionType OptionValue::getType ( ) const

Get the type of the OptionValue.

Returns: type of the OptionValue

Definition at line 147 of file OptionValue.cpp.

147 {return p_type;}

References p_type.

Referenced by Option::checkArgument(), Option::parsePartOption(), Option::print(), and testOptionValue().

Here is the caller graph for this function:

◆ getValue() [1/4]

PVecString & OptionValue::getValue ( )

Get the vector of values.

Returns: vector of values

Definition at line 142 of file OptionValue.cpp.

142 {return p_vecValue;}

References p_vecValue.

◆ getValue() [2/4]

const PVecString & OptionValue::getValue ( ) const

Get the vector of values.

Returns: vector of values

Definition at line 137 of file OptionValue.cpp.

137 {return p_vecValue;}

References p_vecValue.

Referenced by OptionMode::getValue(), printValueOfOpt(), printValueOfOptConst(), and testOptionValue().

Here is the caller graph for this function:

◆ getValue() [3/4]

template<typename T >

void OptionValue::getValue	(	std::vector< T > &	vecValue,
		bool	isParsed
	)		const

Get the value of the option.

Parameters

[out]	vecValue	: value of the option
	isParsed	: true if the option is parsed, false if not

Definition at line 59 of file OptionValue_impl.h.

                                                                       {
         checkTypeFromTemplate<T>();
         if(isParsed){
                 for(PVecString::const_iterator it(p_vecValue.begin()); it != p_vecValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }else{
                 for(PVecString::const_iterator it(p_vecDefaultValue.begin()); it != p_vecDefaultValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }
 }

References p_vecDefaultValue, and p_vecValue.

◆ getValue() [4/4]

template<typename T >

void OptionValue::getValue	(	T &	value,
		bool	isParsed
	)		const

Get the value of the option.

Parameters

[out]	value	: value of the option
	isParsed	: true if the option is parsed, false if not

Definition at line 38 of file OptionValue_impl.h.

                                                         {
         checkTypeFromTemplate<T>();
         if(isParsed){
                 if(p_vecValue.size() > 1lu){
                         std::runtime_error("OptionValue::getValue : several value but only one value in parameter");
                 }
                 value = stringToValue<T>(p_vecValue.front());
         }else{
                 if(p_vecDefaultValue.size() == 1lu){
                         value = stringToValue<T>(p_vecDefaultValue.front());
                 }else{
                         std::runtime_error("OptionValue::getValue : several value but only one value in parameter");
                 }
         }
 }

References p_vecDefaultValue, and p_vecValue.

◆ initialisationOptionValue()

void OptionValue::initialisationOptionValue	(	const PVecString &	vecValue,
		OptionType::OptionType	type,
		const PVecString &	vecDefaultValue,
		const PVecString &	vecPossibleValue
	)

private

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 210 of file OptionValue.cpp.

                                                                                                                                                                           {
         p_vecValue = vecValue;
         p_type = type;
         p_vecDefaultValue = vecDefaultValue;
         p_vecPossibleValue = vecPossibleValue;
 }

References p_type, p_vecDefaultValue, p_vecPossibleValue, and p_vecValue.

Referenced by OptionValue().

Here is the caller graph for this function:

◆ operator=()

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

Definition of equal operator of OptionValue.

Parameters

other : class to copy

Returns: copied class

Definition at line 98 of file OptionValue.cpp.

                                                                {
         copyOptionValue(other);
         return *this;
 }

References copyOptionValue().

Here is the call graph for this function:

◆ setDefaultValue() [1/2]

template<typename T >

void OptionValue::setDefaultValue ( const std::vector< T > & value )

Set the value in the OptionValue.

Parameters

value : value of the OptionValue

Definition at line 29 of file OptionValue_impl.h.

                                                            {
         p_vecDefaultValue = value;
 }

References p_vecDefaultValue.

◆ setDefaultValue() [2/2]

template<typename T >

void OptionValue::setDefaultValue ( const T & value )

Set the value in the OptionValue.

Parameters

value : value of the OptionValue

Definition at line 17 of file OptionValue_impl.h.

                                                 {
         PString valueBinStr;
         valueBinStr.fromValue(value);
         PVecString vecValue;
         vecValue.push_back(valueBinStr);
         p_vecDefaultValue = vecValue;
 }

References PString::fromValue(), and p_vecDefaultValue.

Referenced by OptionParser::addOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

void OptionValue::setType ( OptionType::OptionType type )

Set the type of the OptionValue.

Parameters

type	: type of the OptionValue

Definition at line 106 of file OptionValue.cpp.

                                                   {
         p_type = type;
 }

References p_type.

Referenced by OptionParser::addOption().

Here is the caller graph for this function:

◆ setValue() [1/2]

void OptionValue::setValue ( const PString & value )

Set the value of the OptionValue.

Parameters

value : value to be set

Definition at line 113 of file OptionValue.cpp.

                                                {
         PVecString vecValue;
         vecValue.push_back(value);
         setValue(vecValue);
 }

Referenced by testOptionValue().

Here is the caller graph for this function:

◆ setValue() [2/2]

void OptionValue::setValue ( const PVecString & value )

Set the value of the OptionValue.

Parameters

value : value to be set

Definition at line 122 of file OptionValue.cpp.

122 {p_vecValue = value;}

References p_vecValue.

◆ setVecPossibleValue()

void OptionValue::setVecPossibleValue ( const PVecString & vecPossibleValue )

Set the vector of possible values.

Parameters

vecPossibleValue : vector of possible values

Definition at line 132 of file OptionValue.cpp.

132 {p_vecPossibleValue = vecPossibleValue;}

References p_vecPossibleValue.

Referenced by OptionParser::addOption().

Here is the caller graph for this function:

Member Data Documentation

◆ p_type

OptionType::OptionType OptionValue::p_type

private

Type of the OptionValue.

Definition at line 71 of file OptionValue.h.

Referenced by bashCompletionValue(), checkTypeFromTemplate(), copyOptionValue(), getType(), initialisationOptionValue(), and setType().

◆ p_vecDefaultValue

PVecString OptionValue::p_vecDefaultValue

private

Default value of the OptionValue.

Definition at line 75 of file OptionValue.h.

Referenced by copyOptionValue(), getDefaultValue(), getValue(), initialisationOptionValue(), and setDefaultValue().

◆ p_vecPossibleValue

PVecString OptionValue::p_vecPossibleValue

private

Vector of the possible value for the OptionValue.

Definition at line 77 of file OptionValue.h.

Referenced by bashCompletionValue(), copyOptionValue(), getPossibleValue(), initialisationOptionValue(), and setVecPossibleValue().

◆ p_vecValue

PVecString OptionValue::p_vecValue

private

Vector of the values of the OptionValue.

Definition at line 73 of file OptionValue.h.

Referenced by addValue(), copyOptionValue(), getValue(), initialisationOptionValue(), and setValue().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixInkscape/tmp_project/PhoenixOptionParser/src/OptionValue.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixInkscape/tmp_project/PhoenixOptionParser/src/OptionValue.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixInkscape/tmp_project/PhoenixOptionParser/src/OptionValue_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptionValue() [1/8]

◆ OptionValue() [2/8]

◆ OptionValue() [3/8]

◆ OptionValue() [4/8]

◆ OptionValue() [5/8]

◆ OptionValue() [6/8]

◆ OptionValue() [7/8]

◆ OptionValue() [8/8]

◆ ~OptionValue()

Member Function Documentation

◆ addValue()

◆ bashCompletionValue()

◆ checkTypeFromTemplate()

◆ copyOptionValue()

◆ getDefaultValue() [1/2]

◆ getDefaultValue() [2/2]

◆ getPossibleValue() [1/2]

◆ getPossibleValue() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ getValue() [1/4]

◆ getValue() [2/4]

◆ getValue() [3/4]

◆ getValue() [4/4]

◆ initialisationOptionValue()

◆ operator=()

◆ setDefaultValue() [1/2]

◆ setDefaultValue() [2/2]

◆ setType()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ setVecPossibleValue()

Member Data Documentation

◆ p_type

◆ p_vecDefaultValue

◆ p_vecPossibleValue

◆ p_vecValue