diff options
Diffstat (limited to 'logic/InstanceFactory.h')
-rw-r--r-- | logic/InstanceFactory.h | 38 |
1 files changed, 28 insertions, 10 deletions
diff --git a/logic/InstanceFactory.h b/logic/InstanceFactory.h index 1c527749..01e5af7e 100644 --- a/logic/InstanceFactory.h +++ b/logic/InstanceFactory.h @@ -3,7 +3,7 @@ * 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 @@ -34,15 +34,18 @@ public: /*! * \brief Gets a reference to the instance loader. */ - static InstanceFactory &get() { return loader; } - + static InstanceFactory &get() + { + return loader; + } + enum InstLoadError { NoLoadError = 0, UnknownLoadError, NotAnInstance }; - + enum InstCreateError { NoCreateError = 0, @@ -51,18 +54,33 @@ public: InstExists, CantCreateDir }; - + /*! * \brief Creates a stub instance * * \param inst Pointer to store the created instance in. - * \param instDir The instance's directory. + * \param inst Game version to use for the instance + * \param instDir The new 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, BaseVersionPtr version, + const QString &instDir); + + /*! + * \brief Creates a copy of an existing instance with a new name + * + * \param newInstance Pointer to store the created instance in. + * \param oldInstance The instance to copy + * \param instDir The new 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, BaseVersionPtr version, const QString &instDir); - + InstCreateError copyInstance(BaseInstance *&newInstance, BaseInstance *&oldInstance, + 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. @@ -72,9 +90,9 @@ public: * - NotAnInstance if the given instance directory isn't a valid instance. */ InstLoadError loadInstance(BaseInstance *&inst, const QString &instDir); - + private: InstanceFactory(); - + static InstanceFactory loader; }; |