paludis::args::AliasArg Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::AliasArg:

Public Member Functions
	AliasArg (ArgsOption *const other, const std::string &new_long_name, bool is_hidden=false)
virtual bool	specified () const
virtual bool	explicitly_specified () const
virtual void	set_specified (const ArgsOptionSpecifiedness value)
virtual bool	hidden () const
virtual void	set_hidden (const bool value)
ArgsOption *	other () const
virtual bool	can_be_negated () const
virtual const std::string	forwardable_string () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual const std::shared_ptr< Sequence< std::string > >	forwardable_args () const 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
ArgsGroup *	group ()
Public Member Functions inherited from paludis::DeclareAbstractAcceptMethods< ArgsOption, MakeTypeList< StringArg, AliasArg, SwitchArg, IntegerArg, EnumArg, StringSetArg, StringSequenceArg >::Type >
void	accept (UnwrappedVisitor_ &v)
void	accept (UnwrappedVisitor_ &v) const
void	accept (const UnwrappedVisitor_ &v)
void	accept (const UnwrappedVisitor_ &v) const
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_())
Result_	accept_returning (const UnwrappedVisitor_ &v, const Result_ &r=Result_())
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_()) const
Result_	accept_returning (const UnwrappedVisitor_ &v, const Result_ &r=Result_()) const
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)
void	accept (UnwrappedVisitor_ &v) const
void	accept (const UnwrappedVisitor_ &v)
void	accept (const UnwrappedVisitor_ &v) const
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_())
Result_	accept_returning (const UnwrappedVisitor_ &v, const Result_ &r=Result_())
Result_	accept_returning (UnwrappedVisitor_ &v, const Result_ &r=Result_()) const
Result_	accept_returning (const UnwrappedVisitor_ &v, const Result_ &r=Result_()) const
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 ()

Detailed Description

An AliasArg is an alias for another argument.

Constructor & Destructor Documentation

paludis::args::AliasArg::AliasArg	(	ArgsOption *const	other,
		const std::string &	new_long_name,
		bool	is_hidden = false
	)

Constructor.

Member Function Documentation

virtual bool paludis::args::AliasArg::can_be_negated ( ) const

virtual

Can we be negated?

Needs to match up with ArgsVisitor logic.

Implements paludis::args::ArgsOption.

virtual bool paludis::args::AliasArg::explicitly_specified ( ) const

inlinevirtual

Fetch whether or not we were explicitly (not an env var) specified. Used to catch -x y -x z where -x takes a single value.

Reimplemented from paludis::args::ArgsOption.

References paludis::args::ArgsOption::explicitly_specified().

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

virtual

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.

virtual const std::string paludis::args::AliasArg::forwardable_string ( ) const

virtual

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.

ArgsOption* paludis::args::AliasArg::other ( ) const

inline

Fetch our associated option.

References PALUDIS_ATTRIBUTE.

virtual void paludis::args::AliasArg::set_specified ( const ArgsOptionSpecifiedness  value )

inlinevirtual

Set the value returned by specified().

Reimplemented from paludis::args::ArgsOption.

References paludis::args::ArgsOption::set_specified().

virtual bool paludis::args::AliasArg::specified ( ) const

inlinevirtual

Fetch whether or not we were specified on the command line (or as an env var).

Reimplemented from paludis::args::ArgsOption.

References paludis::args::ArgsOption::specified().

---

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

• /mnt/home/bo/scm/paludis/paludis/paludis/args/args_option.hh