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
|
/* 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 "gui/unknown-game-dialog.h"
#include "common/translation.h"
#include "common/str-array.h"
#include "common/system.h"
#include "gui/gui-manager.h"
#include "gui/message.h"
#include "gui/ThemeEval.h"
#include "gui/widgets/popup.h"
#include "gui/widgets/scrollcontainer.h"
namespace GUI {
enum {
kCopyToClipboard = 'cpcl',
kOpenBugtrackerURL = 'ourl',
kClose = 'clse',
kScrollContainerReflow = 'SCRf'
};
UnknownGameDialog::UnknownGameDialog(const DetectionResults &detectionResults) :
Dialog(30, 20, 260, 124),
_detectionResults(detectionResults) {
// For now place the buttons with a default place and size. They will be resized and moved when rebuild() is called.
_closeButton = new ButtonWidget(this, 0, 0, 0, 0, _("Close"), 0, kClose);
//Check if we have clipboard functionality
if (g_system->hasFeature(OSystem::kFeatureClipboardSupport)) {
_copyToClipboardButton = new ButtonWidget(this, 0, 0, 0, 0, _("Copy to clipboard"), 0, kCopyToClipboard);
} else
_copyToClipboardButton = nullptr;
//Check if we have support for opening URLs
if (g_system->hasFeature(OSystem::kFeatureOpenUrl)) {
_openBugTrackerUrlButton = new ButtonWidget(this, 0, 0, 0, 0, _("Report game"), 0, kOpenBugtrackerURL);
} else
_openBugTrackerUrlButton = nullptr;
// Use a ScrollContainer for the report in case we have a lot of lines.
_textContainer = new ScrollContainerWidget(this, 0, 0, 0, 0, kScrollContainerReflow);
_textContainer->setTarget(this);
rebuild();
}
void UnknownGameDialog::handleMouseWheel(int x, int y, int direction) {
_textContainer->handleMouseWheel(x, y, direction);
}
void UnknownGameDialog::reflowLayout() {
rebuild();
Dialog::reflowLayout();
}
void UnknownGameDialog::rebuild() {
// First remove the old text widgets
for (uint i = 0; i < _textWidgets.size() ; i++) {
_textContainer->removeWidget(_textWidgets[i]);
delete _textWidgets[i];
}
_textWidgets.clear();
// Work out dialog size and position of the various elements in the dialog.
// Limit the width of the dialog to 600 - 2 * 10 pixels.
const int screenW = MIN((int)g_system->getOverlayWidth(), 600);
const int screenH = g_system->getOverlayHeight();
int buttonHeight = g_gui.xmlEval()->getVar("Globals.Button.Height", 0);
int buttonWidth = g_gui.xmlEval()->getVar("Globals.Button.Width", 0);
Common::String reportTranslated = _detectionResults.generateUnknownGameReport(true);
// Check if we have clipboard functionality and expand the reportTranslated message if needed...
if (g_system->hasFeature(OSystem::kFeatureClipboardSupport)) {
reportTranslated += "\n";
reportTranslated += _("Use the button below to copy the required game information into your clipboard.");
}
// Check if we have support for opening URLs and expand the reportTranslated message if needed...
if (g_system->hasFeature(OSystem::kFeatureOpenUrl)) {
reportTranslated += "\n";
reportTranslated += _("You can also directly report your game to the Bug Tracker.");
}
// We use a ScrollContainer to display the text, with a 2 * 8 pixels margin to the dialog border,
// the scrollbar, and 2 * 10 margin for the text in the container.
// We also keep 2 * 10 pixels between the screen border and the dialog.
int scrollbarWidth = g_gui.xmlEval()->getVar("Globals.Scrollbar.Width", 0);
Common::Array<Common::String> lines;
int maxlineWidth = g_gui.getFont().wordWrapText(reportTranslated, screenW - 2 * 20 - 16 - scrollbarWidth, lines);
int lineCount = lines.size() + 1;
_h = MIN(screenH - 20, lineCount * kLineHeight + kLineHeight + buttonHeight + 24);
int closeButtonWidth = MAX(buttonWidth, g_gui.getFont().getStringWidth(_closeButton->getLabel()) + 10);
int copyToClipboardButtonWidth = 0, openBugtrackerURLButtonWidth = 0, totalButtonWidth = closeButtonWidth;
if (_copyToClipboardButton) {
copyToClipboardButtonWidth = MAX(buttonWidth, g_gui.getFont().getStringWidth(_copyToClipboardButton->getLabel()) + 10);
totalButtonWidth += copyToClipboardButtonWidth + 10;
}
if (_openBugTrackerUrlButton) {
openBugtrackerURLButtonWidth = MAX(buttonWidth, g_gui.getFont().getStringWidth(_openBugTrackerUrlButton->getLabel()) + 10);
totalButtonWidth += openBugtrackerURLButtonWidth + 10;
}
_w = MAX(MAX(maxlineWidth, 0) + 16 + scrollbarWidth, totalButtonWidth) + 20;
// Center the dialog on the screen
_x = (g_system->getOverlayWidth() - _w) / 2;
_y = (g_system->getOverlayHeight() - _h) / 2;
// Now move the buttons and text container to their proper place
int buttonPos = _w - closeButtonWidth - 10;
_closeButton->resize(buttonPos, _h - buttonHeight - 8, closeButtonWidth, buttonHeight);
if (_copyToClipboardButton) {
buttonPos -= copyToClipboardButtonWidth + 5;
_copyToClipboardButton->resize(buttonPos, _h - buttonHeight - 8, copyToClipboardButtonWidth, buttonHeight);
}
if (_openBugTrackerUrlButton) {
buttonPos -= openBugtrackerURLButtonWidth + 5;
_openBugTrackerUrlButton->resize(buttonPos, _h - buttonHeight - 8, openBugtrackerURLButtonWidth, buttonHeight);
}
int containerHeight = _h - kLineHeight - buttonHeight - 16;
_textContainer->resize(8, 8, _w - 16, containerHeight);
// And create text widgets
uint y = 8;
for (uint i = 0; i < lines.size() ; i++) {
StaticTextWidget *widget = new StaticTextWidget(_textContainer, 10, y, _w - 36 - scrollbarWidth, kLineHeight, lines[i], Graphics::kTextAlignLeft);
_textWidgets.push_back(widget);
y += kLineHeight;
}
}
Common::String UnknownGameDialog::encodeUrlString(const Common::String& string) {
Common::String encoded;
for (uint i = 0 ; i < string.size() ; ++i) {
char c = string[i];
if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') ||
c == '~' || c == '-' || c == '.' || c == '_')
encoded += c;
else
encoded += Common::String::format("%%%02X", c);
}
return encoded;
}
Common::String UnknownGameDialog::generateBugtrackerURL() {
Common::String report = _detectionResults.generateUnknownGameReport(false);
// Remove the filesystem path from the bugtracker report.
// The path is on the first line between single quotes. We strip everything except the last level.
int path_start = -1, path_size = 0;
for (int i = 0 ; i < report.size() ; ++i) {
char c = report[i];
if (c == '\'') {
if (path_start == -1)
path_start = i + 1;
else
break;
} else if (path_start != -1 && (c == '/' || c == '\\')) {
path_size = 1 + i - path_start;
} else if (c == '\n') {
path_size = 0;
break;
}
}
if (path_size > 0)
report.erase(path_start, path_size);
report = encodeUrlString(report);
// Pass engine name if there is only one.
Common::String engineName = "unknown";
Common::StringArray engines = _detectionResults.getUnknownGameEngines();
if (engines.size() == 1)
engineName = engines.front();
engineName = encodeUrlString(engineName);
return Common::String::format(
"https://www.scummvm.org/unknowngame?"
"engine=%s"
"&description=%s",
engineName.c_str(),
report.c_str());
}
void UnknownGameDialog::handleCommand(CommandSender *sender, uint32 cmd, uint32 data) {
switch(cmd) {
case kCopyToClipboard: {
// TODO: Remove the filesystem path from the report
Common::String report = _detectionResults.generateUnknownGameReport(false);
if (g_system->setTextInClipboard(report)) {
g_system->displayMessageOnOSD(
_("All necessary information about your game has been copied into the clipboard"));
} else {
g_system->displayMessageOnOSD(_("Copying the game information to the clipboard has failed!"));
}
break;
}
case kClose:
// When the detection entry comes from the fallback detector, the game can be added / launched anyways.
// TODO: Add a button to cancel adding the game. And make it clear that launching the game may not work properly.
close();
break;
case kOpenBugtrackerURL:
g_system->openUrl(generateBugtrackerURL());
break;
case kScrollContainerReflow:
for (uint i = 0; i < _textWidgets.size() ; i++)
_textWidgets[i]->setVisible(true);
break;
}
}
} // End of namespace GUI
|
