From d5bb06ed17bd19658a2ff16ccfd297cb63fccc24 Mon Sep 17 00:00:00 2001 From: Paul Gilbert Date: Mon, 3 Jun 2019 19:18:40 -0700 Subject: GLK: ADVSYS: Engine skeleton --- engines/glk/advsys/advsys.cpp | 41 +++++++++++++++ engines/glk/advsys/advsys.h | 68 +++++++++++++++++++++++++ engines/glk/advsys/definitions.h | 34 +++++++++++++ engines/glk/advsys/detection.cpp | 95 +++++++++++++++++++++++++++++++++++ engines/glk/advsys/detection.h | 60 ++++++++++++++++++++++ engines/glk/advsys/detection_tables.h | 49 ++++++++++++++++++ engines/glk/detection.cpp | 9 ++++ engines/glk/module.mk | 2 + 8 files changed, 358 insertions(+) create mode 100644 engines/glk/advsys/advsys.cpp create mode 100644 engines/glk/advsys/advsys.h create mode 100644 engines/glk/advsys/definitions.h create mode 100644 engines/glk/advsys/detection.cpp create mode 100644 engines/glk/advsys/detection.h create mode 100644 engines/glk/advsys/detection_tables.h diff --git a/engines/glk/advsys/advsys.cpp b/engines/glk/advsys/advsys.cpp new file mode 100644 index 0000000000..47c3da1d43 --- /dev/null +++ b/engines/glk/advsys/advsys.cpp @@ -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. + * + */ + +#include "glk/advsys/advsys.h" + +namespace Glk { +namespace AdvSys { + +void AdvSys::runGame() { + // TODO +} + +Common::Error AdvSys::loadGameData(strid_t save) { + return Common::kNoError; +} + +Common::Error AdvSys::saveGameData(strid_t save, const Common::String& desc) { + return Common::kNoError; +} + +} // End of namespace AdvSys +} // End of namespace Glk diff --git a/engines/glk/advsys/advsys.h b/engines/glk/advsys/advsys.h new file mode 100644 index 0000000000..ceb2df3260 --- /dev/null +++ b/engines/glk/advsys/advsys.h @@ -0,0 +1,68 @@ +/* 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_ADVSYS_ADVSYS +#define GLK_ADVSYS_ADVSYS + +#include "common/scummsys.h" +#include "glk/glk_api.h" + +namespace Glk { +namespace AdvSys { + +/** + * AdvSys game interpreter + */ +class AdvSys : public GlkAPI { +private: + +public: + /** + * Constructor + */ + AdvSys(OSystem *syst, const GlkGameDescription &gameDesc) : GlkAPI(syst, gameDesc) {} + + /** + * Run the game + */ + virtual void runGame() override; + + /** + * Returns the running interpreter type + */ + virtual InterpreterType getInterpreterType() const override { return INTERPRETER_ADVSYS; } + + /** + * Load a savegame from the passed stream + */ + virtual Common::Error loadGameData(strid_t save) override; + + /** + * Save the game to the passed stream + */ + virtual Common::Error saveGameData(strid_t save, const Common::String &desc) override; +}; + +} // End of namespace AdvSys +} // End of namespace Glk + +#endif diff --git a/engines/glk/advsys/definitions.h b/engines/glk/advsys/definitions.h new file mode 100644 index 0000000000..6a02a66a6b --- /dev/null +++ b/engines/glk/advsys/definitions.h @@ -0,0 +1,34 @@ +/* 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_ADVSYS_DEFINITIONS +#define GLK_ADVSYS_DEFINITIONS + +namespace Glk { +namespace AdvSys { + + + +} // End of namespace AdvSys +} // End of namespace Glk + +#endif diff --git a/engines/glk/advsys/detection.cpp b/engines/glk/advsys/detection.cpp new file mode 100644 index 0000000000..4cedecfbc0 --- /dev/null +++ b/engines/glk/advsys/detection.cpp @@ -0,0 +1,95 @@ +/* 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/advsys/detection.h" +#include "glk/advsys/detection_tables.h" +#include "common/file.h" +#include "common/md5.h" +#include "engines/game.h" + +namespace Glk { +namespace AdvSys { + +void AdvSysMetaEngine::getSupportedGames(PlainGameList &games) { + for (const PlainGameDescriptor *pd = ADVSYS_GAME_LIST; pd->gameId; ++pd) + games.push_back(*pd); +} + +GameDescriptor AdvSysMetaEngine::findGame(const char *gameId) { + for (const PlainGameDescriptor *pd = ADVSYS_GAME_LIST; pd->gameId; ++pd) { + if (!strcmp(gameId, pd->gameId)) + return *pd; + } + + return GameDescriptor::empty(); +} + +bool AdvSysMetaEngine::detectGames(const Common::FSList &fslist, DetectedGames &gameList) { + const char *const EXTENSIONS[] = { ".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(); + bool hasExt = false; + for (const char *const *ext = &EXTENSIONS[0]; *ext && !hasExt; ++ext) + hasExt = filename.hasSuffixIgnoreCase(*ext); + if (!hasExt) + continue; + + Common::File gameFile; + if (!gameFile.open(*file)) + continue; + Common::String md5 = Common::computeStreamMD5AsString(gameFile, 5000); + int32 filesize = gameFile.size(); + + // Scan through the AdvSys game list for a match + const AdvSysGame *p = ADVSYS_GAMES; + while (p->_md5 && p->_filesize != filesize && 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); + } + } + + return !gameList.empty(); +} + +void AdvSysMetaEngine::detectClashes(Common::StringMap &map) { + for (const PlainGameDescriptor *pd = ADVSYS_GAME_LIST; pd->gameId; ++pd) { + if (map.contains(pd->gameId)) + error("Duplicate game Id found - %s", pd->gameId); + map[pd->gameId] = ""; + } +} + +} // End of namespace AdvSys +} // End of namespace Glk diff --git a/engines/glk/advsys/detection.h b/engines/glk/advsys/detection.h new file mode 100644 index 0000000000..328575714f --- /dev/null +++ b/engines/glk/advsys/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_ADVSYS_DETECTION +#define GLK_ADVSYS_DETECTION + +#include "common/fs.h" +#include "common/hash-str.h" +#include "engines/game.h" +#include "glk/detection.h" + +namespace Glk { +namespace AdvSys { + +class AdvSysMetaEngine { +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 AdvSys +} // End of namespace Glk + +#endif diff --git a/engines/glk/advsys/detection_tables.h b/engines/glk/advsys/detection_tables.h new file mode 100644 index 0000000000..de36a34062 --- /dev/null +++ b/engines/glk/advsys/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 AdvSys { + +/** + * Game descriptor for Scott Adams games + */ +struct AdvSysGame { + const char *_md5; + const char *_gameId; + int32 _filesize; +}; + +const PlainGameDescriptor ADVSYS_GAME_LIST[] = { + { nullptr, nullptr } +}; + +const AdvSysGame ADVSYS_GAMES[] = { + + { nullptr, nullptr, 0 } +}; + +} // End of namespace AdvSys +} // End of namespace Glk diff --git a/engines/glk/detection.cpp b/engines/glk/detection.cpp index a13bed3cfc..22b2d1036d 100644 --- a/engines/glk/detection.cpp +++ b/engines/glk/detection.cpp @@ -22,6 +22,8 @@ #include "glk/glk.h" #include "glk/detection.h" +#include "glk/advsys/detection.h" +#include "glk/advsys/advsys.h" #include "glk/alan2/detection.h" #include "glk/alan2/alan2.h" #include "glk/frotz/detection.h" @@ -116,6 +118,7 @@ Common::Error GlkMetaEngine::createInstance(OSystem *syst, Engine **engine) cons else if ((*engine = create(syst, gameDesc)) != nullptr) {} else if ((*engine = create(syst, gameDesc)) != nullptr) {} #ifndef RELEASE_BUILD + else if ((*engine = create(syst, gameDesc)) != nullptr) {} else if ((*engine = create(syst, gameDesc)) != nullptr) {} else if ((*engine = create(syst, gameDesc)) != nullptr) {} else if ((td = Glk::TADS::TADSMetaEngine::findGame(gameDesc._gameId.c_str()))._description) { @@ -161,6 +164,7 @@ PlainGameList GlkMetaEngine::getSupportedGames() const { Glk::Hugo::HugoMetaEngine::getSupportedGames(list); Glk::Scott::ScottMetaEngine::getSupportedGames(list); #ifndef RELEASE_BUILD + Glk::AdvSys::AdvSysMetaEngine::getSupportedGames(list); Glk::Alan2::Alan2MetaEngine::getSupportedGames(list); Glk::Magnetic::MagneticMetaEngine::getSupportedGames(list); Glk::TADS::TADSMetaEngine::getSupportedGames(list); @@ -183,6 +187,9 @@ PlainGameDescriptor GlkMetaEngine::findGame(const char *gameId) const { if (gd._description) return gd; #ifndef RELEASE_BUILD + gd = Glk::AdvSys::AdvSysMetaEngine::findGame(gameId); + if (gd._description) return gd; + gd = Glk::Alan2::Alan2MetaEngine::findGame(gameId); if (gd._description) return gd; @@ -206,6 +213,7 @@ DetectedGames GlkMetaEngine::detectGames(const Common::FSList &fslist) const { Glk::Scott::ScottMetaEngine::detectGames(fslist, detectedGames); #ifndef RELEASE_BUILD + Glk::AdvSys::AdvSysMetaEngine::detectGames(fslist, detectedGames); Glk::Alan2::Alan2MetaEngine::detectGames(fslist, detectedGames); Glk::Magnetic::MagneticMetaEngine::detectGames(fslist, detectedGames); Glk::TADS::TADSMetaEngine::detectGames(fslist, detectedGames); @@ -222,6 +230,7 @@ void GlkMetaEngine::detectClashes() const { Glk::Scott::ScottMetaEngine::detectClashes(map); #ifndef RELEASE_BUILD + Glk::AdvSys::AdvSysMetaEngine::detectClashes(map); Glk::Alan2::Alan2MetaEngine::detectClashes(map); Glk::Magnetic::MagneticMetaEngine::detectClashes(map); Glk::TADS::TADSMetaEngine::detectClashes(map); diff --git a/engines/glk/module.mk b/engines/glk/module.mk index db930f2e2f..3894969ae1 100644 --- a/engines/glk/module.mk +++ b/engines/glk/module.mk @@ -25,6 +25,8 @@ MODULE_OBJS := \ window_pair.o \ window_text_buffer.o \ window_text_grid.o \ + advsys/advsys.o \ + advsys/detection.o \ alan2/alan2.o \ alan2/decode.o \ alan2/detection.o \ -- cgit v1.2.3