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

/*
 * Copyright (c) 2007 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_LABEL_HH
#define PALUDIS_GUARD_PALUDIS_DEP_LABEL_HH 1

#include <paludis/dep_label-fwd.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/attributes.hh>

/** \file
 * Declarations for dependency label-related classes.
 *
 * \ingroup g_dep_spec
 *
 * \section Examples
 *
 * - \ref example_dep_label.cc "example_dep_label.cc"
 * - \ref example_dep_spec.cc "example_dep_spec.cc" (for specifications)
 * - \ref example_dep_tree.cc "example_dep_tree.cc" (for specification trees)
 * - \ref example_dep_tag.cc "example_dep_tag.cc" (for tags)
 */

namespace paludis
{
    /**
     * Types for visiting a URI label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct URILabelVisitorTypes :
        VisitorTypes<
            URILabelVisitorTypes,
            URILabel,
            URIMirrorsThenListedLabel,
            URIMirrorsOnlyLabel,
            URIListedOnlyLabel,
            URIListedThenMirrorsLabel,
            URILocalMirrorsOnlyLabel,
            URIManualOnlyLabel
        >
    {
    };

    /**
     * Types for visiting a dependency label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct DependencyLabelVisitorTypes :
        VisitorTypes<
            DependencyLabelVisitorTypes,
            DependencyLabel,
            DependencySystemLabel,
            DependencyTypeLabel,
            DependencySuggestLabel,
            DependencyABIsLabel
        >
    {
    };

    /**
     * Types for visiting a dependency system label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct DependencySystemLabelVisitorTypes :
        VisitorTypes<
            DependencySystemLabelVisitorTypes,
            DependencySystemLabel,
            DependencyHostLabel,
            DependencyTargetLabel
        >
    {
    };

    /**
     * Types for visiting a dependency type label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct DependencyTypeLabelVisitorTypes :
        VisitorTypes<
            DependencyTypeLabelVisitorTypes,
            DependencyTypeLabel,
            DependencyBuildLabel,
            DependencyRunLabel,
            DependencyPostLabel,
            DependencyInstallLabel,
            DependencyCompileLabel
        >
    {
    };

    /**
     * Types for visiting a dependency suggests label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct DependencySuggestLabelVisitorTypes :
        VisitorTypes<
            DependencySuggestLabelVisitorTypes,
            DependencySuggestLabel,
            DependencySuggestedLabel,
            DependencyRecommendedLabel,
            DependencyRequiredLabel
        >
    {
    };

    /**
     * Types for visiting a dependency abi label.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct DependencyABIsLabelVisitorTypes :
        VisitorTypes<
            DependencyABIsLabelVisitorTypes,
            DependencyABIsLabel,
            DependencyAnyLabel,
            DependencyMineLabel,
            DependencyPrimaryLabel,
            DependencyABILabel
        >
    {
    };

    /**
     * URI label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE URILabel :
        private InstantiationPolicy<URILabel, instantiation_method::NonCopyableTag>,
        public virtual ConstAcceptInterface<URILabelVisitorTypes>
    {
        public:
            ///\name Basic operations
            ///\{

            virtual ~URILabel() = 0;

            ///\}

            /// Our text.
            virtual const std::string text() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * A concrete URI label class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    template <typename T_>
    class PALUDIS_VISIBLE ConcreteURILabel :
        public URILabel,
        public ConstAcceptInterfaceVisitsThis<URILabelVisitorTypes, ConcreteURILabel<T_> >,
        private PrivateImplementationPattern<ConcreteURILabel<T_> >
    {
        private:
            using PrivateImplementationPattern<ConcreteURILabel<T_> >::_imp;

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

            ConcreteURILabel(const std::string &);
            ~ConcreteURILabel();

            ///\}

            virtual const std::string text() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Convenience typedef alias to obtain our tag.
            typedef T_ Tag;
    };

    /**
     * Dependency label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DependencyLabel :
        private InstantiationPolicy<DependencyLabel, instantiation_method::NonCopyableTag>,
        public virtual ConstAcceptInterface<DependencyLabelVisitorTypes>
    {
        public:
            ///\name Basic operations
            ///\{

            virtual ~DependencyLabel() = 0;

            ///\}

            /// Our text.
            virtual const std::string text() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * System dependency label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct PALUDIS_VISIBLE DependencySystemLabel :
        public DependencyLabel,
        public ConstAcceptInterfaceVisitsThis<DependencyLabelVisitorTypes, DependencySystemLabel>,
        public virtual ConstAcceptInterface<DependencySystemLabelVisitorTypes>
    {
        /// Convenience alias for our visitor types.
        typedef DependencySystemLabelVisitorTypes VisitorTypes;

        typedef ConstAcceptInterface<DependencySystemLabelVisitorTypes>::Heirarchy Heirarchy;
        using ConstAcceptInterface<DependencySystemLabelVisitorTypes>::accept;
    };

    /**
     * Type dependency label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct PALUDIS_VISIBLE DependencyTypeLabel :
        public DependencyLabel,
        public ConstAcceptInterfaceVisitsThis<DependencyLabelVisitorTypes, DependencyTypeLabel>,
        public virtual ConstAcceptInterface<DependencyTypeLabelVisitorTypes>
    {
        /// Convenience alias for our visitor types.
        typedef DependencyTypeLabelVisitorTypes VisitorTypes;

        typedef ConstAcceptInterface<DependencyTypeLabelVisitorTypes>::Heirarchy Heirarchy;
        using ConstAcceptInterface<DependencyTypeLabelVisitorTypes>::accept;
    };

    /**
     * Suggest dependency label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct PALUDIS_VISIBLE DependencySuggestLabel :
        public DependencyLabel,
        public ConstAcceptInterfaceVisitsThis<DependencyLabelVisitorTypes, DependencySuggestLabel>,
        public virtual ConstAcceptInterface<DependencySuggestLabelVisitorTypes>
    {
        /// Convenience alias for our visitor types.
        typedef DependencySuggestLabelVisitorTypes VisitorTypes;

        typedef ConstAcceptInterface<DependencySuggestLabelVisitorTypes>::Heirarchy Heirarchy;
        using ConstAcceptInterface<DependencySuggestLabelVisitorTypes>::accept;
    };

    /**
     * ABI dependency label base class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    struct PALUDIS_VISIBLE DependencyABIsLabel :
        public DependencyLabel,
        public ConstAcceptInterfaceVisitsThis<DependencyLabelVisitorTypes, DependencyABIsLabel>,
        public virtual ConstAcceptInterface<DependencyABIsLabelVisitorTypes>
    {
        /// Convenience alias for our visitor types.
        typedef DependencyABIsLabelVisitorTypes VisitorTypes;

        typedef ConstAcceptInterface<DependencyABIsLabelVisitorTypes>::Heirarchy Heirarchy;
        using ConstAcceptInterface<DependencyABIsLabelVisitorTypes>::accept;
    };

    /**
     * A concrete dependency label class.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    template <typename T_, typename C_>
    class PALUDIS_VISIBLE ConcreteDependencyLabel :
        public C_,
        public ConstAcceptInterfaceVisitsThis<typename C_::VisitorTypes, ConcreteDependencyLabel<T_, C_> >,
        private PrivateImplementationPattern<ConcreteDependencyLabel<T_, C_> >
    {
        private:
            using PrivateImplementationPattern<ConcreteDependencyLabel<T_, C_> >::_imp;

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

            ConcreteDependencyLabel(const std::string &);
            ~ConcreteDependencyLabel();

            ///\}

            virtual const std::string text() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Convenience typedef alias to obtain our tag.
            typedef T_ Tag;
    };

    /**
     * A collection of each dependency label type.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE ActiveDependencyLabels :
        private PrivateImplementationPattern<ActiveDependencyLabels>
    {
        public:
            ///\name Basic operations
            ///\{

            ActiveDependencyLabels(const DependencyLabelsDepSpec &);
            ActiveDependencyLabels(const DependencyLabelSequence &);
            ActiveDependencyLabels(const ActiveDependencyLabels &);
            ActiveDependencyLabels(const ActiveDependencyLabels &, const DependencyLabelsDepSpec &);
            ~ActiveDependencyLabels();

            ///\}

            ///\name Current label selections
            ///\{

            const tr1::shared_ptr<const DependencySystemLabelSequence> system_labels() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const tr1::shared_ptr<const DependencyTypeLabelSequence> type_labels() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const tr1::shared_ptr<const DependencyABIsLabelSequence> abi_labels() const PALUDIS_ATTRIBUTE((warn_unused_result));
            const tr1::shared_ptr<const DependencySuggestLabelSequence> suggest_labels() const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}
    };
}

#endif