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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
|
/* 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.
*
*/
#include "gob/save/saveload.h"
#include "gob/save/saveconverter.h"
#include "gob/inter.h"
#include "gob/variables.h"
namespace Gob {
SaveLoad_v3::SaveFile SaveLoad_v3::_saveFiles[] = {
{ "cat.inf", kSaveModeSave , 0, "savegame"},
{ "ima.inf", kSaveModeSave , 0, "screenshot"},
{ "intro.$$$", kSaveModeSave , 0, "temporary sprite"},
{ "bloc.inf", kSaveModeSave , 0, "notes"},
{ "prot", kSaveModeIgnore, 0, 0},
{ "config", kSaveModeIgnore, 0, 0}
};
SaveLoad_v3::GameHandler::File::File(GobEngine *vm, const char *base) :
SlotFileIndexed(vm, SaveLoad_v3::kSlotCount, base, "s") {
}
SaveLoad_v3::GameHandler::File::File(const File &file) :
SlotFileIndexed(file._vm, file._slotCount, file._base, file._ext) {
}
SaveLoad_v3::GameHandler::File::~File() {
}
int SaveLoad_v3::GameHandler::File::getSlot(int32 offset) const {
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return -1;
return ((offset - (kPropsSize + kIndexSize)) / varSize);
}
int SaveLoad_v3::GameHandler::File::getSlotRemainder(int32 offset) const {
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return -1;
return ((offset - (kPropsSize + kIndexSize)) % varSize);
}
SaveLoad_v3::GameHandler::GameHandler(GobEngine *vm, const char *target,
bool usesScreenshots) : SaveHandler(vm) {
_slotFile = new File(vm, target);
_usesScreenshots = usesScreenshots;
_firstSize = true;
memset(_props, 0, kPropsSize);
memset(_index, 0, kIndexSize);
_hasIndex = false;
_writer = 0;
_reader = 0;
}
SaveLoad_v3::GameHandler::~GameHandler() {
delete _slotFile;
delete _reader;
delete _writer;
}
int32 SaveLoad_v3::GameHandler::getSize() {
// Fake an empty save file for the very first query, to get clear properties
if (_firstSize) {
_firstSize = false;
return -1;
}
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return -1;
return _slotFile->tallyUpFiles(varSize, kPropsSize + kIndexSize);
}
bool SaveLoad_v3::GameHandler::load(int16 dataVar, int32 size, int32 offset) {
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return false;
if (size == 0) {
// Indicator to load all variables
dataVar = 0;
size = varSize;
}
if (((uint32) offset) < kPropsSize) {
// Global properties, like joker usage
debugC(3, kDebugSaveLoad, "Loading global properties");
if (((uint32) (offset + size)) > kPropsSize) {
warning("Wrong global properties list size (%d, %d)", size, offset);
return false;
}
_vm->_inter->_variables->copyFrom(dataVar, _props + offset, size);
} else if (((uint32) offset) == kPropsSize) {
// Save index
if (((uint32) size) != kIndexSize) {
warning("Requested index has wrong size (%d)", size);
return false;
}
// Create/Fake the index
buildIndex(_vm->_inter->_variables->getAddressOff8(dataVar));
} else {
// Save slot, whole variable block
uint32 slot = _slotFile->getSlot(offset);
int slotRem = _slotFile->getSlotRemainder(offset);
debugC(2, kDebugSaveLoad, "Loading from slot %d", slot);
if ((slot >= kSlotCount) || (slotRem != 0) ||
(dataVar != 0) || (((uint32) size) != varSize)) {
warning("Invalid saving procedure (%d, %d, %d, %d, %d)",
dataVar, size, offset, slot, slotRem);
return false;
}
_hasIndex = false;
if (!createReader(slot))
return false;
SavePartInfo info(kSlotNameLength, (uint32) _vm->getGameType(), 0,
_vm->getEndianness(), varSize);
SavePartVars vars(_vm, varSize);
if (!_reader->readPart(0, &info))
return false;
if (!_reader->readPart(1, &vars))
return false;
// Get all variables
if (!vars.writeInto(0, 0, varSize))
return false;
}
return true;
}
bool SaveLoad_v3::GameHandler::save(int16 dataVar, int32 size, int32 offset) {
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return false;
if (size == 0) {
// Indicator to save all variables
dataVar = 0;
size = varSize;
}
if (((uint32) offset) < kPropsSize) {
// Global properties, like joker usage
debugC(3, kDebugSaveLoad, "Saving global properties");
if (((uint32) (offset + size)) > kPropsSize) {
warning("Wrong global properties list size (%d, %d)", size, offset);
return false;
}
_vm->_inter->_variables->copyTo(dataVar, _props + offset, size);
} else if (((uint32) offset) == kPropsSize) {
// Save index
if (((uint32) size) != kIndexSize) {
warning("Requested index has wrong size (%d)", size);
return false;
}
// Just copy the index into our buffer
_vm->_inter->_variables->copyTo(dataVar, _index, kIndexSize);
_hasIndex = true;
} else {
// Save slot, whole variable block
uint32 slot = _slotFile->getSlot(offset);
int slotRem = _slotFile->getSlotRemainder(offset);
debugC(2, kDebugSaveLoad, "Saving to slot %d", slot);
if ((slot >= kSlotCount) || (slotRem != 0) ||
(dataVar != 0) || (((uint32) size) != varSize)) {
warning("Invalid saving procedure (%d, %d, %d, %d, %d)",
dataVar, size, offset, slot, slotRem);
return false;
}
// An index is needed for the save slot description
if (!_hasIndex) {
warning("No index written yet");
return false;
}
_hasIndex = false;
if (!createWriter(slot))
return false;
SavePartInfo info(kSlotNameLength, (uint32) _vm->getGameType(), 0,
_vm->getEndianness(), varSize);
SavePartVars vars(_vm, varSize);
// Write the description
info.setDesc(_index + (slot * kSlotNameLength), kSlotNameLength);
// Write all variables
if (!vars.readFrom(0, 0, varSize))
return false;
if (!_writer->writePart(0, &info))
return false;
if (!_writer->writePart(1, &vars))
return false;
}
return true;
}
bool SaveLoad_v3::GameHandler::saveScreenshot(int slot,
const SavePartSprite *screenshot) {
if (!createWriter(slot))
return false;
return _writer->writePart(2, screenshot);
}
bool SaveLoad_v3::GameHandler::loadScreenshot(int slot,
SavePartSprite *screenshot) {
if (!createReader(slot))
return false;
return _reader->readPart(2, screenshot);
}
void SaveLoad_v3::GameHandler::buildIndex(byte *buffer) const {
uint32 varSize = SaveHandler::getVarSize(_vm);
if (varSize == 0)
return;
SavePartInfo info(40, (uint32) _vm->getGameType(), 0, _vm->getEndianness(), varSize);
SaveConverter_v3 converter(_vm);
_slotFile->buildIndex(buffer, info, &converter);
}
bool SaveLoad_v3::GameHandler::createReader(int slot) {
// If slot < 0, just check if a reader exists
if (slot < 0)
return (_reader != 0);
if (!_reader || (_reader->getSlot() != ((uint32) slot))) {
Common::String slotFile = _slotFile->build(slot);
if (slotFile.empty())
return false;
delete _reader;
SaveConverter_v3 converter(_vm, slotFile);
if (converter.isOldSave()) {
// Old save, plug the converter in
if (!converter.load()) {
return false;
}
_reader = new SaveReader(_usesScreenshots ? 3 : 2, slot, converter);
} else
_reader = new SaveReader(_usesScreenshots ? 3 : 2, slot, slotFile);
if (!_reader->load()) {
delete _reader;
_reader = 0;
return false;
}
}
return true;
}
bool SaveLoad_v3::GameHandler::createWriter(int slot) {
// If slot < 0, just check if a writer exists
if (slot < 0)
return (_writer != 0);
if (!_writer || (_writer->getSlot() != ((uint32) slot))) {
Common::String slotFile = _slotFile->build(slot);
if (slotFile.empty())
return false;
delete _writer;
_writer = new SaveWriter(_usesScreenshots ? 3 : 2, slot, slotFile);
}
return true;
}
SaveLoad_v3::ScreenshotHandler::File::File(const SaveLoad_v3::GameHandler::File &file,
uint32 shotSize, uint32 shotIndexSize) : SaveLoad_v3::GameHandler::File(file) {
_shotSize = shotSize;
_shotIndexSize = shotIndexSize;
}
SaveLoad_v3::ScreenshotHandler::File::~File() {
}
int SaveLoad_v3::ScreenshotHandler::File::getSlot(int32 offset) const {
return ((offset - _shotIndexSize) / _shotSize);
}
int SaveLoad_v3::ScreenshotHandler::File::getSlotRemainder(int32 offset) const {
return ((offset - _shotIndexSize) % _shotSize);
}
void SaveLoad_v3::ScreenshotHandler::File::buildScreenshotIndex(byte *buffer) const {
Common::SaveFileManager *saveMan = g_system->getSavefileManager();
Common::InSaveFile *in;
for (uint32 i = 0; i < _slotCount; i++, buffer++) {
Common::String slotFile = build(i);
if (!slotFile.empty() && ((in = saveMan->openForLoading(slotFile)))) {
delete in;
*buffer = 1;
} else
*buffer = 0;
}
}
SaveLoad_v3::ScreenshotHandler::ScreenshotHandler(GobEngine *vm,
GameHandler *gameHandler, ScreenshotType sShotType) : TempSpriteHandler(vm) {
assert(gameHandler);
_gameHandler = gameHandler;
_sShotType = sShotType;
_shotSize = (_sShotType == kScreenshotTypeLost) ? 4768 : 19968;
_shotIndexSize = (_sShotType == kScreenshotTypeLost) ? 50 : 80;
_file = new File(*_gameHandler->_slotFile, _shotSize, _shotIndexSize);
memset(_index, 0, 80);
}
SaveLoad_v3::ScreenshotHandler::~ScreenshotHandler() {
delete _file;
}
int32 SaveLoad_v3::ScreenshotHandler::getSize() {
return _file->tallyUpFiles(_shotSize, _shotIndexSize);
}
bool SaveLoad_v3::ScreenshotHandler::load(int16 dataVar, int32 size, int32 offset) {
if (offset < _shotIndexSize) {
// Screenshot index list
if ((size + offset) > _shotIndexSize) {
warning("Wrong screenshot index offset (%d, %d)", size, offset);
return false;
}
if (_sShotType == kScreenshotTypeGob3) {
// Create/Fake the index
_file->buildScreenshotIndex(_index + 40);
// The last 10 bytes are 0
memset(_index + 70, 0, 10);
} else if (_sShotType == kScreenshotTypeLost) {
// Create/Fake the index
_file->buildScreenshotIndex(_index);
// The last byte is 0
_index[30] = 0;
}
_vm->_inter->_variables->copyFrom(dataVar, _index + offset, size);
} else {
// Screenshot
uint32 slot = _file->getSlot(offset);
int slotRem = _file->getSlotRemainder(offset);
if ((slot >= kSlotCount) || (slotRem != 0))
return false;
if (!TempSpriteHandler::createFromSprite(dataVar, size, offset))
return false;
if (!_gameHandler->loadScreenshot(slot, _sprite))
return false;
if (!TempSpriteHandler::load(dataVar, size, offset))
return false;
}
return true;
}
bool SaveLoad_v3::ScreenshotHandler::save(int16 dataVar, int32 size, int32 offset) {
if (offset < _shotIndexSize) {
// Screenshot index list
if ((size + offset) > _shotIndexSize) {
warning("Wrong screenshot index offset (%d, %d)", size, offset);
return false;
}
_vm->_inter->_variables->copyTo(dataVar, _index + offset, size);
} else {
// Screenshot
if (!TempSpriteHandler::save(dataVar, size, offset))
return false;
uint32 slot = _file->getSlot(offset);
int slotRem = _file->getSlotRemainder(offset);
if ((slot >= kSlotCount) || (slotRem != 0))
return false;
return _gameHandler->saveScreenshot(slot, _sprite);
}
return true;
}
SaveLoad_v3::SaveLoad_v3(GobEngine *vm, const char *targetName, ScreenshotType sShotType) :
SaveLoad(vm) {
_sShotType = sShotType;
// The Amiga version doesn't use screenshots
if (_vm->getPlatform() == Common::kPlatformAmiga) {
_gameHandler = new GameHandler(vm, targetName, false);
_screenshotHandler = 0;
} else {
_gameHandler = new GameHandler(vm, targetName, true);
_screenshotHandler = new ScreenshotHandler(vm, _gameHandler, sShotType);
}
_tempSpriteHandler = new TempSpriteHandler(vm);
_notesHandler = new NotesHandler(2560, vm, targetName);
_saveFiles[0].handler = _gameHandler;
_saveFiles[1].handler = _screenshotHandler;
_saveFiles[2].handler = _tempSpriteHandler;
_saveFiles[3].handler = _notesHandler;
}
SaveLoad_v3::~SaveLoad_v3() {
delete _screenshotHandler;
delete _gameHandler;
delete _notesHandler;
delete _tempSpriteHandler;
}
const SaveLoad_v3::SaveFile *SaveLoad_v3::getSaveFile(const char *fileName) const {
fileName = stripPath(fileName);
for (int i = 0; i < ARRAYSIZE(_saveFiles); i++)
if (!scumm_stricmp(fileName, _saveFiles[i].sourceName))
return &_saveFiles[i];
return 0;
}
SaveLoad_v3::SaveFile *SaveLoad_v3::getSaveFile(const char *fileName) {
fileName = stripPath(fileName);
for (int i = 0; i < ARRAYSIZE(_saveFiles); i++)
if (!scumm_stricmp(fileName, _saveFiles[i].sourceName))
return &_saveFiles[i];
return 0;
}
SaveHandler *SaveLoad_v3::getHandler(const char *fileName) const {
const SaveFile *saveFile = getSaveFile(fileName);
if (saveFile)
return saveFile->handler;
return 0;
}
const char *SaveLoad_v3::getDescription(const char *fileName) const {
const SaveFile *saveFile = getSaveFile(fileName);
if (saveFile)
return saveFile->description;
return 0;
}
SaveLoad::SaveMode SaveLoad_v3::getSaveMode(const char *fileName) const {
const SaveFile *saveFile = getSaveFile(fileName);
if (saveFile)
return saveFile->mode;
return kSaveModeNone;
}
} // End of namespace Gob
|