SUPERNOVA2: Create engine skeleton for supernova 2

5 files changed, 397 insertions, 0 deletions

diff --git a/engines/supernova2/configure.engine b/engines/supernova2/configure.engine
new file mode 100644
index 0000000000..c935a04fd3
--- /dev/null
+++ b/engines/supernova2/configure.engine
@@ -0,0 +1,3 @@
+# This file is included from the main "configure" script
+# add_engine [name] [desc] [build-by-default] [subengines] [base games] [deps]
+add_engine supernova2 "Mission Supernova 2" no
diff --git a/engines/supernova2/detection.cpp b/engines/supernova2/detection.cpp
new file mode 100644
index 0000000000..396ac6848c
--- /dev/null
+++ b/engines/supernova2/detection.cpp
@@ -0,0 +1,212 @@
+/* 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 "base/plugins.h"
+#include "common/file.h"
+#include "common/savefile.h"
+#include "common/system.h"
+#include "graphics/thumbnail.h"
+#include "engines/advancedDetector.h"
+
+#include "supernova2/supernova2.h"
+
+static const PlainGameDescriptor supernova2Game[] = {
+	{"msn2", "Mission Supernova 2"},
+	{nullptr, nullptr}
+};
+
+namespace Supernova2 {
+static const ADGameDescription gameDescriptions[] = {
+	// Mission Supernova 2
+	{
+		"msn2",
+		nullptr,
+		AD_ENTRY1s("ms2_data.000", "e595610cba4a6d24a763e428d05cc83f", 24805),
+		Common::DE_DEU,
+		Common::kPlatformDOS,
+		ADGF_UNSTABLE,
+		GUIO1(GUIO_NONE)
+	},
+	{
+		"msn2",
+		nullptr,
+		AD_ENTRY1s("ms2_data.000", "e595610cba4a6d24a763e428d05cc83f", 24805),
+		Common::EN_ANY,
+		Common::kPlatformDOS,
+		ADGF_UNSTABLE,
+		GUIO1(GUIO_NONE)
+	},
+
+	AD_TABLE_END_MARKER
+};
+}
+
+class Supernova2MetaEngine: public AdvancedMetaEngine {
+public:
+	Supernova2MetaEngine() : AdvancedMetaEngine(Supernova2::gameDescriptions, sizeof(ADGameDescription), supernova2Game) {
+//		_singleId = "supernova";
+	}
+
+	virtual const char *getName() const {
+		return "Mission Supernova 2";
+	}
+
+	virtual const char *getOriginalCopyright() const {
+		return "Mission Supernova 2(c) 1994 Thomas and Steffen Dingel";
+	}
+
+	virtual bool hasFeature(MetaEngineFeature f) const;
+	virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const;
+	virtual SaveStateList listSaves(const char *target) const;
+	virtual void removeSaveState(const char *target, int slot) const;
+	virtual int getMaximumSaveSlot() const {
+		return 99;
+	}
+	virtual SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
+};
+
+bool Supernova2MetaEngine::hasFeature(MetaEngineFeature f) const {
+	switch (f) {
+	case kSupportsLoadingDuringStartup:
+		// fallthrough
+	case kSupportsListSaves:
+		// fallthrough
+	case kSupportsDeleteSave:
+		// fallthrough
+	case kSavesSupportMetaInfo:
+		// fallthrough
+	case kSavesSupportThumbnail:
+		// fallthrough
+	case kSavesSupportCreationDate:
+		// fallthrough
+	case kSavesSupportPlayTime:
+		return true;
+	default:
+		return false;
+	}
+}
+
+bool Supernova2MetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
+	if (desc) {
+		*engine = new Supernova2::Supernova2Engine(syst);
+	}
+
+	return desc != nullptr;
+}
+
+SaveStateList Supernova2MetaEngine::listSaves(const char *target) const {
+	Common::StringArray filenames;
+	Common::String pattern("msn_save.###");
+
+	filenames = g_system->getSavefileManager()->listSavefiles(pattern);
+
+	SaveStateList saveFileList;
+	for (Common::StringArray::const_iterator file = filenames.begin();
+		 file != filenames.end(); ++file) {
+		int saveSlot = atoi(file->c_str() + file->size() - 3);
+		if (saveSlot >= 0 && saveSlot <= getMaximumSaveSlot()) {
+			Common::InSaveFile *savefile = g_system->getSavefileManager()->openForLoading(*file);
+			if (savefile) {
+				uint saveHeader = savefile->readUint32LE();
+				if (saveHeader == SAVEGAME_HEADER) {
+					byte saveVersion = savefile->readByte();
+					if (saveVersion <= SAVEGAME_VERSION) {
+						int saveFileDescSize = savefile->readSint16LE();
+						char* saveFileDesc = new char[saveFileDescSize];
+						savefile->read(saveFileDesc, saveFileDescSize);
+						saveFileList.push_back(SaveStateDescriptor(saveSlot, saveFileDesc));
+						delete [] saveFileDesc;
+					}
+				}
+				delete savefile;
+			}
+		}
+	}
+
+	Common::sort(saveFileList.begin(), saveFileList.end(), SaveStateDescriptorSlotComparator());
+	return saveFileList;
+}
+
+void Supernova2MetaEngine::removeSaveState(const char *target, int slot) const {
+	Common::String filename = Common::String::format("ms2_save.%03d", slot);
+	g_system->getSavefileManager()->removeSavefile(filename);
+}
+
+SaveStateDescriptor Supernova2MetaEngine::querySaveMetaInfos(const char *target, int slot) const {
+	Common::String fileName = Common::String::format("ms2_save.%03d", slot);
+	Common::InSaveFile *savefile = g_system->getSavefileManager()->openForLoading(fileName);
+
+	if (savefile) {
+		uint saveHeader = savefile->readUint32LE();
+		if (saveHeader != SAVEGAME_HEADER) {
+			delete savefile;
+			return SaveStateDescriptor();
+		}
+		byte saveVersion = savefile->readByte();
+		if (saveVersion > SAVEGAME_VERSION){
+			delete savefile;
+			return SaveStateDescriptor();
+		}
+
+		int descriptionSize = savefile->readSint16LE();
+		char* description = new char[descriptionSize];
+		savefile->read(description, descriptionSize);
+		SaveStateDescriptor desc(slot, description);
+		delete [] description;
+
+		uint32 saveDate = savefile->readUint32LE();
+		int day = (saveDate >> 24) & 0xFF;
+		int month = (saveDate >> 16) & 0xFF;
+		int year = saveDate & 0xFFFF;
+		desc.setSaveDate(year, month, day);
+
+		uint16 saveTime = savefile->readUint16LE();
+		int hour = (saveTime >> 8) & 0xFF;
+		int minutes = saveTime & 0xFF;
+		desc.setSaveTime(hour, minutes);
+
+		uint32 playTime =savefile->readUint32LE();
+		desc.setPlayTime(playTime * 1000);
+
+		if (Graphics::checkThumbnailHeader(*savefile)) {
+			Graphics::Surface *thumbnail;
+			if (!Graphics::loadThumbnail(*savefile, thumbnail)) {
+				delete savefile;
+				return SaveStateDescriptor();
+			}
+			desc.setThumbnail(thumbnail);
+		}
+
+		delete savefile;
+
+		return desc;
+	}
+
+	return SaveStateDescriptor();
+}
+
+
+#if PLUGIN_ENABLED_DYNAMIC(SUPERNOVA2)
+REGISTER_PLUGIN_DYNAMIC(SUPERNOVA2, PLUGIN_TYPE_ENGINE, Supernova2MetaEngine);
+#else
+REGISTER_PLUGIN_STATIC(SUPERNOVA2, PLUGIN_TYPE_ENGINE, Supernova2MetaEngine);
+#endif
diff --git a/engines/supernova2/module.mk b/engines/supernova2/module.mk
new file mode 100644
index 0000000000..c6ebe15d04
--- /dev/null
+++ b/engines/supernova2/module.mk
@@ -0,0 +1,16 @@
+MODULE := engines/supernova2
+
+MODULE_OBJS := \
+	detection.o \
+	supernova2.o
+
+MODULE_DIRS += \
+	engines/supernova2
+
+# This module can be built as a plugin
+ifeq ($(ENABLE_SUPERNOVA2), DYNAMIC_PLUGIN)
+PLUGIN := 1
+endif
+
+# Include common rules
+include $(srcdir)/rules.mk
diff --git a/engines/supernova2/supernova2.cpp b/engines/supernova2/supernova2.cpp
new file mode 100644
index 0000000000..da14dc46a0
--- /dev/null
+++ b/engines/supernova2/supernova2.cpp
@@ -0,0 +1,85 @@
+/* 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 "common/config-manager.h"
+#include "common/debug.h"
+#include "common/debug-channels.h"
+#include "common/endian.h"
+#include "common/error.h"
+#include "common/events.h"
+#include "common/file.h"
+#include "common/fs.h"
+#include "common/memstream.h"
+#include "common/savefile.h"
+#include "common/str.h"
+#include "common/system.h"
+#include "common/translation.h"
+#include "engines/util.h"
+#include "graphics/cursorman.h"
+#include "graphics/surface.h"
+#include "graphics/screen.h"
+#include "graphics/palette.h"
+#include "graphics/thumbnail.h"
+#include "gui/saveload.h"
+
+#include "supernova2/supernova2.h"
+
+
+namespace Supernova2 {
+
+Supernova2Engine::Supernova2Engine(OSystem *syst)
+	: Engine(syst)
+	, _allowLoadGame(true)
+	, _allowSaveGame(true)
+	, _sleepAutoSave(nullptr)
+	, _sleepAuoSaveVersion(-1)
+	, _delay(33)
+	, _textSpeed(1) {
+	if (ConfMan.hasKey("textspeed"))
+		_textSpeed = ConfMan.getInt("textspeed");
+
+	DebugMan.addDebugChannel(1 , "general", "Supernova 2 general debug channel");
+}
+
+Supernova2Engine::~Supernova2Engine() {
+	DebugMan.clearAllDebugChannels();
+
+	delete _sleepAutoSave;
+}
+
+Common::Error Supernova2Engine::run() {
+	init();
+
+	while (!shouldQuit()) {
+		uint32 start = _system->getMillis();
+		int end = _delay - (_system->getMillis() - start);
+		if (end > 0)
+			_system->delayMillis(end);
+	}
+
+	return Common::kNoError;
+}
+
+void Supernova2Engine::init() {
+}
+
+}
diff --git a/engines/supernova2/supernova2.h b/engines/supernova2/supernova2.h
new file mode 100644
index 0000000000..2301f6326e
--- /dev/null
+++ b/engines/supernova2/supernova2.h
@@ -0,0 +1,81 @@
+/* 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 SUPERNOVA_SUPERNOVA2_H
+#define SUPERNOVA_SUPERNOVA2_H
+
+#include "common/array.h"
+#include "common/events.h"
+#include "common/random.h"
+#include "common/scummsys.h"
+#include "engines/engine.h"
+#include "common/file.h"
+
+namespace Common {
+	class MemoryReadWriteStream;
+}
+
+namespace Supernova2 {
+
+#define SAVEGAME_HEADER MKTAG('M','S','N','2')
+#define SAVEGAME_VERSION 9
+
+#define SUPERNOVA2_DAT "supernova2.dat"
+#define SUPERNOVA2_DAT_VERSION 1
+
+class GuiElement;
+
+class Supernova2Engine : public Engine {
+public:
+	explicit Supernova2Engine(OSystem *syst);
+	~Supernova2Engine();
+
+	virtual Common::Error run();
+
+	bool _allowLoadGame;
+	bool _allowSaveGame;
+	Common::StringArray _gameStrings;
+	Common::String _nullString;
+	int _sleepAuoSaveVersion;
+	Common::MemoryReadWriteStream* _sleepAutoSave;
+
+	uint _delay;
+	int  _textSpeed;
+
+	Common::Error loadGameStrings();
+	void init();
+	bool loadGame(int slot);
+	bool saveGame(int slot, const Common::String &description);
+	bool serialize(Common::WriteStream *out);
+	bool deserialize(Common::ReadStream *in, int version);
+	bool quitGameDialog();
+	void errorTempSave(bool saving);
+	void setTextSpeed();
+	const Common::String &getGameString(int idx) const;
+	void setGameString(int idx, const Common::String &string);
+
+	// forwarding calls
+};
+
+}
+
+#endif