Initial commit
This commit is contained in:
392
engines/glk/detection.cpp
Normal file
392
engines/glk/detection.cpp
Normal file
@@ -0,0 +1,392 @@
|
||||
/* 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#define FORBIDDEN_SYMBOL_EXCEPTION_printf
|
||||
|
||||
#include "base/plugins.h"
|
||||
#include "common/md5.h"
|
||||
#include "common/memstream.h"
|
||||
#include "common/str-array.h"
|
||||
#include "common/file.h"
|
||||
#include "common/config-manager.h"
|
||||
|
||||
#include "glk/detection.h"
|
||||
#include "glk/game_description.h"
|
||||
#include "glk/glk.h"
|
||||
|
||||
#include "glk/adrift/detection.h"
|
||||
#include "glk/advsys/detection.h"
|
||||
#include "glk/agt/detection.h"
|
||||
#include "glk/alan2/detection.h"
|
||||
#include "glk/alan3/detection.h"
|
||||
#include "glk/archetype/detection.h"
|
||||
#include "glk/comprehend/detection.h"
|
||||
#include "glk/glulx/detection.h"
|
||||
#include "glk/hugo/detection.h"
|
||||
#include "glk/jacl/detection.h"
|
||||
#include "glk/level9/detection.h"
|
||||
#include "glk/magnetic/detection.h"
|
||||
#include "glk/quest/detection.h"
|
||||
#include "glk/scott/detection.h"
|
||||
#include "glk/zcode/detection.h"
|
||||
|
||||
#ifndef RELEASE_BUILD
|
||||
#include "glk/tads/detection.h"
|
||||
#endif
|
||||
|
||||
#include "base/plugins.h"
|
||||
#include "common/md5.h"
|
||||
#include "common/memstream.h"
|
||||
#include "common/savefile.h"
|
||||
#include "common/str-array.h"
|
||||
#include "common/system.h"
|
||||
#include "graphics/surface.h"
|
||||
#include "common/config-manager.h"
|
||||
#include "common/file.h"
|
||||
|
||||
#include "engines/metaengine.h"
|
||||
#include "engines/engine.h"
|
||||
|
||||
#include "common/hash-str.h"
|
||||
|
||||
#include "common/gui_options.h"
|
||||
|
||||
|
||||
static const DebugChannelDef debugFlagList[] = {
|
||||
{Glk::kDebugCore, "core", "Core engine debug level"},
|
||||
{Glk::kDebugScripts, "scripts", "Game scripts"},
|
||||
{Glk::kDebugGraphics, "graphics", "Graphics handling"},
|
||||
{Glk::kDebugSound, "sound", "Sound and Music handling"},
|
||||
{Glk::kDebugSpeech, "speech", "Text to Speech handling"},
|
||||
DEBUG_CHANNEL_END
|
||||
};
|
||||
|
||||
namespace Glk {
|
||||
|
||||
Common::String GlkDetectedGame::getGlkGUIOptions() {
|
||||
#if defined (USE_TTS)
|
||||
return GUIO2(GUIO_NOMUSIC, GUIO_NOSUBTITLES);
|
||||
#else
|
||||
return GUIO3(GUIO_NOSPEECH, GUIO_NOMUSIC, GUIO_NOSUBTITLES);
|
||||
#endif
|
||||
}
|
||||
|
||||
GlkDetectedGame::GlkDetectedGame(const char *id, const char *desc, const Common::String &filename,
|
||||
GameSupportLevel supportLevel) :
|
||||
DetectedGame("glk", id, desc, Common::EN_ANY, Common::kPlatformUnknown) {
|
||||
setGUIOptions(getGlkGUIOptions());
|
||||
gameSupportLevel = supportLevel;
|
||||
addExtraEntry("filename", filename);
|
||||
}
|
||||
|
||||
GlkDetectedGame::GlkDetectedGame(const char *id, const char *desc, const Common::String &filename,
|
||||
Common::Language lang, Common::Platform p, GameSupportLevel supportLevel) : DetectedGame("glk", id, desc, lang, p) {
|
||||
setGUIOptions(getGlkGUIOptions());
|
||||
gameSupportLevel = supportLevel;
|
||||
addExtraEntry("filename", filename);
|
||||
}
|
||||
|
||||
GlkDetectedGame::GlkDetectedGame(const char *id, const char *desc, const char *xtra,
|
||||
const Common::String &filename, Common::Language lang,
|
||||
GameSupportLevel supportLevel) :
|
||||
DetectedGame("glk", id, desc, lang, Common::kPlatformUnknown, xtra) {
|
||||
setGUIOptions(getGlkGUIOptions());
|
||||
gameSupportLevel = supportLevel;
|
||||
addExtraEntry("filename", filename);
|
||||
}
|
||||
|
||||
GlkDetectedGame::GlkDetectedGame(const char *id, const char *desc, const Common::String &filename,
|
||||
const Common::String &md5, size_t filesize, GameSupportLevel supportLevel) :
|
||||
DetectedGame("glk", id, desc, Common::UNK_LANG, Common::kPlatformUnknown) {
|
||||
setGUIOptions(getGlkGUIOptions());
|
||||
gameSupportLevel = supportLevel;
|
||||
addExtraEntry("filename", filename);
|
||||
|
||||
canBeAdded = true;
|
||||
hasUnknownFiles = true;
|
||||
|
||||
FileProperties fp;
|
||||
fp.md5 = md5;
|
||||
fp.size = filesize;
|
||||
matchedFiles[Common::Path(filename)] = fp;
|
||||
}
|
||||
|
||||
} // End of namespace Glk
|
||||
|
||||
PlainGameList GlkMetaEngineDetection::getSupportedGames() const {
|
||||
PlainGameList list;
|
||||
Glk::Adrift::AdriftMetaEngine::getSupportedGames(list);
|
||||
Glk::AdvSys::AdvSysMetaEngine::getSupportedGames(list);
|
||||
Glk::AGT::AGTMetaEngine::getSupportedGames(list);
|
||||
Glk::Alan2::Alan2MetaEngine::getSupportedGames(list);
|
||||
Glk::Alan3::Alan3MetaEngine::getSupportedGames(list);
|
||||
Glk::Archetype::ArchetypeMetaEngine::getSupportedGames(list);
|
||||
Glk::Comprehend::ComprehendMetaEngine::getSupportedGames(list);
|
||||
Glk::Glulx::GlulxMetaEngine::getSupportedGames(list);
|
||||
Glk::Hugo::HugoMetaEngine::getSupportedGames(list);
|
||||
Glk::JACL::JACLMetaEngine::getSupportedGames(list);
|
||||
Glk::Level9::Level9MetaEngine::getSupportedGames(list);
|
||||
Glk::Magnetic::MagneticMetaEngine::getSupportedGames(list);
|
||||
Glk::Quest::QuestMetaEngine::getSupportedGames(list);
|
||||
Glk::Scott::ScottMetaEngine::getSupportedGames(list);
|
||||
Glk::ZCode::ZCodeMetaEngine::getSupportedGames(list);
|
||||
#ifndef RELEASE_BUILD
|
||||
Glk::TADS::TADSMetaEngine::getSupportedGames(list);
|
||||
#endif
|
||||
|
||||
return list;
|
||||
}
|
||||
|
||||
#define FIND_GAME(SUBENGINE) \
|
||||
Glk::GameDescriptor gd##SUBENGINE = Glk::SUBENGINE::SUBENGINE##MetaEngine::findGame(gameId); \
|
||||
if (gd##SUBENGINE._description) return gd##SUBENGINE
|
||||
|
||||
const DebugChannelDef *GlkMetaEngineDetection::getDebugChannels() const {
|
||||
return debugFlagList;
|
||||
}
|
||||
|
||||
PlainGameDescriptor GlkMetaEngineDetection::findGame(const char *gameId) const {
|
||||
FIND_GAME(Adrift);
|
||||
FIND_GAME(AdvSys);
|
||||
FIND_GAME(Alan2);
|
||||
FIND_GAME(AGT);
|
||||
FIND_GAME(Alan3);
|
||||
FIND_GAME(Archetype);
|
||||
FIND_GAME(Comprehend);
|
||||
FIND_GAME(Glulx);
|
||||
FIND_GAME(Hugo);
|
||||
FIND_GAME(JACL);
|
||||
FIND_GAME(Level9);
|
||||
FIND_GAME(Magnetic);
|
||||
FIND_GAME(Quest);
|
||||
FIND_GAME(Scott);
|
||||
FIND_GAME(ZCode);
|
||||
#ifndef RELEASE_BUILD
|
||||
FIND_GAME(TADS);
|
||||
#endif
|
||||
|
||||
return PlainGameDescriptor::empty();
|
||||
}
|
||||
|
||||
#undef FIND_GAME
|
||||
|
||||
Common::String GlkMetaEngineDetection::findFileByGameId(const Common::String &gameId) {
|
||||
// Get the list of files in the folder and return detection against them
|
||||
Common::FSNode folder = Common::FSNode(ConfMan.getPath("path"));
|
||||
Common::FSList fslist;
|
||||
folder.getChildren(fslist, Common::FSNode::kListFilesOnly);
|
||||
|
||||
// Iterate over the files
|
||||
for (Common::FSList::iterator i = fslist.begin(); i != fslist.end(); ++i) {
|
||||
// Run a detection on each file in the folder individually
|
||||
Common::FSList singleList;
|
||||
singleList.push_back(*i);
|
||||
DetectedGames games = detectGames(singleList);
|
||||
|
||||
// If a detection was found with the correct game Id, we have a winner
|
||||
if (!games.empty() && games.front().gameId == gameId)
|
||||
return (*i).getName();
|
||||
}
|
||||
|
||||
// No match found
|
||||
return Common::String();
|
||||
}
|
||||
|
||||
Common::Error GlkMetaEngineDetection::identifyGame(DetectedGame &game, const void **descriptor) {
|
||||
*descriptor = nullptr;
|
||||
|
||||
// Populate the game description
|
||||
Glk::GlkGameDescription *gameDesc = new Glk::GlkGameDescription;
|
||||
|
||||
gameDesc->_gameId = ConfMan.get("gameid");
|
||||
gameDesc->_filename = ConfMan.get("filename");
|
||||
|
||||
gameDesc->_language = Common::UNK_LANG;
|
||||
gameDesc->_platform = Common::kPlatformUnknown;
|
||||
if (ConfMan.hasKey("language"))
|
||||
gameDesc->_language = Common::parseLanguage(ConfMan.get("language"));
|
||||
if (ConfMan.hasKey("platform"))
|
||||
gameDesc->_platform = Common::parsePlatform(ConfMan.get("platform"));
|
||||
|
||||
// If the game description has no filename, the engine has been launched directly from
|
||||
// the command line. Do a scan for supported games for that Id in the game folder
|
||||
if (gameDesc->_filename.empty()) {
|
||||
gameDesc->_filename = findFileByGameId(gameDesc->_gameId);
|
||||
if (gameDesc->_filename.empty()) {
|
||||
delete gameDesc;
|
||||
return Common::kNoGameDataFoundError;
|
||||
}
|
||||
}
|
||||
|
||||
// Get the MD5
|
||||
Common::File f;
|
||||
if (!f.open(Common::FSNode(ConfMan.getPath("path")).getChild(gameDesc->_filename))) {
|
||||
delete gameDesc;
|
||||
return Common::kNoGameDataFoundError;
|
||||
}
|
||||
|
||||
Common::String fileName = f.getName();
|
||||
if (fileName.hasSuffixIgnoreCase(".D64"))
|
||||
gameDesc->_md5 = Common::computeStreamMD5AsString(f);
|
||||
else
|
||||
gameDesc->_md5 = Common::computeStreamMD5AsString(f, 5000);
|
||||
f.close();
|
||||
|
||||
*descriptor = gameDesc;
|
||||
|
||||
PlainGameDescriptor pdesc(findGame(ConfMan.get("gameid").c_str()));
|
||||
|
||||
if (!pdesc.gameId || !*pdesc.gameId)
|
||||
return Common::kUnknownError;
|
||||
|
||||
game = DetectedGame(getName(), pdesc);
|
||||
return Common::kNoError;
|
||||
}
|
||||
|
||||
DetectedGames GlkMetaEngineDetection::detectGames(const Common::FSList &fslist, uint32 /*skipADFlags*/, bool /*skipIncomplete*/) {
|
||||
#ifndef RELEASE_BUILD
|
||||
// This is as good a place as any to detect multiple sub-engines using the same Ids
|
||||
detectClashes();
|
||||
#endif
|
||||
|
||||
DetectedGames detectedGames;
|
||||
Glk::Adrift::AdriftMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::AdvSys::AdvSysMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::AGT::AGTMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Alan2::Alan2MetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Alan3::Alan3MetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Archetype::ArchetypeMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Comprehend::ComprehendMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Glulx::GlulxMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Hugo::HugoMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::JACL::JACLMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Level9::Level9MetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Magnetic::MagneticMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Quest::QuestMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::Scott::ScottMetaEngine::detectGames(fslist, detectedGames);
|
||||
Glk::ZCode::ZCodeMetaEngine::detectGames(fslist, detectedGames);
|
||||
#ifndef RELEASE_BUILD
|
||||
Glk::TADS::TADSMetaEngine::detectGames(fslist, detectedGames);
|
||||
#endif
|
||||
|
||||
return detectedGames;
|
||||
}
|
||||
|
||||
void GlkMetaEngineDetection::detectClashes() const {
|
||||
Common::StringMap map;
|
||||
Glk::Adrift::AdriftMetaEngine::detectClashes(map);
|
||||
Glk::AdvSys::AdvSysMetaEngine::detectClashes(map);
|
||||
Glk::AGT::AGTMetaEngine::detectClashes(map);
|
||||
Glk::Alan2::Alan2MetaEngine::detectClashes(map);
|
||||
Glk::Alan3::Alan3MetaEngine::detectClashes(map);
|
||||
Glk::Archetype::ArchetypeMetaEngine::detectClashes(map);
|
||||
Glk::Comprehend::ComprehendMetaEngine::detectClashes(map);
|
||||
Glk::Glulx::GlulxMetaEngine::detectClashes(map);
|
||||
Glk::Hugo::HugoMetaEngine::detectClashes(map);
|
||||
Glk::JACL::JACLMetaEngine::detectClashes(map);
|
||||
Glk::Level9::Level9MetaEngine::detectClashes(map);
|
||||
Glk::Magnetic::MagneticMetaEngine::detectClashes(map);
|
||||
Glk::Quest::QuestMetaEngine::detectClashes(map);
|
||||
Glk::Scott::ScottMetaEngine::detectClashes(map);
|
||||
Glk::ZCode::ZCodeMetaEngine::detectClashes(map);
|
||||
#ifndef RELEASE_BUILD
|
||||
Glk::TADS::TADSMetaEngine::detectClashes(map);
|
||||
#endif
|
||||
}
|
||||
|
||||
uint GlkMetaEngineDetection::getMD5Bytes() const {
|
||||
return 5000;
|
||||
}
|
||||
|
||||
void GlkMetaEngineDetection::dumpDetectionEntries() const {
|
||||
#if 0
|
||||
enum class EngineName : uint8 {
|
||||
COMPREHEND,
|
||||
LEVEL9,
|
||||
OTHER
|
||||
};
|
||||
|
||||
struct Detection {
|
||||
const Glk::GlkDetectionEntry *entries;
|
||||
EngineName engineName;
|
||||
};
|
||||
|
||||
const Detection detectionEntries[] = {
|
||||
{ Glk::Adrift::AdriftMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::AdvSys::AdvSysMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::AGT::AGTMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Alan2::Alan2MetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Alan3::Alan3MetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Archetype::ArchetypeMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Comprehend::ComprehendMetaEngine::getDetectionEntries(), EngineName::COMPREHEND },
|
||||
{ Glk::Glulx::GlulxMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Hugo::HugoMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::JACL::JACLMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Level9::Level9MetaEngine::getDetectionEntries(), EngineName::LEVEL9 },
|
||||
{ Glk::Magnetic::MagneticMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Quest::QuestMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::Scott::ScottMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
{ Glk::ZCode::ZCodeMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
#ifndef RELEASE_BUILD
|
||||
{ Glk::TADS::TADSMetaEngine::getDetectionEntries(), EngineName::OTHER },
|
||||
#endif
|
||||
{ nullptr, EngineName::OTHER }
|
||||
};
|
||||
|
||||
for (const Detection *detection = detectionEntries; detection->entries; ++detection) {
|
||||
EngineName engineName = detection->engineName;
|
||||
|
||||
for (const Glk::GlkDetectionEntry *entry = detection->entries; entry->_gameId; ++entry) {
|
||||
PlainGameDescriptor pd = findGame(entry->_gameId);
|
||||
const char *title = pd.description;
|
||||
const char *extra = engineName == EngineName::COMPREHEND ? "" : entry->_extra;
|
||||
|
||||
printf("game (\n");
|
||||
printf("\tname \"%s\"\n", escapeString(entry->_gameId).c_str());
|
||||
printf("\ttitle \"%s\"\n", escapeString(title).c_str());
|
||||
printf("\textra \"%s\"\n", escapeString(extra).c_str());
|
||||
printf("\tlanguage \"%s\"\n", escapeString(getLanguageLocale(entry->_language)).c_str());
|
||||
printf("\tplatform \"%s\"\n", escapeString(getPlatformCode(entry->_platform)).c_str());
|
||||
printf("\tsourcefile \"%s\"\n", escapeString(getName()).c_str());
|
||||
printf("\tengine \"%s\"\n", escapeString(getName()).c_str());
|
||||
|
||||
Common::String checksum = entry->_md5;
|
||||
|
||||
// Filename for Comprehend Engine's md5 is stored in the extra field.
|
||||
// For other engines, filename is not available, so it has been kept as the gameId
|
||||
const char *fname = engineName == EngineName::COMPREHEND ? entry->_extra : entry->_gameId;
|
||||
|
||||
// Level9 engine does not use md5 checksums, so checksums are not printed.
|
||||
if (engineName == EngineName::LEVEL9) {
|
||||
printf("\trom ( name \"%s\" size %lld )\n", escapeString(fname).c_str(), static_cast<long long int>(entry->_filesize));
|
||||
} else {
|
||||
printf("\trom ( name \"%s\" size %lld md5-%d %s )\n", escapeString(fname).c_str(), static_cast<long long int>(entry->_filesize), getMD5Bytes(), checksum.c_str());
|
||||
}
|
||||
|
||||
printf(")\n\n");
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
|
||||
REGISTER_PLUGIN_STATIC(GLK_DETECTION, PLUGIN_TYPE_ENGINE_DETECTION, GlkMetaEngineDetection);
|
||||
Reference in New Issue
Block a user