summaryrefslogtreecommitdiffstats
path: root/backend/BaseInstance.h
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2013-08-03 15:57:33 +0200
committerPetr Mrázek <peterix@gmail.com>2013-08-03 15:57:33 +0200
commit13b1b98f7cf8a3b3b2c15dd42f96537b02c00711 (patch)
treeff3a67221e90eb9aa067e0b0d1f934fd4dd28534 /backend/BaseInstance.h
parent2e0cbf393a5320dbf5448ca44a9b5905314b0be8 (diff)
downloadMultiMC-13b1b98f7cf8a3b3b2c15dd42f96537b02c00711.tar
MultiMC-13b1b98f7cf8a3b3b2c15dd42f96537b02c00711.tar.gz
MultiMC-13b1b98f7cf8a3b3b2c15dd42f96537b02c00711.tar.lz
MultiMC-13b1b98f7cf8a3b3b2c15dd42f96537b02c00711.tar.xz
MultiMC-13b1b98f7cf8a3b3b2c15dd42f96537b02c00711.zip
WTF, I don't even...
Diffstat (limited to 'backend/BaseInstance.h')
-rw-r--r--backend/BaseInstance.h270
1 files changed, 47 insertions, 223 deletions
diff --git a/backend/BaseInstance.h b/backend/BaseInstance.h
index 51f55b5e..088075f2 100644
--- a/backend/BaseInstance.h
+++ b/backend/BaseInstance.h
@@ -25,7 +25,10 @@
#include "libmmc_config.h"
+class MinecraftProcess;
+class GameUpdateTask;
class InstanceList;
+class BaseInstancePrivate;
/*!
* \brief Base class for instances.
@@ -38,128 +41,21 @@ class InstanceList;
class LIBMULTIMC_EXPORT BaseInstance : public QObject
{
Q_OBJECT
-
- // Properties
- /*!
- * The instance's ID.
- * This is a unique identifier string that is, by default, set to the
- * instance's folder name. It's not always the instance's folder name,
- * however, as any class deriving from Instance can override the id()
- * method and change how the ID is determined. The instance's ID should
- * always remain constant. Undefined behavior results if an already loaded
- * instance's ID changes.
- */
- Q_PROPERTY(QString id READ id STORED false)
-
- //! Path to the instance's root directory.
- Q_PROPERTY(QString rootDir READ rootDir)
-
- //! The name of the instance that is displayed to the user.
- Q_PROPERTY(QString name READ name WRITE setName)
-
- //! The instance's icon key.
- Q_PROPERTY(QString iconKey READ iconKey WRITE setIconKey)
-
- //! The instance's notes.
- Q_PROPERTY(QString notes READ notes WRITE setNotes)
-
- //! The instance's group.
- Q_PROPERTY(QString group READ group WRITE setGroup)
-
- /*!
- * Gets the time that the instance was last launched.
- * Stored in milliseconds since epoch.
- * This value is usually used for things like sorting instances by the time
- * they were last launched.
- */
- Q_PROPERTY(qint64 lastLaunch READ lastLaunch WRITE setLastLaunch)
-
- /*!
- * Whether or not the instance's minecraft.jar needs to be rebuilt.
- * If this is true, when the instance launches, its jar mods will be
- * re-added to a fresh minecraft.jar file.
- */
- Q_PROPERTY(bool shouldRebuild READ shouldRebuild WRITE setShouldRebuild)
-
- /*!
- * Whether or not Minecraft should be downloaded when the instance is launched.
- * This returns true if shouldForceUpdate game is true or if the intended and
- * current versions don't match.
- */
- Q_PROPERTY(bool shouldUpdate READ shouldUpdate WRITE setShouldUpdate)
-
- /*!
- * 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.
- */
- Q_PROPERTY(QString currentVersion READ currentVersion WRITE setCurrentVersion)
-
- /*!
- * The version that the user has set for this instance to use.
- * If this is not the same as currentVersion, the instance's game updater
- * will be run on launch.
- */
- Q_PROPERTY(QString intendedVersion READ intendedVersion WRITE setIntendedVersion)
-
- //! The version of LWJGL that this instance uses.
- Q_PROPERTY(QString lwjglVersion READ lwjglVersion WRITE setLWJGLVersion)
-
-
- /*!
- * Gets the last time that the current version was checked.
- * This is checked against the last modified time on the jar file to see if
- * the current version needs to be checked again.
- */
- Q_PROPERTY(qint64 lastCurrentVersionUpdate READ lastCurrentVersionUpdate WRITE setLastCurrentVersionUpdate)
-
- // Dirs
- //! Path to the instance's .minecraft folder.
- Q_PROPERTY(QString minecraftDir READ minecraftDir STORED false)
-
- //! Path to the instance's instMods folder.
- Q_PROPERTY(QString instModsDir READ instModsDir STORED false)
-
- //! Path to the instance's bin folder.
- Q_PROPERTY(QString binDir READ binDir STORED false)
-
- //! Path to the instance's saves folder.
- Q_PROPERTY(QString savesDir READ savesDir STORED false)
-
- //! Path to the instance's mods folder (.minecraft/mods)
- Q_PROPERTY(QString mlModsDir READ mlModsDir STORED false)
-
- //! Path to the instance's coremods folder.
- Q_PROPERTY(QString coreModsDir READ coreModsDir STORED false)
-
- //! Path to the instance's resources folder.
- Q_PROPERTY(QString resourceDir READ resourceDir STORED false)
-
- //! Path to the instance's screenshots folder.
- Q_PROPERTY(QString screenshotsDir READ screenshotsDir STORED false)
-
- //! Path to the instance's texturepacks folder.
- Q_PROPERTY(QString texturePacksDir READ texturePacksDir STORED false)
-
-
- // Files
- //! Path to the instance's minecraft.jar
- Q_PROPERTY(QString mcJar READ mcJar STORED false)
-
- //! Path to the instance's mcbackup.jar
- Q_PROPERTY(QString mcBackup READ mcBackup STORED false)
-
- //! Path to the instance's modlist file.
- Q_PROPERTY(QString modListFile READ modListFile STORED false)
-
+protected:
+ /// no-touchy!
+ BaseInstance(BaseInstancePrivate * d, const QString &rootDir, SettingsObject * settings, QObject *parent = 0);
public:
- explicit BaseInstance(const QString &rootDir, QObject *parent = 0);
+ /// 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;
- //////// STUFF ////////
- virtual QString id() const;
+ /// get the type of this instance
+ QString instanceType() const;
- virtual QString rootDir() const;
+ /// Path to the instance's root directory.
+ QString rootDir() const;
/*!
* \brief Gets the instance list that this instance is a part of.
@@ -167,128 +63,52 @@ public:
* (the parent is not an InstanceList).
* \return A pointer to the InstanceList containing this instance.
*/
- virtual InstanceList *instList() const;
+ InstanceList *instList() const;
//////// INSTANCE INFO ////////
- //// General Info ////
- virtual QString name() const { return settings().get("name").toString(); }
- virtual void setName(QString val)
- {
- settings().set("name", val);
- emit propertiesChanged(this);
- }
-
- virtual QString iconKey() const { return settings().get("iconKey").toString(); }
- virtual void setIconKey(QString val)
- {
- settings().set("iconKey", val);
- emit propertiesChanged(this);
- }
+ /// The name of the instance that is displayed to the user.
+ QString name() const;
- virtual QString notes() const { return settings().get("notes").toString(); }
- virtual void setNotes(QString val) { settings().set("notes", val); }
+ /// Set the name of the instance that is displayed to the user.
+ void setName(QString val);
- virtual QString group() const { return m_group; }
- virtual void setGroup(QString val)
- {
- m_group = val;
- emit propertiesChanged(this);
- }
+ /// The instance's icon key.
+ QString iconKey() const;
- virtual bool shouldRebuild() const { return settings().get("NeedsRebuild").toBool(); }
- virtual void setShouldRebuild(bool val) { settings().set("NeedsRebuild", val); }
+ /// Set the instance's icon key.
+ void setIconKey(QString val);
+ //! The instance's notes.
+ QString notes() const;
- //// Version Stuff ////
-
- virtual QString currentVersion() const { return settings().get("JarVersion").toString(); }
- virtual void setCurrentVersion(QString val) { settings().set("JarVersion", val); }
+ /// set the instance notes text
+ void setNotes(QString val);
- virtual QString lwjglVersion() const { return settings().get("LwjglVersion").toString(); }
- virtual void setLWJGLVersion(QString val) { settings().set("LwjglVersion", val); }
+ //! The instance's group.
+ QString group() const;
- virtual QString intendedVersion() const { return settings().get("IntendedJarVersion").toString(); }
- virtual void setIntendedVersion(QString val) { settings().set("IntendedJarVersion", val); }
+ /// set the instance group
+ void setGroup(QString val);
- virtual bool shouldUpdate() const
- {
- QVariant var = settings().get("ShouldUpdate");
- if(!var.isValid() || var.toBool() == false)
- {
- return intendedVersion() != currentVersion();
- }
- return true;
- }
- virtual void setShouldUpdate(bool val) { settings().set("ShouldUpdate", val); }
-
//// Timestamps ////
- virtual qint64 lastLaunch() const { return settings().get("lastLaunchTime").value<qint64>(); }
- virtual void setLastLaunch(qint64 val = QDateTime::currentMSecsSinceEpoch())
- {
- settings().set("lastLaunchTime", val);
- emit propertiesChanged(this);
- }
-
- virtual qint64 lastCurrentVersionUpdate() const { return settings().get("lastVersionUpdate").value<qint64>(); }
- virtual void setLastCurrentVersionUpdate(qint64 val) { settings().set("lastVersionUpdate", val); }
-
- ////// Directories //////
- QString minecraftDir() const;
- QString instModsDir() const;
- QString binDir() const;
- QString savesDir() const;
- QString mlModsDir() const;
- QString coreModsDir() const;
- QString resourceDir() const;
- QString screenshotsDir() const;
- QString texturePacksDir() const;
-
-
- ////// Files //////
- QString mcJar() const;
- QString mcBackup() const;
- QString modListFile() const;
+ /**
+ * 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());
- //////// LISTS, LISTS, AND MORE LISTS ////////
/*!
* \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;
-
- //////// OTHER FUNCTIONS ////////
-
- //// Version System ////
-
- /*!
- * \brief Checks whether or not the currentVersion of the instance needs to be updated.
- * If this returns true, updateCurrentVersion is called. In the
- * standard instance, this is determined by checking a timestamp
- * stored in the instance config file against the last modified time of Minecraft.jar.
- * \return True if updateCurrentVersion() should be called.
- */
- virtual bool shouldUpdateCurrentVersion() const;
-
- /*!
- * \brief Updates the current version.
- * This function should first set the current version timestamp
- * (setCurrentVersionTimestamp()) to the current time. Next, if
- * keepCurrent is false, this function should check what the
- * instance's current version is and call setCurrentVersion() to
- * update it. This function will automatically be called when the
- * instance is loaded if shouldUpdateCurrentVersion returns true.
- * \param keepCurrent If true, only the version timestamp will be updated.
- */
- virtual void updateCurrentVersion(bool keepCurrent = false);
-
-
- //// Settings System ////
-
/*!
* \brief Gets this instance's settings object.
* This settings object stores instance-specific settings.
@@ -296,16 +116,20 @@ public:
*/
virtual SettingsObject &settings() const;
+ /// returns a valid update task if update is needed, NULL otherwise
+ virtual GameUpdateTask* doUpdate() = 0;
+
+ /// returns a valid minecraft process, ready for launch
+ virtual MinecraftProcess* prepareForLaunch(QString user, QString session) = 0;
+
signals:
/*!
* \brief Signal emitted when properties relevant to the instance view change
*/
void propertiesChanged(BaseInstance * inst);
-private:
- QString m_rootDir;
- QString m_group;
- SettingsObject *m_settings;
+protected:
+ QSharedPointer<BaseInstancePrivate> inst_d;
};
// pointer for lazy people