aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/accounts/accounts_repository.hh
blob: c9d2d22bb2bd7300885f5a428cb6a9f005ba6c0d (plain)
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2009 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_REPOSITORIES_ACCOUNTS_ACCOUNTS_REPOSITORY_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_ACCOUNTS_ACCOUNTS_REPOSITORY_HH 1

#include <paludis/util/attributes.hh>
#include <paludis/util/named_value.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/repository.hh>

namespace paludis
{
    namespace n
    {
        struct environment;
        struct handler;
        struct installed;
        struct name;
        struct root;
    }

    namespace accounts_repository
    {
        struct AccountsRepositoryParams
        {
            NamedValue<n::environment, Environment *> environment;
            NamedValue<n::name, RepositoryName> name;
        };

        struct InstalledAccountsRepositoryParams
        {
            NamedValue<n::environment, Environment *> environment;
            NamedValue<n::handler, std::string> handler;
            NamedValue<n::name, RepositoryName> name;
            NamedValue<n::root, FSEntry> root;
        };

        class PALUDIS_VISIBLE AccountsRepository :
            private PrivateImplementationPattern<AccountsRepository>,
            public Repository,
            public RepositoryDestinationInterface,
            public std::tr1::enable_shared_from_this<AccountsRepository>
        {
            private:
                PrivateImplementationPattern<AccountsRepository>::ImpPtr & _imp;

                void _add_metadata_keys();

            protected:
                virtual void need_keys_added() const;

            public:
                AccountsRepository(const AccountsRepositoryParams &);
                AccountsRepository(const InstalledAccountsRepositoryParams &);

                ~AccountsRepository();

                ///\name RepositoryFactory functions
                ///\{

                static RepositoryName repository_factory_name(
                        const Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                static std::tr1::shared_ptr<Repository> repository_factory_create(
                        Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                static std::tr1::shared_ptr<const RepositoryNameSet> repository_factory_dependencies(
                        const Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                ///\}

                ///\name RepositoryFactory functions for Installed
                ///\{

                static RepositoryName repository_factory_installed_name(
                        const Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                static std::tr1::shared_ptr<Repository> repository_factory_installed_create(
                        Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                static std::tr1::shared_ptr<const RepositoryNameSet> repository_factory_installed_dependencies(
                        const Environment * const env,
                        const std::tr1::function<std::string (const std::string &)> &);

                ///\}

                ///\name Specific metadata keys
                ///\{

                virtual const std::tr1::shared_ptr<const MetadataValueKey<std::string> > format_key() const;
                virtual const std::tr1::shared_ptr<const MetadataValueKey<FSEntry> > location_key() const;
                virtual const std::tr1::shared_ptr<const MetadataValueKey<FSEntry> > installed_root_key() const;

                ///\}

                ///\name Repository content queries
                ///\{

                virtual bool has_category_named(const CategoryNamePart & c) const;
                virtual bool has_package_named(const QualifiedPackageName & q) const;
                virtual std::tr1::shared_ptr<const CategoryNamePartSet> category_names() const;
                virtual std::tr1::shared_ptr<const CategoryNamePartSet> unimportant_category_names() const;
                virtual std::tr1::shared_ptr<const CategoryNamePartSet> category_names_containing_package(
                        const PackageNamePart & p) const;
                virtual std::tr1::shared_ptr<const QualifiedPackageNameSet> package_names(
                        const CategoryNamePart & c) const;
                virtual std::tr1::shared_ptr<const PackageIDSequence> package_ids(const QualifiedPackageName & p) const;
                virtual bool some_ids_might_support_action(const SupportsActionTestBase &) const;

                ///\}

                ///\name Repository behaviour methods
                ///\{

                virtual void invalidate();
                virtual void invalidate_masks();
                virtual void regenerate_cache() const;

                ///\}

                ///\name Destination functions
                ///\{

                virtual bool is_suitable_destination_for(const PackageID &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result));
                virtual bool is_default_destination() const
                    PALUDIS_ATTRIBUTE((warn_unused_result));
                virtual bool want_pre_post_phases() const
                    PALUDIS_ATTRIBUTE((warn_unused_result));
                virtual void merge(const MergeParams &);

                ///\}

                ///\name Set methods
                ///\{

                virtual void populate_sets() const;

                ///\}
        };
    }
}

#endif