geode/loader/include/Geode/utils/VersionInfo.hpp

254 lines
8.3 KiB
C++
Raw Normal View History

2022-07-30 12:24:03 -04:00
#pragma once
#include "../DefaultInclude.hpp"
2022-07-30 12:24:03 -04:00
#include <string_view>
#include <matjson.hpp>
#include <tuple>
#include "../utils/Result.hpp"
2022-07-30 12:24:03 -04:00
namespace geode {
enum class VersionCompare {
LessEq,
Exact,
MoreEq,
Less,
More,
2023-08-07 14:13:40 -04:00
Any
};
2022-07-30 12:24:03 -04:00
/**
* A version label, like v1.0.0-alpha or v2.3.4-prerelease. Limited to these
* options; arbitary identifiers are not supported. Additional numbering
* may be added after the identifier, such as v1.0.0-beta.1
2022-12-12 08:45:27 -05:00
*/
struct VersionTag {
enum {
Alpha,
Beta,
Prerelease,
} value;
std::optional<size_t> number;
using Type = decltype(value);
constexpr VersionTag(Type const& value) : value(value) {}
constexpr VersionTag(Type const& value, std::optional<size_t> number)
: value(value), number(number) {}
constexpr bool operator==(VersionTag const& other) const {
return value == other.value && number == other.number;
}
constexpr bool operator<(VersionTag const& other) const {
if (value == other.value) {
if (number && other.number) return number < other.number;
if (number) return true;
if (other.number) return false;
return false;
}
return value < other.value;
}
constexpr bool operator<=(VersionTag const& other) const {
if (value == other.value) {
if (number && other.number) return number <= other.number;
if (number) return true;
if (other.number) return false;
return true;
}
return value <= other.value;
}
constexpr bool operator>(VersionTag const& other) const {
if (value == other.value) {
if (number && other.number) return number > other.number;
2023-03-06 13:59:30 -05:00
if (number) return false;
if (other.number) return true;
return false;
}
return value > other.value;
}
constexpr bool operator>=(VersionTag const& other) const {
if (value == other.value) {
if (number && other.number) return number >= other.number;
2023-03-06 13:59:30 -05:00
if (number) return false;
if (other.number) return true;
return true;
}
return value >= other.value;
}
static Result<VersionTag> parse(std::stringstream& str);
std::string toSuffixString() const;
std::string toString() const;
2022-12-12 08:45:27 -05:00
};
2023-03-06 13:59:30 -05:00
constexpr bool operator<(std::optional<VersionTag> const& a, std::optional<VersionTag> const& b) {
2023-03-07 03:56:36 -05:00
if (a && b) return *a < *b;
2023-03-06 13:59:30 -05:00
if (a) return true;
if (b) return false;
return false;
}
constexpr bool operator<=(std::optional<VersionTag> const& a, std::optional<VersionTag> const& b) {
2023-03-07 03:56:36 -05:00
if (a && b) return *a <= *b;
2023-03-06 13:59:30 -05:00
if (a) return true;
if (b) return false;
return true;
}
constexpr bool operator>(std::optional<VersionTag> const& a, std::optional<VersionTag> const& b) {
2023-03-07 03:56:36 -05:00
if (a && b) return *a > *b;
2023-03-06 13:59:30 -05:00
if (a) return false;
if (b) return true;
return false;
}
constexpr bool operator>=(std::optional<VersionTag> const& a, std::optional<VersionTag> const& b) {
2023-03-07 03:56:36 -05:00
if (a && b) return *a >= *b;
2023-03-06 13:59:30 -05:00
if (a) return false;
if (b) return true;
return true;
}
2022-12-12 08:45:27 -05:00
/**
* Class representing version information. Uses a limited subset of SemVer;
* identifiers are restricted to a few predefined ones, and only one
* identifier is allowed. See VersionTag for details
2022-07-30 12:24:03 -04:00
*/
class GEODE_DLL VersionInfo final {
2022-07-30 12:24:03 -04:00
protected:
2022-12-12 08:45:27 -05:00
size_t m_major = 1;
size_t m_minor = 0;
size_t m_patch = 0;
std::optional<VersionTag> m_tag;
2022-10-30 14:59:20 -04:00
2022-07-30 12:24:03 -04:00
public:
2022-12-08 15:04:02 -05:00
constexpr VersionInfo() = default;
2022-12-12 08:45:27 -05:00
constexpr VersionInfo(size_t major, size_t minor, size_t patch) {
m_major = major;
m_minor = minor;
m_patch = patch;
}
constexpr VersionInfo(
size_t major, size_t minor, size_t patch,
std::optional<VersionTag> tag
) {
2022-07-30 12:24:03 -04:00
m_major = major;
m_minor = minor;
m_patch = patch;
2022-12-12 08:45:27 -05:00
m_tag = tag;
2022-07-30 12:24:03 -04:00
}
static Result<VersionInfo> parse(std::string const& string);
2022-07-30 12:24:03 -04:00
2022-12-12 08:45:27 -05:00
constexpr size_t getMajor() const {
2022-12-08 15:04:02 -05:00
return m_major;
}
2022-07-30 12:24:03 -04:00
2022-12-12 08:45:27 -05:00
constexpr size_t getMinor() const {
2022-12-08 15:04:02 -05:00
return m_minor;
}
2022-07-30 12:24:03 -04:00
2022-12-12 08:45:27 -05:00
constexpr size_t getPatch() const {
2022-12-08 15:04:02 -05:00
return m_patch;
}
2022-12-12 08:45:27 -05:00
constexpr std::optional<VersionTag> getTag() const {
return m_tag;
}
// Apple clang does not support operator<=>! Yippee!
constexpr bool operator==(VersionInfo const& other) const {
return std::tie(m_major, m_minor, m_patch, m_tag) ==
std::tie(other.m_major, other.m_minor, other.m_patch, other.m_tag);
}
constexpr bool operator<(VersionInfo const& other) const {
return std::tie(m_major, m_minor, m_patch, m_tag) <
std::tie(other.m_major, other.m_minor, other.m_patch, other.m_tag);
}
constexpr bool operator<=(VersionInfo const& other) const {
return std::tie(m_major, m_minor, m_patch, m_tag) <=
std::tie(other.m_major, other.m_minor, other.m_patch, other.m_tag);
}
constexpr bool operator>(VersionInfo const& other) const {
return std::tie(m_major, m_minor, m_patch, m_tag) >
std::tie(other.m_major, other.m_minor, other.m_patch, other.m_tag);
}
constexpr bool operator>=(VersionInfo const& other) const {
return std::tie(m_major, m_minor, m_patch, m_tag) >=
std::tie(other.m_major, other.m_minor, other.m_patch, other.m_tag);
2022-12-08 15:04:02 -05:00
}
2022-07-30 12:24:03 -04:00
2022-12-12 08:45:27 -05:00
std::string toString(bool includeTag = true) const;
friend GEODE_DLL std::string format_as(VersionInfo const& version);
2022-07-30 12:24:03 -04:00
};
2022-11-22 17:35:08 -05:00
class GEODE_DLL ComparableVersionInfo final {
protected:
VersionInfo m_version;
VersionCompare m_compare = VersionCompare::Exact;
2023-08-07 14:13:40 -04:00
public:
constexpr ComparableVersionInfo() = default;
constexpr ComparableVersionInfo(
VersionInfo const& version,
VersionCompare const& compare
) : m_version(version), m_compare(compare) {}
static Result<ComparableVersionInfo> parse(std::string const& string);
constexpr bool compare(VersionInfo const& version) const {
2023-08-07 14:13:40 -04:00
if (m_compare == VersionCompare::Any) {
return true;
}
// opposing major versions never match
if (m_version.getMajor() != version.getMajor()) {
return false;
}
2023-02-09 10:45:06 -05:00
2023-08-07 14:13:40 -04:00
// the comparison works invertedly as a version like "v1.2.0"
// should return true for "<=v1.3.0"
switch (m_compare) {
2023-02-09 10:45:06 -05:00
case VersionCompare::LessEq:
return version <= m_version;
2023-02-09 10:45:06 -05:00
case VersionCompare::MoreEq:
return version >= m_version;
case VersionCompare::Less:
return version < m_version;
case VersionCompare::More:
return version > m_version;
case VersionCompare::Exact:
return version == m_version;
default:
return false;
}
}
std::string toString() const;
friend GEODE_DLL std::string format_as(ComparableVersionInfo const& version);
};
2022-07-30 12:24:03 -04:00
}
template <class V>
requires std::is_same_v<V, geode::VersionInfo> || std::is_same_v<V, geode::ComparableVersionInfo>
struct matjson::Serialize<V> {
static matjson::Value to_json(V const& info) {
return info.toString();
}
2024-01-24 09:17:42 -05:00
static bool is_json(matjson::Value const& json) {
return json.is_string();
}
static V from_json(matjson::Value const& json) {
auto ver = V::parse(json.as_string());
if (!ver) {
throw matjson::JsonException(
"Invalid version format: " + ver.unwrapErr()
);
}
return ver.unwrap();
}
2023-03-07 03:56:36 -05:00
};