/
DefParserTest.cpp
416 lines (338 loc) · 19.7 KB
/
DefParserTest.cpp
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/*
Copyright (C) 2010-2017 Kristian Duske
This file is part of TrenchBroom.
TrenchBroom 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.
TrenchBroom 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 TrenchBroom. If not, see <http://www.gnu.org/licenses/>.
*/
#include <gtest/gtest.h>
#include "CollectionUtils.h"
#include "Assets/AssetTypes.h"
#include "Assets/AttributeDefinition.h"
#include "Assets/EntityDefinition.h"
#include "Assets/EntityDefinitionTestUtils.h"
#include "Model/ModelTypes.h"
#include "IO/DefParser.h"
#include "IO/DiskIO.h"
#include "IO/Path.h"
#include "IO/TestParserStatus.h"
#include "TestUtils.h"
namespace TrenchBroom {
namespace IO {
TEST(DefParserTest, parseIncludedDefFiles) {
const Path basePath = Disk::getCurrentWorkingDir() + Path("data/games");
const Path::List cfgFiles = Disk::findItemsRecursively(basePath, IO::FileExtensionMatcher("def"));
for (const Path& path : cfgFiles) {
MappedFile::Ptr file = Disk::openFile(path);
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file->begin(), file->end(), defaultColor);
TestParserStatus status;
ASSERT_NO_THROW(parser.parseDefinitions(status)) << "Parsing DEF file " << path.asString() << " failed";
ASSERT_EQ(0u, status.countStatus(Logger::LogLevel_Warn)) << "Parsing DEF file " << path.asString() << " produced warnings";
ASSERT_EQ(0u, status.countStatus(Logger::LogLevel_Error)) << "Parsing DEF file " << path.asString() << " produced errors";
}
}
TEST(DefParserTest, parseExtraDefFiles) {
const Path basePath = Disk::getCurrentWorkingDir() + Path("data/IO/Def");
const Path::List cfgFiles = Disk::findItems(basePath, [] (const Path& path, bool directory) {
return !directory && StringUtils::caseInsensitiveEqual(path.extension(), "def");
});
for (const Path& path : cfgFiles) {
MappedFile::Ptr file = Disk::openFile(path);
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file->begin(), file->end(), defaultColor);
TestParserStatus status;
ASSERT_NO_THROW(parser.parseDefinitions(status));
ASSERT_EQ(0u, status.countStatus(Logger::LogLevel_Warn));
ASSERT_EQ(0u, status.countStatus(Logger::LogLevel_Error));
}
}
TEST(DefParserTest, parseEmptyFile) {
const String file = "";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_TRUE(definitions.empty());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parseWhitespaceFile) {
const String file = " \n \t \n ";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_TRUE(definitions.empty());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parseCommentsFile) {
const String file = "// asdfasdfasdf\n//kj3k4jkdjfkjdf\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_TRUE(definitions.empty());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parseSolidClass) {
const String file =
"/*QUAKED worldspawn (0.0 0.0 0.0) ?\n"
"{\n"
"choice \"worldtype\"\n"
" (\n"
" (0,\"medieval\")\n"
" (1,\"metal\")\n"
" (2,\"base\")\n"
" );\n"
"}\n"
"Only used for the world entity. "
"Set message to the level name. "
"Set sounds to the cd track to play. "
"\"worldtype\" type of world\n"
"*/\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_EQ(1u, definitions.size());
Assets::EntityDefinition* definition = definitions[0];
ASSERT_EQ(Assets::EntityDefinition::Type_BrushEntity, definition->type());
ASSERT_EQ(String("worldspawn"), definition->name());
ASSERT_VEC_EQ(Color(0.0f, 0.0f, 0.0f, 1.0f), definition->color());
ASSERT_EQ(String("Only used for the world entity. "
"Set message to the level name. "
"Set sounds to the cd track to play. "
"\"worldtype\" type of world"), definition->description());
const Assets::AttributeDefinitionList& attributes = definition->attributeDefinitions();
ASSERT_EQ(1u, attributes.size());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parsePointClass) {
const String file =
"/*QUAKED monster_zombie (1.0 0.0 0.0) (-16 -16 -24) (16 16 32) Crucified ambush\n"
"If crucified, stick the bounding box 12 pixels back into a wall to look right.\n"
"*/\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_EQ(1u, definitions.size());
Assets::EntityDefinition* definition = definitions[0];
ASSERT_EQ(Assets::EntityDefinition::Type_PointEntity, definition->type());
ASSERT_EQ(String("monster_zombie"), definition->name());
ASSERT_VEC_EQ(Color(1.0f, 0.0f, 0.0f, 1.0f), definition->color());
ASSERT_EQ(String("If crucified, stick the bounding box 12 pixels back into a wall to look right."), definition->description());
Assets::PointEntityDefinition* pointDefinition = static_cast<Assets::PointEntityDefinition*>(definition);
ASSERT_VEC_EQ(vm::vec3(-16.0, -16.0, -24.0), pointDefinition->bounds().min);
ASSERT_VEC_EQ(vm::vec3(16.0, 16.0, 32.0), pointDefinition->bounds().max);
const Assets::AttributeDefinitionList& attributes = definition->attributeDefinitions();
ASSERT_EQ(1u, attributes.size()); // spawnflags
const Assets::AttributeDefinitionPtr attribute = attributes[0];
ASSERT_EQ(Assets::AttributeDefinition::Type_FlagsAttribute, attribute->type());
const Assets::FlagsAttributeDefinition* spawnflags = definition->spawnflags();
ASSERT_TRUE(spawnflags != nullptr);
ASSERT_EQ(0, spawnflags->defaultValue());
const Assets::FlagsAttributeOption::List& options = spawnflags->options();
ASSERT_EQ(2u, options.size());
ASSERT_EQ(1, options[0].value());
ASSERT_EQ(String("Crucified"), options[0].shortDescription());
ASSERT_FALSE(options[0].isDefault());
ASSERT_EQ(2, options[1].value());
ASSERT_EQ(String("ambush"), options[1].shortDescription());
ASSERT_FALSE(options[1].isDefault());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parseSpawnflagWithSkip) {
const String file =
"/*QUAKED item_health (.3 .3 1) (-16 -16 -16) (16 16 16) - SUSPENDED SPIN - RESPAWN\n"
"some desc\n"
"*/\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_EQ(1u, definitions.size());
Assets::EntityDefinition* definition = definitions[0];
ASSERT_EQ(Assets::EntityDefinition::Type_PointEntity, definition->type());
ASSERT_EQ(String("item_health"), definition->name());
ASSERT_VEC_EQ(Color(0.3f, 0.3f, 1.0f, 1.0f), definition->color());
ASSERT_EQ(String("some desc"), definition->description());
Assets::PointEntityDefinition* pointDefinition = static_cast<Assets::PointEntityDefinition*>(definition);
ASSERT_VEC_EQ(vm::vec3(-16.0, -16.0, -16.0), pointDefinition->bounds().min);
ASSERT_VEC_EQ(vm::vec3(16.0, 16.0, 16.0), pointDefinition->bounds().max);
const Assets::AttributeDefinitionList& attributes = definition->attributeDefinitions();
ASSERT_EQ(1u, attributes.size()); // spawnflags
const Assets::AttributeDefinitionPtr attribute = attributes[0];
ASSERT_EQ(Assets::AttributeDefinition::Type_FlagsAttribute, attribute->type());
const Assets::FlagsAttributeDefinition* spawnflags = definition->spawnflags();
ASSERT_TRUE(spawnflags != nullptr);
ASSERT_EQ(0, spawnflags->defaultValue());
const Assets::FlagsAttributeOption::List& options = spawnflags->options();
ASSERT_EQ(5u, options.size());
ASSERT_EQ(String(""), options[0].shortDescription());
ASSERT_FALSE(options[0].isDefault());
ASSERT_EQ(1, options[0].value());
ASSERT_EQ(String("SUSPENDED"), options[1].shortDescription());
ASSERT_FALSE(options[1].isDefault());
ASSERT_EQ(2, options[1].value());
ASSERT_EQ(String("SPIN"), options[2].shortDescription());
ASSERT_FALSE(options[2].isDefault());
ASSERT_EQ(4, options[2].value());
ASSERT_EQ(String(""), options[3].shortDescription());
ASSERT_FALSE(options[3].isDefault());
ASSERT_EQ(8, options[3].value());
ASSERT_EQ(String("RESPAWN"), options[4].shortDescription());
ASSERT_FALSE(options[4].isDefault());
ASSERT_EQ(16, options[4].value());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parseBrushEntityWithMissingBBoxAndNoQuestionMark) {
const String file =
"/*QUAKED item_health (.3 .3 1) SUSPENDED SPIN - RESPAWN\n"
"some desc\n"
"*/\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_EQ(1u, definitions.size());
Assets::EntityDefinition* definition = definitions[0];
ASSERT_EQ(Assets::EntityDefinition::Type_BrushEntity, definition->type());
ASSERT_EQ(String("item_health"), definition->name());
ASSERT_VEC_EQ(Color(0.3f, 0.3f, 1.0f, 1.0f), definition->color());
ASSERT_EQ(String("some desc"), definition->description());
const Assets::AttributeDefinitionList& attributes = definition->attributeDefinitions();
ASSERT_EQ(1u, attributes.size()); // spawnflags
const Assets::AttributeDefinitionPtr attribute = attributes[0];
ASSERT_EQ(Assets::AttributeDefinition::Type_FlagsAttribute, attribute->type());
const Assets::FlagsAttributeDefinition* spawnflags = definition->spawnflags();
ASSERT_TRUE(spawnflags != nullptr);
ASSERT_EQ(0, spawnflags->defaultValue());
const Assets::FlagsAttributeOption::List& options = spawnflags->options();
ASSERT_EQ(4u, options.size());
ASSERT_EQ(String("SUSPENDED"), options[0].shortDescription());
ASSERT_FALSE(options[0].isDefault());
ASSERT_EQ(1, options[0].value());
ASSERT_EQ(String("SPIN"), options[1].shortDescription());
ASSERT_FALSE(options[1].isDefault());
ASSERT_EQ(2, options[1].value());
ASSERT_EQ(String(""), options[2].shortDescription());
ASSERT_FALSE(options[2].isDefault());
ASSERT_EQ(4, options[2].value());
ASSERT_EQ(String("RESPAWN"), options[3].shortDescription());
ASSERT_FALSE(options[3].isDefault());
ASSERT_EQ(8, options[3].value());
VectorUtils::clearAndDelete(definitions);
}
TEST(DefParserTest, parsePointClassWithBaseClasses) {
const String file =
"/*QUAKED _light_style\n"
"{\n"
"choice \"style\"\n"
" (\n"
" (0,\"normal\")\n"
" (1,\"flicker (first variety)\")\n"
" (2,\"slow strong pulse\")\n"
" (3,\"candle (first variety)\")\n"
" (4,\"fast strobe\")\n"
" (5,\"gentle pulse 1\")\n"
" (6,\"flicker (second variety)\")\n"
" (7,\"candle (second variety)\")\n"
" (8,\"candle (third variety)\")\n"
" (9,\"slow strobe (fourth variety)\")\n"
" (10,\"fluorescent flicker\")\n"
" (11,\"slow pulse not fade to black\")\n"
" );\n"
"}\n"
"*/\n"
"\n"
"/*QUAKED light (0.0 1.0 0.0) (-8 -8 -8) (8 8 8) START_OFF\n"
"{\n"
"base(\"_light_style\");\n"
"}\n"
"Non-displayed light.\n"
"Default light value is 300\n"
"If targeted, it will toggle between on or off.\n"
"Default \"style\" is 0.\n"
"*/\n";
const Color defaultColor(1.0f, 1.0f, 1.0f, 1.0f);
DefParser parser(file, defaultColor);
TestParserStatus status;
Assets::EntityDefinitionList definitions = parser.parseDefinitions(status);
ASSERT_EQ(1u, definitions.size());
Assets::EntityDefinition* definition = definitions[0];
ASSERT_EQ(Assets::EntityDefinition::Type_PointEntity, definition->type());
ASSERT_EQ(String("light"), definition->name());
const Assets::AttributeDefinitionList& attributes = definition->attributeDefinitions();
ASSERT_EQ(2u, attributes.size()); // spawn flags and style
Assets::AttributeDefinitionPtr spawnflags = attributes[0];
ASSERT_EQ(Model::AttributeNames::Spawnflags, spawnflags->name());
ASSERT_EQ(Assets::AttributeDefinition::Type_FlagsAttribute, spawnflags->type());
Assets::AttributeDefinitionPtr style = attributes[1];
ASSERT_EQ(String("style"), style->name());
ASSERT_EQ(Assets::AttributeDefinition::Type_ChoiceAttribute, style->type());
const Assets::ChoiceAttributeDefinition* choice = static_cast<const Assets::ChoiceAttributeDefinition*>(definition->attributeDefinition("style"));
ASSERT_EQ(12u, choice->options().size());
VectorUtils::clearAndDelete(definitions);
}
static const String ModelDefinitionTemplate =
"/*QUAKED monster_zombie (1.0 0.0 0.0) (-16 -16 -24) (16 16 32) Crucified ambush\n"
"{\n"
"model(${MODEL});\n"
"}\n"
"*/\n";
using Assets::assertModelDefinition;
TEST(DefParserTest, parseLegacyStaticModelDefinition) {
static const String ModelDefinition = "\":maps/b_shell0.bsp\", \":maps/b_shell1.bsp\" spawnflags = 1";
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell0.bsp")),
ModelDefinition,
ModelDefinitionTemplate);
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp")),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'spawnflags': 1 }");
}
TEST(DefParserTest, parseLegacyDynamicModelDefinition) {
static const String ModelDefinition = "pathKey = \"model\" skinKey = \"skin\" frameKey = \"frame\"";
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp")),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'model': 'maps/b_shell1.bsp' }");
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp"), 1, 2),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'model': 'maps/b_shell1.bsp', 'skin': 1, 'frame': 2 }");
}
TEST(DefParserTest, parseELStaticModelDefinition) {
static const String ModelDefinition = "{{ spawnflags == 1 -> 'maps/b_shell1.bsp', 'maps/b_shell0.bsp' }}";
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell0.bsp")),
ModelDefinition,
ModelDefinitionTemplate);
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp")),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'spawnflags': 1 }");
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell0.bsp")),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'spawnflags': 2 }");
}
TEST(DefParserTest, parseELDynamicModelDefinition) {
static const String ModelDefinition = "{ 'path': model, 'skin': skin, 'frame': frame }";
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp")),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'model': 'maps/b_shell1.bsp' }");
assertModelDefinition<DefParser>(Assets::ModelSpecification(IO::Path("maps/b_shell1.bsp"), 1, 2),
ModelDefinition,
ModelDefinitionTemplate,
"{ 'model': 'maps/b_shell1.bsp', 'skin': 1, 'frame': 2 }");
} }
}