template for container-based options. More...

#include <Options.h>

Inheritance diagram for options::container< T, Container >:

Collaboration diagram for options::container< T, Container >:

Public Member Functions
	container (char aShortName, const std::string &aLongName, const std::string &aExplanation, std::initializer_list< typename Container::value_type > aDefault={})

	container (const container &)=delete

void	fWriteCfgLines (std::ostream &aStream, const char *aPrefix) const override

void	fWriteValue (std::ostream &aStream) const override
	write textual representation of value to a std::ostream More...

void	fSetMe (std::istream &aStream, const internal::sourceItem &aSource) override
	function to set the value from a string, remembering the source More...

void	fCheckRange () const override

Public Member Functions inherited from options::internal::baseForContainer< T >
	baseForContainer (char aShortName, std::string aLongName, std::string aExplanation, short aNargs)

bool	fIsSet () const override
	check if this option was set, regardless of from command line or config file More...

bool	fIsContainer () const override

void	fAddDefaultFromStream (std::istream &aStream) override
	special for use in the shellScriptOptionParser More...

Public Member Functions inherited from options::internal::typed_base< T >
	typed_base (Types ... args)

virtual void	fAddToRange (rangeValueType aValue)
	add a value to the range of allowed values More...

std::enable_if<(!std::is_same< rangeValueType, std::string >::value) &&std::is_same< TT, std::string >::value, void >::type	fAddToRange (const TT &aString)

void	fAddToRange (InputIt aBegin, InputIt aEnd)
	add values from the iterator range [aBegin,aEnd) to the range of allowed values More...

void	fAddToRange (const std::vector< TT > &aRange)
	add values from a vector (may be given as initializer list) to the range of allowed values More...

void	fAddToRangeFromStream (std::istream &aStream) override

void	fWriteRange (std::ostream &aStream) const override

virtual void	fCheckValueForRange (const compareValueType &aValue) const

Public Member Functions inherited from options::base
	base (char aShortName, const std::string &aLongName, const std::string &aExplanation, short aNargs)
	construct an object of type base More...

virtual	~base ()

virtual void	fRequire (const base *aOtherOption)
	require aOtherOption when this option is set More...

virtual void	fRequire (std::vector< const base * > aOtherOptions)
	add vector of other options, particlularly nice for use with initializer list More...

template<typename InputIt >
void	fRequire (InputIt aBegin, InputIt aEnd)
	add all options from the pair of iterators [aBegin,aEnd) to the list of required options More...

virtual void	fForbid (const base *aOtherOption)
	forbid aOtherOption when this option is set More...

virtual void	fForbid (std::vector< const base * > aOtherOptions)
	add vector of other options, particlularly nice for use with initializer list More...

template<typename InputIt >
void	fForbid (InputIt aBegin, InputIt aEnd)
	add all options from the pair of iterators [aBegin,aEnd) to the list of forbidden options More...

const std::string &	fGetLongName () const
	returns long name of option, usually only for internal use. More...

Additional Inherited Members
Public Types inherited from options::internal::typed_base< T >
typedef T	valueType

typedef std::conditional< std::is_same< T, const char * >::value\|\|false, std::string, T >::type	rangeValueType

typedef std::conditional< false, std::string, T >::type	compareValueType

Protected Member Functions inherited from options::base
virtual void	fSetMeNoarg (const internal::sourceItem &)

virtual void	fSetSource (const internal::sourceItem &aSource)
	remember the source that provided the value, e.g. commandline or a config file More...

void	fSetPreserveWorthyStuff (std::vector< std::string > *aStuff)

void	fHide ()
	hide option, will be respected by help More...

bool	fIsHidden () const

void	fDisable ()
	disable option by removing it from the maps More...

Static Protected Member Functions inherited from options::base
static std::map< std::string, base * > &	fGetOptionMap ()

static std::map< char, base * > &	fGetShortOptionMap ()

Protected Attributes inherited from options::internal::baseForContainer< T >
std::vector< internal::sourceItem >	lSources

Protected Attributes inherited from options::internal::typed_base< T >
std::multiset< rangeValueType >	lRange

Protected Attributes inherited from options::base
char	lShortName

const std::string	lLongName

const std::string	lExplanation

internal::sourceItem	lSource

short	lNargs

bool	lHidden

