#include <CLI11.hpp>

Collaboration diagram for CLI::OptionBase< CRTP >:

Public Member Functions
CRTP *	group (const std::string &name)
	Changes the group membership.

CRTP *	required (bool value=true)
	Set the option as required.

CRTP *	mandatory (bool value=true)
	Support Plumbum term.

CRTP *	always_capture_default (bool value=true)

const std::string &	get_group () const
	Get the group of this option.

bool	get_required () const
	True if this is a required option.

bool	get_ignore_case () const
	The status of ignore case.

bool	get_ignore_underscore () const
	The status of ignore_underscore.

bool	get_configurable () const
	The status of configurable.

bool	get_disable_flag_override () const
	The status of configurable.

char	get_delimiter () const
	Get the current delimiter char.

bool	get_always_capture_default () const
	Return true if this will automatically capture the default value for help printing.

MultiOptionPolicy	get_multi_option_policy () const
	The status of the multi option policy.

CRTP *	take_last ()
	Set the multi option policy to take last.

CRTP *	take_first ()
	Set the multi option policy to take last.

CRTP *	take_all ()
	Set the multi option policy to take all arguments.

CRTP *	join ()
	Set the multi option policy to join.

CRTP *	join (char delim)
	Set the multi option policy to join with a specific delimiter.

CRTP *	configurable (bool value=true)
	Allow in a configuration file.

CRTP *	delimiter (char value='\0')
	Allow in a configuration file.

Protected Member Functions
template<typename T >
void	copy_to (T *other) const
	Copy the contents to another similar class (one based on OptionBase)

Protected Attributes
std::string	group_ = std::string("Options")
	The group membership.

bool	required_ {false}
	True if this is a required option.

bool	ignore_case_ {false}
	Ignore the case when matching (option, not value)

bool	ignore_underscore_ {false}
	Ignore underscores when matching (option, not value)

bool	configurable_ {true}
	Allow this option to be given in a configuration file.

bool	disable_flag_override_ {false}
	Disable overriding flag values with '=value'.

char	delimiter_ {'\0'}
	Specify a delimiter character for vector arguments.

bool	always_capture_default_ {false}
	Automatically capture default value.

MultiOptionPolicy	multi_option_policy_ {MultiOptionPolicy::Throw}
	Policy for handling multiple arguments beyond the expected Max.

Detailed Description

template<typename CRTP>
class CLI::OptionBase< CRTP >

This is the CRTP base class for Option and OptionDefaults. It was designed this way to share parts of the class; an OptionDefaults can copy to an Option.

Definition at line 3346 of file CLI11.hpp.

Member Function Documentation

◆ always_capture_default()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::always_capture_default ( bool value = true )

inline

Definition at line 3408 of file CLI11.hpp.

                                                    {
        always_capture_default_ = value;
        return static_cast<CRTP *>(this);
    }

◆ configurable()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::configurable ( bool value = true )

inline

Definition at line 3481 of file CLI11.hpp.

                                          {
        configurable_ = value;
        return static_cast<CRTP *>(this);
    }

Here is the caller graph for this function:

◆ copy_to()

template<typename CRTP >

template<typename T >

void CLI::OptionBase< CRTP >::copy_to ( T * other ) const

inlineprotected

Definition at line 3378 of file CLI11.hpp.

                                                       {
        other->group(group_);
        other->required(required_);
        other->ignore_case(ignore_case_);
        other->ignore_underscore(ignore_underscore_);
        other->configurable(configurable_);
        other->disable_flag_override(disable_flag_override_);
        other->delimiter(delimiter_);
        other->always_capture_default(always_capture_default_);
        other->multi_option_policy(multi_option_policy_);
    }

◆ delimiter()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::delimiter ( char value = '\0' )

inline

Definition at line 3487 of file CLI11.hpp.

                                       {
        delimiter_ = value;
        return static_cast<CRTP *>(this);
    }

Here is the caller graph for this function:

◆ get_always_capture_default()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_always_capture_default ( ) const

inline

Definition at line 3437 of file CLI11.hpp.

3437{ return always_capture_default_; }

◆ get_configurable()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_configurable ( ) const

inline

Definition at line 3428 of file CLI11.hpp.

3428{ return configurable_; }

Here is the caller graph for this function:

◆ get_delimiter()

template<typename CRTP >

char CLI::OptionBase< CRTP >::get_delimiter ( ) const

inline

Definition at line 3434 of file CLI11.hpp.

