aboutsummaryrefslogtreecommitdiff
path: root/engines/gob/saveload.h
blob: 467403bdb84a0ce10f58012f926be796cfa76f3d (plain)
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
/* 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 GOB_SAVELOAD_H
#define GOB_SAVELOAD_H

#include "common/array.h"
#include "common/stream.h"

#include "gob/video.h"
#include "gob/variables.h"

namespace Gob {

class TempSprite {
public:
	TempSprite();
	~TempSprite();

	bool getProperties(int16 dataVar, int32 size, int32 offset,
			int &index, bool &palette) const;

	int32 getSize() const;

	bool saveSprite(const SurfaceDesc &surfDesc);
	bool savePalette(const Video::Color *palette);
	bool loadSprite(SurfaceDesc &surfDesc);
	bool loadPalette(Video::Color *palette);

	bool toBuffer(byte *buffer, int32 size, bool palette) const;
	bool fromBuffer(const byte *buffer, int32 size, bool palette);
	
private:
	byte *_sprite;
	int16 _width;
	int16 _height;
	int32 _size;
	Video::Color _palette[256];

	int getSpriteIndex(int32 size) const;
	bool getSpritePalette(int32 size) const;
};

class PlainSave {
public:
	PlainSave(Endianness endianness);
	~PlainSave();

	bool save(int16 dataVar, int32 size, int32 offset, const char *name,
			const Variables *variables);
	bool load(int16 dataVar, int32 size, int32 offset, const char *name,
			Variables *variables);

	bool save(int16 dataVar, int32 size, int32 offset, const char *name,
			const byte *variables, const byte *variableSizes) const;
	bool load(int16 dataVar, int32 size, int32 offset, const char *name,
			byte *variables, byte *variableSizes) const;

private:
	Endianness _endianness;
};

class StagedSave {
public:
	StagedSave(Endianness endianness);
	~StagedSave();

	void addStage(int32 size, bool endianed = true);

	bool save(int16 dataVar, int32 size, int32 offset, const char *name,
			const Variables *variables);
	bool load(int16 dataVar, int32 size, int32 offset, const char *name,
			Variables *variables);

	bool save(int16 dataVar, int32 size, int32 offset, const char *name,
			const byte *variables, const byte *variableSizes);
	bool load(int16 dataVar, int32 size, int32 offset, const char *name,
			byte *variables, byte *variableSizes);

private:
	struct Stage {
		byte *bufVar;
		byte *bufVarSizes;
		int32 size;
		int32 offset;
		bool endianed;

		Stage(int32 s = 0, int32 off = 0, bool end = true) :
			bufVar(0), bufVarSizes(0), size(s), offset(off), endianed(end) {}
	};

	enum Mode {
		kModeNone,
		kModeSave,
		kModeLoad
	};

	Endianness _endianness;

	Common::Array<Stage> _stages;
	enum Mode _mode;
	char *_name;

	bool _loaded;

	int findStage(int16 dataVar, int32 size, int32 offset) const;
	bool allSaved() const;

	uint32 getSize() const;

	void clear();
	void assertMode(Mode mode, const char *name);

	bool write() const;
	bool read();
};

class PagedBuffer {
public:
	PagedBuffer(uint32 pageSize = 1024);
	~PagedBuffer();

	bool empty() const;
	uint32 getSize() const;

	void clear();

	bool write(const byte *buffer, uint32 size, uint32 offset);
	bool read(byte *buffer, uint32 size, uint32 offset) const;

	uint32 writeToStream(Common::WriteStream &out) const;
	uint32 readFromStream(Common::ReadStream &in);

private:
	uint32 _size;
	uint32 _pageSize;
	Common::Array<byte *> _pages;

	void grow(uint32 size, uint32 offset);
};

class SaveLoad {
public:
	enum SaveMode {
		kSaveModeNone,
		kSaveModeIgnore,
		kSaveModeExists,
		kSaveModeSave
	};

	SaveLoad(GobEngine *vm, const char *targetName);
	virtual ~SaveLoad();

	virtual SaveMode getSaveMode(const char *fileName);

	int32 getSize(const char *fileName);
	bool load(const char *fileName, int16 dataVar, int32 size, int32 offset);
	bool save(const char *fileName, int16 dataVar, int32 size, int32 offset);

	char *setCurrentSlot(char *destName, int slot);
	void buildIndex(byte *buffer, char *name, int n, int32 size, int32 offset = 0);

	static const char *stripPath(const char *fileName);

	static bool fromEndian(byte *buf, const byte *sizes, uint32 count, Endianness endianness);
	static bool toEndian(byte *buf, const byte *sizes, uint32 count, Endianness endianness);
	static uint32 read(Common::ReadStream &in,
			byte *buf, byte *sizes, uint32 count);
	static uint32 write(Common::WriteStream &out,
			const byte *buf, const byte *sizes, uint32 count);

	static bool loadDataEndian(Common::ReadStream &in,
			int16 dataVar, uint32 size,
			byte *variables, byte *variableSizes, Endianness endianness);
	static bool saveDataEndian(Common::WriteStream &out,
			int16 dataVar, uint32 size,
			const byte *variables, const byte *variableSizes, Endianness endianness);

protected:
	GobEngine *_vm;

	char *_targetName;

	virtual int getSaveType(const char *fileName);

	virtual int32 getSizeVersioned(int type);
	virtual bool loadVersioned(int type, int16 dataVar, int32 size, int32 offset);
	virtual bool saveVersioned(int type, int16 dataVar, int32 size, int32 offset);
};

class SaveLoad_v2 : public SaveLoad {
public:
	enum SaveType {
		kSaveGame,
		kSaveTempSprite,
		kSaveNotes
	};

	SaveLoad_v2(GobEngine *vm, const char *targetName);
	virtual ~SaveLoad_v2();

	virtual SaveMode getSaveMode(const char *fileName);

protected:
	struct SaveFile {
		const char *sourceName;
		char *destName;
		SaveMode mode;
		SaveType type;
	};

	static SaveFile _saveFiles[];

	int32 _varSize;

	TempSprite _tmpSprite;
	PlainSave *_notes;
	StagedSave *_save;

	byte _indexBuffer[600];
	bool _hasIndex;

	virtual int getSaveType(const char *fileName);

	virtual int32 getSizeVersioned(int type);
	virtual bool loadVersioned(int type, int16 dataVar, int32 size, int32 offset);
	virtual bool saveVersioned(int type, int16 dataVar, int32 size, int32 offset);

	int getSlot(int32 offset) const;
	int getSlotRemainder(int32 offset) const;

	int32 getSizeGame(SaveFile &saveFile);
	int32 getSizeTempSprite(SaveFile &saveFile);
	int32 getSizeNotes(SaveFile &saveFile);

	bool loadGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadTempSprite(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadNotes(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	bool saveGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveTempSprite(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveNotes(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	void assertInited();
};

enum SaveType {
	kSaveNone = -1,
	kSaveGame,
	kSaveTempSprite,
	kSaveNotes,
	kSaveScreenshot,
	kSaveIgnore
};

class SaveLoad_v3 : public SaveLoad {
public:
	enum SaveType {
		kSaveNone,
		kSaveGame,
		kSaveTempSprite,
		kSaveNotes,
		kSaveScreenshot
	};

	SaveLoad_v3(GobEngine *vm, const char *targetName,
			uint32 screenshotSize = 19968,
			int32 indexOffset = 40, int32 screenshotOffset = 80);
	virtual ~SaveLoad_v3();

	virtual SaveMode getSaveMode(const char *fileName);

protected:
	struct SaveFile {
		const char *sourceName;
		char *destName;
		SaveMode mode;
		SaveType type;
		int slot;
	};

	bool _useScreenshots;
	bool _firstSizeGame;

	uint32 _screenshotSize;
	int32 _indexOffset;
	int32 _screenshotOffset;

	static SaveFile _saveFiles[];

	int32 _varSize;

	TempSprite _screenshot;
	TempSprite _tmpSprite;
	PlainSave *_notes;
	StagedSave *_save;

	byte _propBuffer[1000];
	byte _indexBuffer[1200];
	bool _hasIndex;

	virtual int getSaveType(const char *fileName);

	virtual int32 getSizeVersioned(int type);
	virtual bool loadVersioned(int type, int16 dataVar, int32 size, int32 offset);
	virtual bool saveVersioned(int type, int16 dataVar, int32 size, int32 offset);

	int getSlot(int32 offset) const;
	int getSlotRemainder(int32 offset) const;

	int32 getSizeGame(SaveFile &saveFile);
	int32 getSizeTempSprite(SaveFile &saveFile);
	int32 getSizeNotes(SaveFile &saveFile);
	int32 getSizeScreenshot(SaveFile &saveFile);

	bool loadGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadTempSprite(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadNotes(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadScreenshot(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	bool saveGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveTempSprite(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveNotes(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveScreenshot(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	void assertInited();

	void buildScreenshotIndex(byte *buffer, char *name, int n);
};

class SaveLoad_v4 : public SaveLoad {
public:
	enum SaveType {
		kSaveNone,
		kSaveScreenProps,
		kSaveGame,
		kSaveGameScreenProps
	};

	bool _firstSizeGame;

	SaveLoad_v4(GobEngine *vm, const char *targetName);
	virtual ~SaveLoad_v4();

	virtual SaveMode getSaveMode(const char *fileName);

protected:
	struct SaveFile {
		const char *sourceName;
		char *destName;
		SaveMode mode;
		SaveType type;
	};

	static SaveFile _saveFiles[];

	int32 _varSize;

	StagedSave *_save;

	byte _propBuffer[1000];
	byte _indexBuffer[1200];
	bool _hasIndex;

	byte *_screenProps;

	virtual int getSaveType(const char *fileName);

	virtual int32 getSizeVersioned(int type);
	virtual bool loadVersioned(int type, int16 dataVar, int32 size, int32 offset);
	virtual bool saveVersioned(int type, int16 dataVar, int32 size, int32 offset);

	int getSlot(int32 offset) const;
	int getSlotRemainder(int32 offset) const;

	int32 getSizeScreenProps(SaveFile &saveFile);
	int32 getSizeGame(SaveFile &saveFile);
	int32 getSizeGameScreenProps(SaveFile &saveFile);

	bool loadScreenProps(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool loadGameScreenProps(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	bool saveScreenProps(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveGame(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);
	bool saveGameScreenProps(SaveFile &saveFile, int16 dataVar, int32 size, int32 offset);

	void assertInited();
};

class SaveLoad_v6 : public SaveLoad {
public:
	enum SaveType {
		kSaveNone,
		kSaveNoCD
	};

	SaveLoad_v6(GobEngine *vm, const char *targetName);
	virtual ~SaveLoad_v6();

	virtual SaveMode getSaveMode(const char *fileName);

protected:
	struct SaveFile {
		const char *sourceName;
		char *destName;
		SaveMode mode;
		SaveType type;
	};

	static SaveFile _saveFiles[];
};

} // End of namespace Gob

#endif // GOB_SAVELOAD_H