options::base Class Reference

base class for options More...

#include <Options.h>

Inheritance diagram for options::base:

Collaboration diagram for options::base:

Public Member Functions
	base (char aShortName, const std::string &aLongName, const std::string &aExplanation, short aNargs)
	construct an object of type base More...
virtual	~base ()
virtual void	fAddToRangeFromStream (std::istream &aStream)=0
	special for use in the shellScriptOptionParser More...
virtual void	fAddDefaultFromStream (std::istream &aStream)=0
	special for use in the shellScriptOptionParser More...
virtual void	fWriteValue (std::ostream &aStream) const =0
	write textual representation of value to a std::ostream More...
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...
virtual bool	fIsSet () const
	check if this option was set, regardless of from command line or config file More...
virtual bool	fIsContainer () const
const std::string &	fGetLongName () const
	returns long name of option, usually only for internal use. More...

Protected Member Functions
virtual void	fSetMe (std::istream &aStream, const internal::sourceItem &aSource)=0
	function to set the value from a string, remembering the source More...
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...
virtual void	fWriteCfgLines (std::ostream &aStream, const char *aPrefix) const
virtual void	fCheckRange () const =0
virtual void	fWriteRange (std::ostream &) const
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
static std::map< std::string, base * > &	fGetOptionMap ()
static std::map< char, base * > &	fGetShortOptionMap ()

Protected Attributes
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

Private Member Functions
virtual void	fHandleOption (int argc, const char *argv[], int *i)

Friends
class	parser

Detailed Description

base class for options

Only the templated classes that derive from this base class can contain values. This base class only contains members that are generally usable and do not depend on the type of the option.

Definition at line 193 of file Options.h.

Constructor & Destructor Documentation

base()

options::base::base	(	char	aShortName,
		const std::string &	aLongName,
		const std::string &	aExplanation,
		short	aNargs
	)

construct an object of type base

The newly created object is inserted into the maps sorted by long name and by short name, (short name only if it is not '\0') If a clash wopuld occur, i.e. either long or short name is already taken an exception is thrown.

Parameters

[in]	aShortName	short option without the -, use '\0' to have only a long form
[in]	aLongName	long option without the –, must always be given
[in]	aExplanation	explanation for help output
[in]	aNargs	number of arguments/parameters. May be 0 ot 1.

Definition at line 529 of file Options.cpp.

                                                                                                         :
        lShortName(aShortName),
        lLongName(aLongName),
        lExplanation(aExplanation),
        lNargs(aNargs) {
 
        {
            auto p = parser::fGetInstance();
            if (p != nullptr) {
                if (p->fIsParsingDone()) {
                    throw std::logic_error(internal::conCat(lLongName, " construction after parsing is done"));
                }
            }
        }
 
        if (fGetOptionMap().emplace(lLongName, this).second == false) {
            throw std::logic_error(internal::conCat(lLongName, " already registered"));
        }
        if (lShortName != '\0') {
            if (fGetShortOptionMap().emplace(lShortName, this).second == false) {
                throw std::logic_error(internal::conCat(lLongName, ": short name '", lShortName, " already registered"));
            }
        }
        lPreserveWorthyStuff = nullptr;
    }

References options::internal::conCat(), options::parser::fGetInstance(), fGetOptionMap(), fGetShortOptionMap(), lLongName, lPreserveWorthyStuff, and lShortName.

Here is the call graph for this function:

~base()

options::base::~base ( )

virtual

Definition at line 554 of file Options.cpp.

                {
        fGetOptionMap().clear();
        fGetShortOptionMap().clear();
        delete lPreserveWorthyStuff;
    }

References fGetOptionMap(), fGetShortOptionMap(), and lPreserveWorthyStuff.

Here is the call graph for this function:

Member Function Documentation

fAddDefaultFromStream()

virtual void options::base::fAddDefaultFromStream ( std::istream &  aStream )

pure virtual

special for use in the shellScriptOptionParser

read a value from aStram and set that as default

