Implement all boilerplate concerning Global Main Menu.

All currently defined featues will be supported.  I have implemented 
everything boilerplatish, except for the actual game saving/loading (which
will come in the next commit), getting volumes from the configuration
(because we don't play sounds yet), and changing subtitles.

svn-id: r44583

6 files changed, 343 insertions, 4 deletions

diff --git a/engines/draci/detection.cpp b/engines/draci/detection.cpp
index 3fe37ead53..1d58d25cfa 100644
--- a/engines/draci/detection.cpp
+++ b/engines/draci/detection.cpp
@@ -24,6 +24,7 @@
  */
 
 #include "draci/draci.h"
+#include "draci/saveload.h"
 
 #include "base/plugins.h"
 #include "engines/metaengine.h"
@@ -107,16 +108,86 @@ public:
 	}
 
 	virtual bool hasFeature(MetaEngineFeature f) const;
+	virtual int getMaximumSaveSlot() const { return 99; };
+	virtual SaveStateList listSaves(const char *target) const;
+	virtual void removeSaveState(const char *target, int slot) const;
+	virtual SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
 	virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const;
 };
 
 bool DraciMetaEngine::hasFeature(MetaEngineFeature f) const {
-	return false;
+	return
+		(f == kSupportsListSaves) ||
+		(f == kSupportsDeleteSave) ||
+		(f == kSavesSupportMetaInfo) ||
+		(f == kSavesSupportThumbnail) ||
+		(f == kSavesSupportCreationDate) ||
+		(f == kSavesSupportPlayTime) ||
+		(f == kSupportsLoadingDuringStartup);
 }
 
-bool Draci::DraciEngine::hasFeature(EngineFeature f) const {
-	return (f == kSupportsSubtitleOptions) ||
-		(f == kSupportsRTL);
+SaveStateList DraciMetaEngine::listSaves(const char *target) const {
+	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
+	Common::StringList filenames;
+	Common::String pattern("draci.s??");
+
+	filenames = saveFileMan->listSavefiles(pattern);
+	sort(filenames.begin(), filenames.end());	// Sort (hopefully ensuring we are sorted numerically..)
+
+	SaveStateList saveList;
+	for (Common::StringList::const_iterator file = filenames.begin(); file != filenames.end(); ++file) {
+		// Obtain the last 2 digits of the filename, since they correspond to the save slot
+		int slotNum = atoi(file->c_str() + file->size() - 2);
+
+		if (slotNum >= 0 && slotNum <= 99) {
+			Common::InSaveFile *in = saveFileMan->openForLoading(*file);
+			if (in) {
+				Draci::DraciSavegameHeader header;
+				Draci::readSavegameHeader(in, header);
+				saveList.push_back(SaveStateDescriptor(slotNum, header.saveName));
+				if (header.thumbnail) delete header.thumbnail;
+				delete in;
+			}
+		}
+	}
+
+	return saveList;
+}
+
+void DraciMetaEngine::removeSaveState(const char *target, int slot) const {
+	g_system->getSavefileManager()->removeSavefile(Draci::DraciEngine::getSavegameFile(slot));
+}
+
+SaveStateDescriptor DraciMetaEngine::querySaveMetaInfos(const char *target, int slot) const {
+	Common::InSaveFile *f = g_system->getSavefileManager()->openForLoading(
+		Draci::DraciEngine::getSavegameFile(slot));
+	assert(f);
+
+	Draci::DraciSavegameHeader header;
+	Draci::readSavegameHeader(f, header);
+	delete f;
+
+	// Create the return descriptor
+	SaveStateDescriptor desc(slot, header.saveName);
+	desc.setDeletableFlag(true);
+	desc.setWriteProtectedFlag(false);
+	desc.setThumbnail(header.thumbnail);
+
+	int day = (header.date >> 24) & 0xFF;
+	int month = (header.date >> 16) & 0xFF;
+	int year = header.date & 0xFFFF;
+	desc.setSaveDate(year, month, day);
+
+	int hour = (header.time >> 8) & 0xFF;
+	int minutes = header.time & 0xFF;
+	desc.setSaveTime(hour, minutes);
+
+	minutes = header.playtime / 60;
+	hour = minutes / 60;
+	minutes %= 60;
+	desc.setPlayTime(hour, minutes);
+
+	return desc;
 }
 
 bool DraciMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
diff --git a/engines/draci/draci.cpp b/engines/draci/draci.cpp
index 14deb60603..9ecbfb37bb 100644
--- a/engines/draci/draci.cpp
+++ b/engines/draci/draci.cpp
@@ -81,6 +81,13 @@ DraciEngine::DraciEngine(OSystem *syst, const ADGameDescription *gameDesc)
 	g_eventRec.registerRandomSource(_rnd, "draci");
 }
 
