GLK: AGT: Skeleton engine

9 files changed, 339 insertions, 1 deletions

diff --git a/engines/glk/agt/agt.cpp b/engines/glk/agt/agt.cpp
new file mode 100644
index 0000000000..29e7222a4e
--- /dev/null
+++ b/engines/glk/agt/agt.cpp
@@ -0,0 +1,47 @@
+/* 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/agt/agt.h"
+#include "glk/quetzal.h"
+#include "common/config-manager.h"
+#include "common/translation.h"
+
+namespace Glk {
+namespace AGT {
+
+AGT::AGT(OSystem *syst, const GlkGameDescription &gameDesc) : GlkAPI(syst, gameDesc) {
+}
+
+void AGT::runGame() {
+	// TODO
+}
+
+Common::Error AGT::readSaveData(Common::SeekableReadStream *rs) {
+	return Common::kReadingFailed;
+}
+
+Common::Error AGT::writeGameData(Common::WriteStream *ws) {
+	return Common::kWritingFailed;
+}
+
+} // End of namespace AGT
+} // End of namespace Glk
diff --git a/engines/glk/agt/agt.h b/engines/glk/agt/agt.h
new file mode 100644
index 0000000000..70bb98ae87
--- /dev/null
+++ b/engines/glk/agt/agt.h
@@ -0,0 +1,70 @@
+/* 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.
+ *
+ */
+
+/* Based on Agility interpreter version 1.1.1 */
+
+#ifndef GLK_AGT
+#define GLK_AGT
+
+#include "common/scummsys.h"
+#include "glk/glk_api.h"
+
+namespace Glk {
+namespace AGT {
+
+
+/**
+ * AGT Adams game interpreter
+ */
+class AGT : public GlkAPI {
+public:
+	/**
+	 * Constructor
+	 */
+	AGT(OSystem *syst, const GlkGameDescription &gameDesc);
+
+	/**
+	 * Returns the running interpreter type
+	 */
+	virtual InterpreterType getInterpreterType() const override { return INTERPRETER_AGT; }
+
+	/**
+	 * Execute the game
+	 */
+	virtual void runGame() override;
+
+	/**
+	 * Load a savegame from the passed Quetzal file chunk stream
+	 */
+	virtual Common::Error readSaveData(Common::SeekableReadStream *rs) override;
+
+	/**
+	 * Save the game. The passed write stream represents access to the UMem chunk
+	 * in the Quetzal save file that will be created
+	 */
+	virtual Common::Error writeGameData(Common::WriteStream *ws) override;
+};
+
+} // End of namespace AGT
+} // End of namespace Glk
+
+#endif
diff --git a/engines/glk/agt/detection.cpp b/engines/glk/agt/detection.cpp
new file mode 100644
index 0000000000..ec093b798b
--- /dev/null
+++ b/engines/glk/agt/detection.cpp
@@ -0,0 +1,93 @@
+/* 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/agt/detection.h"
+#include "glk/agt/detection_tables.h"
+#include "glk/blorb.h"
+#include "common/file.h"
+#include "common/md5.h"
+#include "engines/game.h"
+
+namespace Glk {
+namespace AGT {
+
+void AGTMetaEngine::getSupportedGames(PlainGameList &games) {
+	for (const PlainGameDescriptor *pd = AGT_GAME_LIST; pd->gameId; ++pd)
+		games.push_back(*pd);
+}
+
+GameDescriptor AGTMetaEngine::findGame(const char *gameId) {
+	for (const PlainGameDescriptor *pd = AGT_GAME_LIST; pd->gameId; ++pd) {
+		if (!strcmp(gameId, pd->gameId))
+			return *pd;
+	}
+
+	return GameDescriptor::empty();
+}
+
+bool AGTMetaEngine::detectGames(const Common::FSList &fslist, DetectedGames &gameList) {
+	const char *const EXTENSIONS[] = { ".saga", ".dat", nullptr };
+
+	// Loop through the files of the folder
+	for (Common::FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
+		// Check for a recognised filename
+		if (file->isDirectory())
+			continue;
+
+		Common::String filename = file->getName();
+		if (!filename.hasSuffixIgnoreCase(".d$$"))
+			continue;
+
+		Common::File gameFile;
+		if (!gameFile.open(*file))
+			continue;
+		Common::String md5 = Common::computeStreamMD5AsString(gameFile, 5000);
+		size_t filesize = (size_t)gameFile.size();
+
+		// Scan through the AGT game list for a match
+		const GlkDetectionEntry *p = AGT_GAMES;
+		while (p->_md5 && p->_filesize != filesize && md5 != p->_md5)
+			++p;
+
+		if (!p->_gameId) {
+			const PlainGameDescriptor &desc = AGT_GAME_LIST[0];
+			gameList.push_back(GlkDetectedGame(desc.gameId, desc.description, filename, md5, filesize));
+		} else {
+			// Found a match
+			PlainGameDescriptor gameDesc = findGame(p->_gameId);
+			gameList.push_back(GlkDetectedGame(p->_gameId, gameDesc.description, filename));
+		}
+	}
+
+	return !gameList.empty();
+}
+
+void AGTMetaEngine::detectClashes(Common::StringMap &map) {
+	for (const PlainGameDescriptor *pd = AGT_GAME_LIST; pd->gameId; ++pd) {
+		if (map.contains(pd->gameId))
+			error("Duplicate game Id found - %s", pd->gameId);
+		map[pd->gameId] = "";
+	}
+}
+
+} // End of namespace AGT
+} // End of namespace Glk
diff --git a/engines/glk/agt/detection.h b/engines/glk/agt/detection.h
new file mode 100644
index 0000000000..94bb533d5d
--- /dev/null
+++ b/engines/glk/agt/detection.h
@@ -0,0 +1,60 @@
+/* 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_AGT_DETECTION
+#define GLK_AGT_DETECTION
+
+#include "common/fs.h"
+#include "common/hash-str.h"
+#include "engines/game.h"
+#include "glk/detection.h"
+
+namespace Glk {
+namespace AGT {
+
+class AGTMetaEngine {
+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 GameDescriptor findGame(const char *gameId);
+
+	/**
+	 * Detect supported games
+	 */
+	static bool detectGames(const Common::FSList &fslist, DetectedGames &gameList);
+
+	/**
+	 * Check for game Id clashes with other sub-engines
+	 */
+	static void detectClashes(Common::StringMap &map);
+};
+
+} // End of namespace AGT
+} // End of namespace Glk
+
+#endif
diff --git a/engines/glk/agt/detection_tables.h b/engines/glk/agt/detection_tables.h
new file mode 100644
index 0000000000..86e92e0fbb
--- /dev/null
+++ b/engines/glk/agt/detection_tables.h
@@ -0,0 +1,39 @@
+/* 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 AGT {
+
+const PlainGameDescriptor AGT_GAME_LIST[] = {
+	{ nullptr, nullptr }
+};
+
+const GlkDetectionEntry AGT_GAMES[] = {
+	DT_END_MARKER
+};
+
+} // End of namespace AGT
+} // End of namespace Glk
diff --git a/engines/glk/configure.engine b/engines/glk/configure.engine
index 507bcfec58..a00f9fdd14 100644
--- a/engines/glk/configure.engine
+++ b/engines/glk/configure.engine
@@ -1,8 +1,9 @@
 # This file is included from the main "configure" script
 # add_engine [name] [desc] [build-by-default] [subengines] [base games] [deps]
-add_engine glk "Glk Interactive Fiction games" no "glk_adrift glk_advsys glk_alan2 glk_alan3 glk_archetype glk_frotz glk_glulxe glk_hugo glk_jacl glk_level9 glk_magnetic glk_quest glk_scott glk_tads" "Base" "16bit freetype2 jpeg png"
+add_engine glk "Glk Interactive Fiction games" no "glk_adrift glk_advsys glk_agt glk_alan2 glk_alan3 glk_archetype glk_frotz glk_glulxe glk_hugo glk_jacl glk_level9 glk_magnetic glk_quest glk_scott glk_tads" "Base" "16bit freetype2 jpeg png"
 add_engine glk_adrift "ADRIFT" no
 add_engine glk_advsys "AdvSys" no
+add_engine glk_agt "AGT" no
 add_engine glk_alan2 "Alan2" no
 add_engine glk_alan3 "Alan3" no
 add_engine glk_archetype "Archetype" no
diff --git a/engines/glk/detection.cpp b/engines/glk/detection.cpp
index 9cbda0f519..628158f759 100644
--- a/engines/glk/detection.cpp
+++ b/engines/glk/detection.cpp
@@ -34,6 +34,11 @@
 #include "glk/advsys/advsys.h"
 #endif
 
+#ifdef ENABLE_GLK_AGT
+#include "glk/agt/detection.h"
+#include "glk/agt/agt.h"
+#endif
+
 #ifdef ENABLE_GLK_ALAN2
 #include "glk/alan2/detection.h"
 #include "glk/alan2/alan2.h"
@@ -214,6 +219,10 @@ Common::Error GlkMetaEngine::createInstance(OSystem *syst, Engine **engine) cons
 	if ((*engine = create<Glk::AdvSys::AdvSysMetaEngine, Glk::AdvSys::AdvSys>(syst, gameDesc)) != nullptr) {}
 	else
 #endif
+#ifdef ENABLE_GLK_AGT
+		if ((*engine = create<Glk::AGT::AGTMetaEngine, Glk::AGT::AGT>(syst, gameDesc)) != nullptr) {}
+		else
+#endif
 #ifdef ENABLE_GLK_ALAN2
 	if ((*engine = create<Glk::Alan2::Alan2MetaEngine, Glk::Alan2::Alan2>(syst, gameDesc)) != nullptr) {}
 	else
@@ -303,6 +312,9 @@ PlainGameList GlkMetaEngine::getSupportedGames() const {
 #ifdef ENABLE_GLK_ADVSYS
 	Glk::AdvSys::AdvSysMetaEngine::getSupportedGames(list);
 #endif
+#ifdef ENABLE_GLK_AGT
+	Glk::AGT::AGTMetaEngine::getSupportedGames(list);
+#endif
 #ifdef ENABLE_GLK_ALAN2
 	Glk::Alan2::Alan2MetaEngine::getSupportedGames(list);
 #endif
@@ -357,6 +369,9 @@ PlainGameDescriptor GlkMetaEngine::findGame(const char *gameId) const {
 #ifdef ENABLE_GLK_ALAN2
 	FIND_GAME(Alan2);
 #endif
+#ifdef ENABLE_GLK_AGT
+	FIND_GAME(AGT);
+#endif
 #ifdef ENABLE_GLK_ALAN3
 	FIND_GAME(Alan3);
 #endif
@@ -407,6 +422,9 @@ DetectedGames GlkMetaEngine::detectGames(const Common::FSList &fslist) const {
 #ifdef ENABLE_GLK_ADVSYS
 	Glk::AdvSys::AdvSysMetaEngine::detectGames(fslist, detectedGames);
 #endif
+#ifdef ENABLE_GLK_AGT
+	Glk::AGT::AGTMetaEngine::detectGames(fslist, detectedGames);
+#endif
 #ifdef ENABLE_GLK_ALAN2
 	Glk::Alan2::Alan2MetaEngine::detectGames(fslist, detectedGames);
 #endif
@@ -455,6 +473,9 @@ void GlkMetaEngine::detectClashes() const {
 #ifdef ENABLE_GLK_ADVSYS
 	Glk::AdvSys::AdvSysMetaEngine::detectClashes(map);
 #endif
+#ifdef ENABLE_GLK_AGT
+	Glk::AGT::AGTMetaEngine::detectClashes(map);
+#endif
 #ifdef ENABLE_GLK_ALAN2
 	Glk::Alan2::Alan2MetaEngine::detectClashes(map);
 #endif
diff --git a/engines/glk/glk_types.h b/engines/glk/glk_types.h
index e730f15ccf..7609a90f24 100644
--- a/engines/glk/glk_types.h
+++ b/engines/glk/glk_types.h
@@ -38,6 +38,7 @@ enum InterpreterType {
 	INTERPRETER_ADRIFT,
 	INTERPRETER_ADVSYS,
 	INTERPRETER_AGILITY,
+	INTERPRETER_AGT,
 	INTERPRETER_ALAN2,
 	INTERPRETER_ALAN3,
 	INTERPRETER_ARCHETYPE,
diff --git a/engines/glk/module.mk b/engines/glk/module.mk
index 74d3321872..a37bd2bcde 100644
--- a/engines/glk/module.mk
+++ b/engines/glk/module.mk
@@ -69,6 +69,12 @@ MODULE_OBJS += \
 	advsys/vm.o
 endif
 
+ifdef ENABLE_GLK_AGT
+MODULE_OBJS += \
+	agt/agt.o \
+	agt/detection.o
+endif
+
 ifdef ENABLE_GLK_ALAN2
 MODULE_OBJS += \
 	alan2/alan2.o \