aboutsummaryrefslogtreecommitdiff
path: root/paludis/portage_repository.hh
blob: d5c9ce7158f0b1a9b40d65e55ccfe81be8e7fd52 (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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * 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_PORTAGE_REPOSITORY_HH
#define PALUDIS_GUARD_PALUDIS_PORTAGE_REPOSITORY_HH 1

#include <map>
#include <paludis/repository.hh>
#include <paludis/util/fs_entry.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/smart_record.hh>
#include <string>

/** \file
 * Declaration for the PortageRepository class.
 */

namespace paludis
{
    class PackageDatabase;

    enum PortageRepositoryParamsKeys
    {
        prpk_environment,
        prpk_package_database,
        prpk_location,
        prpk_profile,
        prpk_cache,
        prpk_distdir,
        prpk_eclassdir,
        prpk_sync,
        prpk_sync_exclude,
        prpk_root,
        last_prpk
    };

    struct PortageRepositoryParamsTag :
        SmartRecordTag<comparison_mode::NoComparisonTag, void>,
        SmartRecordKeys<PortageRepositoryParamsKeys, last_prpk>,
        SmartRecordKey<prpk_environment, const Environment *>,
        SmartRecordKey<prpk_package_database, const PackageDatabase *>,
        SmartRecordKey<prpk_location, const FSEntry>,
        SmartRecordKey<prpk_profile, const FSEntry>,
        SmartRecordKey<prpk_cache, const FSEntry>,
        SmartRecordKey<prpk_distdir, const FSEntry>,
        SmartRecordKey<prpk_eclassdir, const FSEntry>,
        SmartRecordKey<prpk_sync, const std::string>,
        SmartRecordKey<prpk_sync_exclude, const std::string>,
        SmartRecordKey<prpk_root, const FSEntry>
    {
    };

    typedef MakeSmartRecord<PortageRepositoryParamsTag>::Type PortageRepositoryParams;

    /**
     * A PortageRepository is a Repository that handles the layout used by
     * Portage for the main Gentoo tree.
     */
    class PortageRepository : public Repository,
                              private PrivateImplementationPattern<PortageRepository>
    {
        private:
            void need_category_names() const;
            void need_version_names(const QualifiedPackageName &) const;
            void need_virtual_names() const;
            DepAtom::Pointer do_security_set() const;

        protected:
            /**
             * Try to get the repository name for a particular repository.
             */
            static RepositoryName fetch_repo_name(const std::string & location);

            virtual bool do_has_category_named(const CategoryNamePart &) const;

            virtual bool do_has_package_named(const CategoryNamePart &,
                    const PackageNamePart &) const;

            virtual CategoryNamePartCollection::ConstPointer do_category_names() const;

            virtual QualifiedPackageNameCollection::ConstPointer do_package_names(
                    const CategoryNamePart &) const;

            virtual VersionSpecCollection::ConstPointer do_version_specs(
                    const QualifiedPackageName &) const;

            virtual bool do_has_version(const CategoryNamePart &,
                    const PackageNamePart &, const VersionSpec &) const;

            virtual VersionMetadata::ConstPointer do_version_metadata(
                    const CategoryNamePart &, const PackageNamePart &,
                    const VersionSpec &) const;

            virtual bool do_query_repository_masks(const CategoryNamePart &,
                    const PackageNamePart &, const VersionSpec &) const;

            virtual bool do_query_profile_masks(const CategoryNamePart &,
                    const PackageNamePart &, const VersionSpec &) const;

            virtual UseFlagState do_query_use(const UseFlagName &, const PackageDatabaseEntry *) const;

            virtual bool do_query_use_mask(const UseFlagName &) const;

            virtual bool do_is_arch_flag(const UseFlagName &) const;

            virtual bool do_is_expand_flag(const UseFlagName &) const;

            virtual bool do_is_licence(const std::string &) const;

            virtual bool do_is_mirror(const std::string &) const;

            virtual void do_install(const QualifiedPackageName &, const VersionSpec &,
                    const InstallOptions &) const;

            virtual void do_uninstall(const QualifiedPackageName &,
                    const VersionSpec &, const InstallOptions &) const PALUDIS_ATTRIBUTE((noreturn));

            virtual DepAtom::Pointer do_package_set(const std::string & s) const;

            virtual bool do_sync() const;

        public:
            /**
             * Constructor.
             */
            PortageRepository(const PortageRepositoryParams &);

            /**
             * Virtual constructor.
             */
            static CountedPtr<Repository> make_portage_repository(
                    const Environment * const env,
                    const PackageDatabase * const db,
                    const std::map<std::string, std::string> &);

            /**
             * Destructor.
             */
            ~PortageRepository();

            virtual bool installed() const
            {
                return false;
            }

            virtual void invalidate() const;

            virtual ProvideMapIterator begin_provide_map() const;

            virtual ProvideMapIterator end_provide_map() const;

            virtual void add_to_world(const QualifiedPackageName &) const
            {
            }

            virtual void remove_from_world(const QualifiedPackageName &) const
            {
            }
    };

    /**
     * Thrown if invalid parameters are provided for
     * PortageRepository::make_portage_repository.
     *
     * \ingroup Exception
     */
    class PortageRepositoryConfigurationError : public ConfigurationError
    {
        public:
            /**
             * Constructor.
             */
            PortageRepositoryConfigurationError(const std::string & msg) throw ();
    };

    static const RepositoryMaker::RegisterMaker register_portage_repository(
            "portage", &PortageRepository::make_portage_repository);

}

#endif