2 Copyright (C) 1999-2007 id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
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
25 // q_shared.h -- included first by ALL program modules.
26 // these are the definitions that have no dependance on
27 // central system services, and can be used by any part
28 // of the program without any state issues.
30 // A user mod should never modify this file
32 #define Q3_VERSION "DOOM 0.01"
34 // alignment macros for SIMD
40 #pragma warning(disable : 4018) // signed/unsigned mismatch
41 #pragma warning(disable : 4032)
42 #pragma warning(disable : 4051)
43 #pragma warning(disable : 4057) // slightly different base types
44 #pragma warning(disable : 4100) // unreferenced formal parameter
45 #pragma warning(disable : 4115)
46 #pragma warning(disable : 4125) // decimal digit terminates octal escape sequence
47 #pragma warning(disable : 4127) // conditional expression is constant
48 #pragma warning(disable : 4136)
49 #pragma warning(disable : 4201)
50 #pragma warning(disable : 4214)
51 #pragma warning(disable : 4244)
52 #pragma warning(disable : 4305) // truncation from const double to float
53 #pragma warning(disable : 4310) // cast truncates constant value
54 #pragma warning(disable : 4514)
55 #pragma warning(disable : 4711) // selected for automatic inline expansion
56 #pragma warning(disable : 4220) // varargs matches remaining parameters
68 #ifdef _WIN32 // mac doesn't have malloc.h
69 #include <malloc.h> // for _alloca()
73 //#pragma intrinsic( memset, memcpy )
78 // this is the define for determining if we have an asm version of a C function
79 #if (defined _M_IX86 || defined __i386__) && !defined __sun__ && !defined __LCC__
85 // for windows fastcall option
89 //======================= WIN32 DEFINES =================================
98 // buildstring will be incorporated into the version string
101 #define CPUSTRING "win-x86"
102 #elif defined _M_ALPHA
103 #define CPUSTRING "win-AXP"
107 #define CPUSTRING "win-x86-debug"
108 #elif defined _M_ALPHA
109 #define CPUSTRING "win-AXP-debug"
114 #define PATH_SEP '\\'
118 //======================= MAC OS X SERVER DEFINES =====================
120 #if defined(__MACH__) && defined(__APPLE__)
125 #define CPUSTRING "MacOSXS-ppc"
126 #elif defined __i386__
127 #define CPUSTRING "MacOSXS-i386"
129 #define CPUSTRING "MacOSXS-other"
134 #define GAME_HARD_LINKED
135 #define CGAME_HARD_LINKED
136 #define UI_HARD_LINKED
137 #define _alloca alloca
141 #define ALIGN_ON #pragma align(16)
142 #define ALIGN_OFF #pragma align()
148 void *osxAllocateMemory(long size);
149 void osxFreeMemory(void *pointer);
157 //======================= MAC DEFINES =================================
161 #define MAC_STATIC static
163 #define CPUSTRING "MacOS-PPC"
167 void Sys_PumpEvents( void );
175 #define CPUSTRING "MacOS-PPC"
179 void Sys_PumpEvents( void );
182 #define QDECL __cdecl
184 #define _alloca alloca
187 //======================= LINUX DEFINES =================================
189 // the mac compiler can't handle >32k of locals, so we
190 // just waste space and make big arrays static...
196 #define CPUSTRING "linux-i386"
197 #elif defined __axp__
198 #define CPUSTRING "linux-alpha"
200 #define CPUSTRING "linux-other"
207 //=============================================================
209 typedef enum {qfalse, qtrue} qboolean;
211 typedef unsigned char byte;
213 #define EQUAL_EPSILON 0.001
215 typedef int qhandle_t;
216 typedef int sfxHandle_t;
217 typedef int fileHandle_t;
218 typedef int clipHandle_t;
225 #define NULL ((void *)0)
228 #define MAX_QINT 0x7fffffff
229 #define MIN_QINT (-MAX_QINT-1)
232 #define max( x, y ) ( ( ( x ) > ( y ) ) ? ( x ) : ( y ) )
233 #define min( x, y ) ( ( ( x ) < ( y ) ) ? ( x ) : ( y ) )
237 #define sign( f ) ( ( f > 0 ) ? 1 : ( ( f < 0 ) ? -1 : 0 ) )
241 #define PITCH 0 // up / down
242 #define YAW 1 // left / right
243 #define ROLL 2 // fall over
245 // the game guarantees that no string from the network will ever
246 // exceed MAX_STRING_CHARS
247 #define MAX_STRING_CHARS 1024 // max length of a string passed to Cmd_TokenizeString
248 #define MAX_STRING_TOKENS 256 // max tokens resulting from Cmd_TokenizeString
249 #define MAX_TOKEN_CHARS 1024 // max length of an individual token
251 #define MAX_INFO_STRING 1024
252 #define MAX_INFO_KEY 1024
253 #define MAX_INFO_VALUE 1024
256 #define MAX_QPATH 64 // max length of a quake game pathname
257 #define MAX_OSPATH 128 // max length of a filesystem pathname
259 #define MAX_NAME_LENGTH 32 // max length of a client name
261 // paramters for command buffer stuffing
263 EXEC_NOW, // don't return until completed, a VM should NEVER use this,
264 // because some commands might cause the VM to be unloaded...
265 EXEC_INSERT, // insert at current position, but don't run yet
266 EXEC_APPEND // add to end of the command buffer (normal case)
271 // these aren't needed by any of the VMs. put in another header?
273 #define MAX_MAP_AREA_BYTES 32 // bit vector of area visibility
275 #undef ERR_FATAL // malloc.h on unix
277 // parameters to the main Error routine
280 ERR_FATAL, // exit the entire game with a popup window
281 ERR_DROP, // print to console and disconnect from game
282 ERR_DISCONNECT, // don't kill server
283 ERR_NEED_CD // pop up the need-cd dialog
287 // font rendering values used by ui and cgame
289 #define PROP_GAP_WIDTH 3
290 #define PROP_SPACE_WIDTH 8
291 #define PROP_HEIGHT 27
292 #define PROP_SMALL_SIZE_SCALE 0.75
294 #define BLINK_DIVISOR 200
295 #define PULSE_DIVISOR 75
297 #define UI_LEFT 0x00000000 // default
298 #define UI_CENTER 0x00000001
299 #define UI_RIGHT 0x00000002
300 #define UI_FORMATMASK 0x00000007
301 #define UI_SMALLFONT 0x00000010
302 #define UI_BIGFONT 0x00000020 // default
303 #define UI_GIANTFONT 0x00000040
304 #define UI_DROPSHADOW 0x00000800
305 #define UI_BLINK 0x00001000
306 #define UI_INVERSE 0x00002000
307 #define UI_PULSE 0x00004000
311 ==============================================================
315 ==============================================================
317 #ifdef __cplusplus // so we can include this in C code
323 #define Q_PI 3.14159265358979323846
325 #define M_PI 3.14159265358979323846 // matches value in gcc v2 math.h
328 #include "math_vector.h"
329 #include "math_angles.h"
330 #include "math_matrix.h"
331 #include "math_quaternion.h"
333 class idVec3; // for defining vectors
334 typedef idVec3 &vec3_p; // for passing vectors as function arguments
335 typedef const idVec3 &vec3_c; // for passing vectors as const function arguments
337 class angles_t; // for defining angle vectors
338 typedef angles_t &angles_p; // for passing angles as function arguments
339 typedef const angles_t &angles_c; // for passing angles as const function arguments
341 class mat3_t; // for defining matrices
342 typedef mat3_t &mat3_p; // for passing matrices as function arguments
343 typedef const mat3_t &mat3_c; // for passing matrices as const function arguments
347 #define NUMVERTEXNORMALS 162
348 extern idVec3 bytedirs[NUMVERTEXNORMALS];
350 // all drawing is done to a 640*480 virtual screen size
351 // and will be automatically scaled to the real resolution
352 #define SCREEN_WIDTH 640
353 #define SCREEN_HEIGHT 480
355 #define TINYCHAR_WIDTH (SMALLCHAR_WIDTH)
356 #define TINYCHAR_HEIGHT (SMALLCHAR_HEIGHT/2)
358 #define SMALLCHAR_WIDTH 8
359 #define SMALLCHAR_HEIGHT 16
361 #define BIGCHAR_WIDTH 16
362 #define BIGCHAR_HEIGHT 16
364 #define GIANTCHAR_WIDTH 32
365 #define GIANTCHAR_HEIGHT 48
367 extern idVec4 colorBlack;
368 extern idVec4 colorRed;
369 extern idVec4 colorGreen;
370 extern idVec4 colorBlue;
371 extern idVec4 colorYellow;
372 extern idVec4 colorMagenta;
373 extern idVec4 colorCyan;
374 extern idVec4 colorWhite;
375 extern idVec4 colorLtGrey;
376 extern idVec4 colorMdGrey;
377 extern idVec4 colorDkGrey;
379 #define Q_COLOR_ESCAPE '^'
380 #define Q_IsColorString(p) ( p && *(p) == Q_COLOR_ESCAPE && *((p)+1) && *((p)+1) != Q_COLOR_ESCAPE )
382 #define COLOR_BLACK '0'
383 #define COLOR_RED '1'
384 #define COLOR_GREEN '2'
385 #define COLOR_YELLOW '3'
386 #define COLOR_BLUE '4'
387 #define COLOR_CYAN '5'
388 #define COLOR_MAGENTA '6'
389 #define COLOR_WHITE '7'
390 #define ColorIndex(c) ( ( (c) - '0' ) & 7 )
392 #define S_COLOR_BLACK "^0"
393 #define S_COLOR_RED "^1"
394 #define S_COLOR_GREEN "^2"
395 #define S_COLOR_YELLOW "^3"
396 #define S_COLOR_BLUE "^4"
397 #define S_COLOR_CYAN "^5"
398 #define S_COLOR_MAGENTA "^6"
399 #define S_COLOR_WHITE "^7"
401 extern idVec4 g_color_table[8];
403 #define MAKERGB( v, r, g, b ) v[0]=r;v[1]=g;v[2]=b
404 #define MAKERGBA( v, r, g, b, a ) v[0]=r;v[1]=g;v[2]=b;v[3]=a
406 #define DEG2RAD( a ) ( ( (a) * M_PI ) / 180.0F )
407 #define RAD2DEG( a ) ( ( (a) * 180.0f ) / M_PI )
411 extern idVec3 vec3_origin;
412 extern idVec4 vec4_origin;
413 extern mat3_t axisDefault;
415 #define nanmask (255<<23)
417 #define IS_NAN(x) (((*(int *)&x)&nanmask)==nanmask)
419 float Q_fabs( float f );
420 float Q_rsqrt( float f ); // reciprocal square root
422 #define SQRTFAST( x ) ( 1.0f / Q_rsqrt( x ) )
424 signed char ClampChar( int i );
425 signed short ClampShort( int i );
427 // this isn't a real cheap function to call!
428 int DirToByte( const idVec3 &dir );
429 void ByteToDir( int b, vec3_p dir );
431 #define DotProduct(a,b) ((a)[0]*(b)[0]+(a)[1]*(b)[1]+(a)[2]*(b)[2])
432 #define VectorSubtract(a,b,c) ((c)[0]=(a)[0]-(b)[0],(c)[1]=(a)[1]-(b)[1],(c)[2]=(a)[2]-(b)[2])
433 #define VectorAdd(a,b,c) ((c)[0]=(a)[0]+(b)[0],(c)[1]=(a)[1]+(b)[1],(c)[2]=(a)[2]+(b)[2])
434 #define VectorCopy(a,b) ((b)[0]=(a)[0],(b)[1]=(a)[1],(b)[2]=(a)[2])
435 //#define VectorCopy(a,b) ((b).x=(a).x,(b).y=(a).y,(b).z=(a).z])
437 #define VectorScale(v, s, o) ((o)[0]=(v)[0]*(s),(o)[1]=(v)[1]*(s),(o)[2]=(v)[2]*(s))
438 #define VectorMA(v, s, b, o) ((o)[0]=(v)[0]+(b)[0]*(s),(o)[1]=(v)[1]+(b)[1]*(s),(o)[2]=(v)[2]+(b)[2]*(s))
439 #define CrossProduct(a,b,c) ((c)[0]=(a)[1]*(b)[2]-(a)[2]*(b)[1],(c)[1]=(a)[2]*(b)[0]-(a)[0]*(b)[2],(c)[2]=(a)[0]*(b)[1]-(a)[1]*(b)[0])
441 #define DotProduct4(x,y) ((x)[0]*(y)[0]+(x)[1]*(y)[1]+(x)[2]*(y)[2]+(x)[3]*(y)[3])
442 #define VectorSubtract4(a,b,c) ((c)[0]=(a)[0]-(b)[0],(c)[1]=(a)[1]-(b)[1],(c)[2]=(a)[2]-(b)[2],(c)[3]=(a)[3]-(b)[3])
443 #define VectorAdd4(a,b,c) ((c)[0]=(a)[0]+(b)[0],(c)[1]=(a)[1]+(b)[1],(c)[2]=(a)[2]+(b)[2],(c)[3]=(a)[3]+(b)[3])
444 #define VectorCopy4(a,b) ((b)[0]=(a)[0],(b)[1]=(a)[1],(b)[2]=(a)[2],(b)[3]=(a)[3])
445 #define VectorScale4(v, s, o) ((o)[0]=(v)[0]*(s),(o)[1]=(v)[1]*(s),(o)[2]=(v)[2]*(s),(o)[3]=(v)[3]*(s))
446 #define VectorMA4(v, s, b, o) ((o)[0]=(v)[0]+(b)[0]*(s),(o)[1]=(v)[1]+(b)[1]*(s),(o)[2]=(v)[2]+(b)[2]*(s),(o)[3]=(v)[3]+(b)[3]*(s))
449 #define VectorClear(a) ((a)[0]=(a)[1]=(a)[2]=0)
450 #define VectorNegate(a,b) ((b)[0]=-(a)[0],(b)[1]=-(a)[1],(b)[2]=-(a)[2])
451 #define VectorSet(v, x, y, z) ((v)[0]=(x), (v)[1]=(y), (v)[2]=(z))
452 #define Vector4Copy(a,b) ((b)[0]=(a)[0],(b)[1]=(a)[1],(b)[2]=(a)[2],(b)[3]=(a)[3])
454 #define SnapVector(v) {v[0]=(int)v[0];v[1]=(int)v[1];v[2]=(int)v[2];}
456 float NormalizeColor( vec3_c in, vec3_p out );
458 int VectorCompare( vec3_c v1, vec3_c v2 );
459 float VectorLength( vec3_c v );
460 float Distance( vec3_c p1, vec3_c p2 );
461 float DistanceSquared( vec3_c p1, vec3_c p2 );
462 float VectorNormalize (vec3_p v); // returns vector length
463 void VectorNormalizeFast(vec3_p v); // does NOT return vector length, uses rsqrt approximation
464 float VectorNormalize2( vec3_c v, vec3_p out );
465 void VectorInverse (vec3_p v);
466 void VectorRotate( vec3_c in, mat3_c matrix, vec3_p out );
467 void VectorPolar(vec3_p v, float radius, float theta, float phi);
468 void VectorSnap(vec3_p v);
469 void Vector53Copy( const idVec5_t &in, vec3_p out);
470 void Vector5Scale( const idVec5_t &v, float scale, idVec5_t &out);
471 void Vector5Add( const idVec5_t &va, const idVec5_t &vb, idVec5_t &out);
472 void VectorRotate3( vec3_c vIn, vec3_c vRotation, vec3_p out);
473 void VectorRotate3Origin(vec3_c vIn, vec3_c vRotation, vec3_c vOrigin, vec3_p out);
478 int Q_rand( int *seed );
479 float Q_random( int *seed );
480 float Q_crandom( int *seed );
482 #define random() ((rand () & 0x7fff) / ((float)0x7fff))
483 #define crandom() (2.0 * (random() - 0.5))
485 float Q_rint( float in );
487 void vectoangles( vec3_c value1, angles_p angles);
488 void AnglesToAxis( angles_c angles, mat3_p axis );
490 void AxisCopy( mat3_c in, mat3_p out );
491 qboolean AxisRotated( mat3_c in ); // assumes a non-degenerate axis
493 int SignbitsForNormal( vec3_c normal );
494 int BoxOnPlaneSide( const Bounds &b, struct cplane_s *p );
496 float AngleMod(float a);
497 float LerpAngle (float from, float to, float frac);
498 float AngleSubtract( float a1, float a2 );
499 void AnglesSubtract( angles_c v1, angles_c v2, angles_p v3 );
501 float AngleNormalize360 ( float angle );
502 float AngleNormalize180 ( float angle );
503 float AngleDelta ( float angle1, float angle2 );
505 qboolean PlaneFromPoints( idVec4 &plane, vec3_c a, vec3_c b, vec3_c c );
506 void ProjectPointOnPlane( vec3_p dst, vec3_c p, vec3_c normal );
507 void RotatePointAroundVector( vec3_p dst, vec3_c dir, vec3_c point, float degrees );
508 void RotateAroundDirection( mat3_p axis, float yaw );
509 void MakeNormalVectors( vec3_c forward, vec3_p right, vec3_p up );
510 // perpendicular vector could be replaced by this
512 int PlaneTypeForNormal( vec3_c normal );
514 void MatrixMultiply( mat3_c in1, mat3_c in2, mat3_p out );
515 void MatrixInverseMultiply( mat3_c in1, mat3_c in2, mat3_p out ); // in2 is transposed during multiply
516 void MatrixTransformVector( vec3_c in, mat3_c matrix, vec3_p out );
517 void MatrixProjectVector( vec3_c in, mat3_c matrix, vec3_p out ); // Places the vector into a new coordinate system.
518 void AngleVectors( angles_c angles, vec3_p forward, vec3_p right, vec3_p up);
519 void PerpendicularVector( vec3_p dst, vec3_c src );
521 float TriangleArea( vec3_c a, vec3_c b, vec3_c c );
522 #endif // __cplusplus
524 //=============================================
526 float Com_Clamp( float min, float max, float value );
528 #define FILE_HASH_SIZE 1024
529 int Com_HashString( const char *fname );
531 char *Com_SkipPath( char *pathname );
533 // it is ok for out == in
534 void Com_StripExtension( const char *in, char *out );
536 // "extension" should include the dot: ".map"
537 void Com_DefaultExtension( char *path, int maxSize, const char *extension );
539 int Com_ParseInfos( const char *buf, int max, char infos[][MAX_INFO_STRING] );
542 =====================================================================================
546 =====================================================================================
549 // this just controls the comment printing, it doesn't actually load a file
550 void Com_BeginParseSession( const char *filename );
551 void Com_EndParseSession( void );
553 int Com_GetCurrentParseLine( void );
555 // Will never return NULL, just empty strings.
556 // An empty string will only be returned at end of file.
557 // ParseOnLine will return empty if there isn't another token on this line
559 // this funny typedef just means a moving pointer into a const char * buffer
560 const char *Com_Parse( const char *(*data_p) );
561 const char *Com_ParseOnLine( const char *(*data_p) );
562 const char *Com_ParseRestOfLine( const char *(*data_p) );
564 void Com_UngetToken( void );
567 void Com_MatchToken( const char *(*buf_p), const char *match, qboolean warning = qfalse );
569 void Com_MatchToken( const char *(*buf_p), const char *match, qboolean warning );
572 void Com_ScriptError( const char *msg, ... );
573 void Com_ScriptWarning( const char *msg, ... );
575 void Com_SkipBracedSection( const char *(*program) );
576 void Com_SkipRestOfLine( const char *(*data) );
578 float Com_ParseFloat( const char *(*buf_p) );
579 int Com_ParseInt( const char *(*buf_p) );
581 void Com_Parse1DMatrix( const char *(*buf_p), int x, float *m );
582 void Com_Parse2DMatrix( const char *(*buf_p), int y, int x, float *m );
583 void Com_Parse3DMatrix( const char *(*buf_p), int z, int y, int x, float *m );
585 //=====================================================================================
590 void QDECL Com_sprintf (char *dest, int size, const char *fmt, ...);
593 // mode parm for FS_FOpenFile
607 //=============================================
609 int Q_isprint( int c );
610 int Q_islower( int c );
611 int Q_isupper( int c );
612 int Q_isalpha( int c );
614 // portable case insensitive compare
615 int Q_stricmp (const char *s1, const char *s2);
616 int Q_strncmp (const char *s1, const char *s2, int n);
617 int Q_stricmpn (const char *s1, const char *s2, int n);
618 char *Q_strlwr( char *s1 );
619 char *Q_strupr( char *s1 );
620 char *Q_strrchr( const char* string, int c );
622 // buffer size safe library replacements
623 void Q_strncpyz( char *dest, const char *src, int destsize );
624 void Q_strcat( char *dest, int size, const char *src );
626 // strlen that discounts Quake color sequences
627 int Q_PrintStrlen( const char *string );
628 // removes color sequences from string
629 char *Q_CleanStr( char *string );
631 int Com_Filter( const char *filter, const char *name, int casesensitive );
632 const char *Com_StringContains( const char *str1, const char *str2, int casesensitive );
635 //=============================================
637 short BigShort(short l);
638 short LittleShort(short l);
640 int LittleLong (int l);
641 float BigFloat (float l);
642 float LittleFloat (float l);
644 void Swap_Init (void);
645 char * QDECL va(char *format, ...);
652 //=============================================
657 typedef struct ePair_s {
662 typedef struct mapSide_s {
663 char material[MAX_QPATH];
665 idVec4 textureVectors[2];
679 char material[MAX_QPATH];
681 patchVertex_t *patchVerts;
685 char modelName[MAX_QPATH];
689 typedef struct mapPrimitive_s {
693 // only one of these will be non-NULL
699 typedef struct mapEntity_s {
701 mapPrimitive_t **primitives;
709 mapEntity_t **entities;
713 // the order of entities, brushes, and sides will be maintained, the
714 // lists won't be swapped on each load or save
715 mapFile_t *ParseMapFile( const char *text );
716 void FreeMapFile( mapFile_t *mapFile );
717 void WriteMapFile( const mapFile_t *mapFile, FILE *f );
719 // key names are case-insensitive
720 const char *ValueForMapEntityKey( const mapEntity_t *ent, const char *key );
721 float FloatForMapEntityKey( const mapEntity_t *ent, const char *key );
722 qboolean GetVectorForMapEntityKey( const mapEntity_t *ent, const char *key, idVec3 &vec );
729 byte smoothing[4]; // colors for silhouette smoothing
737 // Tesselate a map patch into smoothed, drawable vertexes
738 // MaxError of around 4 is reasonable
739 drawVertMesh_t *SubdivideMapPatch( const mapPatch_t *patch, float maxError );
740 #endif // __cplusplus
742 //=========================================
748 void QDECL Com_Error( int level, const char *error, ... );
749 void QDECL Com_Printf( const char *msg, ... );
750 void QDECL Com_DPrintf( const char *msg, ... );
758 qboolean frameMemory;
760 int maxElements; // will reallocate and move when exceeded
764 // you don't need to init the growlist if you don't mind it growing and moving
765 // the list as it expands
766 void Com_InitGrowList( growList_t *list, int maxElements );
767 int Com_AddToGrowList( growList_t *list, void *data );
768 void *Com_GrowListElement( const growList_t *list, int index );
769 int Com_IndexForGrowListElement( const growList_t *list, const void *element );
773 // key / value info strings
775 char *Info_ValueForKey( const char *s, const char *key );
776 void Info_RemoveKey( char *s, const char *key );
777 void Info_SetValueForKey( char *s, const char *key, const char *value );
778 qboolean Info_Validate( const char *s );
779 void Info_NextPair( const char *(*s), char key[MAX_INFO_KEY], char value[MAX_INFO_VALUE] );
781 // get cvar defs, collision defs, etc
782 //#include "../shared/interface.h"
784 // get key code numbers for events
785 //#include "../shared/keycodes.h"
788 // get the polygon winding functions
789 //#include "../shared/windings.h"
791 // get the flags class
792 //#include "../shared/idflags.h"
793 #endif // __cplusplus
795 #endif // __Q_SHARED_H