1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/* 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.
*
*/
#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 5
class SavedObject;
struct tSageSavegameHeader {
uint8 version;
Common::String saveName;
Graphics::Surface *thumbnail;
int saveYear, saveMonth, saveDay;
int saveHour, saveMinutes;
int totalFrames;
};
/*--------------------------------------------------------------------------*/
// FIXME: workaround to supress spurious strict-alias warnings on older GCC
// versions. this should be resolved with the savegame rewrite
#define SYNC_POINTER(x) do { \
SavedObject **y = (SavedObject **)((void *)&x); \
s.syncPointer(y); \
} while (false)
#define SYNC_ENUM(FIELD, TYPE) int v_##FIELD = (int)FIELD; s.syncAsUint16LE(v_##FIELD); \
if (s.isLoading()) FIELD = (TYPE)v_##FIELD;
/**
* Derived serializer class with extra synchronisation types
*/
class Serializer : public Common::Serializer {
public:
Serializer(Common::SeekableReadStream *in, Common::WriteStream *out) : Common::Serializer(in, out) {}
// HACK: TSAGE saved games contain a single byte for the savegame version,
// thus the normal syncVersion() Serializer member won't work here. In order
// to maintain compatibility with older game saves, this method is provided
// in order to set the savegame version from a byte
void setSaveVersion(byte version) { _version = version; }
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 synchronize(Serializer &s) = 0;
};
class SaveListener {
public:
virtual ~SaveListener() {}
virtual void listenerSynchronize(Serializer &s) = 0;
};
/*--------------------------------------------------------------------------*/
class SavedObject : public Serialisable {
public:
SavedObject();
virtual ~SavedObject();
virtual Common::String getClassName() { return "SavedObject"; }
virtual void synchronize(Serializer &s) {}
static SavedObject *createInstance(const Common::String &className);
};
/*--------------------------------------------------------------------------*/
/**
* Derived list class with extra functionality
*/
template<typename T>
class SynchronizedList : public Common::List<T> {
public:
void synchronize(Serializer &s) {
int entryCount = 0;
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:
Common::List<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);
int getObjectCount() const;
void listObjects();
};
extern Saver *_saver;
} // End of namespace tSage
#endif
|
