aboutsummaryrefslogtreecommitdiff
path: root/engines/tsage/saveload.h
diff options
context:
space:
mode:
authorMatthew Hoops2011-04-13 16:04:29 -0400
committerMatthew Hoops2011-04-13 16:04:29 -0400
commit6d153f311c65fe414e31e99f8a9a6503c49a01a5 (patch)
tree9173f9964c0fec4215514e622f705810730d0ce9 /engines/tsage/saveload.h
parent47c2a9adbe8d9e6640a819386f0f34e929937672 (diff)
parent66b43f2312578f35e0718d0699de207a7bf77f1a (diff)
downloadscummvm-rg350-6d153f311c65fe414e31e99f8a9a6503c49a01a5.tar.gz
scummvm-rg350-6d153f311c65fe414e31e99f8a9a6503c49a01a5.tar.bz2
scummvm-rg350-6d153f311c65fe414e31e99f8a9a6503c49a01a5.zip
Merge remote branch 'upstream/master' into t7g-ios
Conflicts: video/qt_decoder.cpp
Diffstat (limited to 'engines/tsage/saveload.h')
-rw-r--r--engines/tsage/saveload.h215
1 files changed, 215 insertions, 0 deletions
diff --git a/engines/tsage/saveload.h b/engines/tsage/saveload.h
new file mode 100644
index 0000000000..83661b8f15
--- /dev/null
+++ b/engines/tsage/saveload.h
@@ -0,0 +1,215 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef TSAGE_SAVELOAD_H
+#define TSAGE_SAVELOAD_H
+
+#include "common/scummsys.h"
+#include "common/list.h"
+#include "common/memstream.h"
+#include "common/savefile.h"
+#include "common/serializer.h"
+
+namespace tSage {
+
+typedef void (*SaveNotifierFn)(bool postFlag);
+
+#define TSAGE_SAVEGAME_VERSION 1
+
+class SavedObject;
+
+struct tSageSavegameHeader {
+ uint8 version;
+ Common::String saveName;
+ Graphics::Surface *thumbnail;
+ int saveYear, saveMonth, saveDay;
+ int saveHour, saveMinutes;
+ int totalFrames;
+};
+
+/*--------------------------------------------------------------------------*/
+
+#define SYNC_POINTER(x) s.syncPointer((SavedObject **)&x)
+#define SYNC_ENUM(FIELD, TYPE) int v_##FIELD = (int)FIELD; s.syncAsUint16LE(v_##FIELD); \
+ if (s.isLoading()) FIELD = (TYPE)v_##FIELD;
+
+/**
+ * Derived serialiser class with extra synchronisation types
+ */
+class Serialiser : public Common::Serializer {
+public:
+ Serialiser(Common::SeekableReadStream *in, Common::WriteStream *out) : Common::Serializer(in, out) {}
+
+ void syncPointer(SavedObject **ptr, Common::Serializer::Version minVersion = 0,
+ Common::Serializer::Version maxVersion = kLastVersion);
+ void validate(const Common::String &s, Common::Serializer::Version minVersion = 0,
+ Common::Serializer::Version maxVersion = kLastVersion);
+ void validate(int v, Common::Serializer::Version minVersion = 0,
+ Common::Serializer::Version maxVersion = kLastVersion);
+};
+
+/*--------------------------------------------------------------------------*/
+
+class Serialisable {
+public:
+ virtual ~Serialisable() {}
+ virtual void synchronise(Serialiser &s) = 0;
+};
+
+class SaveListener {
+public:
+ virtual ~SaveListener() {}
+ virtual void listenerSynchronise(Serialiser &s) = 0;
+};
+
+/*--------------------------------------------------------------------------*/
+
+class SavedObject : public Serialisable {
+public:
+ SavedObject();
+ virtual ~SavedObject();
+
+ virtual Common::String getClassName() { return "SavedObject"; }
+ virtual void synchronise(Serialiser &s) {}
+
+ static SavedObject *createInstance(const Common::String &className);
+};
+
+/*--------------------------------------------------------------------------*/
+
+/**
+ * Derived list class with extra functionality
+ */
+template<typename T>
+class SynchronisedList : public Common::List<T> {
+public:
+ void synchronise(Serialiser &s) {
+ int entryCount;
+
+ if (s.isLoading()) {
+ this->clear();
+ s.syncAsUint32LE(entryCount);
+
+ for (int idx = 0; idx < entryCount; ++idx) {
+ this->push_back(static_cast<T>((T)NULL));
+ T &obj = Common::List<T>::back();
+ s.syncPointer((SavedObject **)&obj);
+ }
+ } else {
+ // Get the list size
+ entryCount = this->size();
+
+ // Write out list
+ s.syncAsUint32LE(entryCount);
+ for (typename Common::List<T>::iterator i = this->begin(); i != this->end(); ++i) {
+ s.syncPointer((SavedObject **)&*i);
+ }
+ }
+ }
+};
+
+/**
+ * Search whether an element is contained in a list.
+ *
+ * @param l List to search.
+ * @param v Element to search for.
+ * @return True in case the element is contained, false otherwise.
+ */
+template<typename T>
+inline bool contains(const Common::List<T> &l, const T &v) {
+ return (Common::find(l.begin(), l.end(), v) != l.end());
+}
+
+/**
+ * Derived list class for holding function pointers
+ */
+template<typename T>
+class FunctionList : public Common::List<void (*)(T)> {
+public:
+ void notify(T v) {
+ for (typename Common::List<void (*)(T)>::iterator i = this->begin(); i != this->end(); ++i) {
+ (*i)(v);
+ }
+ }
+};
+
+/*--------------------------------------------------------------------------*/
+
+class SavedObjectRef {
+public:
+ SavedObject **_savedObject;
+ int _objIndex;
+
+ SavedObjectRef() : _savedObject(NULL), _objIndex(-1) {}
+ SavedObjectRef(SavedObject **so, int objIndex) : _savedObject(so), _objIndex(objIndex) {}
+};
+
+typedef SavedObject *(*SavedObjectFactory)(const Common::String &className);
+
+class Saver {
+private:
+ SynchronisedList<SavedObject *> _objList;
+ FunctionList<bool> _saveNotifiers;
+ FunctionList<bool> _loadNotifiers;
+ Common::List<SaveListener *> _listeners;
+
+ Common::List<SavedObjectRef> _unresolvedPtrs;
+ SavedObjectFactory _factoryPtr;
+
+ bool _macroSaveFlag;
+ bool _macroRestoreFlag;
+ int _saveSlot;
+
+ void resolveLoadPointers();
+public:
+ Saver();
+ ~Saver();
+
+ Common::Error save(int slot, const Common::String &saveName);
+ Common::Error restore(int slot);
+ static bool readSavegameHeader(Common::InSaveFile *in, tSageSavegameHeader &header);
+ static void writeSavegameHeader(Common::OutSaveFile *out, tSageSavegameHeader &header);
+
+ void addListener(SaveListener *obj);
+ void addSaveNotifier(SaveNotifierFn fn);
+ void addLoadNotifier(SaveNotifierFn fn);
+ void addObject(SavedObject *obj);
+ void removeObject(SavedObject *obj);
+ void addFactory(SavedObjectFactory fn) { _factoryPtr = fn; }
+ void addSavedObjectPtr(SavedObject **ptr, int objIndex) {
+ _unresolvedPtrs.push_back(SavedObjectRef(ptr, objIndex));
+ }
+
+ bool savegamesExist() const;
+ bool getMacroSaveFlag() const { return _macroSaveFlag; }
+ bool getMacroRestoreFlag() const { return _macroRestoreFlag; }
+ int blockIndexOf(SavedObject *p);
+};
+
+extern Saver *_saver;
+
+} // End of namespace tSage
+
+#endif