paludis::EnvironmentImplementation Class Reference
[Environment]

#include <environment_implementation.hh>

Inheritance diagram for paludis::EnvironmentImplementation:

paludis::PrivateImplementationPattern< C_ > paludis::Environment paludis::MetadataKeyHolder paludis::PrivateImplementationPattern< C_ > paludis::NoConfigEnvironment paludis::TestEnvironment

List of all members.

Basic operations

 EnvironmentImplementation ()
virtual ~EnvironmentImplementation ()=0

Public Member Functions

virtual std::tr1::shared_ptr
< const FSEntrySequence
bashrc_files () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual std::tr1::shared_ptr
< const FSEntrySequence
syncers_dirs () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual std::tr1::shared_ptr
< const FSEntrySequence
fetchers_dirs () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual std::tr1::shared_ptr
< const DestinationsSet
default_destinations () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual std::string distribution () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual bool is_paludis_package (const QualifiedPackageName &) const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual std::tr1::shared_ptr
< PackageIDSequence
operator[] (const Selection &) const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual NotifierCallbackID add_notifier_callback (const NotifierCallbackFunction &)
virtual void remove_notifier_callback (const NotifierCallbackID)
virtual void trigger_notifier_callback (const NotifierCallbackEvent &) const
virtual void add_set (const SetName &, const SetName &, const std::tr1::function< std::tr1::shared_ptr< const SetSpecTree >()> &, const bool combine) const
virtual std::tr1::shared_ptr
< const SetNameSet
set_names () const PALUDIS_ATTRIBUTE((warn_unused_result))
virtual const
std::tr1::shared_ptr< const
SetSpecTree > 
set (const SetName &) 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


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

virtual std::tr1::shared_ptr<const FSEntrySequence> paludis::EnvironmentImplementation::bashrc_files (  )  const [virtual]

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

Implements paludis::Environment.

virtual std::tr1::shared_ptr<const FSEntrySequence> paludis::EnvironmentImplementation::syncers_dirs (  )  const [virtual]

Return directories to search for syncer scripts.

Implements paludis::Environment.

virtual std::tr1::shared_ptr<const FSEntrySequence> paludis::EnvironmentImplementation::fetchers_dirs (  )  const [virtual]

Return directories to search for fetcher scripts.

Implements paludis::Environment.

virtual std::tr1::shared_ptr<const DestinationsSet> paludis::EnvironmentImplementation::default_destinations (  )  const [virtual]

Default destination candidates for installing packages.

Implements paludis::Environment.

virtual bool paludis::EnvironmentImplementation::is_paludis_package ( const QualifiedPackageName  )  const [virtual]

Is the specified package Paludis?

Used by InstallTask to decide whether to exec() after installing a package.

Implements paludis::Environment.

virtual std::tr1::shared_ptr<PackageIDSequence> paludis::EnvironmentImplementation::operator[] ( const Selection &   )  const [virtual]

Select some packages.

Implements paludis::Environment.

virtual NotifierCallbackID paludis::EnvironmentImplementation::add_notifier_callback ( const NotifierCallbackFunction &   )  [virtual]

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.

virtual void paludis::EnvironmentImplementation::remove_notifier_callback ( const   NotifierCallbackID  )  [virtual]

Remove a function added with add_notifier_callback.

Since:
0.40

Implements paludis::Environment.

virtual void paludis::EnvironmentImplementation::trigger_notifier_callback ( const NotifierCallbackEvent &   )  const [virtual]

Trigger a notifier callback.

Since:
0.40

Implements paludis::Environment.

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

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.

virtual std::tr1::shared_ptr<const SetNameSet> paludis::EnvironmentImplementation::set_names (  )  const [virtual]

Return all known named sets.

Implements paludis::Environment.

virtual const std::tr1::shared_ptr<const SetSpecTree> paludis::EnvironmentImplementation::set ( const SetName  )  const [virtual]

Return a named set.

If the named set is not known, returns a zero pointer.

Implements paludis::Environment.


The documentation for this class was generated from the following file:
Generated on Mon Sep 21 10:36:10 2009 for paludis by  doxygen 1.5.4