Implemented in options::internal::baseForContainer< T >, options::internal::baseForContainer< std::string >, options::internal::baseForContainer< unsigned int >, options::internal::baseForMap< T >, options::internal::baseForMap< std::string >, options::single< bool >, options::single< T >, options::single< std::chrono::nanoseconds >, options::single< unsigned long >, options::single< std::chrono::duration< double > >, options::single< double >, options::single< std::string >, options::single< int >, options::single< unsigned int >, options::single< U >, options::single< options::postFixedNumber< size_t > >, options::single< copyRequest::clock_type::duration >, options::single< size_t >, options::single< unsigned >, options::single< std::chrono::seconds >, options::single< std::chrono::duration< Rep, Period > >, options::single< std::chrono::system_clock::time_point >, options::ForeignOption, and options::single< std::regex >.

fAddToRangeFromStream()

virtual void options::base::fAddToRangeFromStream ( std::istream &  aStream )

pure virtual

special for use in the shellScriptOptionParser

read values from aStream and add them to the range vector

Implemented in options::internal::typed_base< T, forceRangeValueTypeString >, options::internal::typed_base< std::chrono::nanoseconds >, options::internal::typed_base< std::chrono::system_clock::time_point >, options::internal::typed_base< unsigned long >, options::internal::typed_base< std::chrono::duration< double > >, options::internal::typed_base< double >, options::internal::typed_base< std::string >, options::internal::typed_base< int >, options::internal::typed_base< unsigned int >, options::internal::typed_base< T >, options::internal::typed_base< U >, options::internal::typed_base< options::postFixedNumber< size_t > >, options::internal::typed_base< copyRequest::clock_type::duration >, options::internal::typed_base< size_t >, options::internal::typed_base< std::regex, true >, options::internal::typed_base< unsigned >, options::internal::typed_base< std::chrono::duration< Rep, Period > >, options::internal::typed_base< std::chrono::seconds >, options::ForeignOption, and options::single< bool >.

fCheckRange()

virtual void options::base::fCheckRange ( ) const

protectedpure virtual

Implemented in options::container< T, Container >, options::map< T, Container >, options::single< bool >, options::single< T >, options::single< std::chrono::duration< Rep, Period > >, options::single< std::chrono::system_clock::time_point >, options::ForeignOption, and options::single< std::regex >.

Referenced by fHandleOption().

Here is the caller graph for this function:

fDisable()

void options::base::fDisable ( )

protected

disable option by removing it from the maps

Definition at line 605 of file Options.cpp.

                        {
        fHide(); // needed to hide forbidden options
        fGetOptionMap().erase(lLongName);
        fGetShortOptionMap().erase(lShortName);
    }

References fGetOptionMap(), fGetShortOptionMap(), fHide(), lLongName, and lShortName.

Here is the call graph for this function:

fForbid() [1/3]

void options::base::fForbid ( const base *  aOtherOption )

virtual

forbid aOtherOption when this option is set

Definition at line 617 of file Options.cpp.

                                               {
        lForbiddenOptions.push_back(aOtherOption);
    }

References lForbiddenOptions.

Referenced by davixCfgX509::davixCfgX509(), dCapCfgPar< T >::fForbid(), fForbid(), and baseTest::setUpOptions().

Here is the caller graph for this function:

fForbid() [2/3]

template<typename InputIt >

void options::base::fForbid ( InputIt  aBegin, InputIt  aEnd  )

inline

add all options from the pair of iterators [aBegin,aEnd) to the list of forbidden options

Definition at line 257 of file Options.h.

                                                                               {
            for (auto it = aBegin; it != aEnd; ++it) {
                fForbid(*it);
            }
        }

References fForbid().

Here is the call graph for this function:

fForbid() [3/3]

void options::base::fForbid ( std::vector< const base * >  aOtherOptions )

virtual

add vector of other options, particlularly nice for use with initializer list

Definition at line 620 of file Options.cpp.

                                                           {
        lForbiddenOptions.insert(lForbiddenOptions.end(), aOtherOptions.cbegin(), aOtherOptions.cend());
    }

References lForbiddenOptions.

fGetLongName()

const std::string& options::base::fGetLongName ( ) const

inline

returns long name of option, usually only for internal use.

Definition at line 273 of file Options.h.

                                              {
            return lLongName;
        };

References lLongName.

Referenced by options::parser::fParse(), options::parser::fPrintOptionHelp(), and mapOption< T >::fWriteValue().

Here is the caller graph for this function:

fGetOptionMap()

static std::map<std::string, base*>& options::base::fGetOptionMap ( )

