paludis  Version 2.6.0
filtered_generator.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2008, 2010, 2011 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_FILTERED_GENERATOR_HH
21 #define PALUDIS_GUARD_PALUDIS_FILTERED_GENERATOR_HH 1
22 
24 #include <paludis/util/pimp.hh>
25 #include <paludis/filter-fwd.hh>
26 #include <paludis/generator-fwd.hh>
27 
28 /** \file
29  * Declarations for the FilteredGenerator class.
30  *
31  * \ingroup g_selections
32  *
33  * \section Examples
34  *
35  * - \ref example_selection.cc "example_selection.cc"
36  */
37 
38 namespace paludis
39 {
40  /**
41  * A FilteredGenerator specifies a desired set of properties for PackageIDs
42  * to be returned by Environment::operator[].
43  *
44  * Most Selection subclasses take a single FilteredGenerator as a parameter.
45  *
46  * \ingroup g_selections
47  */
49  {
50  private:
52 
53  public:
54  ///\name Basic operations
55  ///\{
56 
58  FilteredGenerator(const Generator &, const Filter &);
59  FilteredGenerator(const FilteredGenerator &, const Filter &);
60  FilteredGenerator & operator= (const FilteredGenerator &);
62 
63  ///\}
64 
65  /**
66  * Return our Generator.
67  */
68  const Generator & generator() const PALUDIS_ATTRIBUTE((warn_unused_result));
69 
70  /**
71  * Return our Filter.
72  */
73  const Filter & filter() const PALUDIS_ATTRIBUTE((warn_unused_result));
74  };
75 
76  extern template class Pimp<FilteredGenerator>;
77 }
78 
79 #endif
Definition: pimp.hh:51
Definition: about_metadata-fwd.hh:23
Definition: filter.hh:57
Definition: generator.hh:58
Definition: filtered_generator.hh:48
#define PALUDIS_ATTRIBUTE(x)
Definition: attributes.hh:53
#define PALUDIS_VISIBLE
Definition: attributes.hh:59