aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--launcher/Version.cpp149
-rw-r--r--launcher/Version.h135
-rw-r--r--tests/CMakeLists.txt3
-rw-r--r--tests/Version_test.cpp116
-rw-r--r--tests/testdata/Version/test_vectors.txt63
5 files changed, 336 insertions, 130 deletions
diff --git a/launcher/Version.cpp b/launcher/Version.cpp
index b9090e29..e4311f31 100644
--- a/launcher/Version.cpp
+++ b/launcher/Version.cpp
@@ -1,85 +1,128 @@
#include "Version.h"
-#include <QStringList>
-#include <QUrl>
+#include <QDebug>
#include <QRegularExpression>
#include <QRegularExpressionMatch>
+#include <QUrl>
-Version::Version(const QString &str) : m_string(str)
+Version::Version(QString str) : m_string(std::move(str))
{
parse();
}
-bool Version::operator<(const Version &other) const
-{
- const int size = qMax(m_sections.size(), other.m_sections.size());
- for (int i = 0; i < size; ++i)
- {
- const Section sec1 = (i >= m_sections.size()) ? Section("0") : m_sections.at(i);
- const Section sec2 =
- (i >= other.m_sections.size()) ? Section("0") : other.m_sections.at(i);
- if (sec1 != sec2)
- {
- return sec1 < sec2;
- }
+#define VERSION_OPERATOR(return_on_different) \
+ bool exclude_our_sections = false; \
+ bool exclude_their_sections = false; \
+ \
+ const auto size = qMax(m_sections.size(), other.m_sections.size()); \
+ for (int i = 0; i < size; ++i) { \
+ Section sec1 = (i >= m_sections.size()) ? Section() : m_sections.at(i); \
+ Section sec2 = (i >= other.m_sections.size()) ? Section() : other.m_sections.at(i); \
+ \
+ { /* Don't include appendixes in the comparison */ \
+ if (sec1.isAppendix()) \
+ exclude_our_sections = true; \
+ if (sec2.isAppendix()) \
+ exclude_their_sections = true; \
+ \
+ if (exclude_our_sections) { \
+ sec1 = Section(); \
+ if (sec2.m_isNull) \
+ break; \
+ } \
+ \
+ if (exclude_their_sections) { \
+ sec2 = Section(); \
+ if (sec1.m_isNull) \
+ break; \
+ } \
+ } \
+ \
+ if (sec1 != sec2) \
+ return return_on_different; \
}
+bool Version::operator<(const Version& other) const
+{
+ VERSION_OPERATOR(sec1 < sec2)
+
return false;
}
-bool Version::operator<=(const Version &other) const
+bool Version::operator==(const Version& other) const
+{
+ VERSION_OPERATOR(false)
+
+ return true;
+}
+bool Version::operator!=(const Version& other) const
+{
+ return !operator==(other);
+}
+bool Version::operator<=(const Version& other) const
{
return *this < other || *this == other;
}
-bool Version::operator>(const Version &other) const
+bool Version::operator>(const Version& other) const
{
- const int size = qMax(m_sections.size(), other.m_sections.size());
- for (int i = 0; i < size; ++i)
- {
- const Section sec1 = (i >= m_sections.size()) ? Section("0") : m_sections.at(i);
- const Section sec2 =
- (i >= other.m_sections.size()) ? Section("0") : other.m_sections.at(i);
- if (sec1 != sec2)
- {
- return sec1 > sec2;
- }
- }
-
- return false;
+ return !(*this <= other);
}
-bool Version::operator>=(const Version &other) const
+bool Version::operator>=(const Version& other) const
{
- return *this > other || *this == other;
+ return !(*this < other);
}
-bool Version::operator==(const Version &other) const
+
+void Version::parse()
{
- const int size = qMax(m_sections.size(), other.m_sections.size());
- for (int i = 0; i < size; ++i)
- {
- const Section sec1 = (i >= m_sections.size()) ? Section("0") : m_sections.at(i);
- const Section sec2 =
- (i >= other.m_sections.size()) ? Section("0") : other.m_sections.at(i);
- if (sec1 != sec2)
- {
+ m_sections.clear();
+ QString currentSection;
+
+ if (m_string.isEmpty())
+ return;
+
+ auto classChange = [&](QChar lastChar, QChar currentChar) {
+ if (lastChar.isNull())
return false;
+ if (lastChar.isDigit() != currentChar.isDigit())
+ return true;
+
+ const QList<QChar> s_separators{ '.', '-', '+' };
+ if (s_separators.contains(currentChar) && currentSection.at(0) != currentChar)
+ return true;
+
+ return false;
+ };
+
+ currentSection += m_string.at(0);
+ for (int i = 1; i < m_string.size(); ++i) {
+ const auto& current_char = m_string.at(i);
+ if (classChange(m_string.at(i - 1), current_char)) {
+ if (!currentSection.isEmpty())
+ m_sections.append(Section(currentSection));
+ currentSection = "";
}
+
+ currentSection += current_char;
}
- return true;
-}
-bool Version::operator!=(const Version &other) const
-{
- return !operator==(other);
+ if (!currentSection.isEmpty())
+ m_sections.append(Section(currentSection));
}
-void Version::parse()
+/// qDebug print support for the Version class
+QDebug operator<<(QDebug debug, const Version& v)
{
- m_sections.clear();
+ QDebugStateSaver saver(debug);
- // FIXME: this is bad. versions can contain a lot more separators...
- QStringList parts = m_string.split('.');
+ debug.nospace() << "Version{ string: " << v.toString() << ", sections: [ ";
- for (const auto& part : parts)
- {
- m_sections.append(Section(part));
+ bool first = true;
+ for (auto s : v.m_sections) {
+ if (!first) debug.nospace() << ", ";
+ debug.nospace() << s.m_fullString;
+ first = false;
}
+
+ debug.nospace() << " ]" << " }";
+
+ return debug;
}
diff --git a/launcher/Version.h b/launcher/Version.h
index aceb7a07..659f8e54 100644
--- a/launcher/Version.h
+++ b/launcher/Version.h
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
+ * Copyright (C) 2023 flowln <flowlnlnln@gmail.com>
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
*
* This program is free software: you can redistribute it and/or modify
@@ -35,17 +36,17 @@
#pragma once
+#include <QDebug>
+#include <QList>
#include <QString>
#include <QStringView>
-#include <QList>
class QUrl;
-class Version
-{
-public:
- Version(const QString &str);
- Version() {}
+class Version {
+ public:
+ Version(QString str);
+ Version() = default;
bool operator<(const Version &other) const;
bool operator<=(const Version &other) const;
@@ -54,96 +55,116 @@ public:
bool operator==(const Version &other) const;
bool operator!=(const Version &other) const;
- QString toString() const
- {
- return m_string;
- }
+ QString toString() const { return m_string; }
-private:
- QString m_string;
- struct Section
- {
- explicit Section(const QString &fullString)
+ friend QDebug operator<<(QDebug debug, const Version& v);
+
+ private:
+ struct Section {
+ explicit Section(QString fullString) : m_fullString(std::move(fullString))
{
- m_fullString = fullString;
int cutoff = m_fullString.size();
- for(int i = 0; i < m_fullString.size(); i++)
- {
- if(!m_fullString[i].isDigit())
- {
+ for (int i = 0; i < m_fullString.size(); i++) {
+ if (!m_fullString[i].isDigit()) {
cutoff = i;
break;
}
}
+
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
auto numPart = QStringView{m_fullString}.left(cutoff);
#else
auto numPart = m_fullString.leftRef(cutoff);
#endif
- if(numPart.size())
- {
- numValid = true;
+
+ if (!numPart.isEmpty()) {
+ m_isNull = false;
m_numPart = numPart.toInt();
}
+
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
auto stringPart = QStringView{m_fullString}.mid(cutoff);
#else
auto stringPart = m_fullString.midRef(cutoff);
#endif
- if(stringPart.size())
- {
+
+ if (!stringPart.isEmpty()) {
+ m_isNull = false;
m_stringPart = stringPart.toString();
}
}
- explicit Section() {}
- bool numValid = false;
+
+ explicit Section() = default;
+
+ bool m_isNull = true;
+
int m_numPart = 0;
QString m_stringPart;
+
QString m_fullString;
- inline bool operator!=(const Section &other) const
+ [[nodiscard]] inline bool isAppendix() const { return m_stringPart.startsWith('+'); }
+ [[nodiscard]] inline bool isPreRelease() const { return m_stringPart.startsWith('-') && m_stringPart.length() > 1; }
+
+ inline bool operator==(const Section& other) const
{
- if(numValid && other.numValid)
- {
- return m_numPart != other.m_numPart || m_stringPart != other.m_stringPart;
- }
- else
- {
- return m_fullString != other.m_fullString;
+ if (m_isNull && !other.m_isNull)
+ return false;
+ if (!m_isNull && other.m_isNull)
+ return false;
+
+ if (!m_isNull && !other.m_isNull) {
+ return (m_numPart == other.m_numPart) && (m_stringPart == other.m_stringPart);
}
+
+ return true;
}
- inline bool operator<(const Section &other) const
- {
- if(numValid && other.numValid)
- {
- if(m_numPart < other.m_numPart)
+
+ inline bool operator<(const Section& other) const
+ {
+ static auto unequal_is_less = [](Section const& non_null) -> bool {
+ if (non_null.m_stringPart.isEmpty())
+ return non_null.m_numPart == 0;
+ return (non_null.m_stringPart != QLatin1Char('.')) && non_null.isPreRelease();
+ };
+
+ if (!m_isNull && other.m_isNull)
+ return unequal_is_less(*this);
+ if (m_isNull && !other.m_isNull)
+ return !unequal_is_less(other);
+
+ if (!m_isNull && !other.m_isNull) {
+ if (m_numPart < other.m_numPart)
return true;
- if(m_numPart == other.m_numPart && m_stringPart < other.m_stringPart)
+ if (m_numPart == other.m_numPart && m_stringPart < other.m_stringPart)
return true;
+
+ if (!m_stringPart.isEmpty() && other.m_stringPart.isEmpty())
+ return false;
+ if (m_stringPart.isEmpty() && !other.m_stringPart.isEmpty())
+ return true;
+
return false;
}
- else
- {
- return m_fullString < other.m_fullString;
- }
+
+ return m_fullString < other.m_fullString;
+ }
+
+ inline bool operator!=(const Section& other) const
+ {
+ return !(*this == other);
}
inline bool operator>(const Section &other) const
{
- if(numValid && other.numValid)
- {
- if(m_numPart > other.m_numPart)
- return true;
- if(m_numPart == other.m_numPart && m_stringPart > other.m_stringPart)
- return true;
- return false;
- }
- else
- {
- return m_fullString > other.m_fullString;
- }
+ return !(*this < other || *this == other);
}
};
+
+ private:
+ QString m_string;
QList<Section> m_sections;
void parse();
};
+
+
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index 3d0d2dca..36a3b0f8 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -56,3 +56,6 @@ ecm_add_test(Packwiz_test.cpp LINK_LIBRARIES Launcher_logic Qt${QT_VERSION_MAJOR
ecm_add_test(Index_test.cpp LINK_LIBRARIES Launcher_logic Qt${QT_VERSION_MAJOR}::Test
TEST_NAME Index)
+
+ecm_add_test(Version_test.cpp LINK_LIBRARIES Launcher_logic Qt${QT_VERSION_MAJOR}::Test
+ TEST_NAME Version)
diff --git a/tests/Version_test.cpp b/tests/Version_test.cpp
index 734528b7..afb4c610 100644
--- a/tests/Version_test.cpp
+++ b/tests/Version_test.cpp
@@ -15,56 +15,130 @@
#include <QTest>
-#include <TestUtil.h>
#include <Version.h>
-class ModUtilsTest : public QObject
-{
+class VersionTest : public QObject {
Q_OBJECT
- void setupVersions()
+
+ void addDataColumns()
{
QTest::addColumn<QString>("first");
QTest::addColumn<QString>("second");
QTest::addColumn<bool>("lessThan");
QTest::addColumn<bool>("equal");
+ }
+
+ void setupVersions()
+ {
+ addDataColumns();
QTest::newRow("equal, explicit") << "1.2.0" << "1.2.0" << false << true;
- QTest::newRow("equal, implicit 1") << "1.2" << "1.2.0" << false << true;
- QTest::newRow("equal, implicit 2") << "1.2.0" << "1.2" << false << true;
QTest::newRow("equal, two-digit") << "1.42" << "1.42" << false << true;
QTest::newRow("lessThan, explicit 1") << "1.2.0" << "1.2.1" << true << false;
QTest::newRow("lessThan, explicit 2") << "1.2.0" << "1.3.0" << true << false;
QTest::newRow("lessThan, explicit 3") << "1.2.0" << "2.2.0" << true << false;
- QTest::newRow("lessThan, implicit 1") << "1.2" << "1.2.1" << true << false;
- QTest::newRow("lessThan, implicit 2") << "1.2" << "1.3.0" << true << false;
- QTest::newRow("lessThan, implicit 3") << "1.2" << "2.2.0" << true << false;
+ QTest::newRow("lessThan, implicit 1") << "1.2" << "1.2.0" << true << false;
+ QTest::newRow("lessThan, implicit 2") << "1.2" << "1.2.1" << true << false;
+ QTest::newRow("lessThan, implicit 3") << "1.2" << "1.3.0" << true << false;
+ QTest::newRow("lessThan, implicit 4") << "1.2" << "2.2.0" << true << false;
QTest::newRow("lessThan, two-digit") << "1.41" << "1.42" << true << false;
QTest::newRow("greaterThan, explicit 1") << "1.2.1" << "1.2.0" << false << false;
QTest::newRow("greaterThan, explicit 2") << "1.3.0" << "1.2.0" << false << false;
QTest::newRow("greaterThan, explicit 3") << "2.2.0" << "1.2.0" << false << false;
- QTest::newRow("greaterThan, implicit 1") << "1.2.1" << "1.2" << false << false;
- QTest::newRow("greaterThan, implicit 2") << "1.3.0" << "1.2" << false << false;
- QTest::newRow("greaterThan, implicit 3") << "2.2.0" << "1.2" << false << false;
+ QTest::newRow("greaterThan, implicit 1") << "1.2.0" << "1.2" << false << false;
+ QTest::newRow("greaterThan, implicit 2") << "1.2.1" << "1.2" << false << false;
+ QTest::newRow("greaterThan, implicit 3") << "1.3.0" << "1.2" << false << false;
+ QTest::newRow("greaterThan, implicit 4") << "2.2.0" << "1.2" << false << false;
QTest::newRow("greaterThan, two-digit") << "1.42" << "1.41" << false << false;
}
-private slots:
- void initTestCase()
+ private slots:
+ void test_versionCompare_data()
{
-
+ setupVersions();
}
- void cleanupTestCase()
+
+ void test_versionCompare()
{
+ QFETCH(QString, first);
+ QFETCH(QString, second);
+ QFETCH(bool, lessThan);
+ QFETCH(bool, equal);
+ const auto v1 = Version(first);
+ const auto v2 = Version(second);
+
+ qDebug() << v1 << "vs" << v2;
+
+ QCOMPARE(v1 < v2, lessThan);
+ QCOMPARE(v1 > v2, !lessThan && !equal);
+ QCOMPARE(v1 == v2, equal);
}
- void test_versionCompare_data()
+ void test_flexVerTestVector_data()
{
- setupVersions();
+ addDataColumns();
+
+ QDir test_vector_dir(QFINDTESTDATA("testdata/Version"));
+
+ QFile vector_file{test_vector_dir.absoluteFilePath("test_vectors.txt")};
+
+ vector_file.open(QFile::OpenModeFlag::ReadOnly);
+
+ int test_number = 0;
+ const QString test_name_template { "FlexVer test #%1 (%2)" };
+ for (auto line = vector_file.readLine(); !vector_file.atEnd(); line = vector_file.readLine()) {
+ line = line.simplified();
+ if (line.startsWith('#') || line.isEmpty())
+ continue;
+
+ test_number += 1;
+
+ auto split_line = line.split('<');
+ if (split_line.size() == 2) {
+ QString first{split_line.first().simplified()};
+ QString second{split_line.last().simplified()};
+
+ auto new_test_name = test_name_template.arg(QString::number(test_number), "lessThan").toLatin1().data();
+ QTest::newRow(new_test_name) << first << second << true << false;
+
+ continue;
+ }
+
+ split_line = line.split('=');
+ if (split_line.size() == 2) {
+ QString first{split_line.first().simplified()};
+ QString second{split_line.last().simplified()};
+
+ auto new_test_name = test_name_template.arg(QString::number(test_number), "equals").toLatin1().data();
+ QTest::newRow(new_test_name) << first << second << false << true;
+
+ continue;
+ }
+
+ split_line = line.split('>');
+ if (split_line.size() == 2) {
+ QString first{split_line.first().simplified()};
+ QString second{split_line.last().simplified()};
+
+ auto new_test_name = test_name_template.arg(QString::number(test_number), "greaterThan").toLatin1().data();
+ QTest::newRow(new_test_name) << first << second << false << false;
+
+ continue;
+ }
+
+ qCritical() << "Unexpected separator in the test vector: ";
+ qCritical() << line;
+
+ QVERIFY(0 != 0);
+ }
+
+ vector_file.close();
}
- void test_versionCompare()
+
+ void test_flexVerTestVector()
{
QFETCH(QString, first);
QFETCH(QString, second);
@@ -74,12 +148,14 @@ private slots:
const auto v1 = Version(first);
const auto v2 = Version(second);
+ qDebug() << v1 << "vs" << v2;
+
QCOMPARE(v1 < v2, lessThan);
QCOMPARE(v1 > v2, !lessThan && !equal);
QCOMPARE(v1 == v2, equal);
}
};
-QTEST_GUILESS_MAIN(ModUtilsTest)
+QTEST_GUILESS_MAIN(VersionTest)
#include "Version_test.moc"
diff --git a/tests/testdata/Version/test_vectors.txt b/tests/testdata/Version/test_vectors.txt
new file mode 100644
index 00000000..e6c6507c
--- /dev/null
+++ b/tests/testdata/Version/test_vectors.txt
@@ -0,0 +1,63 @@
+# Test vector from:
+# https://github.com/unascribed/FlexVer/blob/704e12759b6e59220ff888f8bf2ec15b8f8fd969/test/test_vectors.txt
+#
+# This test file is formatted as "<lefthand> <operator> <righthand>", seperated by the space character
+# Implementations should ignore lines starting with "#" and lines that have a length of 0
+
+# Basic numeric ordering (lexical string sort fails these)
+10 > 2
+100 > 10
+
+# Trivial common numerics
+1.0 < 1.1
+1.0 < 1.0.1
+1.1 > 1.0.1
+
+# SemVer compatibility
+1.5 > 1.5-pre1
+1.5 = 1.5+foobar
+
+# SemVer incompatibility
+1.5 < 1.5-2
+1.5-pre10 > 1.5-pre2
+
+# Empty strings
+ =
+1 >
+ < 1
+
+# Check boundary between textual and prerelease
+a-a < a
+
+# Check boundary between textual and appendix
+a+a = a
+
+# Dash is included in prerelease comparison (if stripped it will be a smaller component)
+# Note that a-a < a=a regardless since the prerelease splits the component creating a smaller first component; 0 is added to force splitting regardless
+a0-a < a0=a
+
+# Pre-releases must contain only non-digit
+1.16.5-10 > 1.16.5
+
+# Pre-releases can have multiple dashes (should not be split)
+# Reasoning for test data: "p-a!" > "p-a-" (correct); "p-a!" < "p-a t-" (what happens if every dash creates a new component)
+-a- > -a!
+
+# Misc
+b1.7.3 > a1.2.6
+b1.2.6 > a1.7.3
+a1.1.2 < a1.1.2_01
+1.16.5-0.00.5 > 1.14.2-1.3.7
+1.0.0 < 1.0.0_01
+1.0.1 > 1.0.0_01
+1.0.0_01 < 1.0.1
+0.17.1-beta.1 < 0.17.1
+0.17.1-beta.1 < 0.17.1-beta.2
+1.4.5_01 = 1.4.5_01+fabric-1.17
+1.4.5_01 = 1.4.5_01+fabric-1.17+ohgod
+14w16a < 18w40b
+18w40a < 18w40b
+1.4.5_01+fabric-1.17 < 18w40b
+13w02a < c0.3.0_01
+0.6.0-1.18.x < 0.9.beta-1.18.x
+
generated by cgit (git 2.46.0) at 2025-02-03 04:10:21 +0000