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;
64 if ( bspDrawVerts == 0 ) {
65 numBSPDrawVertsBuffer = 1024;
67 bspDrawVerts = safe_malloc_info( sizeof( bspDrawVert_t ) * numBSPDrawVertsBuffer, "IncDrawVerts" );
70 else if ( numBSPDrawVerts > numBSPDrawVertsBuffer ) {
71 numBSPDrawVertsBuffer *= 3; // multiply by 1.5
72 numBSPDrawVertsBuffer /= 2;
74 bspDrawVerts = realloc( bspDrawVerts, sizeof( bspDrawVert_t ) * numBSPDrawVertsBuffer );
76 if ( !bspDrawVerts ) {
77 Error( "realloc() failed (IncDrawVerts)" );
81 memset( bspDrawVerts + ( numBSPDrawVerts - 1 ), 0, sizeof( bspDrawVert_t ) );
84 void SetDrawVerts( int n ){
85 if ( bspDrawVerts != 0 ) {
90 numBSPDrawVertsBuffer = numBSPDrawVerts;
92 bspDrawVerts = safe_malloc_info( sizeof( bspDrawVert_t ) * numBSPDrawVertsBuffer, "IncDrawVerts" );
94 memset( bspDrawVerts, 0, n * sizeof( bspDrawVert_t ) );
97 int numBSPDrawSurfacesBuffer = 0;
98 void SetDrawSurfacesBuffer(){
99 if ( bspDrawSurfaces != 0 ) {
100 free( bspDrawSurfaces );
103 numBSPDrawSurfacesBuffer = MAX_MAP_DRAW_SURFS;
105 bspDrawSurfaces = safe_malloc_info( sizeof( bspDrawSurface_t ) * numBSPDrawSurfacesBuffer, "IncDrawSurfaces" );
107 memset( bspDrawSurfaces, 0, MAX_MAP_DRAW_SURFS * sizeof( bspDrawSurface_t ) );
110 void SetDrawSurfaces( int n ){
111 if ( bspDrawSurfaces != 0 ) {
112 free( bspDrawSurfaces );
115 numBSPDrawSurfaces = n;
116 numBSPDrawSurfacesBuffer = numBSPDrawSurfaces;
118 bspDrawSurfaces = safe_malloc_info( sizeof( bspDrawSurface_t ) * numBSPDrawSurfacesBuffer, "IncDrawSurfaces" );
120 memset( bspDrawSurfaces, 0, n * sizeof( bspDrawSurface_t ) );
123 void BSPFilesCleanup(){
124 if ( bspDrawVerts != 0 ) {
125 free( bspDrawVerts );
127 if ( bspDrawSurfaces != 0 ) {
128 free( bspDrawSurfaces );
130 if ( bspLightBytes != 0 ) {
131 free( bspLightBytes );
133 if ( bspGridPoints != 0 ) {
134 free( bspGridPoints );
145 if all values are 32 bits, this can be used to swap everything
148 void SwapBlock( int *block, int size ){
153 if ( block == NULL ) {
159 for ( i = 0; i < size; i++ )
160 block[ i ] = LittleLong( block[ i ] );
167 byte swaps all data in the abstract bsp
170 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 ){
268 /* check for odd size */
269 if ( header->lumps[ lump ].length % size ) {
271 Sys_FPrintf( SYS_WRN, "WARNING: GetLumpElements: odd lump size (%d) in lump %d\n", header->lumps[ lump ].length, lump );
275 Error( "GetLumpElements: odd lump size (%d) in lump %d", header->lumps[ lump ].length, lump );
279 /* return element count */
280 return header->lumps[ lump ].length / size;
287 returns a pointer to the specified lump
290 void *GetLump( bspHeader_t *header, int lump ){
291 return (void*)( (byte*) header + header->lumps[ lump ].offset );
298 copies a bsp file lump into a destination buffer
301 int CopyLump( bspHeader_t *header, int lump, void *dest, int size ){
305 /* get lump length and offset */
306 length = header->lumps[ lump ].length;
307 offset = header->lumps[ lump ].offset;
309 /* handle erroneous cases */
313 if ( length % size ) {
315 Sys_FPrintf( SYS_WRN, "WARNING: CopyLump: odd lump size (%d) in lump %d\n", length, lump );
319 Error( "CopyLump: odd lump size (%d) in lump %d", length, lump );
323 /* copy block of memory and return */
324 memcpy( dest, (byte*) header + offset, length );
325 return length / size;
328 int CopyLump_Allocate( bspHeader_t *header, int lump, void **dest, int size, int *allocationVariable ){
329 /* get lump length and offset */
330 *allocationVariable = header->lumps[ lump ].length / size;
331 *dest = realloc( *dest, size * *allocationVariable );
332 return CopyLump( header, lump, *dest, size );
338 adds a lump to an outgoing bsp file
341 void AddLump( FILE *file, bspHeader_t *header, int lumpNum, const void *data, int length ){
345 /* add lump to bsp file header */
346 lump = &header->lumps[ lumpNum ];
347 lump->offset = LittleLong( ftell( file ) );
348 lump->length = LittleLong( length );
350 /* write lump to file */
351 SafeWrite( file, data, ( length + 3 ) & ~3 );
358 loads a bsp file into memory
361 void LoadBSPFile( const char *filename ){
363 if ( game == NULL || game->load == NULL ) {
364 Error( "LoadBSPFile: unsupported BSP file format" );
367 /* load it, then byte swap the in-memory version */
368 game->load( filename );
379 void WriteBSPFile( const char *filename ){
380 char tempname[ 1024 ];
385 if ( game == NULL || game->write == NULL ) {
386 Error( "WriteBSPFile: unsupported BSP file format" );
389 /* make fake temp name so existing bsp file isn't damaged in case write process fails */
391 sprintf( tempname, "%s.%08X", filename, (int) tm );
393 /* byteswap, write the bsp, then swap back so it can be manipulated further */
395 game->write( tempname );
398 /* replace existing bsp file */
400 rename( tempname, filename );
407 dumps info about current file
410 void PrintBSPFileSizes( void ){
411 /* parse entities first */
412 if ( numEntities <= 0 ) {
416 /* note that this is abstracted */
417 Sys_Printf( "Abstracted BSP file components (*actual sizes may differ)\n" );
419 /* print various and sundry bits */
420 Sys_Printf( "%9d models %9d\n",
421 numBSPModels, (int) ( numBSPModels * sizeof( bspModel_t ) ) );
422 Sys_Printf( "%9d shaders %9d\n",
423 numBSPShaders, (int) ( numBSPShaders * sizeof( bspShader_t ) ) );
424 Sys_Printf( "%9d brushes %9d\n",
425 numBSPBrushes, (int) ( numBSPBrushes * sizeof( bspBrush_t ) ) );
426 Sys_Printf( "%9d brushsides %9d *\n",
427 numBSPBrushSides, (int) ( numBSPBrushSides * sizeof( bspBrushSide_t ) ) );
428 Sys_Printf( "%9d fogs %9d\n",
429 numBSPFogs, (int) ( numBSPFogs * sizeof( bspFog_t ) ) );
430 Sys_Printf( "%9d planes %9d\n",
431 numBSPPlanes, (int) ( numBSPPlanes * sizeof( bspPlane_t ) ) );
432 Sys_Printf( "%9d entdata %9d\n",
433 numEntities, bspEntDataSize );
436 Sys_Printf( "%9d nodes %9d\n",
437 numBSPNodes, (int) ( numBSPNodes * sizeof( bspNode_t ) ) );
438 Sys_Printf( "%9d leafs %9d\n",
439 numBSPLeafs, (int) ( numBSPLeafs * sizeof( bspLeaf_t ) ) );
440 Sys_Printf( "%9d leafsurfaces %9d\n",
441 numBSPLeafSurfaces, (int) ( numBSPLeafSurfaces * sizeof( *bspLeafSurfaces ) ) );
442 Sys_Printf( "%9d leafbrushes %9d\n",
443 numBSPLeafBrushes, (int) ( numBSPLeafBrushes * sizeof( *bspLeafBrushes ) ) );
446 Sys_Printf( "%9d drawsurfaces %9d *\n",
447 numBSPDrawSurfaces, (int) ( numBSPDrawSurfaces * sizeof( *bspDrawSurfaces ) ) );
448 Sys_Printf( "%9d drawverts %9d *\n",
449 numBSPDrawVerts, (int) ( numBSPDrawVerts * sizeof( *bspDrawVerts ) ) );
450 Sys_Printf( "%9d drawindexes %9d\n",
451 numBSPDrawIndexes, (int) ( numBSPDrawIndexes * sizeof( *bspDrawIndexes ) ) );
454 Sys_Printf( "%9d lightmaps %9d\n",
455 numBSPLightBytes / ( game->lightmapSize * game->lightmapSize * 3 ), numBSPLightBytes );
456 Sys_Printf( "%9d lightgrid %9d *\n",
457 numBSPGridPoints, (int) ( numBSPGridPoints * sizeof( *bspGridPoints ) ) );
458 Sys_Printf( " visibility %9d\n",
464 /* -------------------------------------------------------------------------------
468 ------------------------------------------------------------------------------- */
473 strips low byte chars off the end of a string
476 void StripTrailing( char *e ){
480 s = e + strlen( e ) - 1;
481 while ( s >= e && *s <= 32 )
492 parses a single quoted "key" "value" pair into an epair struct
495 epair_t *ParseEPair( void ){
499 /* allocate and clear new epair */
500 e = safe_malloc( sizeof( epair_t ) );
501 memset( e, 0, sizeof( epair_t ) );
504 if ( strlen( token ) >= ( MAX_KEY - 1 ) ) {
505 Error( "ParseEPair: token too long" );
508 e->key = copystring( token );
512 if ( strlen( token ) >= MAX_VALUE - 1 ) {
513 Error( "ParseEpar: token too long" );
515 e->value = copystring( token );
517 /* strip trailing spaces that sometimes get accidentally added in the editor */
518 StripTrailing( e->key );
519 StripTrailing( e->value );
529 parses an entity's epairs
532 qboolean ParseEntity( void ){
537 if ( !GetToken( qtrue ) ) {
540 if ( strcmp( token, "{" ) ) {
541 Error( "ParseEntity: { not found" );
543 AUTOEXPAND_BY_REALLOC( entities, numEntities, allocatedEntities, 32 );
545 /* create new entity */
546 mapEnt = &entities[ numEntities ];
548 memset( mapEnt, 0, sizeof( *mapEnt ) );
553 if ( !GetToken( qtrue ) ) {
554 Error( "ParseEntity: EOF without closing brace" );
556 if ( !EPAIR_STRCMP( token, "}" ) ) {
560 e->next = mapEnt->epairs;
564 /* return to sender */
572 parses the bsp entity data string into entities
575 void ParseEntities( void ){
577 ParseFromMemory( bspEntData, bspEntDataSize );
578 while ( ParseEntity() ) ;
580 /* ydnar: set number of bsp entities in case a map is loaded on top */
581 numBSPEntities = numEntities;
587 * must be called before UnparseEntities
589 void InjectCommandLine( char **argv, int beginArgs, int endArgs ){
590 const char *previousCommandLine;
591 char newCommandLine[1024];
593 char *outpos = newCommandLine;
594 char *sentinel = newCommandLine + sizeof( newCommandLine ) - 1;
597 previousCommandLine = ValueForKey( &entities[0], "_q3map2_cmdline" );
598 if ( previousCommandLine && *previousCommandLine ) {
599 inpos = previousCommandLine;
600 while ( outpos != sentinel && *inpos )
601 *outpos++ = *inpos++;
602 if ( outpos != sentinel ) {
605 if ( outpos != sentinel ) {
610 for ( i = beginArgs; i < endArgs; ++i )
612 if ( outpos != sentinel && i != beginArgs ) {
616 while ( outpos != sentinel && *inpos )
617 if ( *inpos != '\\' && *inpos != '"' && *inpos != ';' && (unsigned char) *inpos >= ' ' ) {
618 *outpos++ = *inpos++;
623 SetKeyValue( &entities[0], "_q3map2_cmdline", newCommandLine );
624 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 ){
641 char key[ 1024 ], value[ 1024 ];
646 AUTOEXPAND_BY_REALLOC( bspEntData, 0, allocatedBSPEntData, 1024 );
652 /* run through entity list */
653 for ( i = 0; i < numBSPEntities && i < numEntities; i++ )
657 AUTOEXPAND_BY_REALLOC( bspEntData, sz + 65536, allocatedBSPEntData, 1024 );
663 ep = entities[ i ].epairs;
665 continue; /* ent got removed */
668 /* ydnar: certain entities get stripped from bsp file */
669 value2 = ValueForKey( &entities[ i ], "classname" );
670 if ( !Q_stricmp( value2, "misc_model" ) ||
671 !Q_stricmp( value2, "_decal" ) ||
672 !Q_stricmp( value2, "_skybox" ) ) {
676 /* add beginning brace */
677 strcat( end, "{\n" );
680 /* walk epair list */
681 for ( ep = entities[ i ].epairs; ep != NULL; ep = ep->next )
684 strcpy( key, ep->key );
685 StripTrailing( key );
686 strcpy( value, ep->value );
687 StripTrailing( value );
690 sprintf( line, "\"%s\" \"%s\"\n", key, value );
692 end += strlen( line );
695 /* add trailing brace */
699 /* check for overflow */
700 if ( end > buf + allocatedBSPEntData ) {
701 Error( "Entity text too long" );
706 bspEntDataSize = end - buf + 1;
713 prints an entity's epairs to the console
716 void PrintEntity( const entity_t *ent ){
720 Sys_Printf( "------- entity %p -------\n", ent );
721 for ( ep = ent->epairs; ep != NULL; ep = ep->next )
722 Sys_Printf( "%s = %s\n", ep->key, ep->value );
730 sets an epair in an entity
733 void SetKeyValue( entity_t *ent, const char *key, const char *value ){
737 /* check for existing epair */
738 for ( ep = ent->epairs; ep != NULL; ep = ep->next )
740 if ( !EPAIR_STRCMP( ep->key, key ) ) {
742 ep->value = copystring( value );
747 /* create new epair */
748 ep = safe_malloc( sizeof( *ep ) );
749 ep->next = ent->epairs;
751 ep->key = copystring( key );
752 ep->value = copystring( value );
759 returns true if entity has this key
762 qboolean KeyExists( const entity_t *ent, const char *key ){
765 /* walk epair list */
766 for ( ep = ent->epairs; ep != NULL; ep = ep->next )
768 if ( !EPAIR_STRCMP( ep->key, key ) ) {
781 gets the value for an entity key
784 const char *ValueForKey( const entity_t *ent, const char *key ){
793 /* walk epair list */
794 for ( ep = ent->epairs; ep != NULL; ep = ep->next )
796 if ( !EPAIR_STRCMP( ep->key, key ) ) {
801 /* if no match, return empty string */
809 gets the integer point value for an entity key
812 int IntForKey( const entity_t *ent, const char *key ){
816 k = ValueForKey( ent, key );
824 gets the floating point value for an entity key
827 vec_t FloatForKey( const entity_t *ent, const char *key ){
831 k = ValueForKey( ent, key );
839 gets a 3-element vector value for an entity key
842 qboolean GetVectorForKey( const entity_t *ent, const char *key, vec3_t vec ){
848 k = ValueForKey( ent, key );
850 /* scanf into doubles, then assign, so it is vec_t size independent */
852 sscanf( k, "%lf %lf %lf", &v1, &v2, &v3 );
857 /* true if the key is found, false otherwise */
865 finds an entity target
868 entity_t *FindTargetEntity( const char *target ){
873 /* walk entity list */
874 for ( i = 0; i < numEntities; i++ )
876 n = ValueForKey( &entities[ i ], "targetname" );
877 if ( !strcmp( n, target ) ) {
878 return &entities[ i ];
889 GetEntityShadowFlags() - ydnar
890 gets an entity's shadow flags
891 note: does not set them to defaults if the keys are not found!
894 void GetEntityShadowFlags( const entity_t *ent, const entity_t *ent2, int *castShadows, int *recvShadows ){
897 /* get cast shadows */
898 if ( castShadows != NULL ) {
899 value = ValueForKey( ent, "_castShadows" );
900 if ( value[ 0 ] == '\0' ) {
901 value = ValueForKey( ent, "_cs" );
903 if ( value[ 0 ] == '\0' ) {
904 value = ValueForKey( ent2, "_castShadows" );
906 if ( value[ 0 ] == '\0' ) {
907 value = ValueForKey( ent2, "_cs" );
909 if ( value[ 0 ] != '\0' ) {
910 *castShadows = atoi( value );
915 if ( recvShadows != NULL ) {
916 value = ValueForKey( ent, "_receiveShadows" );
917 if ( value[ 0 ] == '\0' ) {
918 value = ValueForKey( ent, "_rs" );
920 if ( value[ 0 ] == '\0' ) {
921 value = ValueForKey( ent2, "_receiveShadows" );
923 if ( value[ 0 ] == '\0' ) {
924 value = ValueForKey( ent2, "_rs" );
926 if ( value[ 0 ] != '\0' ) {
927 *recvShadows = atoi( value );
931 /* vortex: game-specific default eneity keys */
932 value = ValueForKey( ent, "classname" );
933 if ( !Q_stricmp( game->magic, "dq" ) || !Q_stricmp( game->magic, "prophecy" ) ) {
934 /* vortex: deluxe quake default shadow flags */
935 if ( !Q_stricmp( value, "func_wall" ) ) {
936 if ( recvShadows != NULL ) {
939 if ( castShadows != NULL ) {