paludis  Version 2.6.0
fuzzy_finder.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2007 Fernando J. Pereda
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_FUZZY_FINDER_HH
21 #define PALUDIS_GUARD_PALUDIS_FUZZY_FINDER_HH 1
22 
24 #include <paludis/util/pimp.hh>
25 #include <paludis/util/wrapped_forward_iterator.hh>
26 #include <paludis/name.hh>
27 #include <paludis/filter-fwd.hh>
28 #include <string>
29 
30 /** \file
31  * Declarations for paludis::FuzzyCandidatesFinder and paludis::FuzzyRepositoriesFinder
32  *
33  * \ingroup g_environment
34  */
35 
36 namespace paludis
37 {
38  /**
39  * Object to find package names to a given name
40  *
41  * \ingroup g_environment
42  */
44  {
45  private:
47 
48  public:
49  ///\name Basic Operations
50  ///\{
51 
52  FuzzyCandidatesFinder(const Environment & e, const std::string & name, const Filter & filter);
54 
55  ///\}
56 
57  ///\name Iterate over the candidates
58  ///\{
59 
60  struct CandidatesConstIteratorTag;
63 
64  CandidatesConstIterator begin() const;
65  CandidatesConstIterator end() const;
66 
67  ///\}
68  };
69 
70  /**
71  * Object to find repositories similar to a given name
72  *
73  * \ingroup g_environment
74  */
76  {
77  private:
79 
80  public:
81  ///\name Basic Operations
82  ///\{
83 
84  FuzzyRepositoriesFinder(const Environment & e, const std::string & name);
86 
87  ///\}
88 
89  ///\name Iterate over the candidates
90  ///\{
91 
92  struct RepositoriesConstIteratorTag;
95 
96  RepositoriesConstIterator begin() const;
97  RepositoriesConstIterator end() const;
98 
99  ///\}
100  };
101 
104 
105 }
106 
107 #endif
Definition: pimp.hh:51
Definition: about_metadata-fwd.hh:23
Definition: filter.hh:57
Definition: environment.hh:200
Definition: fuzzy_finder.hh:43
Definition: wrapped_forward_iterator-fwd.hh:26
Definition: fuzzy_finder.hh:75
#define PALUDIS_VISIBLE
Definition: attributes.hh:59