mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-11-21 16:55:46 +03:00
Code Issues Projects Releases Packages Wiki Activity

Improve constructor of Version class

Browse source 
Now we can write `Version<int, 3, 1>(1)` and provide only 1 parameter
instead of all 3 parameters at once at the constructor. Note that for
this instance of `Version` 3 numbers were specified but only 1 is truly
mandatory.

The added code are required to specify conditions of the template
instantiation for the compiler.
This commit is contained in:
Chocobo1 2022-07-30 22:56:31 +08:00
parent 958929aa77
commit a4c2363f43
No known key found for this signature in database
GPG key ID: 210D9C873253A68C
4 changed files with 174 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/base/utils/version.h
View file

@ -29,6 +29,7 @@
#pragma once
#include <array>
#include <type_traits>
#include <QDebug>
#include <QString>
@ -42,8 +43,8 @@ namespace Utils
template <typename T, std::size_t N, std::size_t Mandatory = N>
class Version final : public IStringable
{
static_assert(N > 0, "The number of version components may not be smaller than 1");
static_assert(N >= Mandatory,
static_assert((N > 0), "The number of version components may not be smaller than 1");
static_assert((N >= Mandatory),
"The number of mandatory components may not be larger than the total number of components");
public:
@ -52,10 +53,13 @@ namespace Utils
constexpr Version() = default;
template <typename ... Other>
template <typename ... Other
, typename std::enable_if_t<std::conjunction_v<std::is_constructible<T, Other>...>, int> = 0>
constexpr Version(Other ... components)
: m_components {{static_cast<T>(components) ...}}
{
static_assert((sizeof...(Other) <= N), "Too many parameters provided");
static_assert((sizeof...(Other) >= Mandatory), "Not enough parameters provided");
}
/**
@ -65,7 +69,7 @@ namespace Utils
* @throws RuntimeError if parsing fails
*/
Version(const QString &version)
: Version {version.split(u'.')}
: m_components {parseList(version.split(u'.'))}
{
}
@ -76,7 +80,7 @@ namespace Utils
* @throws RuntimeError if parsing fails
*/
Version(const QByteArray &version)
: Version {version.split('.')}
: m_components {parseList(version.split('.'))}
{
}
@ -158,8 +162,8 @@ namespace Utils
private:
using ComponentsArray = std::array<T, N>;
template <typename StringsList>
static ComponentsArray parseList(const StringsList &versionParts)
template <typename StringList>
static ComponentsArray parseList(const StringList &versionParts)
{
if ((static_cast<std::size_t>(versionParts.size()) > N)
|| (static_cast<std::size_t>(versionParts.size()) < Mandatory))
@ -171,19 +175,13 @@ namespace Utils
ComponentsArray res {{}};
for (std::size_t i = 0; i < static_cast<std::size_t>(versionParts.size()); ++i)
{
res[i] = static_cast<T>(versionParts[static_cast<typename StringsList::size_type>(i)].toInt(&ok));
res[i] = static_cast<T>(versionParts[static_cast<typename StringList::size_type>(i)].toInt(&ok));
if (!ok)
throw RuntimeError(u"Can not parse version component"_qs);
}
return res;
}
template <typename StringsList>
Version(const StringsList &versionParts)
: m_components (parseList(versionParts)) // GCC 4.8.4 has problems with the uniform initializer here
{
}
ComponentsArray m_components {{}};
};

2
src/gui/utils.cpp
View file

@ -194,7 +194,7 @@ void Utils::Gui::openFolderSelect(const Path &path)
proc.waitForFinished();
const auto nautilusVerStr = QString::fromLocal8Bit(proc.readLine()).remove(QRegularExpression(u"[^0-9.]"_qs));
using NautilusVersion = Utils::Version<int, 3>;
if (NautilusVersion::tryParse(nautilusVerStr, {1, 0, 0}) > NautilusVersion {3, 28})
if (NautilusVersion::tryParse(nautilusVerStr, {1, 0, 0}) > NautilusVersion {3, 28, 0})
proc.startDetached(u"nautilus"_qs, {(Fs::isDir(path) ? path.parentPath() : path).toString()});
else
proc.startDetached(u"nautilus"_qs, {u"--no-desktop"_qs, (Fs::isDir(path) ? path.parentPath() : path).toString()});

1
test/CMakeLists.txt
View file

@ -15,6 +15,7 @@ set(testFiles
testutilscompare.cpp
testutilsgzip.cpp
testutilsstring.cpp
testutilsversion.cpp
)
foreach(testFile ${testFiles})

160
test/testutilsversion.cpp Normal file
View file

@ -0,0 +1,160 @@
/*
* Bittorrent Client using Qt and libtorrent.
* Copyright (C) 2022 Mike Tzou (Chocobo1)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give permission to
* link this program with the OpenSSL project's "OpenSSL" library (or with
* modified versions of it that use the same license as the "OpenSSL" library),
* and distribute the linked executables. You must obey the GNU General Public
* License in all respects for all of the code used other than "OpenSSL". If you
* modify file(s), you may extend this exception to your version of the file(s),
* but you are not obligated to do so. If you do not wish to do so, delete this
* exception statement from your version.
*/
#include <QTest>
#include "base/global.h"
#include "base/utils/version.h"
class TestUtilsVersion final : public QObject
{
Q_OBJECT
Q_DISABLE_COPY_MOVE(TestUtilsVersion)
public:
TestUtilsVersion() = default;
private slots:
void testConstructors() const
{
using TwoDigits = Utils::Version<unsigned char, 2, 1>;
TwoDigits();
TwoDigits(0);
TwoDigits(0, 1);
using ThreeDigits = Utils::Version<int, 3>;
// should not compile:
// ThreeDigits(1);
// ThreeDigits(1, 2);
// ThreeDigits(1, 2, 3, 4);
QCOMPARE(ThreeDigits(u"1.2.3"_qs), ThreeDigits(1, 2, 3));
QCOMPARE(ThreeDigits(QByteArrayLiteral("1.2.3")), ThreeDigits(1, 2, 3));
#if (QT_VERSION >= QT_VERSION_CHECK(6, 3, 0))
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(u""_qs));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(u"1"_qs));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(u"1.0"_qs));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(u"1.0.1.1"_qs));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(u"random_string"_qs));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(QByteArrayLiteral("1")));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(QByteArrayLiteral("1.0")));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(QByteArrayLiteral("1.0.1.1")));
QVERIFY_THROWS_EXCEPTION(RuntimeError, ThreeDigits(QByteArrayLiteral("random_string")));
#endif
}
void testVersionComponents() const
{
const Utils::Version<int, 1> version1 {1};
QCOMPARE(version1[0], 1);
QCOMPARE(version1.majorNumber(), 1);
// should not compile:
// version1.minorNumber();
// version1.revisionNumber();
// version1.patchNumber();
#if (QT_VERSION >= QT_VERSION_CHECK(6, 3, 0))
QVERIFY_THROWS_EXCEPTION(std::out_of_range, version1[1]);
QVERIFY_THROWS_EXCEPTION(std::out_of_range, version1[2]);
#endif
const Utils::Version<int, 4> version2 {10, 11, 12, 13};
QCOMPARE(version2[0], 10);
QCOMPARE(version2[1], 11);
QCOMPARE(version2[2], 12);
QCOMPARE(version2[3], 13);
QCOMPARE(version2.majorNumber(), 10);
QCOMPARE(version2.minorNumber(), 11);
QCOMPARE(version2.revisionNumber(), 12);
QCOMPARE(version2.patchNumber(), 13);
}
void testToString() const
{
using OneMandatory = Utils::Version<int, 2, 1>;
QCOMPARE(OneMandatory(u"10"_qs).toString(), u"10"_qs);
using FourDigits = Utils::Version<int, 4>;
QCOMPARE(FourDigits().toString(), u"0.0.0.0"_qs);
QCOMPARE(FourDigits(10, 11, 12, 13).toString(), u"10.11.12.13"_qs);
}
void testIsValid() const
{
using ThreeDigits = Utils::Version<int, 3>;
QCOMPARE(ThreeDigits().isValid(), false);
QCOMPARE(ThreeDigits(10, 11, 12).isValid(), true);
}
void testTryParse() const
{
using OneMandatory = Utils::Version<int, 2, 1>;
const OneMandatory default1 {10, 11};
QCOMPARE(OneMandatory::tryParse(u"1"_qs, default1), OneMandatory(1));
QCOMPARE(OneMandatory::tryParse(u"1.2"_qs, default1), OneMandatory(1, 2));
QCOMPARE(OneMandatory::tryParse(u"1,2"_qs, default1), default1);
QCOMPARE(OneMandatory::tryParse(u""_qs, default1), default1);
QCOMPARE(OneMandatory::tryParse(u"random_string"_qs, default1), default1);
using FourDigits = Utils::Version<int, 4>;
const FourDigits default4 {10, 11, 12, 13};
QCOMPARE(FourDigits::tryParse(u"1"_qs, default4), default4);
QCOMPARE(FourDigits::tryParse(u"1.2.3.4"_qs, default4), FourDigits(1, 2, 3, 4));
QCOMPARE(FourDigits::tryParse(u"1,2.3.4"_qs, default4), default4);
}
void testComparisons() const
{
using ThreeDigits = Utils::Version<int, 3>;
QVERIFY(ThreeDigits() == ThreeDigits());
QVERIFY(!(ThreeDigits() != ThreeDigits()));
QVERIFY(ThreeDigits() <= ThreeDigits());
QVERIFY(ThreeDigits() >= ThreeDigits());
QVERIFY(ThreeDigits() != ThreeDigits(1, 2, 3));
QVERIFY(ThreeDigits() < ThreeDigits(1, 2, 3));
QVERIFY(ThreeDigits() <= ThreeDigits(1, 2, 3));
QVERIFY(ThreeDigits(1, 2, 3) != ThreeDigits());
QVERIFY(ThreeDigits(1, 2, 3) > ThreeDigits());
QVERIFY(ThreeDigits(1, 2, 3) >= ThreeDigits());
QVERIFY(ThreeDigits(1, 3, 3) != ThreeDigits(2, 2, 3));
QVERIFY(ThreeDigits(1, 3, 3) < ThreeDigits(2, 2, 3));
QVERIFY(ThreeDigits(1, 3, 3) <= ThreeDigits(2, 2, 3));
QVERIFY(ThreeDigits(1, 2, 3) != ThreeDigits(1, 2, 4));
QVERIFY(ThreeDigits(1, 2, 3) < ThreeDigits(1, 2, 4));
QVERIFY(ThreeDigits(1, 2, 3) <= ThreeDigits(1, 2, 4));
}
};
QTEST_APPLESS_MAIN(TestUtilsVersion)
#include "testutilsversion.moc"