aboutsummaryrefslogtreecommitdiff
path: root/python/mask.cc
blob: f42b8fa0eff2f7f0a6592739db98cc0b7c54c567 (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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007 Piotr JaroszyƄski
 *
 * 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
 */

#include <python/paludis_python.hh>
#include <python/iterable.hh>

#include <paludis/mask.hh>
#include <paludis/util/visitor-impl.hh>
#include <paludis/util/kc.hh>

using namespace paludis;
using namespace paludis::python;
namespace bp = boost::python;

class MaskSptrToPythonVisitor :
    public ConstVisitor<MaskVisitorTypes>
{
    private:
        const tr1::shared_ptr<const Mask> & _m_ptr;

    public:
        bp::object obj;

        MaskSptrToPythonVisitor(const tr1::shared_ptr<const Mask> & m_ptr) :
            _m_ptr(m_ptr)
        {
        }

        void visit(const UserMask & m)
        {
            obj = bp::object(tr1::static_pointer_cast<const UserMask>(_m_ptr));
        }

        void visit(const UnacceptedMask & m)
        {
            obj = bp::object(tr1::static_pointer_cast<const UnacceptedMask>(_m_ptr));
        }

        void visit(const RepositoryMask & m)
        {
            obj = bp::object(tr1::static_pointer_cast<const RepositoryMask>(_m_ptr));
        }

        void visit(const UnsupportedMask & m)
        {
            obj = bp::object(tr1::static_pointer_cast<const UnsupportedMask>(_m_ptr));
        }

        void visit(const AssociationMask & m)
        {
            obj = bp::object(tr1::static_pointer_cast<const AssociationMask>(_m_ptr));
        }
};

struct MaskSptrToPython
{
    MaskSptrToPython()
    {
        bp::to_python_converter<tr1::shared_ptr<const Mask>, MaskSptrToPython>();
    }

    static PyObject *
    convert(const tr1::shared_ptr<const Mask> & m)
    {
        MaskSptrToPythonVisitor v(m);
        m->accept(v);
        return bp::incref(v.obj.ptr());
    }
};

struct MaskWrapper :
    Mask,
    bp::wrapper<Mask>
{
    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("Mask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("Mask", "description");
    }
};

struct UserMaskWrapper :
    UserMask,
    bp::wrapper<UserMask>
{
    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("UserMask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("UserMask", "description");
    }
};

struct UnacceptedMaskWrapper :
    UnacceptedMask,
    bp::wrapper<UnacceptedMask>
{
    virtual const tr1::shared_ptr<const MetadataKey> unaccepted_key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("unaccepted_key"))
            return f();
        else
            throw PythonMethodNotImplemented("UnacceptedMask", "unaccepted_key");
    }

    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("UnacceptedMask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("UnacceptedMask", "description");
    }
};

struct RepositoryMaskWrapper :
    RepositoryMask,
    bp::wrapper<RepositoryMask>
{
    virtual const tr1::shared_ptr<const MetadataKey> mask_key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("mask_key"))
            return f();
        else
            throw PythonMethodNotImplemented("RepositoryMask", "mask_key");
    }

    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("RepositoryMask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("RepositoryMask", "description");
    }
};
struct UnsupportedMaskWrapper :
    UnsupportedMask,
    bp::wrapper<UnsupportedMask>
{
    virtual const std::string explanation() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("explanation"))
            return f();
        else
            throw PythonMethodNotImplemented("UnsupportedMask", "explanation");
    }

    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("UnsupportedMask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("UnsupportedMask", "description");
    }
};

struct AssociationMaskWrapper :
    AssociationMask,
    bp::wrapper<AssociationMask>
{
    virtual const tr1::shared_ptr<const PackageID> associated_package() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("associated_package"))
            return f();
        else
            throw PythonMethodNotImplemented("AssociationMask", "associated_package");
    }

    virtual char key() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("key"))
            return f();
        else
            throw PythonMethodNotImplemented("AssociationMask", "key");
    }

    virtual const std::string description() const
    {
        Lock l(get_mutex());

        if (bp::override f = get_override("description"))
            return f();
        else
            throw PythonMethodNotImplemented("AssociationMask", "description");
    }
};


