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
24 #include "iscriplib.h"
27 #include "ifiletypes.h"
29 #include "qerplugin.h"
32 #include "string/string.h"
34 #include "generic/constant.h"
36 #include "modulesystem/singletonmodule.h"
42 class MapDoom3Dependencies :
43 public GlobalRadiantModuleRef,
44 public GlobalFiletypesModuleRef,
45 public GlobalScripLibModuleRef,
46 public GlobalEntityClassManagerModuleRef,
47 public GlobalSceneGraphModuleRef,
48 public GlobalBrushModuleRef
50 PatchModuleRef m_patchDef2Doom3Module;
51 PatchModuleRef m_patchDoom3Module;
53 MapDoom3Dependencies() :
54 GlobalEntityClassManagerModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("entityclass")),
55 GlobalBrushModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("brushtypes")),
56 m_patchDef2Doom3Module("def2doom3"),
57 m_patchDoom3Module("doom3")
60 BrushCreator& getBrushDoom3()
62 return GlobalBrushModule::getTable();
64 PatchCreator& getPatchDoom3()
66 return *m_patchDoom3Module.getTable();
68 PatchCreator& getPatchDef2Doom3()
70 return *m_patchDef2Doom3Module.getTable();
74 class MapDoom3API : public TypeSystemRef, public MapFormat, public PrimitiveParser
76 MapDoom3Dependencies& m_dependencies;
78 typedef MapFormat Type;
79 STRING_CONSTANT(Name, "mapdoom3");
80 INTEGER_CONSTANT(MapVersion, 2);
82 MapDoom3API(MapDoom3Dependencies& dependencies) : m_dependencies(dependencies)
84 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("doom3 maps", "*.map"));
85 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("doom3 region", "*.reg"));
92 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
94 const char* primitive = tokeniser.getToken();
97 if(string_equal(primitive, "patchDef3"))
99 return m_dependencies.getPatchDoom3().createPatch();
101 else if(string_equal(primitive, "patchDef2"))
103 return m_dependencies.getPatchDef2Doom3().createPatch();
105 else if(string_equal(primitive, "brushDef3"))
107 return m_dependencies.getBrushDoom3().createBrush();
111 Tokeniser_unexpectedError(tokeniser, primitive, "#doom3-primitive");
114 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
116 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
117 tokeniser.nextLine();
118 if(!Tokeniser_parseToken(tokeniser, "Version"))
123 if(!Tokeniser_getSize(tokeniser, version))
127 if(version != MapVersion())
129 globalErrorStream() << "Doom 3 map version " << MapVersion() << " supported, version is " << Unsigned(version) << "\n";
132 tokeniser.nextLine();
133 Map_Read(root, tokeniser, entityTable, *this);
136 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
138 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
139 writer.writeToken("Version");
140 writer.writeInteger(MapVersion());
142 Map_Write(root, traverse, writer, false);
147 typedef SingletonModule<
149 MapDoom3Dependencies,
150 DependenciesAPIConstructor<MapDoom3API, MapDoom3Dependencies>
154 MapDoom3Module g_MapDoom3Module;
157 class MapQuake4API : public TypeSystemRef, public MapFormat, public PrimitiveParser
159 MapDoom3Dependencies& m_dependencies;
161 typedef MapFormat Type;
162 STRING_CONSTANT(Name, "mapquake4");
163 INTEGER_CONSTANT(MapVersion, 3);
165 MapQuake4API(MapDoom3Dependencies& dependencies) : m_dependencies(dependencies)
167 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake4 maps", "*.map"));
168 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake4 region", "*.reg"));
170 MapFormat* getTable()
175 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
177 const char* primitive = tokeniser.getToken();
180 if(string_equal(primitive, "patchDef3"))
182 return m_dependencies.getPatchDoom3().createPatch();
184 else if(string_equal(primitive, "patchDef2"))
186 return m_dependencies.getPatchDef2Doom3().createPatch();
188 else if(string_equal(primitive, "brushDef3"))
190 return m_dependencies.getBrushDoom3().createBrush();
194 Tokeniser_unexpectedError(tokeniser, primitive, "#quake4-primitive");
197 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
199 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
200 tokeniser.nextLine();
201 if(!Tokeniser_parseToken(tokeniser, "Version"))
206 if(!Tokeniser_getSize(tokeniser, version))
210 if(version != MapVersion())
212 globalErrorStream() << "Quake 4 map version " << MapVersion() << " supported, version is " << Unsigned(version) << "\n";
215 tokeniser.nextLine();
216 Map_Read(root, tokeniser, entityTable, *this);
219 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
221 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
222 writer.writeToken("Version");
223 writer.writeInteger(MapVersion());
225 Map_Write(root, traverse, writer, false);
230 typedef SingletonModule<
232 MapDoom3Dependencies,
233 DependenciesAPIConstructor<MapQuake4API, MapDoom3Dependencies>
237 MapQuake4Module g_MapQuake4Module;
240 class MapDependencies :
241 public GlobalRadiantModuleRef,
242 public GlobalBrushModuleRef,
243 public GlobalPatchModuleRef,
244 public GlobalFiletypesModuleRef,
245 public GlobalScripLibModuleRef,
246 public GlobalEntityClassManagerModuleRef,
247 public GlobalSceneGraphModuleRef
251 GlobalBrushModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("brushtypes")),
252 GlobalPatchModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("patchtypes")),
253 GlobalEntityClassManagerModuleRef(GlobalRadiant().getRequiredGameDescriptionKeyValue("entityclass"))
258 class MapQ3API : public TypeSystemRef, public MapFormat, public PrimitiveParser
260 mutable bool detectedFormat;
262 typedef MapFormat Type;
263 STRING_CONSTANT(Name, "mapq3");
267 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake3 maps", "*.map"));
268 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake3 region", "*.reg"));
270 MapFormat* getTable()
275 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
277 const char* primitive = tokeniser.getToken();
280 if(string_equal(primitive, "patchDef2"))
282 return GlobalPatchModule::getTable().createPatch();
284 if(GlobalBrushModule::getTable().useAlternativeTextureProjection())
286 if(string_equal(primitive, "brushDef"))
288 detectedFormat = true;
289 return GlobalBrushModule::getTable().createBrush();
291 else if(!detectedFormat && string_equal(primitive, "("))
293 detectedFormat = true;
295 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-switch-to-texdef");
301 if(string_equal(primitive, "("))
303 detectedFormat = true;
304 tokeniser.ungetToken(); // (
305 return GlobalBrushModule::getTable().createBrush();
307 else if(!detectedFormat && string_equal(primitive, "("))
309 detectedFormat = true;
311 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-switch-to-brush-primitives");
317 Tokeniser_unexpectedError(tokeniser, primitive, "#quake3-primitive");
321 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
323 detectedFormat = false;
325 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
326 Map_Read(root, tokeniser, entityTable, *this);
329 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
331 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
332 Map_Write(root, traverse, writer, false);
337 typedef SingletonModule<MapQ3API, MapDependencies> MapQ3Module;
339 MapQ3Module g_MapQ3Module;
342 class MapQ1API : public TypeSystemRef, public MapFormat, public PrimitiveParser
345 typedef MapFormat Type;
346 STRING_CONSTANT(Name, "mapq1");
350 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake maps", "*.map"));
351 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake region", "*.reg"));
353 MapFormat* getTable()
358 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
360 const char* primitive = tokeniser.getToken();
363 if(string_equal(primitive, "("))
365 tokeniser.ungetToken(); // (
366 return GlobalBrushModule::getTable().createBrush();
370 Tokeniser_unexpectedError(tokeniser, primitive, "#quake-primitive");
373 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
375 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
376 Map_Read(root, tokeniser, entityTable, *this);
379 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
381 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
382 Map_Write(root, traverse, writer, true);
387 typedef SingletonModule<MapQ1API, MapDependencies> MapQ1Module;
389 MapQ1Module g_MapQ1Module;
392 class MapHalfLifeAPI : public TypeSystemRef, public MapFormat, public PrimitiveParser
395 typedef MapFormat Type;
396 STRING_CONSTANT(Name, "maphl");
400 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("half-life maps", "*.map"));
401 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("half-life region", "*.reg"));
403 MapFormat* getTable()
408 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
410 const char* primitive = tokeniser.getToken();
413 if(string_equal(primitive, "("))
415 tokeniser.ungetToken(); // (
416 return GlobalBrushModule::getTable().createBrush();
420 Tokeniser_unexpectedError(tokeniser, primitive, "#halflife-primitive");
423 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
425 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
426 Map_Read(root, tokeniser, entityTable, *this);
429 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
431 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
432 Map_Write(root, traverse, writer, true);
437 typedef SingletonModule<MapHalfLifeAPI, MapDependencies> MapHalfLifeModule;
439 MapHalfLifeModule g_MapHalfLifeModule;
442 class MapQ2API : public TypeSystemRef, public MapFormat, public PrimitiveParser
445 typedef MapFormat Type;
446 STRING_CONSTANT(Name, "mapq2");
450 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake2 maps", "*.map"));
451 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("quake2 region", "*.reg"));
453 MapFormat* getTable()
457 scene::Node& parsePrimitive(Tokeniser& tokeniser) const
459 const char* primitive = tokeniser.getToken();
462 if(string_equal(primitive, "("))
464 tokeniser.ungetToken(); // (
465 return GlobalBrushModule::getTable().createBrush();
469 Tokeniser_unexpectedError(tokeniser, primitive, "#quake2-primitive");
472 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
474 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
475 Map_Read(root, tokeniser, entityTable, *this);
478 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
480 TokenWriter& writer = GlobalScripLibModule::getTable().m_pfnNewSimpleTokenWriter(outputStream);
481 Map_Write(root, traverse, writer, true);
486 typedef SingletonModule<MapQ2API, MapDependencies> MapQ2Module;
488 MapQ2Module g_MapQ2Module;
492 #define PARSE_ERROR "error parsing VMF"
494 inline void parseToken(Tokeniser& tokeniser, const char* token)
496 ASSERT_MESSAGE(Tokeniser_parseToken(tokeniser, token), "error parsing vmf: token not found: " << makeQuoted(token));
499 #include "generic/arrayrange.h"
502 typedef ArrayConstRange<VMFBlock> VMFBlockArrayRange;
509 VMFBlockArrayRange m_children;
510 typedef const VMFBlock Value;
512 VMFBlock(const char* name, VMFBlockArrayRange children = VMFBlockArrayRange(0, 0)) : m_name(name), m_children(children)
515 const char* name() const
519 typedef Value* const_iterator;
520 const_iterator begin() const
522 return m_children.first;
524 const_iterator end() const
526 return m_children.last;
530 const VMFBlock c_vmfNormals("normals");
531 const VMFBlock c_vmfDistances("distances");
532 const VMFBlock c_vmfOffsets("offsets");
533 const VMFBlock c_vmfOffsetNormals("offset_normals");
534 const VMFBlock c_vmfAlphas("alphas");
535 const VMFBlock c_vmfTriangleTags("triangle_tags");
536 const VMFBlock c_vmfAllowedVerts("allowed_verts");
537 const VMFBlock c_vmfDispInfoChildren[] = { c_vmfNormals, c_vmfDistances, c_vmfOffsets, c_vmfOffsetNormals, c_vmfAlphas, c_vmfTriangleTags, c_vmfAllowedVerts };
538 const VMFBlock c_vmfDispInfo("dispinfo", ARRAY_RANGE(c_vmfDispInfoChildren));
539 const VMFBlock c_vmfSideChildren[] = { c_vmfDispInfo };
540 const VMFBlock c_vmfSide("side", ARRAY_RANGE(c_vmfSideChildren));
541 const VMFBlock c_vmfEditor("editor");
542 const VMFBlock c_vmfVersionInfo("versioninfo");
543 const VMFBlock c_vmfViewSettings("viewsettings");
544 const VMFBlock c_vmfCordon("cordon");
545 const VMFBlock c_vmfGroupChildren[] = { c_vmfEditor };
546 const VMFBlock c_vmfGroup("group", ARRAY_RANGE(c_vmfGroupChildren));
547 const VMFBlock c_vmfCamera("camera");
548 const VMFBlock c_vmfCamerasChildren[] = { c_vmfCamera };
549 const VMFBlock c_vmfCameras("cameras", ARRAY_RANGE(c_vmfCamerasChildren));
550 VMFBlock c_vmfVisGroup("visgroup");
551 VMFBlock c_vmfVisGroups("visgroups", VMFBlockArrayRange(&c_vmfVisGroup, &c_vmfVisGroup+1));
552 const VMFBlock c_vmfSolidChildren[] = { c_vmfSide, c_vmfEditor };
553 const VMFBlock c_vmfSolid("solid", ARRAY_RANGE(c_vmfSolidChildren));
554 const VMFBlock c_vmfConnections("connections");
555 const VMFBlock c_vmfEntityChildren[] = { c_vmfEditor, c_vmfSolid, c_vmfGroup, c_vmfConnections };
556 const VMFBlock c_vmfEntity("entity", ARRAY_RANGE(c_vmfEntityChildren));
557 const VMFBlock c_vmfWorldChildren[] = { c_vmfEditor, c_vmfSolid, c_vmfGroup };
558 const VMFBlock c_vmfWorld("world", ARRAY_RANGE(c_vmfWorldChildren));
559 const VMFBlock c_vmfRootChildren[] = { c_vmfVersionInfo, c_vmfViewSettings, c_vmfVisGroups, c_vmfWorld, c_vmfEntity, c_vmfCameras, c_vmfCordon };
560 const VMFBlock c_vmfRoot("", ARRAY_RANGE(c_vmfRootChildren));
567 c_vmfVisGroup.m_children = VMFBlockArrayRange(&c_vmfVisGroup, &c_vmfVisGroup+1);
576 inline VMFBlock::const_iterator VMFBlock_find(const VMFBlock& block, const char* name)
578 for(VMFBlock::const_iterator i = block.begin(); i != block.end(); ++i)
580 if(string_equal(name, (*i).name()))
588 void VMF_parseBlock(Tokeniser& tokeniser, const VMFBlock& block)
592 const char* key = tokeniser.getToken();
593 if(key == 0 || string_equal(key, "}"))
595 tokeniser.ungetToken();
598 CopiedString tmp(key);
599 tokeniser.nextLine();
600 const char* value = tokeniser.getToken();
601 tokeniser.nextLine();
602 if(string_equal(value, "{"))
604 VMFBlock::const_iterator i = VMFBlock_find(block, tmp.c_str());
605 ASSERT_MESSAGE(i != block.end(), "error parsing vmf block " << makeQuoted(block.name()) << ": unknown block: " << makeQuoted(tmp.c_str()));
606 if(string_equal(tmp.c_str(), "solid"))
610 else if(string_equal(tmp.c_str(), "entity") || string_equal(tmp.c_str(), "world"))
614 VMF_parseBlock(tokeniser, *i);
615 parseToken(tokeniser, "}");
616 tokeniser.nextLine();
625 void VMF_Read(scene::Node& root, Tokeniser& tokeniser, EntityCreator& entityTable)
627 g_vmf_entities = g_vmf_brushes = 0;
628 VMF_parseBlock(tokeniser, c_vmfRoot);
629 globalOutputStream() << g_vmf_entities << " entities\n";
630 globalOutputStream() << g_vmf_brushes << " brushes\n";
633 class MapVMFAPI : public TypeSystemRef, public MapFormat
636 typedef MapFormat Type;
637 STRING_CONSTANT(Name, "mapvmf");
641 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("vmf maps", "*.vmf"));
642 GlobalFiletypesModule::getTable().addType(Type::Name(), Name(), filetype_t("vmf region", "*.reg"));
644 MapFormat* getTable()
649 void readGraph(scene::Node& root, TextInputStream& inputStream, EntityCreator& entityTable) const
651 Tokeniser& tokeniser = GlobalScripLibModule::getTable().m_pfnNewSimpleTokeniser(inputStream);
652 VMF_Read(root, tokeniser, entityTable);
655 void writeGraph(scene::Node& root, GraphTraversalFunc traverse, TextOutputStream& outputStream) const
660 typedef SingletonModule<MapVMFAPI, MapDependencies> MapVMFModule;
662 MapVMFModule g_MapVMFModule;
666 extern "C" void RADIANT_DLLEXPORT Radiant_RegisterModules(ModuleServer& server)
668 initialiseModule(server);
670 g_MapDoom3Module.selfRegister();
671 g_MapQuake4Module.selfRegister();
672 g_MapQ3Module.selfRegister();
673 g_MapQ1Module.selfRegister();
674 g_MapQ2Module.selfRegister();
675 g_MapHalfLifeModule.selfRegister();
676 g_MapVMFModule.selfRegister();