summaryrefslogtreecommitdiffstats
path: root/backend/InstanceFactory.h
diff options
context:
space:
mode:
Diffstat (limited to 'backend/InstanceFactory.h')
-rw-r--r--backend/InstanceFactory.h79
1 files changed, 79 insertions, 0 deletions
diff --git a/backend/InstanceFactory.h b/backend/InstanceFactory.h
new file mode 100644
index 00000000..0dd4c5d8
--- /dev/null
+++ b/backend/InstanceFactory.h
@@ -0,0 +1,79 @@
+/* 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
+
+#include <QObject>
+#include <QMap>
+#include <QList>
+
+#include "libmmc_config.h"
+
+class BaseInstance;
+
+/*!
+ * The \bInstanceFactory\b is a singleton that manages loading and creating instances.
+ */
+class LIBMULTIMC_EXPORT InstanceFactory : public QObject
+{
+ Q_OBJECT
+public:
+ /*!
+ * \brief Gets a reference to the instance loader.
+ */
+ static InstanceFactory &get() { return loader; }
+
+ enum InstLoadError
+ {
+ NoLoadError = 0,
+ UnknownLoadError,
+ NotAnInstance
+ };
+
+ enum InstCreateError
+ {
+ NoCreateError = 0,
+ UnknownCreateError,
+ InstExists,
+ CantCreateDir
+ };
+
+ /*!
+ * \brief Creates an instance with the given type and stores it in inst.
+ *
+ * \param inst Pointer to store the created instance in.
+ * \param type The type of instance to create.
+ * \param instDir The instance's directory.
+ * \return An InstCreateError error code.
+ * - InstExists if the given instance directory is already an instance.
+ * - CantCreateDir if the given instance directory cannot be created.
+ */
+ InstCreateError createInstance(BaseInstance *&inst, const QString &instDir);
+
+ /*!
+ * \brief Loads an instance from the given directory.
+ * Checks the instance's INI file to figure out what the instance's type is first.
+ * \param inst Pointer to store the loaded instance in.
+ * \param instDir The instance's directory.
+ * \return An InstLoadError error code.
+ * - NotAnInstance if the given instance directory isn't a valid instance.
+ */
+ InstLoadError loadInstance(BaseInstance *&inst, const QString &instDir);
+
+private:
+ InstanceFactory();
+
+ static InstanceFactory loader;
+};