pollymc/api/logic/BaseInstance.h

285 lines
7.7 KiB
C
Raw Normal View History

2015-02-03 03:55:30 +05:30
/* Copyright 2013-2015 MultiMC Contributors
2013-02-15 10:10:00 +05:30
*
* 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
*
2013-02-15 10:10:00 +05:30
* 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
2016-10-03 04:25:54 +05:30
#include <cassert>
2013-02-15 10:10:00 +05:30
#include <QObject>
#include "QObjectPtr.h"
2013-02-15 10:10:00 +05:30
#include <QDateTime>
#include <QSet>
#include <QProcess>
2013-02-15 10:10:00 +05:30
2015-02-09 06:21:14 +05:30
#include "settings/SettingsObject.h"
2013-02-26 02:14:36 +05:30
2015-02-09 06:21:14 +05:30
#include "settings/INIFile.h"
#include "BaseVersionList.h"
#include "minecraft/auth/MojangAccount.h"
2015-07-22 12:31:04 +05:30
#include "launch/MessageLevel.h"
#include "pathmatcher/IPathMatcher.h"
#include "multimc_logic_export.h"
2014-02-21 23:45:59 +05:30
class QDir;
class Task;
class LaunchTask;
class BaseInstance;
2016-10-03 04:25:54 +05:30
class BaseInstanceProvider;
2013-02-15 10:10:00 +05:30
2014-09-06 21:46:56 +05:30
// pointer for lazy people
typedef std::shared_ptr<BaseInstance> InstancePtr;
2013-02-15 10:10:00 +05:30
/*!
* \brief Base class for instances.
* This class implements many functions that are common between instances and
2013-02-15 10:10:00 +05:30
* provides a standard interface for all instances.
*
2013-02-15 10:10:00 +05:30
* To create a new instance type, create a new class inheriting from this class
* and implement the pure virtual functions.
*/
class MULTIMC_LOGIC_EXPORT BaseInstance : public QObject, public std::enable_shared_from_this<BaseInstance>
2013-02-15 10:10:00 +05:30
{
Q_OBJECT
2013-08-03 19:27:33 +05:30
protected:
/// no-touchy!
2015-02-01 07:38:25 +05:30
BaseInstance(SettingsObjectPtr globalSettings, SettingsObjectPtr settings, const QString &rootDir);
2016-10-03 04:25:54 +05:30
public: /* types */
enum class Status
{
Present,
Gone // either nuked or invalidated
};
2013-02-15 10:10:00 +05:30
public:
2013-08-03 19:27:33 +05:30
/// virtual destructor to make sure the destruction is COMPLETE
virtual ~BaseInstance() {};
2014-02-21 23:45:59 +05:30
virtual void copy(const QDir &newDir) {}
2015-01-28 03:01:07 +05:30
virtual void init() = 0;
/// nuke thoroughly - deletes the instance contents, notifies the list/model which is
/// responsible of cleaning up the husk
void nuke();
2016-10-03 04:25:54 +05:30
/***
* the instance has been invalidated - it is no longer tracked by MultiMC for some reason,
* but it has not necessarily been deleted.
*
* Happens when the instance folder changes to some other location, or the instance is removed by external means.
*/
void invalidate();
/// The instance's ID. The ID SHALL be determined by MMC internally. The ID IS guaranteed to
/// be unique.
virtual QString id() const;
2014-12-18 07:18:14 +05:30
void setRunning(bool running);
bool isRunning() const;
int64_t totalTimePlayed() const;
void resetTimePlayed();
2016-10-03 04:25:54 +05:30
void setProvider(BaseInstanceProvider * provider);
BaseInstanceProvider * provider() const;
2013-08-03 19:27:33 +05:30
/// get the type of this instance
QString instanceType() const;
2013-08-03 19:27:33 +05:30
/// Path to the instance's root directory.
QString instanceRoot() const;
2013-08-03 19:27:33 +05:30
QString name() const;
void setName(QString val);
2014-01-13 04:08:12 +05:30
/// Value used for instance window titles
QString windowTitle() const;
2013-08-03 19:27:33 +05:30
QString iconKey() const;
void setIconKey(QString val);
2013-08-03 19:27:33 +05:30
QString notes() const;
void setNotes(QString val);
2013-08-03 19:27:33 +05:30
QString group() const;
void setGroupInitial(QString val);
void setGroupPost(QString val);
QString getPreLaunchCommand();
QString getPostExitCommand();
QString getWrapperCommand();
2015-07-22 12:31:04 +05:30
/// guess log level from a line of game log
virtual MessageLevel::Enum guessLevel(const QString &line, MessageLevel::Enum level)
{
return level;
};
2014-05-05 03:40:59 +05:30
virtual QStringList extraArguments() const;
2013-08-05 06:59:50 +05:30
virtual QString intendedVersionId() const = 0;
2013-08-04 03:28:39 +05:30
virtual bool setIntendedVersionId(QString version) = 0;
2013-08-05 06:59:50 +05:30
/*!
* The instance's current version.
* This value represents the instance's current version. If this value is
2013-08-05 06:59:50 +05:30
* different from the intendedVersion, the instance should be updated.
* \warning Don't change this value unless you know what you're doing.
*/
virtual QString currentVersionId() const = 0;
2013-08-05 06:59:50 +05:30
/*!
2015-01-28 03:01:07 +05:30
* Whether or not 'the game' should be downloaded when the instance is launched.
2013-08-05 06:59:50 +05:30
*/
virtual bool shouldUpdate() const = 0;
virtual void setShouldUpdate(bool val) = 0;
/// Traits. Normally inside the version, depends on instance implementation.
virtual QSet <QString> traits() = 0;
2013-08-03 19:27:33 +05:30
/**
* Gets the time that the instance was last launched.
* Stored in milliseconds since epoch.
*/
qint64 lastLaunch() const;
/// Sets the last launched time to 'val' milliseconds since epoch
void setLastLaunch(qint64 val = QDateTime::currentMSecsSinceEpoch());
2014-09-06 21:46:56 +05:30
InstancePtr getSharedPtr();
2013-03-09 01:26:26 +05:30
/*!
* \brief Gets a pointer to this instance's version list.
* \return A pointer to the available version list for this instance.
*/
2015-01-28 03:01:07 +05:30
virtual std::shared_ptr<BaseVersionList> versionList() const = 0;
2013-02-26 02:14:36 +05:30
/*!
* \brief Gets this instance's settings object.
* This settings object stores instance-specific settings.
* \return A pointer to this instance's settings object.
*/
virtual SettingsObjectPtr settings() const;
/// returns a valid update task
virtual shared_qobject_ptr<Task> createUpdateTask() = 0;
/// returns a valid launcher (task container)
virtual std::shared_ptr<LaunchTask> createLaunchTask(AuthSessionPtr account) = 0;
/// returns the current launch task (if any)
std::shared_ptr<LaunchTask> getLaunchTask();
/*!
* Returns a task that should be done right before launch
* This task should do any extra preparations needed
*/
virtual std::shared_ptr<Task> createJarModdingTask() = 0;
/*!
* Create envrironment variables for running the instance
*/
virtual QProcessEnvironment createEnvironment() = 0;
/*!
* Returns a matcher that can maps relative paths within the instance to whether they are 'log files'
*/
virtual IPathMatcher::Ptr getLogFileMatcher() = 0;
/*!
* Returns the root folder to use for looking up log files
*/
virtual QString getLogFileRoot() = 0;
/*!
* does any necessary cleanups after the instance finishes. also runs before\
* TODO: turn into a task that can run asynchronously
*/
2013-08-05 06:59:50 +05:30
virtual void cleanupAfterRun() = 0;
virtual QString getStatusbarDescription() = 0;
/// FIXME: this really should be elsewhere...
virtual QString instanceConfigFolder() const = 0;
/// get variables this instance exports
virtual QMap<QString, QString> getVariables() const = 0;
virtual QString typeName() const = 0;
enum InstanceFlag
{
2014-09-06 21:46:56 +05:30
VersionBrokenFlag = 0x01,
UpdateAvailable = 0x02
};
2015-10-11 23:26:31 +05:30
Q_DECLARE_FLAGS(InstanceFlags, InstanceFlag)
2014-09-06 21:46:56 +05:30
InstanceFlags flags() const;
void setFlags(const InstanceFlags &flags);
void setFlag(const InstanceFlag flag);
void unsetFlag(const InstanceFlag flag);
bool canLaunch() const;
virtual bool canExport() const = 0;
virtual bool reload();
/**
* 'print' a verbose desription of the instance into a QStringList
*/
virtual QStringList verboseDescription(AuthSessionPtr session) = 0;
2016-10-03 04:25:54 +05:30
Status currentStatus() const;
protected:
void changeStatus(Status newStatus);
signals:
/*!
* \brief Signal emitted when properties relevant to the instance view change
*/
void propertiesChanged(BaseInstance *inst);
/*!
* \brief Signal emitted when groups are affected in any way
*/
void groupChanged();
void flagsChanged();
void launchTaskChanged(std::shared_ptr<LaunchTask>);
void runningStatusChanged(bool running);
2016-10-03 04:25:54 +05:30
void statusChanged(Status from, Status to);
protected slots:
void iconUpdated(QString key);
2016-10-03 04:25:54 +05:30
protected: /* data */
2014-12-18 07:18:14 +05:30
QString m_rootDir;
QString m_group;
2015-02-09 06:21:14 +05:30
SettingsObjectPtr m_settings;
2014-12-18 07:18:14 +05:30
InstanceFlags m_flags;
bool m_isRunning = false;
std::shared_ptr<LaunchTask> m_launchProcess;
QDateTime m_timeStarted;
2016-10-03 04:25:54 +05:30
BaseInstanceProvider * m_provider = nullptr;
private: /* data */
Status m_status = Status::Present;
2013-02-15 10:10:00 +05:30
};
2014-09-06 21:46:56 +05:30
Q_DECLARE_METATYPE(std::shared_ptr<BaseInstance>)
Q_DECLARE_METATYPE(BaseInstance::InstanceFlag)
2014-09-06 21:46:56 +05:30
Q_DECLARE_OPERATORS_FOR_FLAGS(BaseInstance::InstanceFlags)