aboutsummaryrefslogtreecommitdiff
path: root/paludis/dep_list.hh
blob: 00719771ebfb433a1f54b7ccadccad520997f054 (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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 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_DEP_LIST_HH
#define PALUDIS_GUARD_PALUDIS_DEP_LIST_HH 1

#include <paludis/dep_atom.hh>
#include <paludis/dep_tag.hh>
#include <paludis/name.hh>
#include <paludis/environment.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/version_spec.hh>

#include <iosfwd>
#include <bitset>

#include <libwrapiter/libwrapiter_forward_iterator.hh>

namespace paludis
{
    /**
     * What type of target are we handling at the top level.
     *
     * \ingroup grpdepresolver
     */
    enum DepListTargetType
    {
        dl_target_package,   ///\< A package, so force reinstalls.
        dl_target_set        ///\< A set, so don't force reinstalls.
    };

    /**
     * When should we reinstall.
     *
     * \ingroup grpdepresolver
     */
    enum DepListReinstallOption
    {
        dl_reinstall_never,             ///\< Never.
        dl_reinstall_always,            ///\< Always.
        dl_reinstall_if_use_changed     ///\< If a USE flag has changed.
    };

    /**
     * When can we fall back to installed?
     *
     * \ingroup grpdepresolver
     */
    enum DepListFallBackOption
    {
        dl_fall_back_as_needed_except_targets,
        dl_fall_back_as_needed,
        dl_fall_back_never
    };

    /**
     * When should we reinstall scm.
     *
     * \ingroup grpdepresolver
     */
    enum DepListReinstallScmOption
    {
        dl_reinstall_scm_never,
        dl_reinstall_scm_always,
        dl_reinstall_scm_daily,
        dl_reinstall_scm_weekly
    };

    /**
     * When should we upgrade.
     *
     * \ingroup grpdepresolver
     */
    enum DepListUpgradeOption
    {
        dl_upgrade_always,          ///\< Always.
        dl_upgrade_as_needed        ///\< Only as needed.
    };

    /**
     * How should we handle a dep class.
     *
     * \ingroup grpdepresolver
     */
    enum DepListDepsOption
    {
        dl_deps_discard,           ///\< Discard it
        dl_deps_pre,               ///\< As a pre dependency
        dl_deps_pre_or_post,       ///\< As a pre dependency with fallback to post
        dl_deps_post,              ///\< As a post dependency
        dl_deps_try_post           ///\< As an optional post dependency
    };

    /**
     * How we handle circular deps.
     *
     * \ingroup grpdepresolver
     */
    enum DepListCircularOption
    {
        dl_circular_error,    ///\< As an error
        dl_circular_discard   ///\< Discard them
    };

    /**
     * State of a DepListEntry.
     *
     * \ingroup grpdepresolver
     */
    enum DepListEntryState
    {
        dle_no_deps,         ///\< Dependencies have yet to be added
        dle_has_pre_deps,    ///\< Predependencies have been added
        dle_has_all_deps     ///\< All dependencies have been added
    };

#include <paludis/dep_list-sr.hh>

    /**
     * Thrown if an error occurs whilst building a DepList.
     *
     * \ingroup grpdepresolver
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class DepListError : public Exception
    {
        protected:
            ///\name Basic operations
            ///\{

            DepListError(const std::string &) throw ();

            ///\}
    };

    /**
     * Thrown if all versions of a particular atom are masked.
     *
     * \ingroup grpdepresolver
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class AllMaskedError : public DepListError
    {
        private:
            std::string _query;

        public:
            ///\name Basic operations
            ///\{

            AllMaskedError(const std::string & query) throw ();

            virtual ~AllMaskedError() throw ()
            {
            }

            ///\}

            /**
             * Our query.
             */
            const std::string & query() const
            {
                return _query;
            }
    };

    /**
     * Thrown if all versions of a particular atom are masked,
     * but would not be if use requirements were not in effect.
     *
     * \ingroup grpdepresolver
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class UseRequirementsNotMetError : public DepListError
    {
        private:
            std::string _query;

        public:
            ///\name Basic operations
            ///\{

            UseRequirementsNotMetError(const std::string & query) throw ();

            virtual ~UseRequirementsNotMetError() throw ()
            {
            }

            ///\}

            /**
             * Our query.
             */
            const std::string & query() const
            {
                return _query;
            }
    };

    /**
     * Thrown if a block is encountered.
     *
     * \ingroup grpdepresolver
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class BlockError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            BlockError(const std::string & msg) throw ();

            ///\}
    };

    /**
     * Thrown if a circular dependency is encountered.
     *
     * \ingroup grpdepresolver
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class CircularDependencyError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            CircularDependencyError(const std::string & msg) throw ();

            ///\}
    };

    /**
     * Holds a list of dependencies in merge order.
     *
     * \ingroup grpdepresolver
     * \nosubgrouping
     */
    class DepList :
        private InstantiationPolicy<DepList, instantiation_method::NonCopyableTag>,
        private PrivateImplementationPattern<DepList>
    {
        protected:
            class AddVisitor;
            class QueryVisitor;

            friend class AddVisitor;
            friend class QueryVisitor;

            void add_in_role(DepAtom::ConstPointer, const std::string & role);
            bool prefer_installed_over_uninstalled(const PackageDatabaseEntry &,
                    const PackageDatabaseEntry &);
            void add_package(const PackageDatabaseEntry &, DepTag::ConstPointer);
            void add_already_installed_package(const PackageDatabaseEntry &, DepTag::ConstPointer);
            void add_predeps(DepAtom::ConstPointer, const DepListDepsOption, const std::string &);
            void add_postdeps(DepAtom::ConstPointer, const DepListDepsOption, const std::string &);
            bool is_top_level_target(const PackageDatabaseEntry &) const;

        public:
            ///\name Basic operations
            ///\{

            DepList(const Environment * const, const DepListOptions &);

            virtual ~DepList();

            ///\}

            /**
             * Our options.
             */
            DepListOptions & options;

            /**
             * Add the packages required to resolve an additional dependency
             * atom.
             */
            void add(DepAtom::ConstPointer);

            /**
             * Clear the list.
             */
            void clear();

            /**
             * Is an atom structure already installed?
             */
            bool already_installed(DepAtom::ConstPointer) const;

            /**
             * Is an atom structure already installed (overloaded for raw pointer)?
             */
            bool already_installed(const DepAtom * const) const;

            ///\name Iterate over our dependency list entries.
            ///\{

            typedef libwrapiter::ForwardIterator<DepList, const DepListEntry> Iterator;

            Iterator begin() const;

            Iterator end() const;

            ///\}
    };
}

#endif