GLK: TADS: Skeleton engine

7 files changed, 312 insertions, 1 deletions

diff --git a/engines/glk/detection.cpp b/engines/glk/detection.cpp
index 4e9dee32e3..d5b0ce8286 100644
--- a/engines/glk/detection.cpp
+++ b/engines/glk/detection.cpp
@@ -25,6 +25,8 @@
 #include "glk/frotz/frotz.h"
 #include "glk/scott/detection.h"
 #include "glk/scott/scott.h"
+#include "glk/tads/detection.h"
+#include "glk/tads/tads.h"
 
 #include "base/plugins.h"
 #include "common/md5.h"
@@ -133,6 +135,8 @@ Common::Error GlkMetaEngine::createInstance(OSystem *syst, Engine **engine) cons
 		*engine = new Glk::Frotz::Frotz(syst, gameDesc);
 	} else if (Glk::Scott::ScottMetaEngine::findGame(gameDesc._gameId.c_str()).description) {
 		*engine = new Glk::Scott::Scott(syst, gameDesc);
+	} else if (Glk::TADS::TADSMetaEngine::findGame(gameDesc._gameId.c_str()).description) {
+		*engine = new Glk::TADS::TADS(syst, gameDesc);
 	} else {
 		return Common::kNoGameDataFoundError;
 	}
@@ -166,6 +170,7 @@ PlainGameList GlkMetaEngine::getSupportedGames() const {
 	PlainGameList list;
 	Glk::Frotz::FrotzMetaEngine::getSupportedGames(list);
 	Glk::Scott::ScottMetaEngine::getSupportedGames(list);
+	Glk::TADS::TADSMetaEngine::getSupportedGames(list);
 
 	return list;
 }
@@ -179,6 +184,9 @@ PlainGameDescriptor GlkMetaEngine::findGame(const char *gameId) const {
 	gd = Glk::Scott::ScottMetaEngine::findGame(gameId);
 	if (gd.description) return gd;
 
+	gd = Glk::TADS::TADSMetaEngine::findGame(gameId);
+	if (gd.description) return gd;
+
 	return PlainGameDescriptor();
 }
 
@@ -186,6 +194,7 @@ DetectedGames GlkMetaEngine::detectGames(const Common::FSList &fslist) const {
 	DetectedGames detectedGames;
 	Glk::Frotz::FrotzMetaEngine::detectGames(fslist, detectedGames);
 	Glk::Scott::ScottMetaEngine::detectGames(fslist, detectedGames);
+	Glk::TADS::TADSMetaEngine::detectGames(fslist, detectedGames);
 
 	return detectedGames;
 }
diff --git a/engines/glk/module.mk b/engines/glk/module.mk
index 4112a9f020..b75772dc4f 100644
--- a/engines/glk/module.mk
+++ b/engines/glk/module.mk
@@ -42,7 +42,9 @@ MODULE_OBJS := \
 	frotz/quetzal.o \
 	frotz/screen.o \
 	scott/detection.o \
-	scott/scott.o
+	scott/scott.o \
+	tads/detection.o \
+	tads/tads.o
 
 # This module can be built as a plugin
 ifeq ($(ENABLE_GLK), DYNAMIC_PLUGIN)
