TITANIC: Initial engine skeleton

6 files changed, 330 insertions, 0 deletions

diff --git a/engines/titanic/configure.engine b/engines/titanic/configure.engine
new file mode 100644
index 0000000000..781b783cf5
--- /dev/null
+++ b/engines/titanic/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 titanic "Starship Titanic" no
diff --git a/engines/titanic/detection.cpp b/engines/titanic/detection.cpp
new file mode 100644
index 0000000000..70fe25d532
--- /dev/null
+++ b/engines/titanic/detection.cpp
@@ -0,0 +1,129 @@
+/* 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 "titanic/titanic.h"
+
+#include "base/plugins.h"
+#include "common/savefile.h"
+#include "common/str-array.h"
+#include "common/memstream.h"
+#include "engines/advancedDetector.h"
+#include "common/system.h"
+#include "graphics/colormasks.h"
+#include "graphics/surface.h"
+
+#define MAX_SAVES 99
+
+namespace Titanic {
+
+struct TitanicGameDescription {
+	ADGameDescription desc;
+};
+
+uint32 TitanicEngine::getFeatures() const {
+	return _gameDescription->desc.flags;
+}
+
+bool TitanicEngine::isDemo() const {
+	return (bool)(_gameDescription->desc.flags & ADGF_DEMO);
+}
+
+Common::Language TitanicEngine::getLanguage() const {
+	return _gameDescription->desc.language;
+}
+
+} // End of namespace Titanic
+
+static const PlainGameDescriptor TitanicGames[] = {
+	{"titanic", "Starship Titanic"},
+	{0, 0}
+};
+
+#include "titanic/detection_tables.h"
+
+class TitanicMetaEngine : public AdvancedMetaEngine {
+public:
+	TitanicMetaEngine() : AdvancedMetaEngine(Titanic::gameDescriptions, sizeof(Titanic::TitanicGameDescription), TitanicGames) {
+		_maxScanDepth = 3;
+	}
+
+	virtual const char *getName() const {
+		return "Titanic Engine";
+	}
+
+	virtual const char *getOriginalCopyright() const {
+		return "Titanic Engine (c)";
+	}
+
+	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 int getMaximumSaveSlot() const;
+	virtual void removeSaveState(const char *target, int slot) const;
+	SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
+};
+
+bool TitanicMetaEngine::hasFeature(MetaEngineFeature f) const {
+	return
+	    (f == kSupportsListSaves) ||
+		(f == kSupportsLoadingDuringStartup) ||
+		(f == kSupportsDeleteSave) ||
+		(f == kSavesSupportMetaInfo) ||
+		(f == kSavesSupportThumbnail);
+}
+
+bool Titanic::TitanicEngine::hasFeature(EngineFeature f) const {
+	return
+		(f == kSupportsRTL) ||
+		(f == kSupportsLoadingDuringRuntime) ||
+		(f == kSupportsSavingDuringRuntime);
+}
+
+bool TitanicMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
+	const Titanic::TitanicGameDescription *gd = (const Titanic::TitanicGameDescription *)desc;
+	*engine = new Titanic::TitanicEngine(syst, gd);
+
+	return gd != 0;
+}
+
+SaveStateList TitanicMetaEngine::listSaves(const char *target) const {
+	SaveStateList saveList;
+	return saveList;
+}
+
+int TitanicMetaEngine::getMaximumSaveSlot() const {
+	return MAX_SAVES;
+}
+
+void TitanicMetaEngine::removeSaveState(const char *target, int slot) const {
+}
+
+SaveStateDescriptor TitanicMetaEngine::querySaveMetaInfos(const char *target, int slot) const {
+	return SaveStateDescriptor();
+}
+
+
+#if PLUGIN_ENABLED_DYNAMIC(TITANIC)
+	REGISTER_PLUGIN_DYNAMIC(TITANIC, PLUGIN_TYPE_ENGINE, TitanicMetaEngine);
+#else
+	REGISTER_PLUGIN_STATIC(TITANIC, PLUGIN_TYPE_ENGINE, TitanicMetaEngine);
+#endif
diff --git a/engines/titanic/detection_tables.h b/engines/titanic/detection_tables.h
new file mode 100644
index 0000000000..dab7bd5462
--- /dev/null
+++ b/engines/titanic/detection_tables.h
@@ -0,0 +1,41 @@
+/* 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.
+ *
+ */
+
+namespace Titanic {
+	
+static const TitanicGameDescription gameDescriptions[] = {
+	{
+		{
+			"titanic",
+			0,
+			AD_ENTRY1s("a.st", "b283436d90974fdc81accc95dbd8e61c", 15405985),
+			Common::EN_ANY,
+			Common::kPlatformWindows,
+			ADGF_NO_FLAGS,
+			GUIO1(GUIO_NONE)
+		},
+	},
+
+	{ AD_TABLE_END_MARKER }
+};
+
+} // End of namespace Titanic
diff --git a/engines/titanic/module.mk b/engines/titanic/module.mk
new file mode 100644
index 0000000000..bb359414ab
--- /dev/null
+++ b/engines/titanic/module.mk
@@ -0,0 +1,13 @@
+MODULE := engines/titanic
+
+MODULE_OBJS := \
+	detection.o \
+	titanic.o
+
+# This module can be built as a plugin
+ifeq ($(ENABLE_TITANIC), DYNAMIC_PLUGIN)
+PLUGIN := 1
+endif
+
+# Include common rules
+include $(srcdir)/rules.mk
diff --git a/engines/titanic/titanic.cpp b/engines/titanic/titanic.cpp
new file mode 100644
index 0000000000..88e9fbca5b
--- /dev/null
+++ b/engines/titanic/titanic.cpp
@@ -0,0 +1,58 @@
+/* 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/scummsys.h"
+#include "common/config-manager.h"
+#include "common/debug-channels.h"
+#include "common/events.h"
+#include "engines/util.h"
+#include "graphics/scaler.h"
+#include "graphics/thumbnail.h"
+#include "titanic/titanic.h"
+
+namespace Titanic {
+
+TitanicEngine::TitanicEngine(OSystem *syst, const TitanicGameDescription *gameDesc)
+	: _gameDescription(gameDesc), Engine(syst) {
+}
+
+TitanicEngine::~TitanicEngine() {
+}
+
+void TitanicEngine::initialize() {
+	// Set up debug channels
+	DebugMan.addDebugChannel(kDebugCore, "core", "Core engine debug level");
+	DebugMan.addDebugChannel(kDebugScripts, "scripts", "Game scripts");
+	DebugMan.addDebugChannel(kDebugGraphics, "graphics", "Graphics handling");
+	DebugMan.addDebugChannel(kDebugSound, "sound", "Sound and Music handling");
+
+	initGraphics(320, 200, false);
+
+}
+
+Common::Error TitanicEngine::run() {
+	initialize();
+
+	return Common::kNoError;
+}
+
+} // End of namespace Titanic
diff --git a/engines/titanic/titanic.h b/engines/titanic/titanic.h
new file mode 100644
index 0000000000..a49bb2d70c
--- /dev/null
+++ b/engines/titanic/titanic.h
@@ -0,0 +1,86 @@
+/* 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 TITANIC_TITANIC_H
+#define TITANIC_TITANIC_H
+
+#include "common/scummsys.h"
+#include "common/system.h"
+#include "common/serializer.h"
+#include "engines/advancedDetector.h"
+#include "engines/engine.h"
+
+/**
+ * This is the namespace of the Titanic engine.
+ *
+ * Status of this engine: In Development
+ *
+ * Games using this engine:
+ * - Starship Titanic
+ */
+namespace Titanic {
+
+enum TitanicDebugChannels {
+	kDebugCore      = 1 << 0,
+	kDebugScripts	= 1 << 1,
+	kDebugGraphics	= 1 << 2,
+	kDebugSound     = 1 << 3
+};
+
+#define TITANIC_SAVEGAME_VERSION 1
+
+struct TitanicGameDescription;
+
+struct TitanicSavegameHeader {
+	uint8 _version;
+	Common::String _saveName;
+	Graphics::Surface *_thumbnail;
+	int _year, _month, _day;
+	int _hour, _minute;
+	int _totalFrames;
+};
+
+class TitanicEngine : public Engine {
+private:
+	/**
+	 * Handles basic initialization
+	 */
+	void initialize();
+protected:
+	const TitanicGameDescription *_gameDescription;
+	int _loadSaveSlot;
+
+	// Engine APIs
+	virtual Common::Error run();
+	virtual bool hasFeature(EngineFeature f) const;
+public:
+	TitanicEngine(OSystem *syst, const TitanicGameDescription *gameDesc);
+	virtual ~TitanicEngine();
+
+	uint32 getFeatures() const;
+	bool isDemo() const;
+	Common::Language getLanguage() const;
+};
+
+} // End of namespace Titanic
+
+#endif /* TITANIC_TITANIC_H */