1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
* Copyright (c) 2006, 2007, 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_REPOSITORY_NAME_CACHE_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORY_NAME_CACHE_HH 1
#include <paludis/util/pimp.hh>
#include <paludis/util/fs_path-fwd.hh>
#include <paludis/name.hh>
#include <memory>
/** \file
* Declarations for RepositoryNameCache, which is used by some Repository
* subclasses to implement a names class.
*
* \ingroup g_repository
*
* \section Examples
*
* - None at this time.
*/
namespace paludis
{
class Repository;
/**
* Used by various Repository subclasses to implement a names cache.
*
* \see Repository
* \ingroup g_repository
* \nosubgrouping
*/
class PALUDIS_VISIBLE RepositoryNameCache
{
private:
Pimp<RepositoryNameCache> _imp;
public:
///\name Basic operations
///\{
RepositoryNameCache(
const FSPath & location,
const Repository * const repo);
virtual ~RepositoryNameCache();
///\}
///\name Cache helper functions
///\{
/**
* Implement category_names_containing_package.
*
* May return a zero pointer, in which case the repository should
* fall back to Repository::do_category_names_containing_package or
* its own implementation.
*/
std::shared_ptr<const CategoryNamePartSet> category_names_containing_package(
const PackageNamePart & p) const;
/**
* Whether or not our cache is usable.
*
* Initially this will be true. After the first query the value may
* change to false (the query will return a zero pointer too).
*/
bool usable() const PALUDIS_ATTRIBUTE((nothrow));
/**
* Implement cache regeneration.
*/
void regenerate_cache() const;
/**
* Add a new package to the cache.
*/
void add(const QualifiedPackageName &);
/**
* Remove a package from the cache.
*/
void remove(const QualifiedPackageName &);
///\}
};
}
#endif
|