Option< T > Class Template Reference

#include <CommandLine.h>

Inheritance diagram for Option< T >:

Public Member Functions
	Option (const std::string &name, const std::string &description, T init)
virtual bool	canSet (void) const override
	Can this option be set?
virtual bool	parseAndSetValue (const std::string s) override
	From a given string, set the value of this option.
virtual bool	isBool (void) const override
void	setValue (T v)
bool	isSet (void) const
T	operator() (void) const

Static Private Member Functions
static bool	fromString (const std::string &s, bool &value)
static bool	fromString (const std::string s, std::string &value)
static bool	fromString (const std::string s, u32_t &value)

Private Attributes
bool	isExplicitlySet
T	value

Additional Inherited Members
Static Public Member Functions inherited from OptionBase
static std::vector< std::string >	parseOptions (int argc, char *argv[], std::string description, std::string callFormat)
Protected Types inherited from OptionBase
typedef std::pair< std::string, std::string >	PossibilityDescription
	Name/description pairs.
typedef std::vector< std::pair< std::string, std::string > >	PossibilityDescriptions
template<typename T >
using	OptionPossibility = std::tuple< T, std::string, std::string >
Protected Member Functions inherited from OptionBase
	OptionBase (std::string name, std::string description)
	OptionBase (std::string name, std::string description, PossibilityDescriptions possibilityDescriptions)
virtual bool	isMultiple (void) const
	Whether this option is an OptionMultiple.
Static Protected Member Functions inherited from OptionBase
template<typename T >
static PossibilityDescriptions	extractPossibilityDescriptions (const std::vector< OptionPossibility< T > > possibilities)
static std::map< std::string, OptionBase * > &	getOptionsMap (void)
Protected Attributes inherited from OptionBase
std::string	name
std::string	description
PossibilityDescriptions	possibilityDescriptions
	For when we have possibilities like in an OptionMap.

Detailed Description

template<typename T>
class Option< T >

General -name=value options. Retrieve value by Opt().

Definition at line 325 of file CommandLine.h.

Constructor & Destructor Documentation

Option()

template<typename T >

Option< T >::Option ( const std::string &  name, const std::string &  description, T  init  )

inline

Definition at line 328 of file CommandLine.h.

        : OptionBase(name, description), isExplicitlySet(false), value(init)
    {
        assert(!name.empty() && "Option: empty option name given");
    }

Member Function Documentation

canSet()

template<typename T >

virtual bool Option< T >::canSet ( void  ) const

inlineoverridevirtual

Can this option be set?

Implements OptionBase.

Definition at line 334 of file CommandLine.h.

    {
        // Don't allow duplicates.
        return !isExplicitlySet;
    }

fromString() [1/3]

template<typename T >

static bool Option< T >::fromString ( const std::string &  s, bool &  value  )

inlinestaticprivate

Definition at line 368 of file CommandLine.h.

    {
        if (s == "true")
            value = true;
        else if (s == "false")
            value = false;
        else
            return false;
        return true;
    }

fromString() [2/3]

template<typename T >

static bool Option< T >::fromString ( const std::string  s, std::string &  value  )

inlinestaticprivate

Definition at line 380 of file CommandLine.h.

    {
        value = s;
        return true;
    }

fromString() [3/3]

template<typename T >

static bool Option< T >::fromString ( const std::string  s, u32_t &  value  )

inlinestaticprivate

Definition at line 387 of file CommandLine.h.

    {
        // We won't allow anything except [0-9]+.
        if (s.empty()) return false;
        for (char c : s)
        {
            if (!(c >= '0' && c <= '9')) return false;
        }
 
        // Use strtoul because we're not using exceptions.
        assert(sizeof(unsigned long) >= sizeof(u32_t));
        const unsigned long sv = std::strtoul(s.c_str(), nullptr, 10);
 
        // Out of range according to strtoul, or according to us compared to u32_t.
        if (errno == ERANGE || sv > std::numeric_limits<u32_t>::max()) return false;
        value = sv;
        return true;
    }

isBool()

template<typename T >

virtual bool Option< T >::isBool ( void  ) const

inlineoverridevirtual

Whether this option represents a boolean. Important as such arguments don't require a value.

Reimplemented from OptionBase.

Definition at line 346 of file CommandLine.h.

    {
        return std::is_same<T, bool>::value;
    }

isSet()

template<typename T >

bool Option< T >::isSet ( void  ) const

inline

Definition at line 356 of file CommandLine.h.

    {
        return isExplicitlySet;
    }

operator()()

template<typename T >

T Option< T >::operator() ( void  ) const

inline

Definition at line 361 of file CommandLine.h.

    {
        return value;
    }

parseAndSetValue()

template<typename T >

virtual bool Option< T >::parseAndSetValue ( const std::string  value )

inlineoverridevirtual

From a given string, set the value of this option.

Implements OptionBase.

Definition at line 340 of file CommandLine.h.

    {
        isExplicitlySet = fromString(s, value);
        return isExplicitlySet;
    }

setValue()

template<typename T >

void Option< T >::setValue ( T  v )

inline

Definition at line 351 of file CommandLine.h.

    {
        value = v;
    }

Member Data Documentation

isExplicitlySet

template<typename T >

bool Option< T >::isExplicitlySet

private

Definition at line 407 of file CommandLine.h.

value

template<typename T >

T Option< T >::value

private

Definition at line 408 of file CommandLine.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/CommandLine.h