aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/portage/portage_repository.hh
blob: e6326a0a99e23bf28ed60c47abd0c1a237d817c6 (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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 <paludis/repository.hh>
#include <paludis/package_database.hh>
#include <paludis/util/fs_entry.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/repositories/portage/portage_repository_params.hh>
#include <paludis/repositories/portage/portage_repository_profile.hh>
#include <string>

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

namespace paludis
{
    class PortageRepositoryProfile;
    class PortageRepositoryNews;

#include <paludis/repositories/portage/portage_repository-sr.hh>

    /**
     * A PortageRepository is a Repository that handles the layout used by
     * Portage for the main Gentoo tree.
     *
     * \ingroup grpportagerepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE PortageRepository :
        public Repository,
        public RepositoryMaskInterface,
        public RepositoryUseInterface,
        public RepositoryInstallableInterface,
        public RepositorySyncableInterface,
        public RepositoryNewsInterface,
        public RepositorySetsInterface,
        public RepositoryEnvironmentVariableInterface,
        public RepositoryMirrorsInterface,
        public RepositoryVirtualsInterface,
        private PrivateImplementationPattern<PortageRepository>
    {
        private:
            void need_category_names() const;
            void need_version_names(const QualifiedPackageName &) const;
            void need_mirrors() const;
            PackageDatabaseEntryCollection::Iterator find_best(PackageDatabaseEntryCollection & c,
                    const PackageDatabaseEntry & e) 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 QualifiedPackageName &) const;

            virtual std::tr1::shared_ptr<const CategoryNamePartCollection> do_category_names() const;

            std::tr1::shared_ptr<const CategoryNamePartCollection> do_category_names_containing_package(
                    const PackageNamePart & p) const;

            virtual std::tr1::shared_ptr<const QualifiedPackageNameCollection> do_package_names(
                    const CategoryNamePart &) const;

            virtual std::tr1::shared_ptr<const VersionSpecCollection> do_version_specs(
                    const QualifiedPackageName &) const;

            virtual bool do_has_version(const QualifiedPackageName &, const VersionSpec &) const;

            virtual std::tr1::shared_ptr<const VersionMetadata> do_version_metadata(
                    const QualifiedPackageName &,
                    const VersionSpec &) const;

            virtual bool do_query_repository_masks(const QualifiedPackageName &,
                    const VersionSpec &) const;

            virtual bool do_query_profile_masks(const QualifiedPackageName &,
                    const VersionSpec &) const;

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

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

            virtual std::tr1::shared_ptr<DepAtom> do_package_set(const SetName &) const;

            virtual std::tr1::shared_ptr<const SetsCollection> sets_list() const;

            virtual bool do_sync() const;

            virtual std::tr1::shared_ptr<const VirtualsCollection> virtual_packages() const;

            virtual std::tr1::shared_ptr<const VersionMetadata> virtual_package_version_metadata(
                    const RepositoryVirtualsEntry &, const VersionSpec & v) const;

            /* RepositoryUseInterface */

            virtual UseFlagState do_query_use(const UseFlagName &, const PackageDatabaseEntry *) const;
            virtual bool do_query_use_mask(const UseFlagName &, const PackageDatabaseEntry *) const;
            virtual bool do_query_use_force(const UseFlagName &, const PackageDatabaseEntry *) const;
            virtual std::tr1::shared_ptr<const UseFlagNameCollection> do_arch_flags() const;
            virtual std::tr1::shared_ptr<const UseFlagNameCollection> do_use_expand_flags() const;
            virtual std::tr1::shared_ptr<const UseFlagNameCollection> do_use_expand_hidden_prefixes() const;
            virtual UseFlagName do_use_expand_name(const UseFlagName & u) const;
            virtual UseFlagName do_use_expand_value(const UseFlagName & u) const;
            virtual std::tr1::shared_ptr<const UseFlagNameCollection> do_use_expand_prefixes() const;
            virtual std::string do_describe_use_flag(const UseFlagName &,
                    const PackageDatabaseEntry * const) const;

            /* end of RepositoryUseInterface */

        public:
            virtual std::tr1::shared_ptr<const RepositoryInfo> info(bool verbose) const;

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

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

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

            virtual void update_news() const;

            virtual std::string get_environment_variable(
                    const PackageDatabaseEntry & for_package,
                    const std::string & var) const;

            virtual MirrorsIterator begin_mirrors(const std::string & s) const;
            virtual MirrorsIterator end_mirrors(const std::string & s) const;

            ///\name Information about PortageRepository
            ///\{

            std::string profile_variable(const std::string &) const;

            typedef libwrapiter::ForwardIterator<PortageRepository, std::pair<
                const QualifiedPackageName, std::tr1::shared_ptr<const PackageDepAtom> > > OurVirtualsIterator;

            ///\}

            ///\name Profile setting and querying functions
            ///\{

            typedef libwrapiter::ForwardIterator<PortageRepository,
                    const PortageRepositoryProfilesDescLine> ProfilesIterator;
            ProfilesIterator begin_profiles() const;
            ProfilesIterator end_profiles() const;

            ProfilesIterator find_profile(const FSEntry & location) const;
            void set_profile(const ProfilesIterator & iter);
            void set_profile_by_arch(const UseFlagName &);

            ///\}
    };
}

#endif