marko/semver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move inline definitions out of the main header file; Add accessors for version field.

Browse Source
This commit is contained in:
Marko Zivanovic
2015-10-12 23:59:23 +02:00
parent 2dd59e5977
commit 6f2d8c6a72
8 changed files with 225 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/semver200.h
+48
View File
@@ -0,0 +1,48 @@
/*
The MIT License (MIT)
Copyright (c) 2015 Marko Zivanovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#pragma once
#include "version.h"
namespace version {
/// Parse string into Version_data structure according to semantic versioning 2.0.0 rules.
struct Semver200_parser {
Version_data parse(const std::string&) const;
};
/// Compare Version_data to another using semantic versioning 2.0.0 rules.
struct Semver200_comparator {
int compare(const Version_data&, const Version_data&) const;
};
/// Concrete version class that binds all semver 2.0.0 functionality together.
class Semver200_version : public Basic_version<Semver200_parser, Semver200_comparator> {
public:
Semver200_version(const std::string& v)
: Basic_version{ v, Semver200_parser(), Semver200_comparator() } {}
};
}
include/version.h
+39 -63
View File
@@ -75,46 +75,45 @@ namespace version {
Build_identifiers build_ids;
};
/// Forward declaration required for operators' template declarations.
template<typename P, typename C>
class Basic_version;
/// Compare if left version object is less than the right.
template<typename P, typename C>
bool operator<(const Basic_version<P, C>&, const Basic_version<P, C>&);
/// Compare if two version objects are equal.
template<typename P, typename C>
bool operator==(const Basic_version<P, C>& l, const Basic_version<P, C>& r);
/// Output version object to stream using standard semver format (X.Y.Z-PR+B).
template<typename P, typename C>
std::ostream& operator<<(std::ostream& os, const Basic_version<P, C>& v);
/// Generic version description and comparison class.
/**
Basic_version class describes general version object without prescribing parsing,
validation and comparison rules. These rules are implemented by supplied Parser and
Comparator parameters.
validation and comparison rules. These rules are implemented by supplied P and
C parameters.
*/
template<typename Parser, typename Comparator>
class Basic_version {
public:
/// Construct Basic_version object using Parser to parse version string and Comparator for comparison.
/// Construct Basic_version object using P to parse version string and C for comparison.
Basic_version(const std::string& v, Parser p, Comparator c)
: parser_(p), comparator_(c), ver_(parser_.parse(v)) {};
/// Compare if left version object is less than the right.
friend bool operator<(const Basic_version& l, const Basic_version& r) {
return l.comparator_.compare(l.ver_, r.ver_) == -1;
}
/// Compare if two version objects are equal.
friend bool operator==(const Basic_version& l, const Basic_version& r) {
return l.comparator_.compare(l.ver_, r.ver_) == 0;
}
/// Output version object to stream using standard semver format (X.Y.Z-PR+B).
friend std::ostream& operator<<(std::ostream& os, const Basic_version& v) {
os << v.ver_.major << "." << v.ver_.minor << "." << v.ver_.patch;
if (!v.ver_.prerelease_ids.empty()) {
os << "-";
for (auto it = v.ver_.prerelease_ids.cbegin(); it < v.ver_.prerelease_ids.cend() - 1; ++it) {
os << it->first << ".";
}
os << v.ver_.prerelease_ids.crbegin()->first;
}
if (!v.ver_.build_ids.empty()) {
os << "+";
for (auto it = v.ver_.build_ids.cbegin(); it < v.ver_.build_ids.cend() - 1; ++it) {
os << *it << ".";
}
os << *v.ver_.build_ids.crbegin();
}
return os;
}
const int major() const;
const int minor() const;
const int patch() const;
const std::string prerelease() const;
const std::string build() const;
friend bool operator< <>(const Basic_version& l, const Basic_version& r);
friend bool operator== <>(const Basic_version& l, const Basic_version& r);
friend std::ostream& operator<< <>(std::ostream& os, const Basic_version& v);
private:
Parser parser_;
@@ -122,45 +121,22 @@ namespace version {
const Version_data ver_;
};
/// Parse string into Version_data structure according to semantic versioning 2.0.0 rules.
struct Semver200_parser {
Version_data parse(const std::string&) const;
};
/// Compare Version_data to another using semantic versioning 2.0.0 rules.
struct Semver200_comparator {
int compare(const Version_data&, const Version_data&) const;
};
/// Concrete version class that binds all semver 2.0.0 functionality together.
class Semver200_version : public Basic_version<Semver200_parser, Semver200_comparator> {
public:
Semver200_version(const std::string& v)
: Basic_version{ v, Semver200_parser(), Semver200_comparator() } {}
};
/// Compare if two version objects are different.
template<typename P, typename C>
inline bool operator!=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l == r);
}
template<typename Parser, typename Comparator>
bool operator!=(const version::Basic_version<Parser, Comparator>& l, const version::Basic_version<Parser, Comparator>& r);
/// Compare if left version object is greater than the right.
template<typename P, typename C>
inline bool operator>(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return r < l;
}
template<typename Parser, typename Comparator>
bool operator>(const version::Basic_version<Parser, Comparator>& l, const version::Basic_version<Parser, Comparator>& r);
/// Compare if left version object is greater than or equal the right.
template<typename P, typename C>
inline bool operator>=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l < r);
}
template<typename Parser, typename Comparator>
bool operator>=(const version::Basic_version<Parser, Comparator>& l, const version::Basic_version<Parser, Comparator>& r);
/// Compare if left version object is less than or equal the right.
template<typename P, typename C>
inline bool operator<=(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return !(l > r);
}
template<typename Parser, typename Comparator>
bool operator<=(const version::Basic_version<Parser, Comparator>& l, const version::Basic_version<Parser, Comparator>& r);
}
#include "version.inl"
include/version.inl
+122
View File
@@ -0,0 +1,122 @@
/*
The MIT License (MIT)
Copyright (c) 2015 Marko Zivanovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#pragma once
#include "version.h"
namespace version {
namespace {
/// Utility function to splice all vector elements to output stream, using designated separator and
/// function object for getting value from vector element.
template<typename T, typename F>
std::ostream& splice(std::ostream& os, const std::vector<T>& v, const std::string& sep, F read) {
for (auto it = v.cbegin(); it < v.cend() - 1; ++it) {
os << read(*it) << sep;
}
os << read(*v.crbegin());
return os;
}
}
template<typename P, typename C>
const int Basic_version<P, C>::major() const {
return ver_.major;
}
template<typename P, typename C>
const int Basic_version<P, C>::minor() const {
return ver_.minor;
}
template<typename P, typename C>
const int Basic_version<P, C>::patch() const {
return ver_.patch;
}
template<typename P, typename C>
const std::string Basic_version<P, C>::prerelease() const {
std::stringstream ss;
splice(ss, ver_.prerelease_ids, ".", [](const auto& id) { return id.first;});
return ss.str();
}
template<typename P, typename C>
const std::string Basic_version<P, C>::build() const {
std::stringstream ss;
splice(ss, ver_.build_ids, ".", [](const auto& id) { return id;});
return ss.str();
}
template<typename P, typename C>
bool operator<(const Basic_version<P, C>& l, const Basic_version<P, C>& r) {
return l.comparator_.compare(l.ver_, r.ver_) == -1;
}
template<typename P, typename C>
bool operator==(const version::Basic_version<P, C>& l, const version::Basic_version<P, C>& r) {
return l.comparator_.compare(l.ver_, r.ver_) == 0;
}
template<typename P, typename C>
std::ostream& operator<<(std::ostream& os, const version::Basic_version<P, C>& v) {
os << v.ver_.major << "." << v.ver_.minor << "." << v.ver_.patch;
if (!v.ver_.prerelease_ids.empty()) {
os << "-";
splice(os, v.ver_.prerelease_ids, ".", [](const auto& id) { return id.first;});
}
if (!v.ver_.build_ids.empty()) {
os << "+";
splice(os, v.ver_.build_ids, ".", [](const auto& id) { return id;});
}
return os;
}
/// Compare if two version objects are different.
template<typename P, typename C>
inline bool operator!=(const version::Basic_version<P, C>& l, const version::Basic_version<P, C>& r) {
return !(l == r);
}
/// Compare if left version object is greater than the right.
template<typename P, typename C>
inline bool operator>(const version::Basic_version<P, C>& l, const version::Basic_version<P, C>& r) {
return r < l;
}
/// Compare if left version object is greater than or equal the right.
template<typename P, typename C>
inline bool operator>=(const version::Basic_version<P, C>& l, const version::Basic_version<P, C>& r) {
return !(l < r);
}
/// Compare if left version object is less than or equal the right.
template<typename P, typename C>
inline bool operator<=(const version::Basic_version<P, C>& l, const version::Basic_version<P, C>& r) {
return !(l > r);
}
}