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
|
/* 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/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;
}
DetectedGame::DetectedGame() :
engineName(nullptr),
hasUnknownFiles(false),
canBeAdded(true),
language(Common::UNK_LANG),
platform(Common::kPlatformUnknown),
gameSupportLevel(kStableGame) {
}
DetectedGame::DetectedGame(const PlainGameDescriptor &pgd) :
engineName(nullptr),
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 &id, const Common::String &d, Common::Language l, Common::Platform p, const Common::String &ex) :
engineName(nullptr),
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();
}
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() const {
const bool hasCustomLanguage = (language != Common::UNK_LANG);
const bool hasCustomPlatform = (platform != Common::kPlatformUnknown);
const bool hasExtraDesc = !extra.empty();
// 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;
}
Common::String DetectionResults::generateUnknownGameReport(bool translate, uint32 wordwrapAt) const {
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::String report = Common::String::format(
translate ? _(reportStart) : reportStart, _detectedGames[0].path.c_str(),
"https://bugs.scummvm.org/"
);
report += "\n";
FilePropertiesMap matchedFiles;
const char *currentEngineName = nullptr;
for (uint i = 0; i < _detectedGames.size(); i++) {
const DetectedGame &game = _detectedGames[i];
if (!game.hasUnknownFiles) continue;
if (!currentEngineName || strcmp(currentEngineName, game.engineName) != 0) {
currentEngineName = game.engineName;
// If the engine is not the same as for the previous entry, print an engine line header
report += "\n";
report += Common::String::format(
translate ? _(reportEngineHeader) : reportEngineHeader,
game.engineName
);
report += " ";
} else {
report += ", ";
}
// 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++) {
matchedFiles.setVal(it->_key, it->_value);
}
}
if (wordwrapAt) {
report.wordWrap(wordwrapAt);
}
report += "\n\n";
for (FilePropertiesMap::const_iterator file = matchedFiles.begin(); file != matchedFiles.end(); ++file)
report += Common::String::format(" {\"%s\", 0, \"%s\", %d},\n", file->_key.c_str(), file->_value.md5.c_str(), file->_value.size);
report += "\n";
return report;
}
Common::StringArray DetectionResults::getUnknownGameEngines() const {
Common::StringArray engines;
const char *currentEngineName = nullptr;
for (uint i = 0; i < _detectedGames.size(); i++) {
const DetectedGame &game = _detectedGames[i];
if (!game.hasUnknownFiles)
continue;
if (!currentEngineName || strcmp(currentEngineName, game.engineName) != 0) {
currentEngineName = game.engineName;
engines.push_back(Common::String(currentEngineName));
}
}
return engines;
}
|
