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
|
/*
* Copyright (C) 2016 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef IGNITION_MATH_SEMANTICVERSION_HH_
#define IGNITION_MATH_SEMANTICVERSION_HH_
#include <memory>
#include <string>
#include <ignition/math/Helpers.hh>
#include <ignition/math/config.hh>
namespace ignition
{
namespace math
{
inline namespace IGNITION_MATH_VERSION_NAMESPACE
{
// Forward declare private data class
class SemanticVersionPrivate;
/// \class SemanticVersion SemanticVersion.hh
/// ignition/math/SemanticVersion.hh
/// \brief Version comparison class based on Semantic Versioning 2.0.0
/// http://semver.org/
/// Compares versions and converts versions from string.
class IGNITION_MATH_VISIBLE SemanticVersion
{
/// \brief Default constructor. Use the Parse function to populate
/// an instance with version information.
public: SemanticVersion();
/// \brief Constructor
/// \param[in] _v the string version. ex: "0.3.2"
public: explicit SemanticVersion(const std::string &_v);
/// \brief Copy constructor
/// \param[in] _copy the other version
public: SemanticVersion(const SemanticVersion &_copy);
/// \brief Assignment operator
/// \param[in] _other The version to assign from.
/// \return The reference to this instance
public: SemanticVersion &operator=(const SemanticVersion &_other);
/// \brief Constructor
/// \param[in] _major The major number
/// \param[in] _minor The minor number
/// \param[in] _patch The patch number
/// \param[in] _prerelease The prerelease string
/// \param[in] _build The build metadata string
public: SemanticVersion(const unsigned int _major,
const unsigned int _minor = 0,
const unsigned int _patch = 0,
const std::string &_prerelease = "",
const std::string &_build = "");
/// \brief Destructor
public: ~SemanticVersion();
/// \brief Parse a version string and set the major, minor, patch
/// numbers, and prerelease and build strings.
/// \param[in] _versionStr The version string, such as "1.2.3-pr+123"
/// \retur True on success.
public: bool Parse(const std::string &_versionStr);
/// \brief Returns the version as a string
/// \return The semantic version string
public: std::string Version() const;
/// \brief Get the major number
/// \return The major number
public: unsigned int Major() const;
/// \brief Get the minor number
/// \return The minor number
public: unsigned int Minor() const;
/// \brief Get the patch number
/// \return The patch number
public: unsigned int Patch() const;
/// \brief Get the prerelease string.
/// \return Prelrease string, empty if a prerelease string was not
/// specified.
public: std::string Prerelease() const;
/// \brief Get the build metadata string. Build meta data is not used
/// when determining precedence.
/// \return Build metadata string, empty if a build metadata string was
/// not specified.
public: std::string Build() const;
/// \brief Less than comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is newer
public: bool operator<(const SemanticVersion &_other) const;
/// \brief Less than or equal comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is newer or equal
public: bool operator<=(const SemanticVersion &_other) const;
/// \brief Greater than comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is older
public: bool operator>(const SemanticVersion &_other) const;
/// \brief Greater than or equal comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is older or the same
public: bool operator>=(const SemanticVersion &_other) const;
/// \brief Equality comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is the same
public: bool operator==(const SemanticVersion &_other) const;
/// \brief Inequality comparison operator
/// \param[in] _other The other version to compare to
/// \return True if _other version is different
public: bool operator!=(const SemanticVersion &_other) const;
/// \brief Stream insertion operator
/// \param _out output stream
/// \param _v Semantic version to output
/// \return the stream
public: friend std::ostream &operator<<(std::ostream &_out,
const SemanticVersion &_v)
{
_out << _v.Version();
return _out;
}
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
/// \brief Pointer to private data
private: std::unique_ptr<SemanticVersionPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
};
}
}
}
#endif
|
