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

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

#include <paludis/use_requirements-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/name.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/wrapped_output_iterator.hh>

namespace paludis
{
    /**
     * A selection of USE flag requirements.
     *
     * \ingroup g_dep_spec
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UseRequirements :
        private PrivateImplementationPattern<UseRequirements>
    {
        public:
            ///\name Basic operations
            ///\{

            UseRequirements();
            UseRequirements(const UseRequirements &);
            ~UseRequirements();

            ///\}

            ///\name Iterate over our USE requirements
            ///\{

            struct ConstIteratorTag;
            typedef WrappedForwardIterator<ConstIteratorTag, const tr1::shared_ptr<const UseRequirement> > ConstIterator;

            ConstIterator begin() const;
            ConstIterator end() const;

            ///\}

            /// Find the requirement for a particular USE flag.
            ConstIterator find(const UseFlagName & u) const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Insert a new requirement.
            void insert(const tr1::shared_ptr<const UseRequirement> &);

            /// Are we empty?
            bool empty() const
                PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * Visitor types for a UseRequirement.
     *
     * \ingroup g_dep_spec
     * \since 0.26
     */
    struct UseRequirementVisitorTypes :
        VisitorTypes<
            UseRequirementVisitorTypes,
            UseRequirement,
            EnabledUseRequirement,
            DisabledUseRequirement,
            EqualUseRequirement,
            NotEqualUseRequirement
        >
    {
    };

    /**
     * A requirement for a use flag.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE UseRequirement :
        public virtual ConstAcceptInterface<UseRequirementVisitorTypes>
    {
        public:
            virtual ~UseRequirement() = 0;

            /// Our use flag.
            virtual const UseFlagName flag() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * An enabled requirement for a use flag.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE EnabledUseRequirement :
        public UseRequirement,
        public ConstAcceptInterfaceVisitsThis<UseRequirementVisitorTypes, EnabledUseRequirement>
    {
        private:
            const UseFlagName _name;

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

            EnabledUseRequirement(const UseFlagName &);
            ~EnabledUseRequirement();

            ///\}

            virtual const UseFlagName flag() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * A disabled requirement for a use flag.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE DisabledUseRequirement :
        public UseRequirement,
        public ConstAcceptInterfaceVisitsThis<UseRequirementVisitorTypes, DisabledUseRequirement>
    {
        private:
            const UseFlagName _name;

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

            DisabledUseRequirement(const UseFlagName &);
            ~DisabledUseRequirement();

            ///\}

            const UseFlagName flag() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * An equal requirement for a use flag.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE EqualUseRequirement :
        public UseRequirement,
        public ConstAcceptInterfaceVisitsThis<UseRequirementVisitorTypes, EqualUseRequirement>
    {
        private:
            const UseFlagName _name;
            const tr1::shared_ptr<const PackageID> _id;

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

            EqualUseRequirement(const UseFlagName &, const tr1::shared_ptr<const PackageID> &);
            ~EqualUseRequirement();

            ///\}

            const UseFlagName flag() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Our package.
            const tr1::shared_ptr<const PackageID> package_id() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * A not equal requirement for a use flag.
     *
     * \since 0.26
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE NotEqualUseRequirement :
        public UseRequirement,
        public ConstAcceptInterfaceVisitsThis<UseRequirementVisitorTypes, NotEqualUseRequirement>
    {
        private:
            const UseFlagName _name;
            const tr1::shared_ptr<const PackageID> _id;

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

            NotEqualUseRequirement(const UseFlagName &, const tr1::shared_ptr<const PackageID> &);
            ~NotEqualUseRequirement();

            ///\}

            const UseFlagName flag() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /// Our package.
            const tr1::shared_ptr<const PackageID> package_id() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };
}

#endif