diff --git a/engines/glk/tads/detection.cpp b/engines/glk/tads/detection.cpp
new file mode 100644
index 0000000000..ef2caa2edc
--- /dev/null
+++ b/engines/glk/tads/detection.cpp
@@ -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.
+ *
+ */
+
+#include "glk/tads/detection.h"
+#include "glk/tads/detection_tables.h"
+#include "common/file.h"
+#include "common/md5.h"
+#include "engines/game.h"
+
+namespace Glk {
+namespace TADS {
+
+void TADSMetaEngine::getSupportedGames(PlainGameList &games) {
+	for (const PlainGameDescriptor *pd = TADS_GAME_LIST; pd->gameId; ++pd)
+		games.push_back(*pd);
+}
+
+PlainGameDescriptor TADSMetaEngine::findGame(const char *gameId) {
+	for (const PlainGameDescriptor *pd = TADS_GAME_LIST; pd->gameId; ++pd) {
+		if (!strcmp(gameId, pd->gameId))
+			return *pd;
+	}
+
+	return PlainGameDescriptor();;
+}
+
+bool TADSMetaEngine::detectGames(const Common::FSList &fslist, DetectedGames &gameList) {
+	Common::File gameFile;
+	Common::String md5;
+
+	// Loop through the files of the folder
+	for (Common::FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
+		if (file->isDirectory() || !(file->getName().hasSuffixIgnoreCase(".saga")
+				|| file->getName().hasSuffixIgnoreCase(".dat")))
+			continue;
+
+		if (gameFile.open(*file)) {
+			md5 = Common::computeStreamMD5AsString(gameFile, 5000);
+
+			// Scan through the TADS game list for a match
+			const TADSGame *p = TADS_GAMES;
+			while (p->_md5 && p->_filesize != gameFile.size() && md5 != p->_md5)
+				++p;
+
+			if (p->_filesize) {
+				// Found a match
+				PlainGameDescriptor gameDesc = findGame(p->_gameId);
+				DetectedGame gd(p->_gameId, gameDesc.description, Common::EN_ANY, Common::kPlatformUnknown);
+				gd.addExtraEntry("filename", file->getName());
+
+				gameList.push_back(gd);
+			}
+
+			gameFile.close();
+		}
+	}
+
+	return !gameList.empty();
+}
+
+} // End of namespace TADS
+} // End of namespace Glk
diff --git a/engines/glk/tads/detection.h b/engines/glk/tads/detection.h
new file mode 100644
index 0000000000..59a6bc72a3
--- /dev/null
+++ b/engines/glk/tads/detection.h
@@ -0,0 +1,56 @@
+/* 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 GLK_TADS_DETECTION
+#define GLK_TADS_DETECTION
+
+#include "common/fs.h"
+#include "engines/game.h"
+
+namespace Glk {
+namespace TADS {
+
+/**
+ * Meta engine for TADS interpreter
+ */
+class TADSMetaEngine {
+public:
+	/**
+	 * Get a list of supported games
+	 */
+	static void getSupportedGames(PlainGameList &games);
+
+	/**
+	 * Returns a game description for the given game Id, if it's supported
+	 */
+	static PlainGameDescriptor findGame(const char *gameId);
+
+	/**
+	 * Detect supported games
+	 */
+	static bool detectGames(const Common::FSList &fslist, DetectedGames &gameList);
+};
+
+} // End of namespace TADS
+} // End of namespace Glk
+
+#endif
diff --git a/engines/glk/tads/detection_tables.h b/engines/glk/tads/detection_tables.h
new file mode 100644
index 0000000000..eb9441f736
--- /dev/null
+++ b/engines/glk/tads/detection_tables.h
@@ -0,0 +1,49 @@
+/* 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 "engines/game.h"
+#include "common/gui_options.h"
+#include "common/language.h"
+
+namespace Glk {
+namespace TADS {
+
+/**
+ * Game descriptor
+ */
+struct TADSGame {
+	const char *_md5;
+	const char *_gameId;
+	int32 _filesize;
+};
+
+const PlainGameDescriptor TADS_GAME_LIST[] = {
+	{ "tads",     "TADS" },
+	{ nullptr, nullptr }
+};
+
+const TADSGame TADS_GAMES[] = {
+	{ nullptr, nullptr, 0 }
+};
+
+} // End of namespace Frotz
+} // End of namespace Glk
diff --git a/engines/glk/tads/tads.cpp b/engines/glk/tads/tads.cpp
new file mode 100644
index 0000000000..8a40dbd7d0
--- /dev/null
+++ b/engines/glk/tads/tads.cpp
@@ -0,0 +1,48 @@
+/* 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 "glk/tads/tads.h"
+#include "common/config-manager.h"
+#include "common/translation.h"
+
+namespace Glk {
+namespace TADS {
+
+TADS::TADS(OSystem *syst, const GlkGameDescription &gameDesc) : GlkAPI(syst, gameDesc) {
+}
+
+void TADS::runGame(Common::SeekableReadStream *gameFile) {
+	// TODO
+}
+
+Common::Error TADS::loadGameData(strid_t file) {
+	// TODO
+	return Common::kNoError;
+}
+
+Common::Error TADS::saveGameData(strid_t file, const Common::String &desc) {
+	// TODO
+	return Common::kNoError;
+}
+
+} // End of namespace TADS
+} // End of namespace Glk
diff --git a/engines/glk/tads/tads.h b/engines/glk/tads/tads.h
new file mode 100644
index 0000000000..23caef7c23
--- /dev/null
+++ b/engines/glk/tads/tads.h
@@ -0,0 +1,66 @@
+/* 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 GLK_TADS
+#define GLK_TADS
+
+#include "common/scummsys.h"
+#include "glk/glk_api.h"
+
+namespace Glk {
+namespace TADS {
+
+/**
+ * tads game interpreter
+ */
+class TADS : public GlkAPI {
+public:
+	/**
+	 * Constructor
+	 */
+	TADS(OSystem *syst, const GlkGameDescription &gameDesc);
+
+	/**
+	 * Returns the running interpreter type
+	 */
+	virtual InterpreterType getInterpreterType() const override { return INTERPRETER_SCOTT; }
+
+	/**
+	 * Execute the game
+	 */
+	virtual void runGame(Common::SeekableReadStream *gameFile) override;
+
+	/**
+	 * Load a savegame from the passed stream
+	 */
+	virtual Common::Error loadGameData(strid_t file) override;
+
+	/**
+	 * Save the game to the passed stream
+	 */
+	virtual Common::Error saveGameData(strid_t file, const Common::String &desc) override;
+};
+
+} // End of namespace TADS
+} // End of namespace Glk
+
+#endif