inlinestaticprotected

Definition at line 196 of file Options.h.

                                                         {
            static std::map<std::string, base*> gOptions;
            return gOptions;
        };

Referenced by base(), options::parser::fCheckConsistency(), fDisable(), options::parser::fHelp(), options::parser::fParse(), options::parser::fReadCfgFile(), options::parser::fWriteCfgFile(), and ~base().

Here is the caller graph for this function:

fGetShortOptionMap()

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

inlinestaticprotected

Definition at line 200 of file Options.h.

                                                         {
            static std::map<char, base*> gShortOptions;
            return gShortOptions;
        };

Referenced by base(), fDisable(), options::parser::fParse(), and ~base().

Here is the caller graph for this function:

fHandleOption()

void options::base::fHandleOption ( int  argc, const char *  argv[], int *  i  )

privatevirtual

Definition at line 566 of file Options.cpp.

                                                                 {
        if (*i + lNargs >= argc) {
            throw internal::optionError(this, internal::conCat(lNargs, " args needed, but only ", argc - *i - 1 , " remain."));
        }
        if (lNargs == 0) {
            fSetMeNoarg(internal::sourceItem(&internal::sourceFile::gCmdLine, *i));
        } else if (lNargs == 1) {
            std::stringstream sbuf(argv[*i + 1]);
            fSetMe(sbuf, internal::sourceItem(&internal::sourceFile::gCmdLine, *i));
            *i += lNargs;
        }
        fCheckRange();
    }

References options::internal::conCat(), fCheckRange(), fSetMe(), fSetMeNoarg(), options::internal::sourceFile::gCmdLine, and lNargs.

Here is the call graph for this function:

fHide()

void options::base::fHide ( )

protected

hide option, will be respected by help

Definition at line 596 of file Options.cpp.

                     {
        lHidden = true;
    }

References lHidden.

Referenced by fDisable().

Here is the caller graph for this function:

fIsContainer()

virtual bool options::base::fIsContainer ( ) const

inlinevirtual

Reimplemented in options::internal::baseForContainer< T >, and options::internal::baseForMap< T >.

Definition at line 267 of file Options.h.

                                          {
            return false;
        };

Referenced by options::internal::positional_base::positional_base().

Here is the caller graph for this function:

fIsHidden()

bool options::base::fIsHidden ( ) const

protected

Definition at line 600 of file Options.cpp.

                               {
        return lHidden;
    }

References lHidden.

Referenced by options::parser::fPrintOptionHelp().

Here is the caller graph for this function:

fIsSet()

virtual bool options::base::fIsSet ( ) const

inlinevirtual

check if this option was set, regardless of from command line or config file

Reimplemented in options::internal::baseForContainer< T >, and options::internal::baseForMap< T >.

Definition at line 263 of file Options.h.

                                    {
            return ! lSource.fIsUnset();
        };

References options::internal::sourceItem::fIsUnset(), and lSource.

Referenced by dCapCfgTimePar< T >::applySingle(), davixCfgPar< struct timespec * >::applySingle(), davixCfgEnum< const Davix::RequestProtocol::Protocol >::applySingle(), davixCfgX509::applySingle(), followJsonRequestProvider::followStream(), messageQueue::kafka::init(), main(), libsshCommon::openSessions(), cmdLineRequestProvider::prepareMappings(), and followJsonRequestProvider::processJson().

Here is the call graph for this function:

Here is the caller graph for this function:

fRequire() [1/3]

void options::base::fRequire ( const base *  aOtherOption )

virtual

require aOtherOption when this option is set

Definition at line 611 of file Options.cpp.

                                                {
        lRequiredOptions.push_back(aOtherOption);
    }

References lRequiredOptions.

Referenced by davixCfgX509::davixCfgX509(), fRequire(), and main().

Here is the caller graph for this function:

fRequire() [2/3]

template<typename InputIt >

void options::base::fRequire ( InputIt  aBegin, InputIt  aEnd  )

inline

add all options from the pair of iterators [aBegin,aEnd) to the list of required options

Definition at line 247 of file Options.h.

                                                                                {
            for (auto it = aBegin; it != aEnd; ++it) {
                fRequire(*it);
            }
        }

References fRequire().

Here is the call graph for this function:

fRequire() [3/3]

