pollymc/api/logic/minecraft/MinecraftProfile.h

204 lines
6.1 KiB
C++

/* Copyright 2013-2017 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.
*/
#pragma once
#include <QAbstractListModel>
#include <QString>
#include <QList>
#include <memory>
#include "Library.h"
#include "ProfilePatch.h"
#include "ProfileUtils.h"
#include "BaseVersion.h"
#include "MojangDownloadInfo.h"
#include "multimc_logic_export.h"
class MinecraftInstance;
class MULTIMC_LOGIC_EXPORT MinecraftProfile : public QAbstractListModel
{
Q_OBJECT
public:
explicit MinecraftProfile(MinecraftInstance * instance);
virtual ~MinecraftProfile();
virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const 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;
/// is this version unchanged by the user?
bool isVanilla();
/// remove any customizations on top of whatever 'vanilla' means
bool revertToVanilla();
/// install more jar mods
void installJarMods(QStringList selectedFiles);
/// install more jar mods
void installCustomJar(QString selectedFile);
/// DEPRECATED, remove ASAP
int getFreeOrderNumber();
enum MoveDirection { MoveUp, MoveDown };
/// move patch file # up or down the list
void move(const int index, const MoveDirection direction);
/// remove patch file # - including files/records
bool remove(const int index);
/// remove patch file by id - including files/records
bool remove(const QString id);
bool customize(int index);
bool revertToBase(int index);
void resetOrder();
/// reload all profile patches from storage, clear the profile and apply the patches
void reload();
/// clear the profile
void clear();
/// apply the patches. Catches all the errors and returns true/false for success/failure
bool reapplyPatches();
public: /* application of profile variables from patches */
void applyMinecraftVersion(const QString& id);
void applyMainClass(const QString& mainClass);
void applyAppletClass(const QString& appletClass);
void applyMinecraftArguments(const QString& minecraftArguments);
void applyMinecraftVersionType(const QString& type);
void applyMinecraftAssets(MojangAssetIndexInfo::Ptr assets);
void applyTraits(const QSet<QString> &traits);
void applyTweakers(const QStringList &tweakers);
void applyJarMods(const QList<LibraryPtr> &jarMods);
void applyMods(const QList<LibraryPtr> &jarMods);
void applyLibrary(LibraryPtr library);
void applyMainJar(LibraryPtr jar);
void applyProblemSeverity(ProblemSeverity severity);
public: /* getters for profile variables */
QString getMinecraftVersion() const;
QString getMainClass() const;
QString getAppletClass() const;
QString getMinecraftVersionType() const;
MojangAssetIndexInfo::Ptr getMinecraftAssets() const;
QString getMinecraftArguments() const;
const QSet<QString> & getTraits() const;
const QStringList & getTweakers() const;
const QList<LibraryPtr> & getJarMods() const;
const QList<LibraryPtr> & getLibraries() const;
const QList<LibraryPtr> & getNativeLibraries() const;
const LibraryPtr getMainJar() const;
void getLibraryFiles(const QString & architecture, QStringList & jars, QStringList & nativeJars, const QString & overridePath,
const QString & tempPath) const;
bool hasTrait(const QString & trait) const;
ProblemSeverity getProblemSeverity() const;
public:
/// get the profile patch by id
ProfilePatchPtr versionPatch(const QString &id);
/// get the profile patch by index
ProfilePatchPtr versionPatch(int index);
/// save the current patch order
void saveCurrentOrder() const;
/// Remove all the patches
void clearPatches();
/// Add the patch object to the internal list of patches
void appendPatch(ProfilePatchPtr patch);
private:
void load_internal();
bool resetOrder_internal();
bool saveOrder_internal(ProfileUtils::PatchOrder order) const;
bool installJarMods_internal(QStringList filepaths);
bool installCustomJar_internal(QString filepath);
bool removePatch_internal(ProfilePatchPtr patch);
bool customizePatch_internal(ProfilePatchPtr patch);
bool revertPatch_internal(ProfilePatchPtr patch);
void loadDefaultBuiltinPatches_internal();
void loadUserPatches_internal();
void upgradeDeprecatedFiles_internal();
private: /* data */
/// the version of Minecraft - jar to use
QString m_minecraftVersion;
/// Release type - "release" or "snapshot"
QString m_minecraftVersionType;
/// Assets type - "legacy" or a version ID
MojangAssetIndexInfo::Ptr m_minecraftAssets;
/**
* arguments that should be used for launching minecraft
*
* ex: "--username ${auth_player_name} --session ${auth_session}
* --version ${version_name} --gameDir ${game_directory} --assetsDir ${game_assets}"
*/
QString m_minecraftArguments;
/// A list of all tweaker classes
QStringList m_tweakers;
/// The main class to load first
QString m_mainClass;
/// The applet class, for some very old minecraft releases
QString m_appletClass;
/// the list of libraries
QList<LibraryPtr> m_libraries;
/// the main jar
LibraryPtr m_mainJar;
/// the list of libraries
QList<LibraryPtr> m_nativeLibraries;
/// traits, collected from all the version files (version files can only add)
QSet<QString> m_traits;
/// A list of jar mods. version files can add those.
QList<LibraryPtr> m_jarMods;
/// the list of mods
QList<LibraryPtr> m_mods;
ProblemSeverity m_problemSeverity = ProblemSeverity::None;
/// list of attached profile patches
QList<ProfilePatchPtr> m_patches;
// the instance this belongs to
MinecraftInstance *m_instance;
};