aboutsummaryrefslogtreecommitdiff
path: root/paludis/dep_spec_data.hh
blob: 45cd81f23b908b99679f3c90b636ee4b8963ccb0 (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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006, 2007, 2008, 2009, 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_DEP_SPEC_DATA_HH
#define PALUDIS_GUARD_PALUDIS_DEP_SPEC_DATA_HH 1

#include <paludis/dep_spec_data-fwd.hh>
#include <paludis/changed_choices-fwd.hh>
#include <paludis/name-fwd.hh>
#include <paludis/version_operator-fwd.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/environment-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/package_dep_spec_constraint-fwd.hh>
#include <paludis/version_spec-fwd.hh>

#include <paludis/util/attributes.hh>
#include <paludis/util/fs_path-fwd.hh>
#include <paludis/util/pimp.hh>

#include <string>
#include <memory>

namespace paludis
{
    /**
     * Data for a ConditionalDepSpec.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE ConditionalDepSpecData
    {
        public:
            ///\name Basic operations
            ///\{

            virtual ~ConditionalDepSpecData();

            ///\}

            /**
             * Fetch ourself as a string.
             */
            virtual std::string as_string() const = 0;

            /**
             * Fetch the result for condition_met.
             *
             * \since 0.58 takes env, package_id
             */
            virtual bool condition_met(
                    const Environment * const,
                    const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            /**
             * Fetch the result for condition_would_be_met_when.
             *
             * \since 0.58 takes env, package_id
             */
            virtual bool condition_would_be_met_when(
                    const Environment * const,
                    const std::shared_ptr<const PackageID> &,
                    const ChangedChoices &) const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            /**
             * Fetch the result for condition_meetable.
             *
             * \since 0.58 takes env, package_id
             */
            virtual bool condition_meetable(
                    const Environment * const,
                    const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * Data for a PackageDepSpec.
     *
     * \since 0.26
     * \since 0.61 is not abstract
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE PackageDepSpecData
    {
        protected:
            Pimp<PackageDepSpecData> _imp;

            PackageDepSpecData(const PackageDepSpecData &);

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

            explicit PackageDepSpecData(const PackageDepSpecDataOptions &);

            virtual ~PackageDepSpecData();

            ///\}

            /**
             * Fetch ourself as a string.
             */
            std::string as_string() const;

            /**
             * Fetch the single NameConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const NameConstraint> package_name_constraint() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Fetch the single PackageNamePartConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const PackageNamePartConstraint> package_name_part_constraint() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Fetch the single CategoryNamePartConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const CategoryNamePartConstraint> category_name_part_constraint() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Fetch all our VersionConstraints, if we have any, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const VersionConstraintSequence> all_version_constraints() const;

            /**
             * Fetch the single ExactSlotConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const ExactSlotConstraint> exact_slot_constraint() const;

            /**
             * Fetch the single AnySlotConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const AnySlotConstraint> any_slot_constraint() const;

            /**
             * Fetch the single InRepositoryConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const InRepositoryConstraint> in_repository_constraint() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Fetch the single InstallableToRepositoryConstraint, if we have one, or
             *
             * \since 0.61
             */
            const std::shared_ptr<const InstallableToRepositoryConstraint> installable_to_repository_constraint() const;

            /**
             * Fetch the single FromRepositoryConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const FromRepositoryConstraint> from_repository_constraint() const;

            /**
             * Fetch the single InstalledAtPathConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const InstalledAtPathConstraint> installed_at_path_constraint() const;

            /**
             * Fetch the single InstallableToPathConstraint, if we have one, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const InstallableToPathConstraint> installable_to_path_constraint() const;

            /**
             * Fetch all our KeyConstraints, if we have any, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const KeyConstraintSequence> all_key_constraints() const;

            /**
             * Fetch all our ChoiceConstraints, if we have any, or
             * a null pointer otherwise.
             *
             * \since 0.61
             */
            const std::shared_ptr<const ChoiceConstraintSequence> all_choice_constraints() const;

            /**
             * Our options.
             *
             * \since 0.61
             */
            const PackageDepSpecDataOptions options() const;
    };

    /**
     * Partially constructed PackageDepSpecData, which can be used to build up a
     * PackageDepSpec.
     *
     * \since 0.61
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE MutablePackageDepSpecData :
        private PackageDepSpecData
    {
        public:
            explicit MutablePackageDepSpecData(const PackageDepSpecDataOptions &);

            MutablePackageDepSpecData(const PackageDepSpecData &);

            MutablePackageDepSpecData(const MutablePackageDepSpecData &);

            ~MutablePackageDepSpecData();

            /**
             * Add a package constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_package(const QualifiedPackageName &);

            /**
             * Clear any package constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_package();

            /**
             * Add a package name part constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_package_name_part(const PackageNamePart &);

            /**
             * Clear any package name part constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_package_name_part();

            /**
             * Add a category name part constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_category_name_part(const CategoryNamePart &);

            /**
             * Clear any category name part constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_category_name_part();

            /**
             * Add a version constraint.
             *
             * The combiner must be vcc_and if this is the first version
             * constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_version(const VersionConstraintCombiner, const VersionOperator &, const VersionSpec &);

            /**
             * Clear any version constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_versions();

            /**
             * Add an exact slot constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_exact_slot(const SlotName &, const bool locked);

            /**
             * Clear any exact slot constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_exact_slot();

            /**
             * Add an in repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_in_repository(const RepositoryName &);

            /**
             * Clear any in repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_in_repository();

            /**
             * Add an installable to path constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_installable_to_path(const FSPath &, const bool);

            /**
             * Clear any installable to path constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_installable_to_path();

            /**
             * Add an installable to repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_installable_to_repository(const RepositoryName &, const bool);

            /**
             * Clear any installable to repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_installable_to_repository();

            /**
             * Add a from repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_from_repository(const RepositoryName &);

            /**
             * Clear any from repository constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_from_repository();

            /**
             * Add an installed at path constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_installed_at_path(const FSPath &);

            /**
             * Clear any installed at path constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_installed_at_path();

            /**
             * Add an any slot constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_any_slot(const bool);

            /**
             * Clear our AnySlotConstraint, if we have one.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_any_slot();

            /**
             * Add a choice constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_choice(const std::shared_ptr<const ChoiceConstraint> &);

            /**
             * Clear any choice constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_choices();

            /**
             * Add a key constraint.
             *
             * \return *this
             */
            MutablePackageDepSpecData & constrain_key(
                    const KeyConstraintKeyType, const std::string &, const KeyConstraintOperation, const std::string &);

            /**
             * Clear any key constraints.
             *
             * \return *this
             */
            MutablePackageDepSpecData & unconstrain_keys();

            /**
             * Convert ourself to a PackageDepSpec.
             */
            operator PackageDepSpec() const;
    };
}

#endif