void expose_mask()
{
    /**
     * RepositoryMaskInfo
     */
    register_shared_ptrs_to_python<RepositoryMaskInfo>(rsp_const);
    bp::class_<RepositoryMaskInfo, tr1::shared_ptr<RepositoryMaskInfo> >
        (
         "RepositoryMaskInfo",
         "Information about a RepositoryMask.",
         bp::init<const FSEntry &, const tr1::shared_ptr<const Sequence<std::string> > &>(
             "__init__(path_str, list of string)"
             )
        )
        .add_property("mask_file",
                &kc_getter<RepositoryMaskInfo, FSEntry, k::mask_file>,
                &kc_setter<RepositoryMaskInfo, FSEntry, k::mask_file>,
                "[ro] str\n"
                "Holds the file whence the mask originates."
                )

        .add_property("comment",
                &kc_getter<RepositoryMaskInfo, tr1::shared_ptr<const Sequence<std::string> >, k::comment>,
                &kc_setter<RepositoryMaskInfo, tr1::shared_ptr<const Sequence<std::string> >, k::comment>,
                "[ro] Iterable of str\n"
                "Sequence of lines explaining the mask."
                )
        ;

    /**
     * Mask
     */
    MaskSptrToPython();
    register_shared_ptrs_to_python<Mask>(rsp_non_const);
    bp::class_<MaskWrapper, boost::noncopyable>
        (
         "Mask",
         "A Mask represents one reason why a PackageID is masked (not available to\n"
         "be installed).\n\n"

         "A basic Mask has:\n\n"

         "- A single character key, which can be used by clients if they need a\n"
         "  very compact way of representing a mask.\n\n"

         "- A description.\n\n"

         "Subclasses provide additional information.",
         bp::no_init
        )
        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;

    /**
     * UserMask
     */
    bp::register_ptr_to_python<tr1::shared_ptr<const UserMask> >();
    bp::implicitly_convertible<tr1::shared_ptr<UserMaskWrapper>, tr1::shared_ptr<Mask> >();
    bp::class_<UserMaskWrapper, tr1::shared_ptr<UserMaskWrapper>,
                bp::bases<Mask>, boost::noncopyable>
        (
         "UserMask",
         "A UserMask is a Mask due to user configuration.\n\n"

         "Can be subclassed in Python.",
         bp::init<>()
        )
        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;

    /**
     * UnacceptedMask
     */
    bp::register_ptr_to_python<tr1::shared_ptr<const UnacceptedMask> >();
    bp::implicitly_convertible<tr1::shared_ptr<UnacceptedMaskWrapper>, tr1::shared_ptr<Mask> >();
    bp::class_<UnacceptedMaskWrapper, tr1::shared_ptr<UnacceptedMaskWrapper>,
            bp::bases<Mask>, boost::noncopyable>
        (
         "UnacceptedMask",
         "An UnacceptedMask is a Mask that signifies that a particular value or\n"
         "combination of values in (for example) a MetadataSetKey or\n"
         "MetadataSpecTreeKey is not accepted by user configuration.\n\n"

         "Can be subclassed in Python.",
         bp::init<>()
        )
        .def("unaccepted_key", bp::pure_virtual(&UnacceptedMask::unaccepted_key),
                "unaccepted_key() -> MetadataKey\n"
                "Fetch the metadata key that is not accepted."
                )

        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;

    /**
     * RepositoryMask
     */
    bp::register_ptr_to_python<tr1::shared_ptr<const RepositoryMask> >();
    bp::implicitly_convertible<tr1::shared_ptr<RepositoryMaskWrapper>, tr1::shared_ptr<Mask> >();
    bp::class_<RepositoryMaskWrapper, tr1::shared_ptr<RepositoryMaskWrapper>,
            bp::bases<Mask>, boost::noncopyable>
        (
         "RepositoryMask",
         "A RepositoryMask is a Mask that signifies that a PackageID has been\n"
         "marked as masked by a Repository.\n\n"

         "Can be subclassed in Python.",
         bp::init<>()
        )
        .def("mask_key", bp::pure_virtual(&RepositoryMask::mask_key),
                "mask_key() -> MetadataKey\n"
                "Fetch a metadata key explaining the mask. May return None,\n"
                "if no more information is available."
                )

        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;

    /**
     * UnsupportedMask
     */
    bp::register_ptr_to_python<tr1::shared_ptr<const UnsupportedMask> >();
    bp::implicitly_convertible<tr1::shared_ptr<UnsupportedMaskWrapper>, tr1::shared_ptr<Mask> >();
    bp::class_<UnsupportedMaskWrapper, tr1::shared_ptr<UnsupportedMaskWrapper>,
            bp::bases<Mask>, boost::noncopyable>
        (
         "UnsupportedMask",
         "An UnsupportedMask is a Mask that signifies that a PackageID is not\n"
         "supported, for example because it is broken or because it uses an\n"
         "unrecognised EAPI.\n\n"

         "Can be subclassed in Python.",
         bp::init<>()
        )
        .def("explanation", bp::pure_virtual(&UnsupportedMask::explanation),
                "explanation() -> str\n"
                "An explanation of why we are unsupported."
                )

        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;

    /**
     * AssociationMask
     */
    bp::register_ptr_to_python<tr1::shared_ptr<const AssociationMask> >();
    bp::implicitly_convertible<tr1::shared_ptr<AssociationMaskWrapper>, tr1::shared_ptr<Mask> >();
    bp::class_<AssociationMaskWrapper, tr1::shared_ptr<AssociationMaskWrapper>,
            bp::bases<Mask>, boost::noncopyable>
        (
         "AssociationMask",
         "An AssociationMask is a Mask that signifies that a PackageID is masked\n"
         "because of its association with another PackageID that is itself masked.\n\n"

         "This is used by old-style virtuals. If the provider of a virtual is\n"
         "masked then the virtual itself is masked by association.\n\n"

         "Can be subclassed in Python.",
         bp::init<>()
        )
        .def("associated_package", bp::pure_virtual(&AssociationMask::associated_package),
                "associated_package() -> PackageID\n"
                "Fetch the associated package."
                )

        .def("key", bp::pure_virtual(&Mask::key),
                "key() -> string\n"
                "A single character key, which can be used by clients if they need\n"
                "a very compact way of representing a mask."
                )

        .def("description", bp::pure_virtual(&Mask::description),
                "description() -> string\n"
                "A description of the mask."
                )
        ;
}