MACVENTURE: Add metadata to savegames

engines/macventure/detection.cpp

@@ -29,10 +29,9 @@
 
 namespace MacVenture {
 
-	const char *MacVentureEngine::getGameFileName() const {
+const char *MacVentureEngine::getGameFileName() const {
 	return _gameDescription->filesDescriptions[0].fileName;
-	}
+}
-
 }
 
 namespace MacVenture {
@@ -46,6 +45,8 @@ static const PlainGameDescriptor macventureGames[] = {
 	{ 0, 0 }
 };
 
+SaveStateDescriptor loadMetaData(Common::SeekableReadStream *s, int slot);
+
 class MacVentureMetaEngine : public AdvancedMetaEngine {
 public:
 	MacVentureMetaEngine() : AdvancedMetaEngine(MacVenture::gameDescriptions, sizeof(ADGameDescription), macventureGames) {
@@ -62,12 +63,57 @@ public:
 
 	virtual bool createInstance(OSystem * syst, Engine ** engine, const ADGameDescription * desc) const;
 	virtual bool hasFeature(MetaEngineFeature f) const;
+	virtual SaveStateList listSaves(const char *target) const;
+	virtual int getMaximumSaveSlot() const;
 };
 
 bool MacVentureMetaEngine::hasFeature(MetaEngineFeature f) const {
-	return false;
+	return
+		(f == kSupportsListSaves) ||
+		(f == kSupportsLoadingDuringStartup);
 }
 
+SaveStateList MacVentureMetaEngine::listSaves(const char *target) const {
+	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
+	Common::StringArray filenames;
+	Common::String pattern = target;
+	pattern += ".###";
+
+	filenames = saveFileMan->listSavefiles(pattern);
+
+	SaveStateList saveList;
+	for (Common::StringArray::const_iterator file = filenames.begin(); file != filenames.end(); ++file) {
+		int slotNum = atoi(file->c_str() + file->size() - 3);
+		Common::InSaveFile *in = g_system->getSavefileManager()->openForLoading(*file);
+
+		SaveStateDescriptor desc;
+		// Do not allow save slot 0 (used for auto-saving) to be deleted or
+		// overwritten.
+		desc.setDeletableFlag(slotNum != 0);
+		desc.setWriteProtectedFlag(slotNum == 0);
+
+		if (slotNum >= 0 && slotNum <= getMaximumSaveSlot()) {
+			Common::InSaveFile *in = saveFileMan->openForLoading(*file);
+			if (in) {
+				SaveStateDescriptor desc = loadMetaData(in, slotNum);
+				if (desc.getSaveSlot() != slotNum) {
+					// invalid
+					delete in;
+					continue;
+				}
+				saveList.push_back(desc);
+				delete in;
+			}
+		}
+	}
+
+	// Sort saves based on slot number.
+	Common::sort(saveList.begin(), saveList.end(), SaveStateDescriptorSlotComparator());
+	return saveList;
+}
+
+int MacVentureMetaEngine::getMaximumSaveSlot() const { return 999; }
+
 bool MacVentureMetaEngine::createInstance(OSystem * syst, Engine ** engine, const ADGameDescription *game) const {
 	if (game) {
 		*engine = new MacVentureEngine(syst, game);

engines/macventure/macventure.cpp

@@ -178,21 +178,6 @@ Common::Error MacVentureEngine::run() {
 	return Common::kNoError;
 }
 
-Common::Error MacVentureEngine::loadGameState(int slot) {
-	Common::InSaveFile *file = getSaveFileManager()->openForLoading("Shadowgate.1");
-	_world->loadGameFrom(file);
-	reset();
-	return Common::kNoError;
-}
-
-Common::Error MacVentureEngine::saveGameState(int slot, const Common::String &desc) {
-	Common::SaveFileManager *manager = getSaveFileManager();
-	// HACK Get a real name!
-	Common::OutSaveFile *file = manager->openForSaving("Shadowgate.1");
-	_world->saveGameInto(file);
-	delete file;
-}
-
 void MacVentureEngine::reset() {
 	resetInternals();
 	resetGui();

engines/macventure/module.mk

@@ -13,7 +13,8 @@ MODULE_OBJS := \
 	controls.o \
 	prebuilt_dialogs.o \
 	windows.o \
-	sound.o
+	sound.o \
+	saveload.o
 
 
 MODULE_DIRS += \

engines/macventure/saveload.cpp

@@ -0,0 +1,89 @@
+/* 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 "macventure/macventure.h"
+
+#include "common/error.h"
+#include "common/savefile.h"
+#include "engines/savestate.h"
+
+namespace MacVenture {
+
+#define MACVENTURE_SAVE_HEADER MKTAG('M', 'V', 'S', 'S') // (M)ac(V)enture (S)cummVM (S)ave (0x4d565353, uint32)
+#define MACVENTURE_SAVE_VERSION 1 //1 BYTE
+#define MACVENTURE_DESC_LENGTH 1 //1 BYTE for the description length
+
+SaveStateDescriptor loadMetaData(Common::SeekableReadStream *s, int slot) {
+	// Metadata is stored at the end of the file
+	// |DESCRIPTION						|
+	// |HEADER			|VERSION|DESCLEN|
+	s->seek(-(5 + MACVENTURE_DESC_LENGTH), SEEK_END);
+	uint32 sig = s->readUint32BE();
+	byte version = s->readByte();
+
+	SaveStateDescriptor desc(-1, "");	// init to an invalid save slot
+
+	if (sig != MACVENTURE_SAVE_HEADER || version > MACVENTURE_SAVE_VERSION)
+		return desc;
+
+	// Save is valid, set its slot number
+	desc.setSaveSlot(slot);
+
+	// Load the description
+	Common::String name;
+	// Depends on MACVENTURE_DESC_LENGTH
+	byte descSize = s->readByte();
+	s->seek(-(5 + MACVENTURE_DESC_LENGTH + descSize), SEEK_END);
+	for (int i = 0; i < descSize; ++i)
+		name += s->readByte();
+	desc.setDescription(name);
+
+	return desc;
+}
+
+void writeMetaData(Common::OutSaveFile *file, Common::String desc) {
+	if (desc.size() >= (1 << (MACVENTURE_DESC_LENGTH * 4))) {
+		desc.erase((1 << (MACVENTURE_DESC_LENGTH * 4)) - 1);
+	}
+	file->writeString(desc);
+	file->writeUint32BE(MACVENTURE_SAVE_HEADER);
+	file->writeByte(MACVENTURE_SAVE_VERSION);
+	file->writeByte(desc.size());
+}
+
+Common::Error MacVentureEngine::loadGameState(int slot) {
+	Common::InSaveFile *file = getSaveFileManager()->openForLoading("shadowgate.001");
+	_world->loadGameFrom(file);
+	reset();
+	return Common::kNoError;
+}
+
+Common::Error MacVentureEngine::saveGameState(int slot, const Common::String &desc) {
+	Common::SaveFileManager *manager = getSaveFileManager();
+	// HACK Get a real name!
+	Common::OutSaveFile *file = manager->openForSaving(desc);
+	_world->saveGameInto(file);
+	writeMetaData(file, desc);
+	delete file;
+}
+
+} // End of namespace MacVenture