PrismLauncher/launcher/modplatform/ModIndex.h

// SPDX-License-Identifier: GPL-3.0-only
/*
*  PolyMC - Minecraft Launcher
*  Copyright (c) 2022 flowln <flowlnlnln@gmail.com>
*
*  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, version 3.
*
*  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, see <https://www.gnu.org/licenses/>.
*/

#pragma once

#include <QList>
#include <QMetaType>
#include <QString>
#include <QVariant>
#include <QVector>
#include <optional>

class QIODevice;

namespace ModPlatform {

enum class ResourceProvider { MODRINTH, FLAME };

enum class ResourceType { MOD, RESOURCE_PACK, SHADER_PACK };

class ProviderCapabilities {
   public:
    auto name(ResourceProvider) -> const char*;
    auto readableName(ResourceProvider) -> QString;
    auto hashType(ResourceProvider) -> QStringList;
    auto hash(ResourceProvider, QIODevice*, QString type = "") -> QString;
};

struct ModpackAuthor {
    QString name;
    QString url;
};

struct DonationData {
    QString id;
    QString platform;
    QString url;
};

struct IndexedVersionType {
    enum class Enum {
        Release = 1,
        Beta,
        Alpha,
        UNKNOWN
    };
    IndexedVersionType(const QString& type);
    IndexedVersionType(int type);
    IndexedVersionType(const IndexedVersionType::Enum& type);
    IndexedVersionType(const IndexedVersionType& type);
    IndexedVersionType() : IndexedVersionType(IndexedVersionType::Enum::UNKNOWN) {}
    static const QString toString (const IndexedVersionType::Enum& type);
    static IndexedVersionType::Enum enumFromString(const QString& type);
    bool isValid() const {return m_type != IndexedVersionType::Enum::UNKNOWN; }
    IndexedVersionType& operator=(const IndexedVersionType& other);
    bool operator==(const IndexedVersionType& other) const { return m_type == other.m_type; }
    bool operator==(const IndexedVersionType::Enum& type) const { return m_type == type; }
    bool operator!=(const IndexedVersionType& other) const { return m_type != other.m_type; }
    bool operator!=(const IndexedVersionType::Enum& type) const { return m_type != type; }
    bool operator<(const IndexedVersionType& other) const { return m_type < other.m_type; }
    bool operator<(const IndexedVersionType::Enum& type) const { return m_type < type; }
    bool operator<=(const IndexedVersionType& other) const { return m_type <= other.m_type; }
    bool operator<=(const IndexedVersionType::Enum& type) const { return m_type <= type; }
    bool operator>(const IndexedVersionType& other) const { return m_type > other.m_type; }
    bool operator>(const IndexedVersionType::Enum& type) const { return m_type > type; }
    bool operator>=(const IndexedVersionType& other) const { return m_type >= other.m_type; }
    bool operator>=(const IndexedVersionType::Enum& type) const { return m_type >= type; }

    QString toString() const { return toString(m_type); }

    IndexedVersionType::Enum m_type;
};

struct IndexedVersion {
    QVariant addonId;
    QVariant fileId;
    QString version;
    QString version_number = {};
    IndexedVersionType verison_type;
    QStringList mcVersion;
    QString downloadUrl;
    QString date;
    QString fileName;
    QStringList loaders = {};
    QString hash_type;
    QString hash;
    bool is_preferred = true;
    QString changelog;

    // For internal use, not provided by APIs
    bool is_currently_selected = false;
    QString custom_target_folder;
};

struct ExtraPackData {
    QList<DonationData> donate;

    QString issuesUrl;
    QString sourceUrl;
    QString wikiUrl;
    QString discordUrl;

    QString body;
};

struct IndexedPack {
    QVariant addonId;
    ResourceProvider provider;
    QString name;
    QString slug;
    QString description;
    QList<ModpackAuthor> authors;
    QString logoName;
    QString logoUrl;
    QString websiteUrl;

    bool versionsLoaded = false;
    QVector<IndexedVersion> versions;

    // Don't load by default, since some modplatform don't have that info
    bool extraDataLoaded = true;
    ExtraPackData extraData;

    // For internal use, not provided by APIs
    [[nodiscard]] bool isVersionSelected(size_t index) const
    {
        if (!versionsLoaded)
            return false;

        return versions.at(index).is_currently_selected;
    }
    [[nodiscard]] bool isAnyVersionSelected() const
    {
        if (!versionsLoaded)
            return false;

        return std::any_of(versions.constBegin(), versions.constEnd(),
                [](auto const& v) { return v.is_currently_selected; });
    }
};

}  // namespace ModPlatform

Q_DECLARE_METATYPE(ModPlatform::IndexedPack)
Q_DECLARE_METATYPE(ModPlatform::ResourceProvider)