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

/*
 * Copyright (c) 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_MASK_HH
#define PALUDIS_GUARD_PALUDIS_MASK_HH 1

#include <paludis/mask-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/fs_path.hh>
#include <paludis/util/sequence-fwd.hh>
#include <paludis/util/named_value.hh>
#include <paludis/util/type_list.hh>
#include <string>

/** \file
 * Declarations for mask classes.
 *
 * \ingroup g_mask
 *
 * \section Examples
 *
 * - \ref example_mask.cc "example_mask.cc" (for masks)
 */

namespace paludis
{
    namespace n
    {
        typedef Name<struct name_comment> comment;
        typedef Name<struct name_mask> mask;
        typedef Name<struct name_mask_file> mask_file;
        typedef Name<struct name_override_reason> override_reason;
    }

    /**
     * Information about a RepositoryMask.
     *
     * The mask_file key holds the file whence the mask originates.
     *
     * The comment key is a sequence of lines explaining the mask.
     *
     * \ingroup g_package_id
     * \since 0.30
     * \nosubgrouping
     */
    struct RepositoryMaskInfo
    {
        NamedValue<n::comment, std::shared_ptr<const Sequence<std::string> > > comment;
        NamedValue<n::mask_file, FSPath> mask_file;
    };

    /**
     * A Mask represents one reason why a PackageID is masked (not available to
     * be installed).
     *
     * A basic Mask has:
     *
     * - A single character key, which can be used by clients if they need a
     *   very compact way of representing a mask.
     *
     * - A description.
     *
     * Subclasses provide additional information.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE Mask :
        public virtual DeclareAbstractAcceptMethods<Mask, MakeTypeList<
            UserMask, UnacceptedMask, RepositoryMask, UnsupportedMask, AssociationMask>::Type>
    {
        public:
            ///\name Basic operations
            ///\{

            virtual ~Mask() = 0;

            ///\}

            /**
             * A single character key, which can be used by clients if they need
             * a very compact way of representing a mask.
             */
            virtual char key() const = 0;

            /**
             * A description of the mask.
             */
            virtual const std::string description() const = 0;
    };

    /**
     * A UserMask is a Mask due to user configuration.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UserMask :
        public Mask,
        public ImplementAcceptMethods<Mask, UserMask>
    {
    };

    /**
     * An UnacceptedMask is a Mask that signifies that a particular value or
     * combination of values in (for example) a MetadataCollectionKey or
     * MetadataSpecTreeKey is not accepted by user configuration.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UnacceptedMask :
        public Mask,
        public ImplementAcceptMethods<Mask, UnacceptedMask>
    {
        public:
            /**
             * Fetch the raw name of the metadata key that is not accepted.
             *
             * \since 0.59
             */
            virtual const std::string unaccepted_key_name() const = 0;
    };

    /**
     * A RepositoryMask is a Mask that signifies that a PackageID has been
     * marked as masked by a Repository.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE RepositoryMask :
        public Mask,
        public ImplementAcceptMethods<Mask, RepositoryMask>
    {
        public:
            /**
             * Fetch the raw name of a metadata key explaining the mask. May
             * return a zero pointer, if no more information is available.
             *
             * \since 0.59
             */
            virtual const std::string mask_key_name() const = 0;
    };

    /**
     * An UnsupportedMask is a Mask that signifies that a PackageID is not
     * supported, for example because it is broken or because it uses an
     * unrecognised EAPI.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UnsupportedMask :
        public Mask,
        public ImplementAcceptMethods<Mask, UnsupportedMask>
    {
        public:
            /**
             * An explanation of why we are unsupported.
             */
            virtual const std::string explanation() const = 0;
    };

    /**
     * An AssociationMask is a Mask that signifies that a PackageID is masked
     * because of its association with another PackageID that is itself masked.
     *
     * This is used by old-style virtuals. If the provider of a virtual is
     * masked then the virtual itself is masked by association.
     *
     * \ingroup g_mask
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE AssociationMask :
        public Mask,
        public ImplementAcceptMethods<Mask, AssociationMask>
    {
        public:
            /**
             * Fetch a spec identifying the associated package.
             *
             * \since 0.59
             */
            virtual const PackageDepSpec associated_package_spec() const = 0;
    };

    /**
     * An OverriddenMask holds a Mask and an explanation of why it has been overridden.
     *
     * \ingroup g_mask
     * \since 0.34
     */
    struct OverriddenMask
    {
        NamedValue<n::mask, std::shared_ptr<const Mask> > mask;
        NamedValue<n::override_reason, MaskOverrideReason> override_reason;

    };
}

#endif