void options::base::fRequire ( std::vector< const base * >  aOtherOptions )

virtual

add vector of other options, particlularly nice for use with initializer list

Definition at line 614 of file Options.cpp.

                                                            {
        lRequiredOptions.insert(lRequiredOptions.end(), aOtherOptions.cbegin(), aOtherOptions.cend());
    }

References lRequiredOptions.

fSetMe()

virtual void options::base::fSetMe ( std::istream &  aStream, const internal::sourceItem &  aSource  )

protectedpure virtual

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

Implemented in options::internal::OptionReadCfgFile< mayBeMissing >, options::internal::OptionWriteCfgFile, options::withAction< options::single< std::string > >, options::withAction< options::single< bool > >, options::container< T, Container >, options::container< std::string >, options::container< unsigned int >, options::container< T >, options::map< T, Container >, options::map< std::string, pathMapType >, options::map< std::string >, options::map< std::string, std::map< int, std::string > >, options::map< T >, options::single< bool >, options::single< T >, options::single< std::chrono::nanoseconds >, options::single< unsigned long >, options::single< std::chrono::duration< double > >, options::single< double >, options::single< std::string >, options::single< int >, options::single< unsigned int >, options::single< U >, options::single< options::postFixedNumber< size_t > >, options::single< copyRequest::clock_type::duration >, options::single< size_t >, options::single< unsigned >, options::single< std::chrono::seconds >, options::single< std::chrono::duration< Rep, Period > >, options::single< std::chrono::system_clock::time_point >, options::single< std::regex >, options::ForeignOption, and options::internal::OptionHelp.

Referenced by options::internal::baseForMap< std::string >::fAddDefaultFromStream(), options::internal::baseForContainer< unsigned int >::fAddDefaultFromStream(), and fHandleOption().

Here is the caller graph for this function:

fSetMeNoarg()

virtual void options::base::fSetMeNoarg ( const internal::sourceItem &  )

inlineprotectedvirtual

Reimplemented in options::internal::OptionHelp, options::withAction< options::single< std::string > >, options::withAction< options::single< bool > >, options::single< bool >, and options::ForeignOption.

Definition at line 218 of file Options.h.

{};

Referenced by fHandleOption().

Here is the caller graph for this function:

fSetPreserveWorthyStuff()

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

protected

Definition at line 591 of file Options.cpp.

                                                                   {
        lPreserveWorthyStuff = aStuff;
    }

References lPreserveWorthyStuff.

fSetSource()

void options::base::fSetSource ( const internal::sourceItem &  aSource )

protectedvirtual

remember the source that provided the value, e.g. commandline or a config file

Definition at line 561 of file Options.cpp.

                                                           {
        lSource = aSource;
    }

References lSource.

Referenced by options::single< std::regex >::fSetMe(), options::ForeignOption::fSetMe(), options::single< std::chrono::system_clock::time_point >::fSetMe(), options::single< std::chrono::duration< Rep, Period > >::fSetMe(), options::single< std::chrono::seconds >::fSetMe(), options::single< bool >::fSetMe(), options::ForeignOption::fSetMeNoarg(), and options::single< bool >::fSetMeNoarg().

Here is the caller graph for this function:

fWriteCfgLines()

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

protectedvirtual

Reimplemented in options::container< T, Container >, options::container< std::string >, options::container< unsigned int >, options::container< T >, options::map< T, Container >, options::map< std::string, pathMapType >, options::map< std::string >, options::map< std::string, std::map< int, std::string > >, options::map< T >, options::internal::OptionReadCfgFile< mayBeMissing >, options::internal::supressed< T >, options::internal::supressed< std::string >, and options::internal::supressed< bool >.

Definition at line 580 of file Options.cpp.

                                                                             {
        aStream << aPrefix << lLongName << "=";
        auto asOriginalStringKeeper = dynamic_cast<const originalStringKeeper*>(this);
        if (asOriginalStringKeeper) {
            asOriginalStringKeeper->fWriteOriginalString(aStream);
        } else {
            fWriteValue(aStream);
        }
        aStream << "\n";
    }

References options::originalStringKeeper::fWriteOriginalString(), fWriteValue(), and lLongName.

Referenced by options::internal::supressed< bool >::fWriteCfgLines(), and options::internal::OptionReadCfgFile< mayBeMissing >::fWriteCfgLines().

