PrismLauncher/launcher/minecraft/PackProfile.h

176 lines
5.6 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
*
* 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/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
2013-07-22 01:01:56 +01:00
#pragma once
#include <QAbstractListModel>
#include <QString>
#include <QList>
2013-10-06 00:13:40 +01:00
#include <memory>
#include "Library.h"
#include "LaunchProfile.h"
#include "Component.h"
#include "ProfileUtils.h"
2017-03-12 22:19:45 +00:00
#include "BaseVersion.h"
#include "MojangDownloadInfo.h"
#include "net/Mode.h"
#include "modplatform/ModAPI.h"
class MinecraftInstance;
struct PackProfileData;
class ComponentUpdateTask;
class PackProfile : public QAbstractListModel
{
2018-07-15 13:51:05 +01:00
Q_OBJECT
friend ComponentUpdateTask;
public:
2018-07-15 13:51:05 +01:00
enum Columns
{
NameColumn = 0,
VersionColumn,
NUM_COLUMNS
};
explicit PackProfile(MinecraftInstance * instance);
virtual ~PackProfile();
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
virtual int rowCount(const QModelIndex &parent = QModelIndex()) const override;
virtual int columnCount(const QModelIndex &parent) const override;
virtual Qt::ItemFlags flags(const QModelIndex &index) const override;
2018-07-15 13:51:05 +01:00
/// call this to explicitly mark the component list as loaded - this is used to build a new component list from scratch.
void buildingFromScratch();
2018-07-15 13:51:05 +01:00
/// install more jar mods
void installJarMods(QStringList selectedFiles);
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
/// install a jar/zip as a replacement for the main jar
void installCustomJar(QString selectedFile);
2018-07-15 13:51:05 +01:00
enum MoveDirection { MoveUp, MoveDown };
/// move component file # up or down the list
void move(const int index, const MoveDirection direction);
2018-07-15 13:51:05 +01:00
/// remove component file # - including files/records
bool remove(const int index);
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
/// remove component file by id - including files/records
bool remove(const QString id);
2018-07-15 13:51:05 +01:00
bool customize(int index);
2018-07-15 13:51:05 +01:00
bool revertToBase(int index);
2018-07-15 13:51:05 +01:00
/// reload the list, reload all components, resolve dependencies
void reload(Net::Mode netmode);
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
// reload all components, resolve dependencies
void resolve(Net::Mode netmode);
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
/// get current running task...
2021-11-21 22:36:55 +00:00
Task::Ptr getCurrentTask();
2018-07-15 13:51:05 +01:00
std::shared_ptr<LaunchProfile> getProfile() const;
2018-07-15 13:51:05 +01:00
// NOTE: used ONLY by MinecraftInstance to provide legacy version mappings from instance config
void setOldConfigVersion(const QString &uid, const QString &version);
2018-07-15 13:51:05 +01:00
QString getComponentVersion(const QString &uid) const;
2018-07-15 13:51:05 +01:00
bool setComponentVersion(const QString &uid, const QString &version, bool important = false);
2018-07-15 13:51:05 +01:00
bool installEmpty(const QString &uid, const QString &name);
2018-07-15 13:51:05 +01:00
QString patchFilePathForUid(const QString &uid) const;
2018-07-15 13:51:05 +01:00
/// if there is a save scheduled, do it now.
void saveNow();
/// helper method, returns RuntimeContext of instance
RuntimeContext runtimeContext();
signals:
void minecraftChanged();
public:
2018-07-15 13:51:05 +01:00
/// get the profile component by id
Component * getComponent(const QString &id);
2018-07-15 13:51:05 +01:00
/// get the profile component by index
Component * getComponent(int index);
2020-08-24 23:13:43 +01:00
/// Add the component to the internal list of patches
// todo(merged): is this the best approach
void appendComponent(ComponentPtr component);
ModAPI::ModLoaderTypes getModLoaders();
private:
2018-07-15 13:51:05 +01:00
void scheduleSave();
bool saveIsScheduled() const;
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
/// apply the component patches. Catches all the errors and returns true/false for success/failure
void invalidateLaunchProfile();
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
/// insert component so that its index is ideally the specified one (returns real index)
void insertComponent(size_t index, ComponentPtr component);
2015-01-27 21:31:07 +00:00
2018-07-15 13:51:05 +01:00
QString componentsFilePath() const;
QString patchesPattern() const;
2015-01-27 21:31:07 +00:00
private slots:
2018-07-15 13:51:05 +01:00
void save_internal();
void updateSucceeded();
void updateFailed(const QString & error);
void componentDataChanged();
void disableInteraction(bool disable);
2015-01-27 21:31:07 +00:00
private:
2018-07-15 13:51:05 +01:00
bool load();
bool installJarMods_internal(QStringList filepaths);
bool installCustomJar_internal(QString filepath);
2018-07-15 13:51:05 +01:00
bool removeComponent_internal(ComponentPtr patch);
private: /* data */
std::unique_ptr<PackProfileData> d;
};