1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
/* 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/>.
*
*/
#include "engines/game.h"
#include "common/gui_options.h"
#include "common/punycode.h"
#include "common/translation.h"
const PlainGameDescriptor *findPlainGameDescriptor(const char *gameid, const PlainGameDescriptor *list) {
const PlainGameDescriptor *g = list;
while (g->gameId) {
if (0 == scumm_stricmp(gameid, g->gameId))
return g;
g++;
}
return 0;
}
PlainGameDescriptor PlainGameDescriptor::empty() {
PlainGameDescriptor pgd;
pgd.gameId = nullptr;
pgd.description = nullptr;
return pgd;
}
PlainGameDescriptor PlainGameDescriptor::of(const char *gameId, const char *description) {
PlainGameDescriptor pgd;
pgd.gameId = gameId;
pgd.description = description;
return pgd;
}
QualifiedGameDescriptor::QualifiedGameDescriptor(const char *engine, const PlainGameDescriptor &pgd) :
engineId(engine),
gameId(pgd.gameId),
description(pgd.description) {
}
DetectedGame::DetectedGame() :
hasUnknownFiles(false),
canBeAdded(true),
language(Common::UNK_LANG),
platform(Common::kPlatformUnknown),
gameSupportLevel(kStableGame) {
}
DetectedGame::DetectedGame(const Common::String &engine, const PlainGameDescriptor &pgd) :
engineId(engine),
hasUnknownFiles(false),
canBeAdded(true),
language(Common::UNK_LANG),
platform(Common::kPlatformUnknown),
gameSupportLevel(kStableGame) {
gameId = pgd.gameId;
preferredTarget = pgd.gameId;
description = pgd.description;
}
DetectedGame::DetectedGame(const Common::String &engine, const Common::String &id, const Common::String &d, Common::Language l, Common::Platform p, const Common::String &ex, bool unsupported) :
engineId(engine),
hasUnknownFiles(false),
canBeAdded(true),
gameSupportLevel(kStableGame) {
gameId = id;
preferredTarget = id;
description = d;
language = l;
platform = p;
extra = ex;
// Append additional information, if set, to the description.
description += updateDesc(unsupported);
}
void DetectedGame::setGUIOptions(const Common::String &guioptions) {
_guiOptions = Common::getGameGUIOptionsDescription(guioptions);
}
void DetectedGame::appendGUIOptions(const Common::String &str) {
if (!_guiOptions.empty())
_guiOptions += " ";
_guiOptions += str;
}
Common::String DetectedGame::updateDesc(bool skipExtraField) const {
const bool hasCustomLanguage = (language != Common::UNK_LANG);
const bool hasCustomPlatform = (platform != Common::kPlatformUnknown);
const bool hasExtraDesc = (!extra.empty() && !skipExtraField);
// Adapt the description string if custom platform/language is set.
Common::String descr;
if (!hasCustomLanguage && !hasCustomPlatform && !hasExtraDesc)
return descr;
descr += " (";
if (hasExtraDesc)
descr += extra;
if (hasCustomPlatform) {
if (hasExtraDesc)
descr += "/";
descr += Common::getPlatformDescription(platform);
}
if (hasCustomLanguage) {
if (hasExtraDesc || hasCustomPlatform)
descr += "/";
descr += Common::getLanguageDescription(language);
}
descr += ")";
return descr;
}
DetectionResults::DetectionResults(const DetectedGames &detectedGames) :
_detectedGames(detectedGames) {
}
bool DetectionResults::foundUnknownGames() const {
for (uint i = 0; i < _detectedGames.size(); i++) {
if (_detectedGames[i].hasUnknownFiles) {
return true;
}
}
return false;
}
DetectedGames DetectionResults::listRecognizedGames() const {
DetectedGames candidates;
for (uint i = 0; i < _detectedGames.size(); i++) {
if (_detectedGames[i].canBeAdded) {
candidates.push_back(_detectedGames[i]);
}
}
return candidates;
}
DetectedGames DetectionResults::listDetectedGames() const {
return _detectedGames;
}
Common::U32String DetectionResults::generateUnknownGameReport(bool translate, uint32 wordwrapAt) const {
return ::generateUnknownGameReport(_detectedGames, translate, false, wordwrapAt);
}
Common::String md5PropToCachePrefix(MD5Properties flags) {
Common::String res;
if (flags & kMD5Tail) {
res += 't';
} else {
res += 'f';
}
switch (flags & kMD5MacMask) {
case kMD5MacDataFork:
res += 'd';
break;
case kMD5MacResOrDataFork:
res += 'm';
break;
case kMD5MacResFork:
res += 'r';
break;
default:
break;
}
if (flags & kMD5Archive)
res += 'A';
return res;
}
Common::U32String generateUnknownGameReport(const DetectedGames &detectedGames, bool translate, bool fullPath, uint32 wordwrapAt) {
assert(!detectedGames.empty());
const char *reportStart = _s("The game in '%s' seems to be an unknown game variant.\n\n"
"Please report the following data to the ScummVM team at %s "
"along with the name of the game you tried to add and "
"its version, language, etc.:");
const char *reportEngineHeader = _s("Matched game IDs for the %s engine:");
Common::U32String report = Common::U32String::format(
translate ? _(reportStart) : Common::U32String(reportStart),
fullPath ? detectedGames[0].path.toString(Common::Path::kNativeSeparator).c_str() : detectedGames[0].shortPath.c_str(),
"https://bugs.scummvm.org/"
);
report += Common::U32String("\n");
CachedPropertiesMap matchedFiles;
Common::String currentEngineId;
for (uint i = 0; i < detectedGames.size(); i++) {
const DetectedGame &game = detectedGames[i];
if (!game.hasUnknownFiles) continue;
if (currentEngineId.empty() || currentEngineId != game.engineId) {
currentEngineId = game.engineId;
// If the engine is not the same as for the previous entry, print an engine line header
report += Common::U32String("\n");
report += Common::U32String::format(
translate ? _(reportEngineHeader) : Common::U32String(reportEngineHeader),
game.engineId.c_str()
);
report += Common::U32String(" ");
} else {
report += Common::U32String(", ");
}
// Add the gameId to the list of matched games for the engine
// TODO: Use the gameId here instead of the preferred target.
// This is currently impossible due to the AD singleId feature losing the information.
report += game.preferredTarget;
// Consolidate matched files across all engines and detection entries
for (FilePropertiesMap::const_iterator it = game.matchedFiles.begin(); it != game.matchedFiles.end(); it++) {
Common::String key = Common::String::format("%s:%s", md5PropToCachePrefix(it->_value.md5prop).c_str(), it->_key.punycodeEncode().toString('/').c_str());
matchedFiles.setVal(key, it->_value);
}
}
if (wordwrapAt) {
report.wordWrap(wordwrapAt);
}
report += Common::U32String("\n\n");
Common::StringArray filenames;
for (CachedPropertiesMap::const_iterator file = matchedFiles.begin(); file != matchedFiles.end(); ++file) {
filenames.push_back(file->_key);
}
Common::sort(filenames.begin(), filenames.end());
for (uint i = 0; i < filenames.size(); ++i) {
const FileProperties &file = matchedFiles[filenames[i]];
Common::String md5Prefix;
if (file.md5prop & kMD5MacResFork)
md5Prefix += "r";
if (file.md5prop & kMD5MacDataFork)
md5Prefix += "d";
if (file.md5prop & kMD5Tail)
md5Prefix += "t";
if (!md5Prefix.empty())
md5Prefix += ":";
// Skip the md5 prefix and since we could have full paths, take it into account
Common::Path filepath(strchr(filenames[i].c_str(), ':') + 1);
report += Common::String::format(" {\"%s\", 0, \"%s%s\", %lld},\n",
filepath.punycodeEncode().toString().c_str(),
md5Prefix.c_str(), file.md5.c_str(), (long long)file.size);
}
report += Common::U32String("\n");
return report;
}
Common::U32String generateUnknownGameReport(const DetectedGame &detectedGame, bool translate, bool fullPath, uint32 wordwrapAt) {
DetectedGames detectedGames;
detectedGames.push_back(detectedGame);
return generateUnknownGameReport(detectedGames, translate, fullPath, wordwrapAt);
}
|