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

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

#include <paludis/util/operators.hh>
#include <paludis/util/exception.hh>
#include <paludis/version_operator-fwd.hh>
#include <paludis/version_spec-fwd.hh>
#include <string>

/** \file
 * Declarations for VersionOperator classes.
 *
 * \ingroup g_names
 *
 * \section Examples
 *
 * - \ref example_version_operator.cc "example_version_operator.cc"
 * - \ref example_version_spec.cc "example_version_spec.cc"
 */

namespace paludis
{
    /**
     * An operator attached to a VersionSpec, validated.
     *
     * \ingroup g_names
     */
    class PALUDIS_VISIBLE VersionOperator :
        public equality_operators::HasEqualityOperators
    {
        friend std::ostream & operator<< (std::ostream &, const VersionOperator &);

        private:
            static VersionOperatorValue _decode(const std::string & v);

            VersionOperatorValue _v;

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

            /**
             * Constructor.
             */
            VersionOperator(const VersionOperatorValue v) :
                _v(v)
            {
            }

            /**
             * Copy constructor.
             */
            VersionOperator(const VersionOperator & other) :
                _v(other._v)
            {
            }

            /**
             * Constructor, from a string.
             */
            explicit VersionOperator(const std::string & v) :
                _v(_decode(v))
            {
            }

            /**
             * Assignment.
             */
            const VersionOperator & operator= (const VersionOperator & other)
            {
                _v = other._v;
                return *this;
            }

            ///\}

            /**
             * Return value.
             */
            VersionOperatorValue value() const
            {
                return _v;
            }

            /**
             * A VersionSpec comparator function.
             */
            typedef bool (* VersionSpecComparator) (const VersionSpec &, const VersionSpec &);

            /**
             * Fetch a VersionSpecComparator.
             */
            VersionSpecComparator as_version_spec_comparator() const;

            ///\name Comparison operators
            ///\{

            bool operator== (const VersionOperator & other) const
            {
                return _v == other._v;
            }

            std::size_t hash() const
            {
                return static_cast<std::size_t>(_v);
            }

            ///\}
    };

    /**
     * Thrown if a bad version operator is encountered.
     *
     * \ingroup g_names
     * \ingroup g_exceptions
     */
    class PALUDIS_VISIBLE BadVersionOperatorError :
        public Exception
    {
        public:
            /**
             * Constructor.
             */
            BadVersionOperatorError(const std::string & msg) throw ();
    };
}

#endif