2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/GlobalIncs/PsTypes.h $
15 * Header file containg global typedefs, constants and macros
18 * Revision 1.8 2004/06/11 00:15:06 tigital
19 * byte-swapping changes for bigendian systems
21 * Revision 1.7 2002/07/13 19:47:02 theoddone33
22 * Fix some more warnings
24 * Change demo building, edit Makefile if you want the demo.
26 * Revision 1.6 2002/06/19 04:52:45 relnev
27 * MacOS X updates (Ryan)
29 * Revision 1.5 2002/06/17 06:33:08 relnev
30 * ryan's struct patch for gcc 2.95
32 * Revision 1.4 2002/06/09 04:41:14 relnev
33 * added copyright header
35 * Revision 1.3 2002/06/01 07:12:32 relnev
36 * a few NDEBUG updates.
38 * removed a few warnings.
40 * Revision 1.2 2002/05/28 06:28:20 theoddone33
41 * Filesystem mods, actually reads some data files now
43 * Revision 1.1.1.1 2002/05/03 03:28:12 root
47 * 34 6/16/00 3:16p Jefff
48 * sim of the year dvd version changes, a few german soty localization
51 * 33 10/05/99 2:29p Danw
53 * 32 10/01/99 9:10a Daveb
56 * 31 9/13/99 12:22a Dave
59 * 30 8/28/99 4:54p Dave
60 * Fixed directives display for multiplayer clients for wings with
61 * multiple waves. Fixed hud threat indicator rendering color.
63 * 29 8/09/99 4:18p Andsager
64 * Make french and german defines, needed specifically to enable language
65 * under launcher misc. tab
67 * 28 7/20/99 1:49p Dave
68 * Peter Drake build. Fixed some release build warnings.
70 * 27 7/18/99 5:19p Dave
71 * Jump node icon. Fixed debris fogging. Framerate warning stuff.
73 * 26 7/15/99 9:21a Andsager
76 * 25 7/09/99 9:51a Dave
77 * Added thick polyline code.
79 * 24 6/29/99 10:35a Dave
80 * Interface polygon bitmaps! Whee!
82 * 23 6/14/99 10:45a Dave
83 * Made beam weapons specify accuracy by skill level in the weapons.tbl
85 * 22 6/03/99 10:15p Dave
86 * Put in temporary main hall screen.
88 * 21 5/09/99 8:57p Dave
89 * Final E3 build preparations.
91 * 20 4/25/99 7:43p Dave
92 * Misc small bug fixes. Made sun draw properly.
94 * 19 4/25/99 3:03p Dave
95 * Removed E3_BUILD from pstypes
97 * 18 4/25/99 3:02p Dave
98 * Build defines for the E3 build.
100 * 17 4/15/99 1:29p Dave
101 * Remove multiplayer beta build define.
103 * 16 4/15/99 1:24p Dave
104 * Final Beta 1 checkin.
106 * 15 4/14/99 5:28p Dave
109 * 14 4/12/99 2:22p Dave
110 * More checks for dogfight stats.
112 * 13 4/09/99 2:21p Dave
113 * Multiplayer beta stuff. CD checking.
115 * 12 2/25/99 4:19p Dave
116 * Added multiplayer_beta defines. Added cd_check define. Fixed a few
117 * release build warnings. Added more data to the squad war request and
120 * 11 2/23/99 2:29p Dave
121 * First run of oldschool dogfight mode.
123 * 10 2/07/99 8:51p Andsager
124 * Add inner bound to asteroid field. Inner bound tries to stay astroid
125 * free. Wrap when within and don't throw at ships inside.
127 * 9 1/15/99 11:29a Neilk
128 * Fixed D3D screen/texture pixel formatting problem.
130 * 8 1/08/99 2:08p Dave
131 * Fixed software rendering for pofview. Super early support for AWACS and
134 * 7 1/06/99 2:24p Dave
135 * Stubs and release build fixes.
137 * 6 11/30/98 1:07p Dave
138 * 16 bit conversion, first run.
140 * 5 11/05/98 4:18p Dave
141 * First run nebula support. Beefed up localization a bit. Removed all
142 * conditional compiles for foreign versions. Modified mission file
145 * 4 10/13/98 9:28a Dave
146 * Started neatening up freespace.h. Many variables renamed and
147 * reorganized. Added AlphaColors.[h,cpp]
149 * 3 10/07/98 11:28a Dave
151 * 2 10/07/98 10:52a Dave
154 * 1 10/07/98 10:48a Dave
156 * 75 8/20/98 5:30p Dave
157 * Put in handy multiplayer logfile system. Now need to put in useful
158 * applications of it all over the code.
160 * 74 6/17/98 11:01a Lawrance
161 * set correct offset for English special font chars
163 * 73 6/12/98 4:52p Hoffoss
164 * Added support for special characters in in forgeign languages.
166 * 72 6/09/98 6:49p Lawrance
167 * Comment out UK_BUILD
169 * 71 6/09/98 5:15p Lawrance
170 * French/German localization
172 * 70 6/09/98 12:12p Hoffoss
173 * Added XSTR localization code.
175 * 69 6/05/98 9:49a Lawrance
178 * 68 5/22/98 3:13p Allender
179 * no Int3()'s and Asserts
181 * 67 5/20/98 12:59p John
182 * Turned optimizations on for debug builds. Also turning on automatic
183 * function inlining. Turned off the unreachable code warning.
185 * 66 5/04/98 1:49p Allender
186 * make Int3's do nothing when InterplayQA is defined
188 * 65 4/25/98 11:55p Lawrance
189 * compile out Int3() and Assert() for release demo build
200 // Build defines. Comment in/out for whatever build is necessary:
201 // #define OEM_BUILD // enable for OEM builds
202 // #define MULTIPLAYER_BETA_BUILD // enable for multiplayer beta build
203 // #define E3_BUILD // enable for 3dfx E3 build
204 // #define PRESS_TOUR_BUILD // enable for press tour build
205 //#define FS2_DEMO // enable demo build for FS2
206 // #define PD_BUILD // fred documentation/evaluation build
207 // #define FRENCH_BUILD // build for French (obsolete)
208 // #define GERMAN_BUILD // build for German (this is now used)
209 //#define RELEASE_REAL // this means that it is an actual release candidate, not just an optimized/release build
211 // uncomment this #define for DVD version (makes popups say DVD instead of CD 2 or whatever): JCF 5/10/2000
212 // #define DVD_MESSAGE_HACK
215 #if defined(MULTIPLAYER_BETA_BUILD) || defined(E3_BUILD) || defined(RELEASE_REAL)
216 #define GAME_CD_CHECK
219 // 4127 is constant conditional (assert)
220 // 4100 is unreferenced formal parameters,
221 // 4514 is unreferenced inline function removed,
222 // 4201 is nameless struct extension used. (used by windows header files)
223 // 4410 illegal size for operand... ie... fxch st(1)
224 // 4611 is _setjmp warning. Since we use setjmp alot, and we don't really use constructors or destructors, this warning doesn't really apply to us.
225 // 4725 is the pentium division bug warning, and I can't seem to get rid of it, even with this pragma.
226 // JS: I figured out the disabling 4725 works, but not on the first function in the module.
227 // So to disable this, I add in a stub function at the top of each module that does nothing.
228 // 4710 is inline function not expanded (who cares?)
229 // 4711 tells us an inline function was expanded (who cares?)
230 // 4702 unreachable code. I care, but too many to deal with
231 // 4201 nonstandard extension used : nameless struct/union (happens a lot in Windows include headers)
232 // 4390 emptry control statement (triggered by nprintf and mprintf's inside of one-line if's, etc)
234 #pragma warning(disable: 4127 4100 4514 4201 4410 4611 4725 4710 4711 4702 4201 4390)
237 #include <stdio.h> // For NULL, etc
250 // value to represent an uninitialized state in any int or uint
251 #define UNINITIALIZED 0x7f8e6d9c
253 #if defined(DEMO) || defined(OEM_BUILD) // no change for FS2_DEMO
254 #define MAX_PLAYERS 1
256 #define MAX_PLAYERS 12
261 #define USE_INLINE_ASM 1 // Define this to use inline assembly
262 #define STRUCT_CMP(a, b) memcmp((void *) &a, (void *) &b, sizeof(a))
264 #define LOCAL static // make module local varilable static.
267 typedef int socklen_t;
270 typedef __int64 longlong;
272 typedef unsigned char ubyte;
273 typedef unsigned short ushort;
274 typedef unsigned int uint;
275 typedef unsigned long ulong;
277 #define HARDWARE_ONLY
279 //Stucture to store clipping codes in a word
280 typedef struct ccodes {
281 ubyte vor,vand; //or is low byte, and is high byte
284 typedef struct vector {
293 // A vector referenced as an array
294 typedef struct vectora {
298 typedef struct vec2d {
302 // Used for some 2d primitives, like gr_poly
303 typedef struct vert2df {
307 typedef struct angles {
311 typedef struct matrix {
314 vector rvec, uvec, fvec;
321 typedef struct uv_pair {
325 // Used to store rotated points for mines.
326 // Has flag to indicate if projected.
327 typedef struct vertex {
328 float x, y, z; // world space position
329 float sx, sy, sw; // screen space position (sw == 1/z)
330 float u, v; // texture position
331 ubyte r, g, b, a; // color. Use b for darkening;
332 ubyte codes; // what sides of view pyramid this point is on/off. 0 = Inside view pyramid.
333 ubyte flags; // Projection flags. Indicates whether it is projected or not or if projection overflowed.
334 ubyte pad[2]; // pad structure to be 4 byte aligned.
337 #define BMP_AABITMAP (1<<0) // antialiased bitmap
338 #define BMP_TEX_XPARENT (1<<1) // transparent texture
339 #define BMP_TEX_NONDARK (1<<2) // nondarkening texture
340 #define BMP_TEX_OTHER (1<<3) // so we can identify all "normal" textures
343 #define BMP_TEX_ANY ( BMP_TEX_XPARENT | BMP_TEX_NONDARK | BMP_TEX_OTHER )
345 // max res == 1024x768. max texture size == 256
346 #define MAX_BMAP_SECTIONS_X 4
347 #define MAX_BMAP_SECTIONS_Y 3
348 #define MAX_BMAP_SECTION_SIZE 256
349 typedef struct bitmap_section_info {
350 ushort sx[MAX_BMAP_SECTIONS_X]; // x offset of each section
351 ushort sy[MAX_BMAP_SECTIONS_Y]; // y offset of each section
353 ubyte num_x, num_y; // number of x and y sections
354 } bitmap_section_info;
356 typedef struct bitmap {
357 short w, h; // Width and height
358 short rowsize; // What you need to add to go to next row
359 ubyte bpp; // How many bits per pixel it is. (7,8,15,16,24,32)
360 ubyte flags; // See the BMP_???? defines for values
361 uint data; // Pointer to data, or maybe offset into VRAM.
362 ubyte *palette; // If bpp==8, this is pointer to palette. If the BMP_NO_PALETTE_MAP flag
363 // is not set, this palette just points to the screen palette. (gr_palette)
365 bitmap_section_info sections;
368 //This are defined in MainWin.c
369 extern void _cdecl WinAssert(char * text,char *filename, int line);
370 extern void _cdecl Error( char * filename, int line, char * format, ... );
371 extern void _cdecl Warning( char * filename, int line, char * format, ... );
375 // To debug printf do this:
376 // mprintf(( "Error opening %s\n", filename ));
378 #define mprintf(args) outwnd_printf2 args
379 #define nprintf(args) outwnd_printf args
381 #define mprintf(args)
382 #define nprintf(args)
385 #define LOCATION __FILE__,__LINE__
387 // To flag an error, you can do this:
388 // Error( __FILE__, __LINE__, "Error opening %s", filename );
390 // Error( LOCATION, "Error opening %s", filename );
393 #define Assert(x) do {} while (0)
395 void gr_activate(int);
396 #define Assert(x) do { if (!(x)){ gr_activate(0); WinAssert(#x,__FILE__,__LINE__); gr_activate(1); } } while (0)
399 //#define Int3() _asm { int 3 }
402 // Interplay QA version of Int3
403 #define Int3() do { } while (0)
405 // define to call from Warning function above since it calls Int3, so without this, we
406 // get put into infinite dialog boxes
407 #define AsmInt3() _asm { int 3 }
411 // No debug version of Int3
412 #define Int3() do { } while (0)
416 // Debug version of Int3
417 #define Int3() debug_int3()
418 #endif // NDEBUG && DEMO
419 #endif // INTERPLAYQA
421 #define min(a,b) (((a) < (b)) ? (a) : (b))
422 #define max(a,b) (((a) > (b)) ? (a) : (b))
424 #define PI 3.141592654f
425 #define PI2 (3.141592654f*2.0f) // PI*2
426 #define ANG_TO_RAD(x) ((x)*PI/180)
429 extern int Fred_running; // Is Fred running, or FreeSpace?
430 extern int Pofview_running;
431 extern int Nebedit_running;
434 //======================================================================================
435 //====== D E B U G C O N S O L E S T U F F ========================
436 //======================================================================================
438 // Here is a a sample command to toggle something that would
439 // be called by doing "toggle it" from the debug console command window/
442 DCF(toggle_it,"description")
445 This_var = !This_var;
449 dc_printf( "Usage: sample\nToggles This_var on/off.\n" );
453 dc_printf( "The status is %d.\n", This_var );
457 class debug_command {
462 debug_command(char *name,char *help,void (*func)()); // constructor
465 #define DCF(function_name,help_text) \
466 void dcf_##function_name(); \
467 debug_command dc_##function_name(#function_name,help_text,dcf_##function_name); \
468 void dcf_##function_name()
470 // Starts the debug console
471 extern void debug_console( void (*func)() = NULL );
473 // The next three variables tell your function what to do. It should
474 // only change something if the dc_command is set. A minimal function
475 // needs to process the dc_command. Usually, these will be called in
476 // these combinations:
477 // dc_command=true, dc_status=true means process it and show status
478 // dc_help=true means show help only
479 // dc_status=true means show status only
480 // I would recommend doing this in each function:
481 // if (dc_command) { process command }
482 // if (dc_help) { print out help }
483 // if (dc_status) { print out status }
484 // with the last two being optional
486 extern int Dc_command; // If this is set, then process the command
487 extern int Dc_help; // If this is set, then print out the help text in the form, "usage: ... \nLong description\n" );
488 extern int Dc_status; // If this is set, then print out the current status of the command.
490 void dc_get_arg(uint flags); // Gets the next argument. If it doesn't match the flags, this function will print an error and not return.
491 extern char *Dc_arg; // The (lowercased) string value of the argument retrieved from dc_arg
492 extern char *Dc_arg_org; // Dc_arg before it got converted to lowercase
493 extern uint Dc_arg_type; // The type of dc_arg.
494 extern char *Dc_command_line; // The rest of the command line, from the end of the last processed arg on.
495 extern int Dc_arg_int; // If Dc_arg_type & ARG_INT or ARG_HEX is set, then this is the value
496 extern float Dc_arg_float; // If Dc_arg_type & ARG_FLOAT is set, then this is the value
498 // Outputs text to the console
499 void dc_printf( char *format, ... );
501 // Each dc_arg_type can have one or more of these flags set.
502 // This is because some things can fit into two catagories.
503 // Like 1 can be an integer, a float, a string, or a true boolean
505 #define ARG_NONE (1<<0) // no argument
506 #define ARG_ANY 0xFFFFFFFF // Anything.
507 #define ARG_STRING (1<<1) // any valid string
508 #define ARG_QUOTE (1<<2) // a quoted string
509 #define ARG_INT (1<<3) // a valid integer
510 #define ARG_FLOAT (1<<4) // a valid floating point number
512 // some specific commonly used predefined types. Can add up to (1<<31)
513 #define ARG_HEX (1<<5) // a valid hexadecimal integer. Note that ARG_INT will always be set also in this case.
514 #define ARG_TRUE (1<<6) // on, true, non-zero number
515 #define ARG_FALSE (1<<7) // off, false, zero
516 #define ARG_PLUS (1<<8) // Plus sign
517 #define ARG_MINUS (1<<9) // Minus sign
518 #define ARG_COMMA (1<<10) // a comma
520 // A shortcut for boolean only variables.
522 // DCF_BOOL( lighting, Show_lighting )
524 #define DCF_BOOL( function_name, bool_variable ) \
525 void dcf_##function_name(); \
526 debug_command dc_##function_name(#function_name,"Toggles "#bool_variable,dcf_##function_name ); \
527 void dcf_##function_name() { \
528 if ( Dc_command ) { \
529 dc_get_arg(ARG_TRUE|ARG_FALSE|ARG_NONE); \
530 if ( Dc_arg_type & ARG_TRUE ) bool_variable = 1; \
531 else if ( Dc_arg_type & ARG_FALSE ) bool_variable = 0; \
532 else if ( Dc_arg_type & ARG_NONE ) bool_variable ^= 1; \
534 if ( Dc_help ) dc_printf( "Usage: %s [bool]\nSets %s to true or false. If nothing passed, then toggles it.\n", #function_name, #bool_variable ); \
535 if ( Dc_status ) dc_printf( "%s is %s\n", #function_name, (bool_variable?"TRUE":"FALSE") ); \
539 //======================================================================================
540 //======================================================================================
541 //======================================================================================
546 #include "floating.h"
548 // Some constants for stuff
549 #define MAX_FILENAME_LEN 32 // Length for filenames, ie "title.pcx"
550 #define MAX_PATH_LEN 128 // Length for pathnames, ie "c:\bitmaps\title.pcx"
552 // contants and defined for byteswapping routines (useful for mac)
554 #define SWAPSHORT(x) ( \
559 #define SWAPINT(x) ( \
561 (((ulong)x) >> 24) | \
562 ((x & 0x0000ff00) << 8) | \
563 ((x & 0x00ff0000) >> 8) \
565 #if SDL_BYTEORDER == SDL_BIG_ENDIAN
567 float SWAPFLOAT( float *x )
569 #if ! defined( __MWERKS__ )
570 //Usage: void __stwbrx( unsigned int, unsigned int *address, int byteOffsetFromAddress );
571 #define __stwbrx( value, base, index ) \
572 __asm__ ( "stwbrx %0, %1, %2" : : "r" (value), "b%" (index), "r" (base) : "memory" )
581 //load the float into the integer unit
582 //unsigned int a = ((long*) x)[0];
583 register int a = ((int*) x )[0];
585 //store it to the transfer union, with byteswapping
586 __stwbrx( a, 0, &buf.i );
588 //load it into the FPU and return it
593 #if SDL_BYTEORDER != SDL_BIG_ENDIAN
594 #define INTEL_INT(x) x
595 #define INTEL_SHORT(x) x
596 #define INTEL_FLOAT(x) x
598 #define INTEL_INT(x) SWAPINT(x)
599 #define INTEL_SHORT(x) SWAPSHORT(x)
600 #define INTEL_FLOAT(x) SWAPFLOAT(x)
610 // Callback Loading function.
611 // If you pass a function to this, that function will get called
612 // around 10x per second, so you can update the screen.
613 // Pass NULL to turn it off.
614 // Call this with the name of a function. That function will
615 // then get called around 10x per second. The callback function
616 // gets passed a 'count' which is how many times game_busy has
617 // been called since the callback was set. It gets called
618 // one last time with count=-1 when you turn off the callback
619 // by calling game_busy_callback(NULL). Game_busy_callback
620 // returns the current count, so you can tell how many times
621 // game_busy got called.
622 // If delta_step is above 0, then it will also make sure it
623 // calls the callback each time count steps 'delta_step' even
624 // if 1/10th of a second hasn't elapsed.
625 extern int game_busy_callback( void (*callback)(int count), int delta_step = -1 );
627 // Call whenever loading to display cursor
628 extern void game_busy();
631 //=========================================================
632 // Functions to monitor performance
638 int value; // Value that gets cleared to 0 each frame.
639 int min, max, sum, cnt; // Min & Max of value. Sum is used to calculate average
640 monitor(char *name); // constructor
643 // Creates a monitor variable
644 #define MONITOR(function_name) monitor mon_##function_name(#function_name)
646 // Increments a monitor variable
647 #define MONITOR_INC(function_name,inc) do { mon_##function_name.value+=(inc); } while(0)
649 // Call this once per frame to update monitor file
650 void monitor_update();
654 #define MONITOR(function_name)
656 #define MONITOR_INC(function_name,inc) do { } while(0)
658 // Call this once per frame to update monitor file
659 #define monitor_update() do { } while(0)
665 char *XSTR(char *str, int index);
667 // Caps V between MN and MX.
668 template <class T> void CAP( T& v, T mn, T mx )
672 } else if ( v > mx ) {
677 // ========================================================
678 // stamp checksum stuff
679 // ========================================================
681 // here is the define for the stamp for this set of code
682 #define STAMP_STRING "\001\001\001\001\002\002\002\002Read the Foundation Novels from Asimov. I liked them."
683 #define STAMP_STRING_LENGTH 80
684 #define DEFAULT_CHECKSUM_STRING "\001\001\001\001"
685 #define DEFAULT_TIME_STRING "\002\002\002\002"
687 // macro to calculate the checksum for the stamp. Put here so that we can use different methods
688 // for different applications. Requires the local variable 'checksum' to be defined!!!
689 #define CALCULATE_STAMP_CHECKSUM() do { \
693 for ( i = 0; i < (int)strlen(ptr); i++ ) { \
695 checksum += ptr[i]; \
696 if ( checksum & 0x01 ) \
698 checksum = checksum >> 1; \
700 checksum |= 0x80000000; \
702 checksum |= 0x80000000; \
705 //=========================================================
706 // Memory management functions
707 //=========================================================
712 // Returns 0 if not enough RAM.
713 int vm_init(int min_heap_size);
715 // Allocates some RAM.
716 void *vm_malloc( int size, char *filename=NULL, int line=-1 );
719 char *vm_strdup( const char *ptr, char *filename, int line );
722 void vm_free( void *ptr, char *filename=NULL, int line=-1 );
727 // Easy to use macros
728 #define VM_MALLOC(size) vm_malloc((size),__FILE__,__LINE__)
729 #define VM_FREE(ptr) vm_free((ptr),__FILE__,__LINE__)
731 #define malloc(size) vm_malloc((size),__FILE__,__LINE__)
732 #define free(ptr) vm_free((ptr),__FILE__,__LINE__)
733 #define strdup(ptr) vm_strdup((ptr),__FILE__,__LINE__)
738 // Returns 0 if not enough RAM.
739 int vm_init(int min_heap_size);
741 // Allocates some RAM.
742 // void *vm_malloc( int size );
745 // char *vm_strdup( const char *ptr );
748 // void vm_free( void *ptr );
753 // Easy to use macros
754 #define VM_MALLOC(size) vm_malloc(size)
755 #define VM_FREE(ptr) vm_free(ptr)
757 // #define malloc(size) vm_malloc(size)
758 // #define free(ptr) vm_free(ptr)
759 // #define strdup(ptr) vm_strdup(ptr)
760 #define vm_malloc(size) malloc(size)
761 #define vm_free(ptr) free(ptr)
762 #define vm_strdup(ptr) strdup(ptr)