paludis: paludis::ChoiceValue Class Reference

paludis Version 3.0.2

The one true package mangler

#include <choice.hh>

Inheritance diagram for paludis::ChoiceValue:

Properties
virtual const UnprefixedChoiceName	unprefixed_name () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const ChoiceNameWithPrefix	name_with_prefix () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	enabled () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	enabled_by_default () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	presumed () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	locked () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string	description () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual ChoiceOrigin	origin () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string	parameter () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::shared_ptr< const PermittedChoiceValueParameterValues >	permitted_parameter_values () const PALUDIS_ATTRIBUTE((warn_unused_result))=0

Detailed Description

An individial Value in a ChoiceValue.

For example, the 'nls' flag in 'USE'.

Some choice values have an associated parameter. For example, build_options:jobs=4.

Since: 0.32

Member Function Documentation

◆ description()

virtual const std::string paludis::ChoiceValue::description ( ) const

pure virtual

The flag's description, or an empty string.

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References description(), and PALUDIS_ATTRIBUTE.

Referenced by description().

◆ enabled()

virtual bool paludis::ChoiceValue::enabled ( ) const

pure virtual

Is this flag enabled?

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References enabled(), and PALUDIS_ATTRIBUTE.

Referenced by enabled().

◆ enabled_by_default()

virtual bool paludis::ChoiceValue::enabled_by_default ( ) const

pure virtual

Would this flag be enabled by default (i.e. before considering any overrides from the Environment)?

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References enabled_by_default(), and PALUDIS_ATTRIBUTE.

Referenced by enabled_by_default().

◆ locked()

virtual bool paludis::ChoiceValue::locked ( ) const

pure virtual

Is this flag locked (forced or masked)?

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References locked(), and PALUDIS_ATTRIBUTE.

Referenced by locked().

◆ name_with_prefix()

virtual const ChoiceNameWithPrefix paludis::ChoiceValue::name_with_prefix ( ) const

pure virtual

Our name, with prefix if there is one (for example, 'nls' or 'linguas_en').

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References name_with_prefix(), and PALUDIS_ATTRIBUTE.

Referenced by name_with_prefix().

◆ origin()

virtual ChoiceOrigin paludis::ChoiceValue::origin ( ) const

pure virtual

The origin of this choice.

Since: 0.66

Use this to avoid showing things like LINGUAS values that aren't listed in IUSE but that end up as a ChoiceValue anyway.

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References origin(), and PALUDIS_ATTRIBUTE.

Referenced by origin().

◆ parameter()

virtual const std::string paludis::ChoiceValue::parameter ( ) const

pure virtual

This flag's parameter, or an empty string if it doesn't have one.

Since: 0.40

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References PALUDIS_ATTRIBUTE, and parameter().

Referenced by parameter().

◆ permitted_parameter_values()

virtual const std::shared_ptr< const PermittedChoiceValueParameterValues > paludis::ChoiceValue::permitted_parameter_values ( ) const

pure virtual

Permitted values for this flag's parameter, or null if there is no parameter.

Since: 0.59

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References PALUDIS_ATTRIBUTE, PALUDIS_VISIBLE, and permitted_parameter_values().

Referenced by permitted_parameter_values().

◆ presumed()

virtual bool paludis::ChoiceValue::presumed ( ) const

pure virtual

Does this flag have to be explicitly accepted when doing matching?

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References PALUDIS_ATTRIBUTE, and presumed().

Referenced by presumed().

◆ unprefixed_name()

virtual const UnprefixedChoiceName paludis::ChoiceValue::unprefixed_name ( ) const

pure virtual

Our name, without an prefix (for example, 'nls' or 'en').

Implemented in paludis::ELikeDwarfCompressionChoiceValue, paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSymbolsChoiceValue, paludis::ELikeTraceChoiceValue, and paludis::ELikeWorkChoiceValue.

References PALUDIS_ATTRIBUTE.

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

/var/tmp/paludis/build/sys-apps-paludis-scm-r1/work/paludis-scm/paludis/choice.hh