+bool DraciEngine::hasFeature(EngineFeature f) const {
+	return (f == kSupportsSubtitleOptions) ||
+		(f == kSupportsRTL) ||
+		(f == kSupportsLoadingDuringRuntime) ||
+		(f == kSupportsSavingDuringRuntime);
+}
+
 int DraciEngine::init() {
 	// Initialize graphics using following:
 	initGraphics(kScreenWidth, kScreenHeight, false);
@@ -301,7 +308,14 @@ DraciEngine::~DraciEngine() {
 
 Common::Error DraciEngine::run() {
 	init();
+	_engineStartTime = _system->getMillis() / 1000;
 	_game->init();
+
+	// Load game from specified slot, if any
+	if (ConfMan.hasKey("save_slot")) {
+		loadGameState(ConfMan.getInt("save_slot"));
+	}
+
 	_game->start();
 	return Common::kNoError;
 }
@@ -309,9 +323,17 @@ Common::Error DraciEngine::run() {
 void DraciEngine::pauseEngineIntern(bool pause) {
 	Engine::pauseEngineIntern(pause);
 	if (pause) {
+		// Record start of the pause, so that we can later
+		// adjust _engineStartTime accordingly.
+		_pauseStartTime = _system->getMillis();
+
 		_anims->pauseAnimations();
 	} else {
 		_anims->unpauseAnimations();
+
+		// Adjust engine start time
+		_engineStartTime += (_system->getMillis() - _pauseStartTime) / 1000;
+		_pauseStartTime = 0;
 	}
 }
 
@@ -321,4 +343,30 @@ void DraciEngine::syncSoundSettings() {
 	// TODO: update our volumes
 }
 
+const char *DraciEngine::getSavegameFile(int saveGameIdx) {
+	static char buffer[20];
+	sprintf(buffer, "draci.s%02d", saveGameIdx);
+	return buffer;
+}
+
+Common::Error DraciEngine::loadGameState(int slot) {
+	// TODO
+	return Common::kNoError;
+}
+
+bool DraciEngine::canLoadGameStateCurrently() {
+	return (_game->getLoopStatus() == kStatusOrdinary) &&
+		(_game->getLoopSubstatus() == kSubstatusOrdinary);
+}
+
+Common::Error DraciEngine::saveGameState(int slot, const char *desc) {
+	// TODO
+	return Common::kNoError;
+}
+
+bool DraciEngine::canSaveGameStateCurrently() {
+	return (_game->getLoopStatus() == kStatusOrdinary) &&
+		(_game->getLoopSubstatus() == kSubstatusOrdinary);
+}
+
 } // End of namespace Draci
diff --git a/engines/draci/draci.h b/engines/draci/draci.h
index 7876025b9d..fed7cfed7e 100644
--- a/engines/draci/draci.h
+++ b/engines/draci/draci.h
@@ -54,6 +54,12 @@ public:
 
 	void handleEvents();
 
+	static const char *getSavegameFile(int saveGameIdx);
+	virtual Common::Error loadGameState(int slot);
+	virtual bool canLoadGameStateCurrently();
+	virtual Common::Error saveGameState(int slot, const char *desc);
+	virtual bool canSaveGameStateCurrently();
+
 	Screen *_screen;
 	Mouse *_mouse;
 	Game *_game;
@@ -79,6 +85,9 @@ public:
 	bool _showWalkingMap;
 
 	Common::RandomSource _rnd;
+
+	int32 _engineStartTime;
+	int32 _pauseStartTime;
 };
 
 enum {
diff --git a/engines/draci/module.mk b/engines/draci/module.mk
index 3eddfd3079..10abad2b44 100644
--- a/engines/draci/module.mk
+++ b/engines/draci/module.mk
@@ -6,6 +6,7 @@ MODULE_OBJS := \
 	barchive.o \
 	script.o \
 	font.o \
+	saveload.o \
 	sprite.o \
 	screen.o \
 	surface.o \
diff --git a/engines/draci/saveload.cpp b/engines/draci/saveload.cpp
new file mode 100644
index 0000000000..bd2f247dd4
--- /dev/null
+++ b/engines/draci/saveload.cpp
@@ -0,0 +1,155 @@
+/* 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: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk/engines/cruise/saveload.cpp $
+ * $Id: saveload.cpp 42047 2009-07-03 06:19:20Z dreammaster $
+ *
+ */
+
+#include <time.h>	// for extended infos
+
+#include "draci/draci.h"
+#include "draci/saveload.h"
+
+#include "common/serializer.h"
+#include "common/savefile.h"
+#include "common/system.h"
+
+#include "graphics/scaler.h"
+#include "graphics/thumbnail.h"
+
+namespace Draci {
+
+static const char *draciIdentString = "DRACI";
+
+bool readSavegameHeader(Common::InSaveFile *in, DraciSavegameHeader &header) {
+	char saveIdentBuffer[6];
+	header.thumbnail = NULL;
+
+	// Validate the header Id
+	in->read(saveIdentBuffer, 6);
+	if (strcmp(saveIdentBuffer, draciIdentString))
+		return false;
+
+	header.version = in->readByte();
+	if (header.version != DRACI_SAVEGAME_VERSION)
+		return false;
+
+	// Read in the string
+	header.saveName.clear();
+	char ch;
+	while ((ch = (char)in->readByte()) != '\0') header.saveName += ch;
+
+	header.date = in->readUint32LE();
+	header.time = in->readUint16LE();
+	header.playtime = in->readUint32LE();
+
+	// Get the thumbnail
+	header.thumbnail = new Graphics::Surface();
+	if (!Graphics::loadThumbnail(*in, *header.thumbnail)) {
+		delete header.thumbnail;
+		header.thumbnail = NULL;
+		return false;
+	}
+
+	return true;
+}
+
+void writeSavegameHeader(Common::OutSaveFile *out, const DraciSavegameHeader &header, const Graphics::Surface &thumb) {
+	// Write out a savegame header
+	out->write(draciIdentString, 6);
+	out->writeByte(DRACI_SAVEGAME_VERSION);
+
+	// Write savegame name
+	out->write(header.saveName.c_str(), header.saveName.size() + 1);
+
+	out->writeUint32BE(header.date);
+	out->writeUint16BE(header.time);
+	out->writeUint32BE(header.playtime);
+
+	// Create a thumbnail and save it
+	Graphics::saveThumbnail(*out, thumb);
+}
+
+static void DoSync(Common::Serializer &s) {
+}
+
+
+Common::Error saveSavegameData(int saveGameIdx, const Common::String &saveName, const DraciEngine &vm) {
+	const char *filename = vm.getSavegameFile(saveGameIdx);
+	Common::SaveFileManager *saveMan = g_system->getSavefileManager();
+	Common::OutSaveFile *f = saveMan->openForSaving(filename);
+	if (f == NULL)
+		return Common::kNoGameDataFoundError;
+
+	tm curTime;
+	vm._system->getTimeAndDate(curTime);
+
+	// Save the savegame header
+	DraciSavegameHeader header;
+	header.saveName = saveName;
+	header.date = ((curTime.tm_mday & 0xFF) << 24) | (((curTime.tm_mon + 1) & 0xFF) << 16) | ((curTime.tm_year + 1900) & 0xFFFF);
+	header.time = ((curTime.tm_hour & 0xFF) << 8) | ((curTime.tm_min) & 0xFF);
+	header.playtime = vm._system->getMillis() / 1000 - vm._engineStartTime;
+	writeSavegameHeader(f, header, *vm._screen->getSurface());
+
+	if (f->err()) {
+		delete f;
+		saveMan->removeSavefile(filename);
+		return Common::kWritingFailed;
+	} else {
+		// Create the remainder of the savegame
+		Common::Serializer s(NULL, f);
+		DoSync(s);
+
+		f->finalize();
+		delete f;
+		return Common::kNoError;
+	}
+}
+
+Common::Error loadSavegameData(int saveGameIdx, DraciEngine *vm) {
+	Common::String saveName;
+
+	Common::SaveFileManager *saveMan = g_system->getSavefileManager();
+	Common::InSaveFile *f = saveMan->openForLoading(vm->getSavegameFile(saveGameIdx));
+
+	if (f == NULL) {
+		return Common::kNoGameDataFoundError;
+	}
+
+	// Skip over the savegame header
+	DraciSavegameHeader header;
+	readSavegameHeader(f, header);
+	if (header.thumbnail) delete header.thumbnail;
+
+	// Synchronise the remaining data of the savegame
+	Common::Serializer s(f, NULL);
+	DoSync(s);
+
+	delete f;
+
+	// Post processing
+	vm->_engineStartTime = vm->_system->getMillis() / 1000 - header.playtime;
+
+	return Common::kNoError;
+}
+
+} // End of namespace Draci
diff --git a/engines/draci/saveload.h b/engines/draci/saveload.h
new file mode 100644
index 0000000000..b6a6c2930e
--- /dev/null
+++ b/engines/draci/saveload.h
@@ -0,0 +1,55 @@
+/* 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: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk/engines/cruise/saveload.h $
+ * $Id: saveload.h 39981 2009-04-18 12:03:21Z dreammaster $
+ *
+ */
+
+#ifndef DRACI_SAVELOAD_H
+#define DRACI_SAVELOAD_H
+
+#include "common/savefile.h"
+#include "common/scummsys.h"
+#include "graphics/surface.h"
+
+namespace Draci {
+
+#define DRACI_SAVEGAME_VERSION 1
+
+struct DraciSavegameHeader {
+	uint8 version;
+	Common::String saveName;
+	uint32 date;
+	uint16 time;
+	uint32 playtime;
+	Graphics::Surface *thumbnail;
+};
+
+class DraciEngine;
+
+bool readSavegameHeader(Common::InSaveFile *in, DraciSavegameHeader &header);
+void writeSavegameHeader(Common::OutSaveFile *out, const DraciSavegameHeader &header, const Graphics::Surface &thumb);
+Common::Error saveSavegameData(int saveGameIdx, const Common::String &saveName, const DraciEngine &vm);
+Common::Error loadSavegameData(int saveGameIdx, DraciEngine *vm);
+
+} // End of namespace Draci
+
+#endif