/* vim: set sw=4 sts=4 et foldmethod=syntax : */ /* * Copyright (c) 2008, 2010, 2011 Ciaran McCreesh * * This file is part of the Paludis package manager. Paludis is free software; * you can redistribute it and/or modify it under the terms of the GNU General * Public License version 2, as published by the Free Software Foundation. * * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License along with * this program; if not, write to the Free Software Foundation, Inc., 59 Temple * Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef PALUDIS_GUARD_PALUDIS_FILTERED_GENERATOR_HH #define PALUDIS_GUARD_PALUDIS_FILTERED_GENERATOR_HH 1 #include #include #include #include /** \file * Declarations for the FilteredGenerator class. * * \ingroup g_selections * * \section Examples * * - \ref example_selection.cc "example_selection.cc" */ namespace paludis { /** * A FilteredGenerator specifies a desired set of properties for PackageIDs * to be returned by Environment::operator[]. * * Most Selection subclasses take a single FilteredGenerator as a parameter. * * \ingroup g_selections */ class PALUDIS_VISIBLE FilteredGenerator { private: Pimp _imp; public: ///\name Basic operations ///\{ FilteredGenerator(const FilteredGenerator &); FilteredGenerator(const Generator &, const Filter &); FilteredGenerator(const FilteredGenerator &, const Filter &); FilteredGenerator & operator= (const FilteredGenerator &); ~FilteredGenerator(); ///\} /** * Return our Generator. */ const Generator & generator() const PALUDIS_ATTRIBUTE((warn_unused_result)); /** * Return our Filter. */ const Filter & filter() const PALUDIS_ATTRIBUTE((warn_unused_result)); }; extern template class Pimp; } #endif