pollymc/backend/BaseInstance.h

140 lines
4.2 KiB
C
Raw Normal View History

2013-02-15 10:10:00 +05:30
/* Copyright 2013 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
2013-02-15 10:10:00 +05:30
#include <QObject>
#include <QDateTime>
2013-02-26 02:14:36 +05:30
#include <settingsobject.h>
#include "inifile.h"
#include "lists/InstVersionList.h"
2013-02-27 04:17:39 +05:30
#include "libmmc_config.h"
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
class MinecraftProcess;
2013-08-04 18:16:33 +05:30
class OneSixUpdate;
2013-02-15 10:10:00 +05:30
class InstanceList;
2013-08-03 19:27:33 +05:30
class BaseInstancePrivate;
2013-02-15 10:10:00 +05:30
/*!
* \brief Base class for instances.
* This class implements many functions that are common between instances and
* provides a standard interface for all instances.
*
* To create a new instance type, create a new class inheriting from this class
* and implement the pure virtual functions.
*/
class LIBMULTIMC_EXPORT BaseInstance : public QObject
2013-02-15 10:10:00 +05:30
{
Q_OBJECT
2013-08-03 19:27:33 +05:30
protected:
/// no-touchy!
BaseInstance(BaseInstancePrivate * d, const QString &rootDir, SettingsObject * settings, QObject *parent = 0);
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() {};
/// The instance's ID. The ID SHALL be determined by MMC internally. The ID IS guaranteed to be unique.
QString id() const;
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
/// get the type of this instance
QString instanceType() const;
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
/// Path to the instance's root directory.
QString rootDir() const;
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
QString name() const;
void setName(QString val);
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
QString iconKey() const;
void setIconKey(QString val);
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
QString notes() const;
void setNotes(QString val);
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
QString group() const;
void setGroup(QString val);
2013-02-15 10:10:00 +05:30
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
* 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;
//virtual void setCurrentVersionId(QString val) = 0;
/*!
* Whether or not Minecraft should be downloaded when the instance is launched.
*/
virtual bool shouldUpdate() const = 0;
virtual void setShouldUpdate(bool val) = 0;
2013-02-15 10:10:00 +05:30
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());
2013-08-04 03:28:39 +05:30
/*!
* \brief Gets the instance list that this instance is a part of.
* Returns NULL if this instance is not in a list
* (the parent is not an InstanceList).
* \return A pointer to the InstanceList containing this instance.
*/
InstanceList *instList() const;
2013-02-15 10:10:00 +05:30
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.
*/
virtual InstVersionList *versionList() const;
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.
*/
2013-02-26 04:06:27 +05:30
virtual SettingsObject &settings() const;
2013-02-15 10:10:00 +05:30
2013-08-03 19:27:33 +05:30
/// returns a valid update task if update is needed, NULL otherwise
2013-08-04 18:16:33 +05:30
virtual OneSixUpdate* doUpdate() = 0;
2013-08-03 19:27:33 +05:30
/// returns a valid minecraft process, ready for launch
virtual MinecraftProcess* prepareForLaunch(QString user, QString session) = 0;
2013-08-05 06:59:50 +05:30
/// do any necessary cleanups after the instance finishes. also runs before 'prepareForLaunch'
virtual void cleanupAfterRun() = 0;
signals:
/*!
* \brief Signal emitted when properties relevant to the instance view change
*/
void propertiesChanged(BaseInstance * inst);
2013-08-03 19:27:33 +05:30
protected:
QSharedPointer<BaseInstancePrivate> inst_d;
2013-02-15 10:10:00 +05:30
};
// pointer for lazy people
typedef QSharedPointer<BaseInstance> InstancePtr;