paludis::args::IntegerArg Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::IntegerArg:

Public Member Functions
	IntegerArg (ArgsGroup *const, const std::string &long_name, const char short_name, const std::string &description)
int	argument () const
void	set_argument (const int arg)
bool	can_be_negated () const override
const std::string	forwardable_string () const override PALUDIS_ATTRIBUTE((warn_unused_result))
const std::shared_ptr< Sequence< std::string > >	forwardable_args () const override PALUDIS_ATTRIBUTE((warn_unused_result))
Public Member Functions inherited from paludis::args::ArgsOption
void	remove ()
const std::string &	long_name () const
char	short_name () const
const std::string &	description () const
virtual bool	specified () const
virtual bool	explicitly_specified () const
virtual void	set_specified (const ArgsOptionSpecifiedness value)
ArgsGroup *	group ()
Public Member Functions inherited from paludis::DeclareAbstractAcceptMethods< ArgsOption, MakeTypeList< StringArg, AliasArg, SwitchArg, IntegerArg, EnumArg, StringSetArg, StringSequenceArg >::Type >
void	accept (UnwrappedVisitor_ &v)
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_())
auto	make_accept_returning (const Case_ &firstcase, const Cases_ &... cases) const -> CallResultType< Case_ >
void	make_accept (const Cases_ &... cases) const
Public Member Functions inherited from paludis::DeclareAbstractAcceptMethods< ArgsOption, ArgsOption::VisitableTypeList >
void	accept (UnwrappedVisitor_ &v)
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_())
auto	make_accept_returning (const Case_ &firstcase, const Cases_ &... cases) const -> CallResultType< Case_ >
void	make_accept (const Cases_ &... cases) const

Additional Inherited Members
Public Types inherited from paludis::DeclareAbstractAcceptMethods< ArgsOption, MakeTypeList< StringArg, AliasArg, SwitchArg, IntegerArg, EnumArg, StringSetArg, StringSequenceArg >::Type >
typedef MakeTypeList< StringArg, AliasArg, SwitchArg, IntegerArg, EnumArg, StringSetArg, StringSequenceArg >::Type	VisitableTypeList
typedef ArgsOption	VisitableBaseClass
Public Types inherited from paludis::DeclareAbstractAcceptMethods< ArgsOption, ArgsOption::VisitableTypeList >
typedef ArgsOption::VisitableTypeList	VisitableTypeList
typedef ArgsOption	VisitableBaseClass
Protected Member Functions inherited from paludis::args::ArgsOption
	ArgsOption (ArgsGroup *const, const std::string &long_name, const char short_name, const std::string &description)
virtual	~ArgsOption ()=default

Detailed Description

An option that takes an integer argument.

Constructor & Destructor Documentation

IntegerArg()

paludis::args::IntegerArg::IntegerArg	(	ArgsGroup * const	,
		const std::string &	long_name,
		const char	short_name,
		const std::string &	description )

Constructor

References paludis::args::ArgsOption::description(), paludis::args::ArgsOption::long_name(), and paludis::args::ArgsOption::short_name().

Member Function Documentation

argument()

int paludis::args::IntegerArg::argument ( ) const

inline

Fetch the argument that was given to this option.

can_be_negated()

bool paludis::args::IntegerArg::can_be_negated ( ) const

overridevirtual

Can we be negated?

Needs to match up with ArgsVisitor logic.

Implements paludis::args::ArgsOption.

forwardable_args()

const std::shared_ptr< Sequence< std::string > > paludis::args::IntegerArg::forwardable_args ( ) const

overridevirtual

Ourself as a sequence of strings.

For example, { '–foo', 'bar' } or { '–foo', 'bar', '–foo', 'baz' } if not specified, an empty sequence.

Since

0.46

Implements paludis::args::ArgsOption.

References forwardable_args(), and PALUDIS_ATTRIBUTE.

Referenced by forwardable_args().

forwardable_string()

const std::string paludis::args::IntegerArg::forwardable_string ( ) const

overridevirtual

Ourself as a forwardable string.

For example, '–foo bar' or '–foo bar –foo baz' or '–foo', or if not specified, the empty string.

Since

0.40

Implements paludis::args::ArgsOption.

References PALUDIS_ATTRIBUTE.

set_argument()

void paludis::args::IntegerArg::set_argument ( const int arg )

inline

Set the argument returned by argument().

---

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

• /var/tmp/paludis/build/sys-apps-paludis-scm-r1/work/paludis-scm/paludis/args/args_option.hh