3434{ return delimiter_; }

◆ get_disable_flag_override()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_disable_flag_override ( ) const

inline

Definition at line 3431 of file CLI11.hpp.

3431{ return disable_flag_override_; }

◆ get_group()

template<typename CRTP >

const std::string & CLI::OptionBase< CRTP >::get_group ( ) const

inline

Definition at line 3416 of file CLI11.hpp.

3416{ return group_; }

Here is the caller graph for this function:

◆ get_ignore_case()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_ignore_case ( ) const

inline

Definition at line 3422 of file CLI11.hpp.

3422{ return ignore_case_; }

◆ get_ignore_underscore()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_ignore_underscore ( ) const

inline

Definition at line 3425 of file CLI11.hpp.

3425{ return ignore_underscore_; }

◆ get_multi_option_policy()

template<typename CRTP >

MultiOptionPolicy CLI::OptionBase< CRTP >::get_multi_option_policy ( ) const

inline

Definition at line 3440 of file CLI11.hpp.

3440{ return multi_option_policy_; }

◆ get_required()

template<typename CRTP >

bool CLI::OptionBase< CRTP >::get_required ( ) const

inline

Definition at line 3419 of file CLI11.hpp.

3419{ return required_; }

Here is the caller graph for this function:

◆ group()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::group ( const std::string & name )

inline

Definition at line 3394 of file CLI11.hpp.

                                       {
        group_ = name;
        return static_cast<CRTP *>(this);
    }

◆ join() [1/2]

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::join ( )

inline

Definition at line 3466 of file CLI11.hpp.

                 {
        auto self = static_cast<CRTP *>(this);
        self->multi_option_policy(MultiOptionPolicy::Join);
        return self;
    }

◆ join() [2/2]

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::join ( char delim )

inline

Definition at line 3473 of file CLI11.hpp.

                           {
        auto self = static_cast<CRTP *>(this);
        self->delimiter_ = delim;
        self->multi_option_policy(MultiOptionPolicy::Join);
        return self;
    }

◆ mandatory()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::mandatory ( bool value = true )

inline

Definition at line 3406 of file CLI11.hpp.

3406{ return required(value); }

CLI::OptionBase::required

CRTP * required(bool value=true)

Set the option as required.

Definition CLI11.hpp:3400

Here is the call graph for this function:

◆ required()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::required ( bool value = true )

inline

Definition at line 3400 of file CLI11.hpp.

                                      {
        required_ = value;
        return static_cast<CRTP *>(this);
    }

Here is the caller graph for this function:

◆ take_all()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::take_all ( )

inline

Definition at line 3459 of file CLI11.hpp.

                     {
        auto self = static_cast<CRTP *>(this);
        self->multi_option_policy(MultiOptionPolicy::TakeAll);
        return self;
    }

◆ take_first()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::take_first ( )

inline

Definition at line 3452 of file CLI11.hpp.

                       {
        auto self = static_cast<CRTP *>(this);
        self->multi_option_policy(MultiOptionPolicy::TakeFirst);
        return self;
    }

◆ take_last()

template<typename CRTP >

CRTP * CLI::OptionBase< CRTP >::take_last ( )

inline

Definition at line 3445 of file CLI11.hpp.

                      {
        auto self = static_cast<CRTP *>(this);
        self->multi_option_policy(MultiOptionPolicy::TakeLast);
        return self;
    }

CLI::MultiOptionPolicy::Throw

@ Throw

Throw an error if any extra arguments were given.

◆ required_

template<typename CRTP >

bool CLI::OptionBase< CRTP >::required_ {false}

protected

Definition at line 3354 of file CLI11.hpp.

3354{false};

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

programs/clio/CLI11.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ always_capture_default()

◆ configurable()

◆ copy_to()

◆ delimiter()

◆ get_always_capture_default()

◆ get_configurable()

◆ get_delimiter()

◆ get_disable_flag_override()

◆ get_group()

◆ get_ignore_case()

◆ get_ignore_underscore()

◆ get_multi_option_policy()

◆ get_required()

◆ group()

◆ join() [1/2]

◆ join() [2/2]

◆ mandatory()

◆ required()

◆ take_all()

◆ take_first()

◆ take_last()

Member Data Documentation

◆ always_capture_default_

◆ configurable_

◆ delimiter_

◆ disable_flag_override_

◆ group_

◆ ignore_case_

◆ ignore_underscore_

◆ multi_option_policy_

◆ required_