From 223f2613b2756ca8d63bb7dea75335f41d9ad75c Mon Sep 17 00:00:00 2001 From: Paul Gilbert Date: Fri, 22 Nov 2019 19:27:02 -0800 Subject: GLK: AGT: Skeleton engine --- engines/glk/agt/agt.cpp | 47 +++++++++++++++++++ engines/glk/agt/agt.h | 70 ++++++++++++++++++++++++++++ engines/glk/agt/detection.cpp | 93 ++++++++++++++++++++++++++++++++++++++ engines/glk/agt/detection.h | 60 ++++++++++++++++++++++++ engines/glk/agt/detection_tables.h | 39 ++++++++++++++++ 5 files changed, 309 insertions(+) create mode 100644 engines/glk/agt/agt.cpp create mode 100644 engines/glk/agt/agt.h create mode 100644 engines/glk/agt/detection.cpp create mode 100644 engines/glk/agt/detection.h create mode 100644 engines/glk/agt/detection_tables.h (limited to 'engines/glk/agt') 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 -- cgit v1.2.3