aboutsummaryrefslogtreecommitdiff
path: root/paludis/partially_made_package_dep_spec.hh
blob: 14d2c5a5c340e8d242e200eececb9f269959f74f (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
/* 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_PARTIALLY_MADE_PACKAGE_DEP_SPEC_HH
#define PALUDIS_GUARD_PALUDIS_PARTIALLY_MADE_PACKAGE_DEP_SPEC_HH 1

#include <paludis/partially_made_package_dep_spec-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/name-fwd.hh>
#include <paludis/dep_spec.hh>

namespace paludis
{
    /**
     * A PartiallyMadePackageDepSpec is returned by make_package_dep_spec()
     * and is used to incrementally build a PackageDepSpec.
     *
     * \ingroup g_dep_spec
     * \since 0.26
     */
    class PALUDIS_VISIBLE PartiallyMadePackageDepSpec
    {
        private:
            Pimp<PartiallyMadePackageDepSpec> _imp;

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

            PartiallyMadePackageDepSpec(const PartiallyMadePackageDepSpecOptions &);
            ~PartiallyMadePackageDepSpec();
            PartiallyMadePackageDepSpec(const PackageDepSpec &);
            PartiallyMadePackageDepSpec(const PartiallyMadePackageDepSpec &);

            ///\}

            /**
             * Set our package requirements, return ourself.
             */
            PartiallyMadePackageDepSpec & package(const QualifiedPackageName &);

            /**
             * Clear our package requirements, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_package();

            /**
             * Set our exact slot requirements, return ourself.
             *
             * \since 0.61
             */
            PartiallyMadePackageDepSpec & exact_slot_constraint(
                    const SlotName &, const bool);

            /**
             * Set our locked slot requirements, return ourself.
             *
             * \since 0.61
             */
             PartiallyMadePackageDepSpec & any_slot_constraint(
                     const bool);

            /**
             * Clear our exact slot requirements, return ourself.
             *
             * \since 0.61
             */
            PartiallyMadePackageDepSpec & clear_exact_slot();

            /**
             * Clear our any slot requirements, return ourself.
             *
             * \since 0.61
             */
            PartiallyMadePackageDepSpec & clear_any_slot();

            /**
             * Set our in-repository requirement, return ourself.
             */
            PartiallyMadePackageDepSpec & in_repository(const RepositoryName &);

            /**
             * Clear our in-repository requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_in_repository();

            /**
             * Set our from-repository requirement, return ourself.
             */
            PartiallyMadePackageDepSpec & from_repository(const RepositoryName &);

            /**
             * Clear our from-repository requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_from_repository();

            /**
             * Set our installable-to-repository requirement, return ourself.
             *
             * \since 0.61
             */
            PartiallyMadePackageDepSpec & installable_to_repository(const RepositoryName &, const bool);

            /**
             * Clear our installable-to-repository requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_installable_to_repository();

            /**
             * Set our installed-at-path requirement, return ourself.
             *
             * \since 0.32
             */
            PartiallyMadePackageDepSpec & installed_at_path(const FSPath &);

            /**
             * Clear our installed-at-path requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_installed_at_path();

            /**
             * Set our installable-to-path requirement, return ourself.
             *
             * \since 0.61
             */
            PartiallyMadePackageDepSpec & installable_to_path(const FSPath &, const bool include_masked);

            /**
             * Clear our installable-to-path requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_installable_to_path();

            /**
             * Set our package name part requirements, return ourself.
             */
            PartiallyMadePackageDepSpec & package_name_part(const PackageNamePart &);

            /**
             * Clear our package name part requirements, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_package_name_part();

            /**
             * Set our category name part requirements, return ourself.
             */
            PartiallyMadePackageDepSpec & category_name_part(const CategoryNamePart &);

            /**
             * Clear our category name part requirements, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_category_name_part();

            /**
             * Add a version requirement, return ourself.
             */
            PartiallyMadePackageDepSpec & version_requirement(const VersionRequirement &);

            /**
             * Clear all version requirement, return ourself.
             *
             * \since 0.55
             */
            PartiallyMadePackageDepSpec & clear_version_requirements();

            /**
             * Set our version requirements mode, return ourself.
             */
            PartiallyMadePackageDepSpec & version_requirements_mode(const VersionRequirementsMode &);

            /**
             * Add an additional requirement, return ourself.
             */
            PartiallyMadePackageDepSpec & additional_requirement(
                    const std::shared_ptr<const AdditionalPackageDepSpecRequirement> &);

            /**
             * Add a key requirement, return ourself.
             */
            PartiallyMadePackageDepSpec & key_constraint(
                    const std::string & key, const KeyConstraintOperation, const std::string & pattern);

            /**
             * Clear additional requirements, return ourself.
             *
             * \since 0.41
             */
            PartiallyMadePackageDepSpec & clear_additional_requirements();

            /**
             * Turn ourselves into a PackageDepSpec.
             */
            operator const PackageDepSpec() const;

            /**
             * Explicitly turn ourselves into a PackageDepSpec.
             */
            const PackageDepSpec to_package_dep_spec() const;
    };

    extern template class Pimp<PartiallyMadePackageDepSpec>;
}

#endif