std::vector< std::string > *	lPreserveWorthyStuff

std::vector< const base * >	lRequiredOptions

std::vector< const base * >	lForbiddenOptions

Detailed Description

template<typename T, typename Container = std::vector<T>>
class options::container< T, Container >

template for container-based options.

the container is by defalt a std::vector. If a non-vector container is used it needs to have a push_back.

Definition at line 789 of file Options.h.

Constructor & Destructor Documentation

◆ container() [1/2]

template<typename T , typename Container = std::vector<T>>

options::container< T, Container >::container	(	char	aShortName,
		const std::string &	aLongName,
		const std::string &	aExplanation,
		std::initializer_list< typename Container::value_type >	aDefault = `{}`
	)

inline

Definition at line 791 of file Options.h.

                                                                                {}) :
             internal::baseForContainer<T>(aShortName, aLongName, aExplanation, 1) {
             for (const auto& defaultValue : aDefault) {
                 this->push_back(defaultValue);
             }
         }

◆ container() [2/2]

template<typename T , typename Container = std::vector<T>>

options::container< T, Container >::container ( const container< T, Container > & )

delete

Member Function Documentation

◆ fCheckRange()

template<typename T , typename Container = std::vector<T>>

void options::container< T, Container >::fCheckRange ( ) const

inlineoverridevirtual

Implements options::base.

Definition at line 846 of file Options.h.

                                           {
             for (const auto& value : *this) {
                 this->fCheckValueForRange(value);
             }
         };

Referenced by options::withAction< options::single< bool > >::fSetMe(), and options::withAction< options::single< bool > >::fSetMeNoarg().

Here is the caller graph for this function:

◆ fSetMe()

template<typename T , typename Container = std::vector<T>>

void options::container< T, Container >::fSetMe	(	std::istream &	aStream,
		const internal::sourceItem &	aSource
	)

inlineoverridevirtual

function to set the value from a string, remembering the source

Implements options::base.

Definition at line 829 of file Options.h.

                                                                                      {
             T value;
             aStream >> std::setbase(0);
             {
                 using namespace escapedIO;
                 aStream >> value;
             }
             if (aStream.fail()) {
                 std::string arg;
                 aStream.clear();
                 aStream >> arg;
                 throw internal::conversionError(this, arg, typeid(value));
             }
             this->push_back(value);
             this->lSources.push_back(aSource);
         }

◆ fWriteCfgLines()

template<typename T , typename Container = std::vector<T>>

void options::container< T, Container >::fWriteCfgLines	(	std::ostream &	aStream,
		const char *	aPrefix
	)		const

inlineoverridevirtual

Reimplemented from options::base.

Definition at line 799 of file Options.h.

                                                                                      {
             if (this->empty()) {
                 aStream << aPrefix << this->lLongName << "=value\n";
             }
             auto it2 = this->lSources.begin();
             for (auto it = this->begin(); it != this->end(); ++it, ++it2) {
                 aStream << (it2->fIsUnset() ? aPrefix : "") << this->lLongName << "=";
                 {
                     using escapedIO::operator<<;
                     aStream << *it << "\n";
                 }
                 if (!it2->fIsUnset()) {
                     aStream << "# set from " << *it2 << "\n";
                 }
             }
         }

◆ fWriteValue()

template<typename T , typename Container = std::vector<T>>

void options::container< T, Container >::fWriteValue ( std::ostream & aStream ) const

inlineoverridevirtual

write textual representation of value to a std::ostream

Implements options::base.

Definition at line 817 of file Options.h.

                                                              {
             if (this->empty()) {
                 aStream << "\"\"";
             } else {
                 aStream << "\"";
                 for (auto it = this->begin(); it != this->end(); ++it) {
                     using escapedIO::operator<<;
                     aStream << *it << " ";
                 }
                 aStream << "\"";
             }
         }

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

OptionParser/src/include/Options.h (v0.19-24-g0617ca1 with changes)

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T, typename Container = std::vector<T>> class options::container< T, Container >

Constructor & Destructor Documentation

◆ container() [1/2]

◆ container() [2/2]

Member Function Documentation

◆ fCheckRange()

◆ fSetMe()

◆ fWriteCfgLines()

◆ fWriteValue()

template<typename T, typename Container = std::vector<T>>
class options::container< T, Container >