1 /* -------------------------------------------------------------------------------
3 Copyright (C) 1999-2007 id Software, Inc. and contributors.
4 For a list of contributors, see the accompanying CONTRIBUTORS file.
6 This file is part of GtkRadiant.
8 GtkRadiant is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 GtkRadiant is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GtkRadiant; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 ----------------------------------------------------------------------------------
24 This code has been altered significantly from its original form, to support
25 several games based on the Quake III Arena engine, in the form of "Q3Map2."
27 ------------------------------------------------------------------------------- */
32 #define BSPFILE_ABSTRACT_C
42 /* -------------------------------------------------------------------------------
44 this file was copied out of the common directory in order to not break
45 compatibility with the q3map 1.x tree. it was moved out in order to support
46 the raven bsp format (RBSP) used in soldier of fortune 2 and jedi knight 2.
48 since each game has its own set of particular features, the data structures
49 below no longer directly correspond to the binary format of a particular game.
51 the translation will be done at bsp load/save time to keep any sort of
52 special-case code messiness out of the rest of the program.
54 ------------------------------------------------------------------------------- */
58 /* FIXME: remove the functions below that handle memory management of bsp file chunks */
60 int numBSPDrawVertsBuffer = 0;
67 numBSPDrawVertsBuffer = 1024;
69 bspDrawVerts = safe_malloc_info(sizeof(bspDrawVert_t) * numBSPDrawVertsBuffer, "IncDrawVerts");
72 else if(numBSPDrawVerts > numBSPDrawVertsBuffer)
74 numBSPDrawVertsBuffer *= 3; // multiply by 1.5
75 numBSPDrawVertsBuffer /= 2;
77 bspDrawVerts = realloc(bspDrawVerts, sizeof(bspDrawVert_t) * numBSPDrawVertsBuffer);
80 Error( "realloc() failed (IncDrawVerts)");
83 memset(bspDrawVerts + (numBSPDrawVerts - 1), 0, sizeof(bspDrawVert_t));
86 void SetDrawVerts(int n)
92 numBSPDrawVertsBuffer = numBSPDrawVerts;
94 bspDrawVerts = safe_malloc_info(sizeof(bspDrawVert_t) * numBSPDrawVertsBuffer, "IncDrawVerts");
96 memset(bspDrawVerts, 0, n * sizeof(bspDrawVert_t));
99 int numBSPDrawSurfacesBuffer = 0;
100 void SetDrawSurfacesBuffer()
102 if(bspDrawSurfaces != 0)
103 free(bspDrawSurfaces);
105 numBSPDrawSurfacesBuffer = MAX_MAP_DRAW_SURFS;
107 bspDrawSurfaces = safe_malloc_info(sizeof(bspDrawSurface_t) * numBSPDrawSurfacesBuffer, "IncDrawSurfaces");
109 memset(bspDrawSurfaces, 0, MAX_MAP_DRAW_SURFS * sizeof(bspDrawVert_t));
112 void SetDrawSurfaces(int n)
114 if(bspDrawSurfaces != 0)
115 free(bspDrawSurfaces);
117 numBSPDrawSurfaces = n;
118 numBSPDrawSurfacesBuffer = numBSPDrawSurfaces;
120 bspDrawSurfaces = safe_malloc_info(sizeof(bspDrawSurface_t) * numBSPDrawSurfacesBuffer, "IncDrawSurfaces");
122 memset(bspDrawSurfaces, 0, n * sizeof(bspDrawVert_t));
125 void BSPFilesCleanup()
127 if(bspDrawVerts != 0)
129 if(bspDrawSurfaces != 0)
130 free(bspDrawSurfaces);
131 if(bspLightBytes != 0)
133 if(bspGridPoints != 0)
144 if all values are 32 bits, this can be used to swap everything
147 void SwapBlock( int *block, int size )
158 for( i = 0; i < size; i++ )
159 block[ i ] = LittleLong( block[ i ] );
166 byte swaps all data in the abstract bsp
169 void SwapBSPFile( void )
175 SwapBlock( (int*) bspModels, numBSPModels * sizeof( bspModels[ 0 ] ) );
177 /* shaders (don't swap the name) */
178 for( i = 0; i < numBSPShaders ; i++ )
180 bspShaders[ i ].contentFlags = LittleLong( bspShaders[ i ].contentFlags );
181 bspShaders[ i ].surfaceFlags = LittleLong( bspShaders[ i ].surfaceFlags );
185 SwapBlock( (int*) bspPlanes, numBSPPlanes * sizeof( bspPlanes[ 0 ] ) );
188 SwapBlock( (int*) bspNodes, numBSPNodes * sizeof( bspNodes[ 0 ] ) );
191 SwapBlock( (int*) bspLeafs, numBSPLeafs * sizeof( bspLeafs[ 0 ] ) );
194 SwapBlock( (int*) bspLeafSurfaces, numBSPLeafSurfaces * sizeof( bspLeafSurfaces[ 0 ] ) );
197 SwapBlock( (int*) bspLeafBrushes, numBSPLeafBrushes * sizeof( bspLeafBrushes[ 0 ] ) );
200 SwapBlock( (int*) bspBrushes, numBSPBrushes * sizeof( bspBrushes[ 0 ] ) );
203 SwapBlock( (int*) bspBrushSides, numBSPBrushSides * sizeof( bspBrushSides[ 0 ] ) );
206 ((int*) &bspVisBytes)[ 0 ] = LittleLong( ((int*) &bspVisBytes)[ 0 ] );
207 ((int*) &bspVisBytes)[ 1 ] = LittleLong( ((int*) &bspVisBytes)[ 1 ] );
209 /* drawverts (don't swap colors) */
210 for( i = 0; i < numBSPDrawVerts; i++ )
212 bspDrawVerts[ i ].xyz[ 0 ] = LittleFloat( bspDrawVerts[ i ].xyz[ 0 ] );
213 bspDrawVerts[ i ].xyz[ 1 ] = LittleFloat( bspDrawVerts[ i ].xyz[ 1 ] );
214 bspDrawVerts[ i ].xyz[ 2 ] = LittleFloat( bspDrawVerts[ i ].xyz[ 2 ] );
215 bspDrawVerts[ i ].normal[ 0 ] = LittleFloat( bspDrawVerts[ i ].normal[ 0 ] );
216 bspDrawVerts[ i ].normal[ 1 ] = LittleFloat( bspDrawVerts[ i ].normal[ 1 ] );
217 bspDrawVerts[ i ].normal[ 2 ] = LittleFloat( bspDrawVerts[ i ].normal[ 2 ] );
218 bspDrawVerts[ i ].st[ 0 ] = LittleFloat( bspDrawVerts[ i ].st[ 0 ] );
219 bspDrawVerts[ i ].st[ 1 ] = LittleFloat( bspDrawVerts[ i ].st[ 1 ] );
220 for( j = 0; j < MAX_LIGHTMAPS; j++ )
222 bspDrawVerts[ i ].lightmap[ j ][ 0 ] = LittleFloat( bspDrawVerts[ i ].lightmap[ j ][ 0 ] );
223 bspDrawVerts[ i ].lightmap[ j ][ 1 ] = LittleFloat( bspDrawVerts[ i ].lightmap[ j ][ 1 ] );
228 SwapBlock( (int*) bspDrawIndexes, numBSPDrawIndexes * sizeof( bspDrawIndexes[0] ) );
231 /* note: rbsp files (and hence q3map2 abstract bsp) have byte lightstyles index arrays, this follows sof2map convention */
232 SwapBlock( (int*) bspDrawSurfaces, numBSPDrawSurfaces * sizeof( bspDrawSurfaces[ 0 ] ) );
235 for( i = 0; i < numBSPFogs; i++ )
237 bspFogs[ i ].brushNum = LittleLong( bspFogs[ i ].brushNum );
238 bspFogs[ i ].visibleSide = LittleLong( bspFogs[ i ].visibleSide );
242 for( i = 0; i < numBSPAds; i++ )
244 bspAds[ i ].cellId = LittleLong( bspAds[ i ].cellId );
245 bspAds[ i ].normal[ 0 ] = LittleFloat( bspAds[ i ].normal[ 0 ] );
246 bspAds[ i ].normal[ 1 ] = LittleFloat( bspAds[ i ].normal[ 1 ] );
247 bspAds[ i ].normal[ 2 ] = LittleFloat( bspAds[ i ].normal[ 2 ] );
249 for( j = 0; j < 4; j++ )
251 bspAds[ i ].rect[j][ 0 ] = LittleFloat( bspAds[ i ].rect[j][ 0 ] );
252 bspAds[ i ].rect[j][ 1 ] = LittleFloat( bspAds[ i ].rect[j][ 1 ] );
253 bspAds[ i ].rect[j][ 2 ] = LittleFloat( bspAds[ i ].rect[j][ 2 ] );
256 //bspAds[ i ].model[ MAX_QPATH ];
264 gets the number of elements in a bsp lump
267 int GetLumpElements( bspHeader_t *header, int lump, int size )
269 /* check for odd size */
270 if( header->lumps[ lump ].length % size )
274 Sys_Printf( "WARNING: GetLumpElements: odd lump size (%d) in lump %d\n", header->lumps[ lump ].length, lump );
278 Error( "GetLumpElements: odd lump size (%d) in lump %d", header->lumps[ lump ].length, lump );
281 /* return element count */
282 return header->lumps[ lump ].length / size;
289 returns a pointer to the specified lump
292 void *GetLump( bspHeader_t *header, int lump )
294 return (void*)( (byte*) header + header->lumps[ lump ].offset);
301 copies a bsp file lump into a destination buffer
304 int CopyLump( bspHeader_t *header, int lump, void *dest, int size )
309 /* get lump length and offset */
310 length = header->lumps[ lump ].length;
311 offset = header->lumps[ lump ].offset;
313 /* handle erroneous cases */
320 Sys_Printf( "WARNING: CopyLump: odd lump size (%d) in lump %d\n", length, lump );
324 Error( "CopyLump: odd lump size (%d) in lump %d", length, lump );
327 /* copy block of memory and return */
328 memcpy( dest, (byte*) header + offset, length );
329 return length / size;
332 int CopyLump_Allocate( bspHeader_t *header, int lump, void **dest, int size, int *allocationVariable )
336 /* get lump length and offset */
337 *allocationVariable = header->lumps[ lump ].length / size;
338 *dest = realloc(*dest, size * *allocationVariable);
339 return CopyLump(header, lump, *dest, size);
345 adds a lump to an outgoing bsp file
348 void AddLump( FILE *file, bspHeader_t *header, int lumpNum, const void *data, int length )
353 /* add lump to bsp file header */
354 lump = &header->lumps[ lumpNum ];
355 lump->offset = LittleLong( ftell( file ) );
356 lump->length = LittleLong( length );
358 /* write lump to file */
359 SafeWrite( file, data, (length + 3) & ~3 );
366 loads a bsp file into memory
369 void LoadBSPFile( const char *filename )
372 if( game == NULL || game->load == NULL )
373 Error( "LoadBSPFile: unsupported BSP file format" );
375 /* load it, then byte swap the in-memory version */
376 game->load( filename );
387 void WriteBSPFile( const char *filename )
389 char tempname[ 1024 ];
394 if( game == NULL || game->write == NULL )
395 Error( "WriteBSPFile: unsupported BSP file format" );
397 /* make fake temp name so existing bsp file isn't damaged in case write process fails */
399 sprintf( tempname, "%s.%08X", filename, (int) tm );
401 /* byteswap, write the bsp, then swap back so it can be manipulated further */
403 game->write( tempname );
406 /* replace existing bsp file */
408 rename( tempname, filename );
415 dumps info about current file
418 void PrintBSPFileSizes( void )
420 /* parse entities first */
421 if( numEntities <= 0 )
424 /* note that this is abstracted */
425 Sys_Printf( "Abstracted BSP file components (*actual sizes may differ)\n" );
427 /* print various and sundry bits */
428 Sys_Printf( "%9d models %9d\n",
429 numBSPModels, (int) (numBSPModels * sizeof( bspModel_t )) );
430 Sys_Printf( "%9d shaders %9d\n",
431 numBSPShaders, (int) (numBSPShaders * sizeof( bspShader_t )) );
432 Sys_Printf( "%9d brushes %9d\n",
433 numBSPBrushes, (int) (numBSPBrushes * sizeof( bspBrush_t )) );
434 Sys_Printf( "%9d brushsides %9d *\n",
435 numBSPBrushSides, (int) (numBSPBrushSides * sizeof( bspBrushSide_t )) );
436 Sys_Printf( "%9d fogs %9d\n",
437 numBSPFogs, (int) (numBSPFogs * sizeof( bspFog_t ) ) );
438 Sys_Printf( "%9d planes %9d\n",
439 numBSPPlanes, (int) (numBSPPlanes * sizeof( bspPlane_t )) );
440 Sys_Printf( "%9d entdata %9d\n",
441 numEntities, bspEntDataSize );
444 Sys_Printf( "%9d nodes %9d\n",
445 numBSPNodes, (int) (numBSPNodes * sizeof( bspNode_t)) );
446 Sys_Printf( "%9d leafs %9d\n",
447 numBSPLeafs, (int) (numBSPLeafs * sizeof( bspLeaf_t )) );
448 Sys_Printf( "%9d leafsurfaces %9d\n",
449 numBSPLeafSurfaces, (int) (numBSPLeafSurfaces * sizeof( *bspLeafSurfaces )) );
450 Sys_Printf( "%9d leafbrushes %9d\n",
451 numBSPLeafBrushes, (int) (numBSPLeafBrushes * sizeof( *bspLeafBrushes )) );
454 Sys_Printf( "%9d drawsurfaces %9d *\n",
455 numBSPDrawSurfaces, (int) (numBSPDrawSurfaces * sizeof( *bspDrawSurfaces )) );
456 Sys_Printf( "%9d drawverts %9d *\n",
457 numBSPDrawVerts, (int) (numBSPDrawVerts * sizeof( *bspDrawVerts )) );
458 Sys_Printf( "%9d drawindexes %9d\n",
459 numBSPDrawIndexes, (int) (numBSPDrawIndexes * sizeof( *bspDrawIndexes )) );
462 Sys_Printf( "%9d lightmaps %9d\n",
463 numBSPLightBytes / (game->lightmapSize * game->lightmapSize * 3), numBSPLightBytes );
464 Sys_Printf( "%9d lightgrid %9d *\n",
465 numBSPGridPoints, (int) (numBSPGridPoints * sizeof( *bspGridPoints )) );
466 Sys_Printf( " visibility %9d\n",
472 /* -------------------------------------------------------------------------------
476 ------------------------------------------------------------------------------- */
481 strips low byte chars off the end of a string
484 void StripTrailing( char *e )
489 s = e + strlen( e ) - 1;
490 while( s >= e && *s <= 32 )
501 parses a single quoted "key" "value" pair into an epair struct
504 epair_t *ParseEPair( void )
509 /* allocate and clear new epair */
510 e = safe_malloc( sizeof( epair_t ) );
511 memset( e, 0, sizeof( epair_t ) );
514 if( strlen( token ) >= (MAX_KEY - 1) )
515 Error( "ParseEPair: token too long" );
517 e->key = copystring( token );
521 if( strlen( token ) >= MAX_VALUE - 1 )
522 Error( "ParseEpar: token too long" );
523 e->value = copystring( token );
525 /* strip trailing spaces that sometimes get accidentally added in the editor */
526 StripTrailing( e->key );
527 StripTrailing( e->value );
537 parses an entity's epairs
540 qboolean ParseEntity( void )
546 if( !GetToken( qtrue ) )
548 if( strcmp( token, "{" ) )
549 Error( "ParseEntity: { not found" );
550 if( numEntities == MAX_MAP_ENTITIES )
551 Error( "numEntities == MAX_MAP_ENTITIES" );
553 /* create new entity */
554 mapEnt = &entities[ numEntities ];
560 if( !GetToken( qtrue ) )
561 Error( "ParseEntity: EOF without closing brace" );
562 if( !EPAIR_STRCMP( token, "}" ) )
565 e->next = mapEnt->epairs;
569 /* return to sender */
577 parses the bsp entity data string into entities
580 void ParseEntities( void )
583 ParseFromMemory( bspEntData, bspEntDataSize );
584 while( ParseEntity() );
586 /* ydnar: set number of bsp entities in case a map is loaded on top */
587 numBSPEntities = numEntities;
591 * must be called before UnparseEntities
593 void InjectCommandLine(char **argv, int beginArgs, int endArgs)
595 const char *previousCommandLine;
596 char newCommandLine[1024];
598 char *outpos = newCommandLine;
599 char *sentinel = newCommandLine + sizeof(newCommandLine) - 1;
602 previousCommandLine = ValueForKey(&entities[0], "_q3map2_cmdline");
603 if(previousCommandLine && *previousCommandLine)
605 inpos = previousCommandLine;
606 while(outpos != sentinel && *inpos)
607 *outpos++ = *inpos++;
608 if(outpos != sentinel)
610 if(outpos != sentinel)
614 for(i = beginArgs; i < endArgs; ++i)
616 if(outpos != sentinel && i != beginArgs)
619 while(outpos != sentinel && *inpos)
620 if(*inpos != '\\' && *inpos != '"' && *inpos != ';' && (unsigned char) *inpos >= ' ')
621 *outpos++ = *inpos++;
625 SetKeyValue(&entities[0], "_q3map2_cmdline", newCommandLine);
626 SetKeyValue(&entities[0], "_q3map2_version", Q3MAP_VERSION);
631 generates the dentdata string from all the entities.
632 this allows the utilities to add or remove key/value
633 pairs to the data created by the map editor
636 void UnparseEntities( void )
642 char key[ 1024 ], value[ 1024 ];
651 /* run through entity list */
652 for( i = 0; i < numBSPEntities && i < numEntities; i++ )
655 ep = entities[ i ].epairs;
657 continue; /* ent got removed */
659 /* ydnar: certain entities get stripped from bsp file */
660 value2 = ValueForKey( &entities[ i ], "classname" );
661 if( !Q_stricmp( value2, "misc_model" ) ||
662 !Q_stricmp( value2, "_decal" ) ||
663 !Q_stricmp( value2, "_skybox" ) )
666 /* add beginning brace */
667 strcat( end, "{\n" );
670 /* walk epair list */
671 for( ep = entities[ i ].epairs; ep != NULL; ep = ep->next )
674 strcpy( key, ep->key );
675 StripTrailing( key );
676 strcpy( value, ep->value );
677 StripTrailing( value );
680 sprintf( line, "\"%s\" \"%s\"\n", key, value );
682 end += strlen( line );
685 /* add trailing brace */
689 /* check for overflow */
690 if( end > buf + MAX_MAP_ENTSTRING )
691 Error( "Entity text too long" );
695 bspEntDataSize = end - buf + 1;
702 prints an entity's epairs to the console
705 void PrintEntity( const entity_t *ent )
710 Sys_Printf( "------- entity %p -------\n", ent );
711 for( ep = ent->epairs; ep != NULL; ep = ep->next )
712 Sys_Printf( "%s = %s\n", ep->key, ep->value );
720 sets an epair in an entity
723 void SetKeyValue( entity_t *ent, const char *key, const char *value )
728 /* check for existing epair */
729 for( ep = ent->epairs; ep != NULL; ep = ep->next )
731 if( !EPAIR_STRCMP( ep->key, key ) )
734 ep->value = copystring( value );
739 /* create new epair */
740 ep = safe_malloc( sizeof( *ep ) );
741 ep->next = ent->epairs;
743 ep->key = copystring( key );
744 ep->value = copystring( value );
749 returns true if entity has this key
752 qboolean KeyExists( const entity_t *ent, const char *key )
756 /* walk epair list */
757 for( ep = ent->epairs; ep != NULL; ep = ep->next )
759 if( !EPAIR_STRCMP( ep->key, key ) )
769 gets the value for an entity key
772 const char *ValueForKey( const entity_t *ent, const char *key )
781 /* walk epair list */
782 for( ep = ent->epairs; ep != NULL; ep = ep->next )
784 if( !EPAIR_STRCMP( ep->key, key ) )
788 /* if no match, return empty string */
796 gets the integer point value for an entity key
799 int IntForKey( const entity_t *ent, const char *key )
804 k = ValueForKey( ent, key );
812 gets the floating point value for an entity key
815 vec_t FloatForKey( const entity_t *ent, const char *key )
820 k = ValueForKey( ent, key );
828 gets a 3-element vector value for an entity key
831 void GetVectorForKey( const entity_t *ent, const char *key, vec3_t vec )
838 k = ValueForKey( ent, key );
840 /* scanf into doubles, then assign, so it is vec_t size independent */
842 sscanf( k, "%lf %lf %lf", &v1, &v2, &v3 );
852 finds an entity target
855 entity_t *FindTargetEntity( const char *target )
861 /* walk entity list */
862 for( i = 0; i < numEntities; i++ )
864 n = ValueForKey( &entities[ i ], "targetname" );
865 if ( !strcmp( n, target ) )
866 return &entities[ i ];
876 GetEntityShadowFlags() - ydnar
877 gets an entity's shadow flags
878 note: does not set them to defaults if the keys are not found!
881 void GetEntityShadowFlags( const entity_t *ent, const entity_t *ent2, int *castShadows, int *recvShadows )
885 /* get cast shadows */
886 if( castShadows != NULL )
888 value = ValueForKey( ent, "_castShadows" );
889 if( value[ 0 ] == '\0' )
890 value = ValueForKey( ent, "_cs" );
891 if( value[ 0 ] == '\0' )
892 value = ValueForKey( ent2, "_castShadows" );
893 if( value[ 0 ] == '\0' )
894 value = ValueForKey( ent2, "_cs" );
895 if( value[ 0 ] != '\0' )
896 *castShadows = atoi( value );
900 if( recvShadows != NULL )
902 value = ValueForKey( ent, "_receiveShadows" );
903 if( value[ 0 ] == '\0' )
904 value = ValueForKey( ent, "_rs" );
905 if( value[ 0 ] == '\0' )
906 value = ValueForKey( ent2, "_receiveShadows" );
907 if( value[ 0 ] == '\0' )
908 value = ValueForKey( ent2, "_rs" );
909 if( value[ 0 ] != '\0' )
910 *recvShadows = atoi( value );
913 /* vortex: game-specific default eneity keys */
914 value = ValueForKey( ent, "classname" );
915 if (!Q_stricmp( game->magic, "dq" ) || !Q_stricmp( game->magic, "prophecy" ) )
917 /* vortex: deluxe quake default shadow flags */
918 if (!Q_stricmp( value, "func_wall" ) )
920 if( recvShadows != NULL )
922 if( castShadows != NULL )