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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/* 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.
*
* $URL$
* $Id$
*
*/
#include "common/util.h"
#include "common/system.h"
#include "common/events.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
#include "common/xmlparser.h"
#include "gui/InterfaceManager.h"
#include "gui/ThemeParser.h"
#include "graphics/VectorRenderer.h"
namespace GUI {
using namespace Graphics;
using namespace Common;
ThemeParser::ThemeParser() : XMLParser() {
_callbacks["drawstep"] = &ThemeParser::parserCallback_DRAWSTEP;
_callbacks["drawdata"] = &ThemeParser::parserCallback_DRAWDATA;
_callbacks["palette"] = &ThemeParser::parserCallback_palette;
_callbacks["color"] = &ThemeParser::parserCallback_color;
_callbacks["render_info"] = &ThemeParser::parserCallback_renderInfo;
_callbacks["layout_info"] = &ThemeParser::parserCallback_layoutInfo;
_drawFunctions["circle"] = &Graphics::VectorRenderer::drawCallback_CIRCLE;
_drawFunctions["square"] = &Graphics::VectorRenderer::drawCallback_SQUARE;
_drawFunctions["roundedsq"] = &Graphics::VectorRenderer::drawCallback_ROUNDSQ;
_drawFunctions["bevelsq"] = &Graphics::VectorRenderer::drawCallback_BEVELSQ;
_drawFunctions["line"] = &Graphics::VectorRenderer::drawCallback_LINE;
_drawFunctions["triangle"] = &Graphics::VectorRenderer::drawCallback_TRIANGLE;
_drawFunctions["fill"] = &Graphics::VectorRenderer::drawCallback_FILLSURFACE;
_drawFunctions["void"] = &Graphics::VectorRenderer::drawCallback_VOID;
}
bool ThemeParser::keyCallback(Common::String keyName) {
// automatically handle with a function from the hash table.
if (!_callbacks.contains(_activeKey.top()->name))
return parserError("%s is not a valid key name.", keyName.c_str());
return (this->*(_callbacks[_activeKey.top()->name]))();
}
Graphics::DrawStep *ThemeParser::newDrawStep() {
Graphics::DrawStep *step = new DrawStep;
step->fgColor.set = false;
step->bgColor.set = false;
step->gradColor1.set = false;
step->gradColor2.set = false;
step->extraData = 0;
step->factor = 1;
step->fillArea = true;
step->fillMode = Graphics::VectorRenderer::kFillDisabled;
step->scale = (1 << 16);
step->shadow = 0;
step->stroke = 1;
return step;
}
bool ThemeParser::parserCallback_renderInfo() {
ParserNode *infoNode = getActiveNode();
assert(infoNode->name == "render_info");
if (getParentNode(infoNode) != 0)
return parserError("<render_info> keys must be root elements.");
// TODO: Skip key if it's not for this platform.
return true;
}
bool ThemeParser::parserCallback_layoutInfo() {
ParserNode *layoutNode = getActiveNode();
assert(layoutNode->name == "layout_info");
if (getParentNode(layoutNode) != 0)
return parserError("<layout_info> keys must be root elements.");
return true;
}
bool ThemeParser::parserCallback_palette() {
ParserNode *paletteNode = getActiveNode();
assert(paletteNode->name == "palette");
if (getParentNode(paletteNode) == 0 || getParentNode(paletteNode)->name != "render_info")
return parserError("Palette keys must be contained inside a <render_info> section.");
return true;
}
bool ThemeParser::parserCallback_color() {
ParserNode *colorNode = getActiveNode();
if (getParentNode(colorNode) == 0 || getParentNode(colorNode)->name != "palette")
return parserError("Colors must be specified inside <palette> tags.");
if (!colorNode->values.contains("name") || !colorNode->values.contains("rgb"))
return parserError("Color keys must contain 'name' and 'rgb' values for the color.");
Common::String name = colorNode->values["name"];
if (_palette.contains(name))
return parserError("Color '%s' has already been defined.", name.c_str());
int red, green, blue;
if (sscanf(colorNode->values["rgb"].c_str(), "%d, %d, %d", &red, &green, &blue) != 3 ||
red < 0 || red > 255 || green < 0 || green > 255 || blue < 0 || blue > 255)
return parserError("Error when parsing RGB values for palette color '%s'", name.c_str());\
_palette[name].r = red;
_palette[name].g = green;
_palette[name].b = blue;
return true;
}
bool ThemeParser::parserCallback_DRAWSTEP() {
ParserNode *stepNode = _activeKey.top();
ParserNode *drawdataNode = getParentNode(stepNode);
if (!drawdataNode || drawdataNode->name != "drawdata")
return parserError("DrawStep keys must be located inside a DrawData set.");
assert(stepNode->name == "drawstep");
assert(drawdataNode->values.contains("id"));
Graphics::DrawStep *drawstep = newDrawStep();
Common::String functionName = stepNode->values["func"];
if (_drawFunctions.contains(functionName) == false)
return parserError("%s is not a valid drawing function name", functionName.c_str());
drawstep->drawingCall = _drawFunctions[functionName];
int red, green, blue, w, h;
Common::String val;
/**
* Helper macro to sanitize and assign an integer value from a key
* to the draw step.
*
* @param struct_name Name of the field of a DrawStep struct that must be
* assigned.
* @param key_name Name as STRING of the key identifier as it appears in the
* theme description format.
* @param force Sets if the key is optional or necessary.
*/
#define __PARSER_ASSIGN_INT(struct_name, key_name, force) \
if (stepNode->values.contains(key_name)) { \
if (!validateKeyInt(stepNode->values[key_name].c_str()))\
return parserError("Error when parsing key value for '%s'.", key_name); \
\
drawstep->struct_name = atoi(stepNode->values[key_name].c_str()); \
} else if (force) { \
return parserError("Missing necessary key '%s'.", key_name); \
}
/**
* Helper macro to sanitize and assign a RGB value from a key to the draw
* step. RGB values have the following syntax: "R, G, B".
*
* TODO: Handle also specific name colors such as "red", "green", etc.
*
* @param struct_name Name of the field of a DrawStep struct that must be
* assigned.
* @param key_name Name as STRING of the key identifier as it appears in the
* theme description format.
*/
#define __PARSER_ASSIGN_RGB(struct_name, key_name) \
if (stepNode->values.contains(key_name)) { \
val = stepNode->values[key_name]; \
if (_palette.contains(val)) { \
red = _palette[val].r; \
green = _palette[val].g; \
blue = _palette[val].b; \
} else if (sscanf(val.c_str(), "%d, %d, %d", &red, &green, &blue) != 3 || \
red < 0 || red > 255 || green < 0 || green > 255 || blue < 0 || blue > 255) \
return parserError("Error when parsing color struct '%s'", val.c_str());\
\
drawstep->struct_name.r = red; \
drawstep->struct_name.g = green; \
drawstep->struct_name.b = blue; \
drawstep->struct_name.set = true; \
}
__PARSER_ASSIGN_INT(stroke, "stroke", false);
__PARSER_ASSIGN_INT(shadow, "shadow", false);
__PARSER_ASSIGN_INT(factor, "gradient_factor", false);
__PARSER_ASSIGN_RGB(fgColor, "fg_color");
__PARSER_ASSIGN_RGB(bgColor, "bg_color");
__PARSER_ASSIGN_RGB(gradColor1, "gradient_start");
__PARSER_ASSIGN_RGB(gradColor2, "gradient_end");
if (functionName == "roundedsq" || functionName == "circle") {
__PARSER_ASSIGN_INT(radius, "radius", true)
}
if (functionName == "bevelsq") {
__PARSER_ASSIGN_INT(extraData, "bevel", true);
}
if (functionName == "triangle") {
drawstep->extraData = VectorRenderer::kTriangleUp;
if (stepNode->values.contains("orientation")) {
val = stepNode->values["orientation"];
if ( val == "top")
drawstep->extraData = VectorRenderer::kTriangleUp;
else if (val == "bottom")
drawstep->extraData = VectorRenderer::kTriangleDown;
else if (val == "left")
drawstep->extraData = VectorRenderer::kTriangleLeft;
else if (val == "right")
drawstep->extraData = VectorRenderer::kTriangleRight;
else
return parserError("'%s' is not a valid value for triangle orientation.", val.c_str());
}
}
if (stepNode->values.contains("size")) {
if (stepNode->values["size"] == "auto") {
drawstep->fillArea = true;
} else if (sscanf(stepNode->values["size"].c_str(), "%d, %d", &w, &h) == 2) {
drawstep->fillArea = false;
drawstep->w = w;
drawstep->h = h;
} else {
return parserError("Invalid value in 'size' subkey: Valid options are 'auto' or 'X, X' to define width and height.");
}
}
if (stepNode->values.contains("fill")) {
val = stepNode->values["fill"];
if (val == "none")
drawstep->fillMode = VectorRenderer::kFillDisabled;
else if (val == "foreground")
drawstep->fillMode = VectorRenderer::kFillForeground;
else if (val == "background")
drawstep->fillMode = VectorRenderer::kFillBackground;
else if (val == "gradient")
drawstep->fillMode = VectorRenderer::kFillGradient;
else
return parserError("'%s' is not a valid fill mode for a shape.", stepNode->values["fill"].c_str());
}
#undef __PARSER_ASSIGN_INT
#undef __PARSER_ASSIGN_RGB
g_InterfaceManager.addDrawStep(drawdataNode->values["id"], drawstep);
return true;
}
bool ThemeParser::parserCallback_DRAWDATA() {
ParserNode *drawdataNode = _activeKey.top();
bool cached = false;
assert(drawdataNode->name == "drawdata");
if (getParentNode(drawdataNode) == 0 || getParentNode(drawdataNode)->name != "render_info")
return parserError("DrawData keys must be contained inside a <render_info> section.");
if (drawdataNode->values.contains("id") == false)
return parserError("DrawData keys must contain an identifier.");
InterfaceManager::DrawData id = g_InterfaceManager.getDrawDataId(drawdataNode->values["id"]);
if (id == -1)
return parserError("%s is not a valid DrawData set identifier.", drawdataNode->values["id"].c_str());
if (drawdataNode->values.contains("cached") && drawdataNode->values["cached"] == "true") {
cached = true;
}
// Both Max and Johannes suggest using a non-platform specfic approach based on available
// resources and active resolution. getHostPlatformString() has been removed, so fix this.
/* if (drawdataNode->values.contains("platform")) {
if (drawdataNode->values["platform"].compareToIgnoreCase(Common::getHostPlatformString()) != 0) {
drawdataNode->ignore = true;
return true;
}
}*/
if (g_InterfaceManager.addDrawData(id, cached) == false)
return parserError("Repeated DrawData: Only one set of Drawing Data for a widget may be specified on each platform.");
return true;
}
}
|