#include <environment_implementation.hh>

Inheritance diagram for paludis::EnvironmentImplementation:

Public Member Functions
std::shared_ptr< const FSPathSequence >	bashrc_files () const override PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const FSPathSequence >	syncers_dirs () const override PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const FSPathSequence >	fetchers_dirs () const override PALUDIS_ATTRIBUTE((warn_unused_result))
std::string	distribution () const override PALUDIS_ATTRIBUTE((warn_unused_result))
bool	is_paludis_package (const QualifiedPackageName &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< PackageIDSequence >	operator[] (const Selection &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
NotifierCallbackID	add_notifier_callback (const NotifierCallbackFunction &) override
void	remove_notifier_callback (const NotifierCallbackID) override
void	trigger_notifier_callback (const NotifierCallbackEvent &) const override
void	add_set (const SetName &, const SetName &, const std::function< std::shared_ptr< const SetSpecTree >()> &, const bool combine) const override
std::shared_ptr< const SetNameSet >	set_names () const override PALUDIS_ATTRIBUTE((warn_unused_result))
const std::shared_ptr< const SetSpecTree >	set (const SetName &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
void	add_repository (int importance, const std::shared_ptr< Repository > &) override
const std::shared_ptr< const Repository >	fetch_repository (const RepositoryName &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
const std::shared_ptr< Repository >	fetch_repository (const RepositoryName &) override PALUDIS_ATTRIBUTE((warn_unused_result))
bool	has_repository_named (const RepositoryName &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
QualifiedPackageName	fetch_unique_qualified_package_name (const PackageNamePart &, const Filter &=all_filter(), const bool disambiguate=true) const override PALUDIS_ATTRIBUTE((warn_unused_result))
bool	more_important_than (const RepositoryName &, const RepositoryName &) const override PALUDIS_ATTRIBUTE((warn_unused_result))
RepositoryConstIterator	begin_repositories () const override PALUDIS_ATTRIBUTE((warn_unused_result))
RepositoryConstIterator	end_repositories () const override PALUDIS_ATTRIBUTE((warn_unused_result))
const std::shared_ptr< const Set< std::string > >	expand_licence (const std::string &) const override
Public Member Functions inherited from paludis::Environment
virtual const std::shared_ptr< Repository >	repository_from_new_config_file (const FSPath &) PALUDIS_ATTRIBUTE((warn_unused_result))=0
IteratorRange< RepositoryConstIterator >	repositories () const
	Environment (const Environment &)=delete
Environment &	operator= (const Environment &)=delete
virtual const Tribool	want_choice_enabled (const std::shared_ptr< const PackageID > &, const std::shared_ptr< const Choice > &, const UnprefixedChoiceName &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string	value_for_choice_parameter (const std::shared_ptr< const PackageID > &, const std::shared_ptr< const Choice > &, const UnprefixedChoiceName &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual std::shared_ptr< const Set< UnprefixedChoiceName > >	known_choice_value_names (const std::shared_ptr< const PackageID > &, const std::shared_ptr< const Choice > &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual Tribool	interest_in_suggestion (const std::shared_ptr< const PackageID > &from_id, const PackageDepSpec &spec) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	accept_license (const std::string &, const std::shared_ptr< const PackageID > &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	accept_keywords (const std::shared_ptr< const KeywordNameSet > &, const std::shared_ptr< const PackageID > &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::shared_ptr< const Mask >	mask_for_user (const std::shared_ptr< const PackageID > &, const bool will_be_used_for_overridden) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	unmasked_by_user (const std::shared_ptr< const PackageID > &, const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual std::shared_ptr< const FSPathSequence >	hook_dirs () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual std::string	reduced_username () const =0
virtual uid_t	reduced_uid () const =0
virtual gid_t	reduced_gid () const =0
virtual std::shared_ptr< const MirrorsSequence >	mirrors (const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual HookResult	perform_hook (const Hook &, const std::shared_ptr< OutputManager > &optional_output_manager) const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool	add_to_world (const QualifiedPackageName &) const =0
virtual bool	add_to_world (const SetName &) const =0
virtual bool	remove_from_world (const QualifiedPackageName &) const =0
virtual bool	remove_from_world (const SetName &) const =0
virtual void	update_config_files_for_package_move (const PackageDepSpec &, const QualifiedPackageName &) const =0
virtual const std::shared_ptr< const MetadataValueKey< FSPath > >	preferred_root_key () const =0
virtual const std::shared_ptr< const MetadataValueKey< FSPath > >	system_root_key () const =0
virtual const std::shared_ptr< const MetadataValueKey< std::string > >	format_key () const =0
virtual const std::shared_ptr< const MetadataValueKey< FSPath > >	config_location_key () const =0
virtual const std::shared_ptr< OutputManager >	create_output_manager (const CreateOutputManagerInfo &) const =0
MetadataConstIterator	begin_metadata () const PALUDIS_ATTRIBUTE((warn_unused_result))
MetadataConstIterator	end_metadata () const PALUDIS_ATTRIBUTE((warn_unused_result))
IteratorRange< MetadataConstIterator >	metadata () const
MetadataConstIterator	find_metadata (const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result))

Protected Member Functions
virtual void	populate_sets () const =0
virtual void	populate_standard_sets () const
void	set_always_exists (const SetName &) const
Protected Member Functions inherited from paludis::MetadataKeyHolder
virtual void	add_metadata_key (const std::shared_ptr< const MetadataKey > &) const
virtual void	clear_metadata_keys () const
virtual void	need_keys_added () const =0

Additional Inherited Members
typedef WrappedForwardIterator< RepositoryConstIteratorTag, const std::shared_ptr< Repository > >	RepositoryConstIterator
typedef WrappedForwardIterator< MetadataConstIteratorTag, const std::shared_ptr< const MetadataKey > >	MetadataConstIterator
Static Protected Member Functions inherited from paludis::Environment
static const Filter &	all_filter () PALUDIS_ATTRIBUTE((warn_unused_result))

Detailed Description

Simplifies implementing the Environment interface.

Most Environment subclasses derive from this class, rather than directly from the abstract base. It provides default implementations for many methods.

See also: Environment

Member Function Documentation

◆ add_notifier_callback()

NotifierCallbackID paludis::EnvironmentImplementation::add_notifier_callback ( const NotifierCallbackFunction & )

overridevirtual

Set a callback function to use when a particular event occurs.

The return value can be passed to remove_notifier_callback.

Since: 0.40

Implements paludis::Environment.

References add_notifier_callback().

Referenced by add_notifier_callback().

◆ add_repository()

void paludis::EnvironmentImplementation::add_repository	(	int	importance,
		const std::shared_ptr< Repository > &	)

overridevirtual

Add a repository.

Since: 0.61 is in Environment rather than PackageDatabase

Exceptions

DuplicateRepositoryError if a Repository with the same name as the new Repository already exists in our collection.

Implements paludis::Environment.

References add_repository().

Referenced by add_repository().

◆ add_set()

void paludis::EnvironmentImplementation::add_set	(	const SetName &	base_name,
		const SetName &	combined_name,
		const std::function< std::shared_ptr< const SetSpecTree >()> &	func,
		const bool	combine ) const

overridevirtual

Add a package set.

Generally called by repositories, when Repository::populate_sets is called.

Parameters

base_name	The basic name of the set, such as 'security'.
combined_name	The name to use for this set when combine is true, such as 'security.myrepo'. If combine is false, should be the same as base_name.
func	A function that returns the set.
combine	If true, rename the set from foo to foo.reponame, and make the foo set contain foo.reponame, along with any other repositories' sets named foo. If false, throw if the set already exists.

Since: 0.40

Implements paludis::Environment.

References add_set().

Referenced by add_set().

◆ bashrc_files()

std::shared_ptr< const FSPathSequence > paludis::EnvironmentImplementation::bashrc_files ( ) const

overridevirtual

Return a collection of bashrc files to be used by the various components that are implemented in bash.

Implements paludis::Environment.

References PALUDIS_ATTRIBUTE.

◆ begin_repositories()

RepositoryConstIterator paludis::EnvironmentImplementation::begin_repositories ( ) const

overridevirtual

Implements paludis::Environment.

◆ distribution()

std::string paludis::EnvironmentImplementation::distribution ( ) const

overridevirtual

Implements paludis::Environment.

◆ end_repositories()

RepositoryConstIterator paludis::EnvironmentImplementation::end_repositories ( ) const

overridevirtual

Implements paludis::Environment.

◆ expand_licence()

const std::shared_ptr< const Set< std::string > > paludis::EnvironmentImplementation::expand_licence ( const std::string & ) const

overridevirtual

Expand a licence group into its constituent licences, recursively (if any of our repositories thinks it is a group).

The original group is included in the result.

Since: 0.68

Implements paludis::Environment.

References expand_licence().

Referenced by expand_licence().

◆ fetch_repository() [1/2]

const std::shared_ptr< const Repository > paludis::EnvironmentImplementation::fetch_repository ( const RepositoryName & ) const

overridevirtual

Fetch a named repository.

Since: 0.61 is in Environment rather than PackageDatabase

Implements paludis::Environment.

References fetch_repository(), and PALUDIS_ATTRIBUTE.

Referenced by fetch_repository(), and fetch_repository().

◆ fetch_repository() [2/2]

const std::shared_ptr< Repository > paludis::EnvironmentImplementation::fetch_repository ( const RepositoryName & )

overridevirtual

Fetch a named repository.

Since: 0.61 is in Environment rather than PackageDatabase

Implements paludis::Environment.

References fetch_repository(), and PALUDIS_ATTRIBUTE.

◆ fetch_unique_qualified_package_name()

QualifiedPackageName paludis::EnvironmentImplementation::fetch_unique_qualified_package_name	(	const PackageNamePart &	,
		const Filter &	= all_filter(),
		const bool	disambiguate = true ) const

overridevirtual

Disambiguate a package name. If a filter is specified, limit the potential results to packages that match.

Exceptions

AmbiguousPackageNameError if there is no unambiguous disambiguation. If disambiguate is set to false, the exception will be always thrown in presence of ambiguity.