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

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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_VERSION_SPEC_HH
#define PALUDIS_GUARD_PALUDIS_VERSION_SPEC_HH 1

#include <paludis/util/comparison_policy.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/collection.hh>

#include <iosfwd>
#include <string>

/** \file
 * Declarations of the VersionSpec class.
 *
 * \ingroup grpversions
 */

namespace paludis
{
    /**
     * Thrown if a VersionSpec is created from an invalid version string.
     *
     * \ingroup grpexceptions
     * \ingroup grpversions
     */
    class BadVersionSpecError : public NameError
    {
        public:
            /**
             * Constructor.
             */
            BadVersionSpecError(const std::string & name) throw ();
    };

    /**
     * A VersionSpec represents a version number (for example, 1.2.3b-r1).
     *
     * \ingroup grpversions
     */
    class VersionSpec :
        private PrivateImplementationPattern<VersionSpec>,
        public ComparisonPolicy<VersionSpec, comparison_mode::FullComparisonTag,
            comparison_method::CompareByMemberComparisonFunctionTag>
    {
        friend std::ostream & operator<< (std::ostream &, const VersionSpec &);

        protected:
            /**
             * Compare to another version.
             */
            int compare(const VersionSpec & other) const;

        public:
            /**
             * Constructor.
             */
            explicit VersionSpec(const std::string & text);

            /**
             * Copy constructor.
             */
            VersionSpec(const VersionSpec & other);

            /**
             * Destructor.
             */
            ~VersionSpec();

            /**
             * Assignment.
             */
            const VersionSpec & operator= (const VersionSpec & other);

            /**
             * Comparison function for ~ depend operator.
             */
            bool tilde_compare(const VersionSpec & other) const;

            /**
             * Comparison function for ~> depend operator (gems).
             */
            bool tilde_greater_compare(const VersionSpec & other) const;

            /**
             * Comparison function for =* depend operator.
             */
            bool equal_star_compare(const VersionSpec & other) const;

            /**
             * Fetch a hash value, used to avoid exposing our internals to
             * CRCHash.
             */
            std::size_t hash_value() const;

            /**
             * Remove the revision part.
             */
            VersionSpec remove_revision() const;

            /**
             * Revision part only (or "r0").
             */
            std::string revision_only() const;

            /**
             * Bump ourself.
             *
             * This is used by the ~> operator. It returns a version where the
             * next to last number is one greater (e.g. 5.3.1 => 5.4). Any non
             * number parts are stripped (e.g. 1.2.3_alpha4-r5 => 1.3).
             */
            VersionSpec bump() const;

            /**
             * Are we an -scm package, or something pretending to be one?
             */
            bool is_scm() const;

    };

    /**
     * Output a VersionSpec to a stream.
     *
     * \ingroup grpversions
     */
    std::ostream & operator<< (std::ostream &, const VersionSpec &);

    /**
     * Holds a collection of VersionSpec instances.
     *
     * \ingroup grpversions
     */
    typedef SortedCollection<VersionSpec> VersionSpecCollection;
}

#endif