2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "iscriplib.h"
25 #include "ifiletypes.h"
27 #include "qerplugin.h"
30 #include "string/string.h"
32 #include "generic/constant.h"
34 #include "modulesystem/singletonmodule.h"
40 class MapDoom3Dependencies :
41 public GlobalRadiantModuleRef,
42 public GlobalFiletypesModuleRef,
43 public GlobalScripLibModuleRef,
44 public GlobalEntityClassManagerModuleRef,
45 public GlobalSceneGraphModuleRef,
46 public GlobalBrushModuleRef {
47 PatchModuleRef m_patchDef2Doom3Module;
48 PatchModuleRef m_patchDoom3Module;
50 MapDoom3Dependencies() :
51 GlobalEntityClassManagerModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("entityclass")),
52 GlobalBrushModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("brushtypes")),
53 m_patchDef2Doom3Module("def2doom3"),
54 m_patchDoom3Module("doom3")
58 BrushCreator &getBrushDoom3()
60 return GlobalBrushModule::getTable();
63 PatchCreator &getPatchDoom3()
65 return *m_patchDoom3Module.getTable();
68 PatchCreator &getPatchDef2Doom3()
70 return *m_patchDef2Doom3Module.getTable();
74 class MapDoom3API : public TypeSystemRef, public MapFormat, public PrimitiveParser {
75 MapDoom3Dependencies &m_dependencies;
77 typedef MapFormat Type;
79 STRING_CONSTANT(Name, "mapdoom3");
81 UINT_CONSTANT(MapVersion, 2);
83 MapDoom3API(MapDoom3Dependencies &dependencies) : m_dependencies(dependencies)
85 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("doom3 maps", "*.map"));
86 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("doom3 region", "*.reg"));
94 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
96 const char *primitive = tokeniser.getToken();
98 if (string_equal(primitive, "patchDef3")) {
99 return m_dependencies.getPatchDoom3().createPatch();
100 } else if (string_equal(primitive, "patchDef2")) {
101 return m_dependencies.getPatchDef2Doom3().createPatch();
102 } else if (string_equal(primitive, "brushDef3")) {
103 return m_dependencies.getBrushDoom3().createBrush();
107 Tokeniser_unexpectedError(tokeniser, primitive, "#doom3-primitive");
111 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
113 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
114 tokeniser.nextLine();
115 if (!Tokeniser_parseToken(tokeniser, "Version")) {
119 if (!Tokeniser_getSize(tokeniser, version)) {
122 if (version != MapVersion()) {
123 globalErrorStream() << "Doom 3 map version " << MapVersion() << " supported, version is "
124 << Unsigned(version) << "\n";
127 tokeniser.nextLine();
128 Map_Read(root, tokeniser, entityTable, *this);
132 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
134 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
135 writer.writeToken("Version");
136 writer.writeInteger(MapVersion());
138 Map_Write(root, traverse, writer, false);
143 typedef SingletonModule<
145 MapDoom3Dependencies,
146 DependenciesAPIConstructor<MapDoom3API, MapDoom3Dependencies>
150 MapDoom3Module g_MapDoom3Module;
153 class MapQuake4API : public TypeSystemRef, public MapFormat, public PrimitiveParser {
154 MapDoom3Dependencies &m_dependencies;
156 typedef MapFormat Type;
158 STRING_CONSTANT(Name, "mapquake4");
160 UINT_CONSTANT(MapVersion, 3);
162 MapQuake4API(MapDoom3Dependencies &dependencies) : m_dependencies(dependencies)
164 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake4 maps", "*.map"));
165 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake4 region", "*.reg"));
168 MapFormat *getTable()
173 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
175 const char *primitive = tokeniser.getToken();
176 if (primitive != 0) {
177 if (string_equal(primitive, "patchDef3")) {
178 return m_dependencies.getPatchDoom3().createPatch();
179 } else if (string_equal(primitive, "patchDef2")) {
180 return m_dependencies.getPatchDef2Doom3().createPatch();
181 } else if (string_equal(primitive, "brushDef3")) {
182 return m_dependencies.getBrushDoom3().createBrush();
186 Tokeniser_unexpectedError(tokeniser, primitive, "#quake4-primitive");
190 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
192 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
193 tokeniser.nextLine();
194 if (!Tokeniser_parseToken(tokeniser, "Version")) {
198 if (!Tokeniser_getSize(tokeniser, version)) {
201 if (version != MapVersion()) {
202 globalErrorStream() << "Quake 4 map version " << MapVersion() << " supported, version is "
203 << Unsigned(version) << "\n";
206 tokeniser.nextLine();
207 Map_Read(root, tokeniser, entityTable, *this);
211 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
213 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
214 writer.writeToken("Version");
215 writer.writeInteger(MapVersion());
217 Map_Write(root, traverse, writer, false);
222 typedef SingletonModule<
224 MapDoom3Dependencies,
225 DependenciesAPIConstructor<MapQuake4API, MapDoom3Dependencies>
229 MapQuake4Module g_MapQuake4Module;
232 class MapDependencies :
233 public GlobalRadiantModuleRef,
234 public GlobalBrushModuleRef,
235 public GlobalPatchModuleRef,
236 public GlobalFiletypesModuleRef,
237 public GlobalScripLibModuleRef,
238 public GlobalEntityClassManagerModuleRef,
239 public GlobalSceneGraphModuleRef {
242 GlobalBrushModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("brushtypes")),
243 GlobalPatchModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("patchtypes")),
244 GlobalEntityClassManagerModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("entityclass"))
249 class MapQ3API : public TypeSystemRef, public MapFormat, public PrimitiveParser {
250 mutable bool detectedFormat;
252 typedef MapFormat Type;
254 STRING_CONSTANT(Name, "mapq3");
258 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(),
259 filetype_t("quake3 maps", "*.map", true, true, true));
260 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(),
261 filetype_t("quake3 region", "*.reg", true, true, true));
262 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(),
263 filetype_t("quake3 compiled maps", "*.bsp", false, true, false));
266 MapFormat *getTable()
271 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
273 const char *primitive = tokeniser.getToken();
274 if (primitive != 0) {
275 if (string_equal(primitive, "patchDef2")) {
276 return GlobalPatchModule::getTable().createPatch();
278 if (GlobalBrushModule::getTable().useAlternativeTextureProjection()) {
279 if (string_equal(primitive, "brushDef")) {
280 detectedFormat = true;
281 return GlobalBrushModule::getTable().createBrush();
282 } else if (!detectedFormat && string_equal(primitive, "(")) {
283 detectedFormat = true;
285 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-switch-to-texdef");
289 if (string_equal(primitive, "(")) {
290 detectedFormat = true;
291 tokeniser.ungetToken(); // (
292 return GlobalBrushModule::getTable().createBrush();
293 } else if (!detectedFormat && string_equal(primitive, "brushDef")) {
294 detectedFormat = true;
296 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-switch-to-brush-primitives");
302 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-primitive");
306 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
308 detectedFormat = false;
310 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
311 Map_Read(root, tokeniser, entityTable, *this);
315 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
317 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
318 Map_Write(root, traverse, writer, false);
323 typedef SingletonModule<MapQ3API, MapDependencies> MapQ3Module;
325 MapQ3Module g_MapQ3Module;
328 class MapQ1API : public TypeSystemRef, public MapFormat, public PrimitiveParser {
330 typedef MapFormat Type;
332 STRING_CONSTANT(Name, "mapq1");
336 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake maps", "*.map"));
337 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake region", "*.reg"));
340 MapFormat *getTable()
345 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
347 const char *primitive = tokeniser.getToken();
348 if (primitive != 0) {
349 if (string_equal(primitive, "(")) {
350 tokeniser.ungetToken(); // (
351 return GlobalBrushModule::getTable().createBrush();
355 Tokeniser_unexpectedError(tokeniser, primitive, "#quake-primitive");
359 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
361 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
362 Map_Read(root, tokeniser, entityTable, *this);
366 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
368 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
369 Map_Write(root, traverse, writer, true);
374 typedef SingletonModule<MapQ1API, MapDependencies> MapQ1Module;
376 MapQ1Module g_MapQ1Module;
379 class MapHalfLifeAPI : public TypeSystemRef, public MapFormat, public PrimitiveParser {
381 typedef MapFormat Type;
383 STRING_CONSTANT(Name, "maphl");
387 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("half-life maps", "*.map"));
388 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("half-life region", "*.reg"));
391 MapFormat *getTable()
396 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
398 const char *primitive = tokeniser.getToken();
399 if (primitive != 0) {
400 if (string_equal(primitive, "(")) {
401 tokeniser.ungetToken(); // (
402 return GlobalBrushModule::getTable().createBrush();
406 Tokeniser_unexpectedError(tokeniser, primitive, "#halflife-primitive");
410 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
412 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
413 Map_Read(root, tokeniser, entityTable, *this);
417 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
419 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
420 Map_Write(root, traverse, writer, true);
425 typedef SingletonModule<MapHalfLifeAPI, MapDependencies> MapHalfLifeModule;
427 MapHalfLifeModule g_MapHalfLifeModule;
430 class MapQ2API : public TypeSystemRef, public MapFormat, public PrimitiveParser {
432 typedef MapFormat Type;
434 STRING_CONSTANT(Name, "mapq2");
438 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake2 maps", "*.map"));
439 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake2 region", "*.reg"));
442 MapFormat *getTable()
447 scene::Node &parsePrimitive(Tokeniser &tokeniser) const
449 const char *primitive = tokeniser.getToken();
450 if (primitive != 0) {
451 if (string_equal(primitive, "(")) {
452 tokeniser.ungetToken(); // (
453 return GlobalBrushModule::getTable().createBrush();
457 Tokeniser_unexpectedError(tokeniser, primitive, "#quake2-primitive");
461 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
463 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
464 Map_Read(root, tokeniser, entityTable, *this);
468 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
470 TokenWriter &writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
471 Map_Write(root, traverse, writer, true);
476 typedef SingletonModule<MapQ2API, MapDependencies> MapQ2Module;
478 MapQ2Module g_MapQ2Module;
481 const char *PARSE_ERROR = "error parsing VMF";
483 inline void parseToken(Tokeniser &tokeniser, const char *token)
485 ASSERT_MESSAGE(Tokeniser_parseToken(tokeniser, token), "error parsing vmf: token not found: " << makeQuoted(token));
488 #include "generic/arrayrange.h"
492 typedef ArrayConstRange<VMFBlock> VMFBlockArrayRange;
498 VMFBlockArrayRange m_children;
499 typedef const VMFBlock Value;
501 VMFBlock(const char *name, VMFBlockArrayRange children = VMFBlockArrayRange(0, 0)) : m_name(name),
506 const char *name() const
511 typedef Value *const_iterator;
513 const_iterator begin() const
515 return m_children.first;
518 const_iterator end() const
520 return m_children.last;
524 const VMFBlock c_vmfNormals("normals");
525 const VMFBlock c_vmfDistances("distances");
526 const VMFBlock c_vmfOffsets("offsets");
527 const VMFBlock c_vmfOffsetNormals("offset_normals");
528 const VMFBlock c_vmfAlphas("alphas");
529 const VMFBlock c_vmfTriangleTags("triangle_tags");
530 const VMFBlock c_vmfAllowedVerts("allowed_verts");
531 const VMFBlock c_vmfDispInfoChildren[] = {c_vmfNormals, c_vmfDistances, c_vmfOffsets, c_vmfOffsetNormals, c_vmfAlphas,
532 c_vmfTriangleTags, c_vmfAllowedVerts};
533 const VMFBlock c_vmfDispInfo("dispinfo", ARRAY_RANGE(c_vmfDispInfoChildren));
534 const VMFBlock c_vmfSideChildren[] = {c_vmfDispInfo};
535 const VMFBlock c_vmfSide("side", ARRAY_RANGE(c_vmfSideChildren));
536 const VMFBlock c_vmfEditor("editor");
537 const VMFBlock c_vmfVersionInfo("versioninfo");
538 const VMFBlock c_vmfViewSettings("viewsettings");
539 const VMFBlock c_vmfCordon("cordon");
540 const VMFBlock c_vmfGroupChildren[] = {c_vmfEditor};
541 const VMFBlock c_vmfGroup("group", ARRAY_RANGE(c_vmfGroupChildren));
542 const VMFBlock c_vmfCamera("camera");
543 const VMFBlock c_vmfCamerasChildren[] = {c_vmfCamera};
544 const VMFBlock c_vmfCameras("cameras", ARRAY_RANGE(c_vmfCamerasChildren));
545 VMFBlock c_vmfVisGroup("visgroup");
546 VMFBlock c_vmfVisGroups("visgroups", VMFBlockArrayRange(&c_vmfVisGroup, &c_vmfVisGroup + 1));
547 const VMFBlock c_vmfSolidChildren[] = {c_vmfSide, c_vmfEditor};
548 const VMFBlock c_vmfSolid("solid", ARRAY_RANGE(c_vmfSolidChildren));
549 const VMFBlock c_vmfConnections("connections");
550 const VMFBlock c_vmfEntityChildren[] = {c_vmfEditor, c_vmfSolid, c_vmfGroup, c_vmfConnections};
551 const VMFBlock c_vmfEntity("entity", ARRAY_RANGE(c_vmfEntityChildren));
552 const VMFBlock c_vmfWorldChildren[] = {c_vmfEditor, c_vmfSolid, c_vmfGroup};
553 const VMFBlock c_vmfWorld("world", ARRAY_RANGE(c_vmfWorldChildren));
554 const VMFBlock c_vmfRootChildren[] = {c_vmfVersionInfo, c_vmfViewSettings, c_vmfVisGroups, c_vmfWorld, c_vmfEntity,
555 c_vmfCameras, c_vmfCordon};
556 const VMFBlock c_vmfRoot("", ARRAY_RANGE(c_vmfRootChildren));
562 c_vmfVisGroup.m_children = VMFBlockArrayRange(&c_vmfVisGroup, &c_vmfVisGroup + 1);
571 inline VMFBlock::const_iterator VMFBlock_find(const VMFBlock &block, const char *name)
573 for (VMFBlock::const_iterator i = block.begin(); i != block.end(); ++i) {
574 if (string_equal(name, (*i).name())) {
581 void VMF_parseBlock(Tokeniser &tokeniser, const VMFBlock &block)
584 const char *key = tokeniser.getToken();
585 if (key == 0 || string_equal(key, "}")) {
586 tokeniser.ungetToken();
589 CopiedString tmp(key);
590 tokeniser.nextLine();
591 const char *value = tokeniser.getToken();
592 tokeniser.nextLine();
593 if (string_equal(value, "{")) {
594 VMFBlock::const_iterator i = VMFBlock_find(block, tmp.c_str());
595 ASSERT_MESSAGE(i != block.end(),
596 "error parsing vmf block " << makeQuoted(block.name()) << ": unknown block: "
597 << makeQuoted(tmp.c_str()));
598 if (string_equal(tmp.c_str(), "solid")) {
600 } else if (string_equal(tmp.c_str(), "entity") || string_equal(tmp.c_str(), "world")) {
603 VMF_parseBlock(tokeniser, *i);
604 parseToken(tokeniser, "}");
605 tokeniser.nextLine();
612 void VMF_Read(scene::Node &root, Tokeniser &tokeniser, EntityCreator &entityTable)
614 g_vmf_entities = g_vmf_brushes = 0;
615 VMF_parseBlock(tokeniser, c_vmfRoot);
616 globalOutputStream() << g_vmf_entities << " entities\n";
617 globalOutputStream() << g_vmf_brushes << " brushes\n";
620 class MapVMFAPI : public TypeSystemRef, public MapFormat {
622 typedef MapFormat Type;
624 STRING_CONSTANT(Name, "mapvmf");
628 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("vmf maps", "*.vmf"));
629 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("vmf region", "*.reg"));
632 MapFormat *getTable()
637 void readGraph(scene::Node &root, TextInputStream &inputStream, EntityCreator &entityTable) const
639 Tokeniser &tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
640 VMF_Read(root, tokeniser, entityTable);
644 void writeGraph(scene::Node &root, GraphTraversalFunc traverse, TextOutputStream &outputStream) const
649 typedef SingletonModule<MapVMFAPI, MapDependencies> MapVMFModule;
651 MapVMFModule g_MapVMFModule;
654 extern "C" void RADIANT_DLLEXPORT Radiant_RegisterModules(ModuleServer &server)
656 initialiseModule(server);
658 g_MapDoom3Module.selfRegister();
659 g_MapQuake4Module.selfRegister();
660 g_MapQ3Module.selfRegister();
661 g_MapQ1Module.selfRegister();
662 g_MapQ2Module.selfRegister();
663 g_MapHalfLifeModule.selfRegister();
664 g_MapVMFModule.selfRegister();