paludis Version 3.0.2
The one true package mangler
paludis::Filter Class Reference

#include <filter.hh>

Inheritance diagram for paludis::Filter:

Public Member Functions

std::string as_string () const PALUDIS_ATTRIBUTE((warn_unused_result))

Protected Member Functions

 Filter (const std::shared_ptr< const FilterHandler > &)

Basic operations

 Filter (const Filter &)
Filter & operator= (const Filter &)

For use by Selection

const RepositoryContentMayExcludes may_excludes () const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const RepositoryNameSet > repositories (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const CategoryNamePartSet > categories (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &, const std::shared_ptr< const CategoryNamePartSet > &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const QualifiedPackageNameSet > packages (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &, const std::shared_ptr< const QualifiedPackageNameSet > &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const PackageIDSet > ids (const Environment *const, const std::shared_ptr< const PackageIDSet > &) const PALUDIS_ATTRIBUTE((warn_unused_result))

Detailed Description

A Filter subclass can be used to further restrict the values picked by a Generator, which when combined together produces a FilteredGenerator which can be passed to a Selection subclass.

Constructor & Destructor Documentation

◆ Filter()

paludis::Filter::Filter ( const Filter & )

Filter subclasses can be copied without losing information.

Member Function Documentation

◆ as_string()

std::string paludis::Filter::as_string ( ) const

A Filter can be represented as a string, for use by operator<<.

References PALUDIS_ATTRIBUTE.

◆ categories()

std::shared_ptr< const CategoryNamePartSet > paludis::Filter::categories ( const Environment * const ,
const std::shared_ptr< const RepositoryNameSet > & ,
const std::shared_ptr< const CategoryNamePartSet > &  ) const

Filter candidate category names.

References categories(), and PALUDIS_ATTRIBUTE.

Referenced by categories().

◆ ids()

std::shared_ptr< const PackageIDSet > paludis::Filter::ids ( const Environment * const ,
const std::shared_ptr< const PackageIDSet > &  ) const

Filter candidate PackageID instances.

References ids(), and PALUDIS_ATTRIBUTE.

Referenced by ids().

◆ may_excludes()

const RepositoryContentMayExcludes paludis::Filter::may_excludes ( ) const

Return any RepositoryContentMayExcludes that are implied by this filter.

Since
0.59

References may_excludes(), and PALUDIS_ATTRIBUTE.

Referenced by may_excludes().

◆ packages()

std::shared_ptr< const QualifiedPackageNameSet > paludis::Filter::packages ( const Environment * const ,
const std::shared_ptr< const RepositoryNameSet > & ,
const std::shared_ptr< const QualifiedPackageNameSet > &  ) const

Filter candidate package names.

References packages(), and PALUDIS_ATTRIBUTE.

Referenced by packages().

◆ repositories()

std::shared_ptr< const RepositoryNameSet > paludis::Filter::repositories ( const Environment * const ,
const std::shared_ptr< const RepositoryNameSet > &  ) const

Filter candidate repository names.

References PALUDIS_ATTRIBUTE, and repositories().

Referenced by repositories().


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