aboutsummaryrefslogtreecommitdiff
path: root/python/version_spec.cc
blob: 17e6d726024f01fe158c68386052367ced4807b6 (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
/* 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/exception.hh>

#include <paludis/version_spec.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/options.hh>
#include <paludis/user_dep_spec.hh>

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

namespace
{
    VersionSpec * make_version_spec(const std::string & s)
    {
        return new VersionSpec(s, user_version_spec_options());
    }

}

void expose_version_spec()
{
    /**
     * Exceptions
     */
    ExceptionRegister::get_instance()->add_exception<BadVersionSpecError>
        ("BadVersionSpecError", "BaseException",
         "Thrown if a VersionSpec is created from an invalid version string.");

    /**
     * VersionSpec
     */
    bp::class_<VersionSpec>
        (
         "VersionSpec",
         "A VersionSpec represents a version number (for example, 1.2.3b-r1).\n\n"

         "See U{example_version_spec<###EX###example_version_spec.html>}",
         bp::no_init
        )
        .def("__init__",
                bp::make_constructor(&make_version_spec),
                "__init__(string)"
            )

        .def("bump", &VersionSpec::bump,
                "bump() -> VersionSpec\n"
                "This is used by the ~> operator. It returns a VersionSpec where the next to last number "
                "is one greater (e.g. 5.3.1 => 5.4).\n"
                "Any non number parts are stripped (e.g. 1.2.3_alpha4-r5 => 1.3)."
            )

        .add_property("is_scm", &VersionSpec::is_scm,
                "[ro] bool\n"
                "Are we an -scm package, or something pretending to be one?"
                )

        .add_property("has_scm_part", &VersionSpec::has_scm_part,
                "[ro] bool\n"
                "Do we have an -scm part?"
                )

        .add_property("has_try_part", &VersionSpec::has_try_part,
                "[ro] bool\n"
                "Do we have a -try part?"
                )

        .def("remove_revision", &VersionSpec::remove_revision,
                "remove_revision() -> VersionSpec\n"
                "Remove the revision part."
            )

        .def("revision_only", &VersionSpec::revision_only,
                "revision_only() -> string\n"
                "Revision part only (or \"r0\")."
            )

        .def("__cmp__", &VersionSpec::compare)

        .def(bp::self_ns::str(bp::self))
        ;
}