Here is the call graph for this function:

Here is the caller graph for this function:

fWriteRange()

virtual void options::base::fWriteRange ( std::ostream &  ) const

inlineprotectedvirtual

Reimplemented in options::internal::typed_base< T, forceRangeValueTypeString >, options::internal::typed_base< std::chrono::nanoseconds >, options::internal::typed_base< std::chrono::system_clock::time_point >, options::internal::typed_base< unsigned long >, options::internal::typed_base< std::chrono::duration< double > >, options::internal::typed_base< double >, options::internal::typed_base< std::string >, options::internal::typed_base< int >, options::internal::typed_base< unsigned int >, options::internal::typed_base< T >, options::internal::typed_base< U >, options::internal::typed_base< options::postFixedNumber< size_t > >, options::internal::typed_base< copyRequest::clock_type::duration >, options::internal::typed_base< size_t >, options::internal::typed_base< std::regex, true >, options::internal::typed_base< unsigned >, options::internal::typed_base< std::chrono::duration< Rep, Period > >, options::internal::typed_base< std::chrono::seconds >, and options::single< std::chrono::system_clock::time_point >.

Definition at line 226 of file Options.h.

{};

Referenced by options::parser::fParse().

Here is the caller graph for this function:

fWriteValue()

virtual void options::base::fWriteValue ( std::ostream &  aStream ) const

pure virtual

write textual representation of value to a std::ostream

Implemented in options::container< T, Container >, options::container< std::string >, options::container< unsigned int >, options::container< T >, options::map< T, Container >, options::map< std::string, pathMapType >, options::map< std::string >, options::map< std::string, std::map< int, std::string > >, options::map< T >, options::single< bool >, options::single< T >, options::single< std::chrono::nanoseconds >, options::single< unsigned long >, options::single< std::chrono::duration< double > >, options::single< double >, options::single< std::string >, options::single< int >, options::single< unsigned int >, options::single< U >, options::single< options::postFixedNumber< size_t > >, options::single< copyRequest::clock_type::duration >, options::single< size_t >, options::single< unsigned >, options::single< std::chrono::seconds >, options::single< std::chrono::duration< Rep, Period > >, options::single< std::chrono::system_clock::time_point >, listOption< T >, options::ForeignOption, mapOption< T >, options::single< std::regex >, and arrayOption< T >.

Referenced by options::parser::fPrintOptionHelp(), and fWriteCfgLines().

Here is the caller graph for this function:

Friends And Related Function Documentation

parser

friend class parser

friend

Definition at line 194 of file Options.h.

Member Data Documentation

lExplanation

const std::string options::base::lExplanation

protected

Definition at line 207 of file Options.h.

Referenced by options::parser::fPrintOptionHelp().

lForbiddenOptions

std::vector<const base*> options::base::lForbiddenOptions

protected

Definition at line 214 of file Options.h.

Referenced by fForbid(), and options::parser::fPrintOptionHelp().

lHidden

bool options::base::lHidden

protected

Definition at line 210 of file Options.h.

Referenced by fHide(), and fIsHidden().

lLongName

const std::string options::base::lLongName

protected

Definition at line 206 of file Options.h.

Referenced by base(), fDisable(), fGetLongName(), options::parser::fPrintOptionHelp(), fWriteCfgLines(), options::map< T >::fWriteCfgLines(), and options::container< T >::fWriteCfgLines().

lNargs

short options::base::lNargs

protected

Definition at line 209 of file Options.h.

Referenced by options::ForeignOption::fAddArgs(), and fHandleOption().

lPreserveWorthyStuff

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

protected

Definition at line 211 of file Options.h.

Referenced by base(), fSetPreserveWorthyStuff(), and ~base().

lRequiredOptions

std::vector<const base*> options::base::lRequiredOptions

protected

Definition at line 213 of file Options.h.

Referenced by options::parser::fPrintOptionHelp(), and fRequire().

lShortName

char options::base::lShortName

protected

Definition at line 203 of file Options.h.

Referenced by base(), fDisable(), and options::parser::fPrintOptionHelp().

lSource

internal::sourceItem options::base::lSource

protected

Definition at line 208 of file Options.h.

Referenced by fIsSet(), and fSetSource().

---

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

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