]> icculus.org git repositories - taylor/freespace2.git/blob - include/pstypes.h
silence various MSVC warnings
[taylor/freespace2.git] / include / pstypes.h
1 /*
2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
3  *
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
6  * the source.
7  */
8
9 /*
10  * $Logfile: /Freespace2/code/GlobalIncs/PsTypes.h $
11  * $Revision$
12  * $Date$
13  * $Author$
14  *
15  * Header file containg global typedefs, constants and macros
16  *
17  * $Log$
18  * Revision 1.12  2005/10/01 21:38:32  taylor
19  * some reorg of includes to not requires the same headers in many different files
20  * handle FS1 specific language changes
21  * some OS X changes for paths and to handle socklen_t better
22  *
23  * Revision 1.11  2004/12/15 04:10:45  taylor
24  * outwnd_unix.cpp from fs2_open for logging to file in debug mode
25  * fixes for default function values
26  * always use vm_* functions for sanity sake
27  * make cfilearchiver 64-bit compatible
28  * fix crash on exit from double free()
29  * fix crash on startup from extra long GL extension string in debug
30  *
31  * Revision 1.10  2004/07/04 11:31:43  taylor
32  * amd64 support, compiler warning fixes, don't use software rendering
33  *
34  * Revision 1.9  2004/06/11 21:39:44  taylor
35  * x86 compile fixes for OSX patch
36  *
37  * Revision 1.8  2004/06/11 00:15:06  tigital
38  * byte-swapping changes for bigendian systems
39  *
40  * Revision 1.7  2002/07/13 19:47:02  theoddone33
41  * Fix some more warnings
42  *
43  * Change demo building, edit Makefile if you want the demo.
44  *
45  * Revision 1.6  2002/06/19 04:52:45  relnev
46  * MacOS X updates (Ryan)
47  *
48  * Revision 1.5  2002/06/17 06:33:08  relnev
49  * ryan's struct patch for gcc 2.95
50  *
51  * Revision 1.4  2002/06/09 04:41:14  relnev
52  * added copyright header
53  *
54  * Revision 1.3  2002/06/01 07:12:32  relnev
55  * a few NDEBUG updates.
56  *
57  * removed a few warnings.
58  *
59  * Revision 1.2  2002/05/28 06:28:20  theoddone33
60  * Filesystem mods, actually reads some data files now
61  *
62  * Revision 1.1.1.1  2002/05/03 03:28:12  root
63  * Initial import.
64  *
65  * 
66  * 34    6/16/00 3:16p Jefff
67  * sim of the year dvd version changes, a few german soty localization
68  * fixes
69  * 
70  * 33    10/05/99 2:29p Danw
71  * 
72  * 32    10/01/99 9:10a Daveb
73  * V 1.1 PATCH
74  * 
75  * 31    9/13/99 12:22a Dave
76  * Minor build update.
77  * 
78  * 30    8/28/99 4:54p Dave
79  * Fixed directives display for multiplayer clients for wings with
80  * multiple waves. Fixed hud threat indicator rendering color.
81  * 
82  * 29    8/09/99 4:18p Andsager
83  * Make french and german defines, needed specifically to enable language
84  * under launcher misc. tab
85  * 
86  * 28    7/20/99 1:49p Dave
87  * Peter Drake build. Fixed some release build warnings.
88  * 
89  * 27    7/18/99 5:19p Dave
90  * Jump node icon. Fixed debris fogging. Framerate warning stuff.
91  * 
92  * 26    7/15/99 9:21a Andsager
93  * FS2_DEMO check in
94  * 
95  * 25    7/09/99 9:51a Dave
96  * Added thick polyline code.
97  * 
98  * 24    6/29/99 10:35a Dave
99  * Interface polygon bitmaps! Whee!
100  * 
101  * 23    6/14/99 10:45a Dave
102  * Made beam weapons specify accuracy by skill level in the weapons.tbl
103  * 
104  * 22    6/03/99 10:15p Dave
105  * Put in temporary main hall screen.
106  * 
107  * 21    5/09/99 8:57p Dave
108  * Final E3 build preparations.
109  * 
110  * 20    4/25/99 7:43p Dave
111  * Misc small bug fixes. Made sun draw properly.
112  * 
113  * 19    4/25/99 3:03p Dave
114  * Removed E3_BUILD from pstypes
115  * 
116  * 18    4/25/99 3:02p Dave
117  * Build defines for the E3 build.
118  * 
119  * 17    4/15/99 1:29p Dave
120  * Remove multiplayer beta build define.
121  * 
122  * 16    4/15/99 1:24p Dave
123  * Final Beta 1 checkin.
124  * 
125  * 15    4/14/99 5:28p Dave
126  * Minor bug fixes.
127  * 
128  * 14    4/12/99 2:22p Dave
129  * More checks for dogfight stats.
130  * 
131  * 13    4/09/99 2:21p Dave
132  * Multiplayer beta stuff. CD checking.
133  * 
134  * 12    2/25/99 4:19p Dave
135  * Added multiplayer_beta defines. Added cd_check define. Fixed a few
136  * release build warnings. Added more data to the squad war request and
137  * response packets.
138  * 
139  * 11    2/23/99 2:29p Dave
140  * First run of oldschool dogfight mode. 
141  * 
142  * 10    2/07/99 8:51p Andsager
143  * Add inner bound to asteroid field.  Inner bound tries to stay astroid
144  * free.  Wrap when within and don't throw at ships inside.
145  * 
146  * 9     1/15/99 11:29a Neilk
147  * Fixed D3D screen/texture pixel formatting problem. 
148  * 
149  * 8     1/08/99 2:08p Dave
150  * Fixed software rendering for pofview. Super early support for AWACS and
151  * beam weapons.
152  * 
153  * 7     1/06/99 2:24p Dave
154  * Stubs and release build fixes.
155  * 
156  * 6     11/30/98 1:07p Dave
157  * 16 bit conversion, first run.
158  * 
159  * 5     11/05/98 4:18p Dave
160  * First run nebula support. Beefed up localization a bit. Removed all
161  * conditional compiles for foreign versions. Modified mission file
162  * format.
163  * 
164  * 4     10/13/98 9:28a Dave
165  * Started neatening up freespace.h. Many variables renamed and
166  * reorganized. Added AlphaColors.[h,cpp]
167  * 
168  * 3     10/07/98 11:28a Dave
169  * 
170  * 2     10/07/98 10:52a Dave
171  * Initial checkin.
172  * 
173  * 1     10/07/98 10:48a Dave
174  * 
175  * 75    8/20/98 5:30p Dave
176  * Put in handy multiplayer logfile system. Now need to put in useful
177  * applications of it all over the code.
178  * 
179  * 74    6/17/98 11:01a Lawrance
180  * set correct offset for English special font chars
181  * 
182  * 73    6/12/98 4:52p Hoffoss
183  * Added support for special characters in in forgeign languages.
184  * 
185  * 72    6/09/98 6:49p Lawrance
186  * Comment out UK_BUILD
187  * 
188  * 71    6/09/98 5:15p Lawrance
189  * French/German localization
190  * 
191  * 70    6/09/98 12:12p Hoffoss
192  * Added XSTR localization code.
193  * 
194  * 69    6/05/98 9:49a Lawrance
195  * OEM changes
196  * 
197  * 68    5/22/98 3:13p Allender
198  * no Int3()'s and Asserts
199  * 
200  * 67    5/20/98 12:59p John
201  * Turned optimizations on for debug builds.   Also turning on automatic
202  * function inlining.  Turned off the unreachable code warning.
203  * 
204  * 66    5/04/98 1:49p Allender
205  * make Int3's do nothing when InterplayQA is defined
206  * 
207  * 65    4/25/98 11:55p Lawrance
208  * compile out Int3() and SDL_assert() for release demo build
209  * 
210  *
211  * $NoKeywords: $
212  *
213  */
214
215 #ifndef _PSTYPES_H
216 #define _PSTYPES_H
217
218
219 // Build defines.  Comment in/out for whatever build is necessary:
220 // #define OEM_BUILD                                            // enable for OEM builds
221 // #define MULTIPLAYER_BETA_BUILD                               // enable for multiplayer beta build
222 // #define E3_BUILD                                                     // enable for 3dfx E3 build                                             
223 // #define PRESS_TOUR_BUILD                     // enable for press tour build
224 //#define FS2_DEMO                                      // enable demo build for FS2
225 // #define PD_BUILD                                             // fred documentation/evaluation build
226 //      #define FRENCH_BUILD                            // build for French (obsolete)
227 // #define GERMAN_BUILD                         // build for German (this is now used)
228 //#define RELEASE_REAL                                  // this means that it is an actual release candidate, not just an optimized/release build
229
230 // uncomment this #define for DVD version (makes popups say DVD instead of CD 2 or whatever): JCF 5/10/2000
231 // #define DVD_MESSAGE_HACK
232
233
234 #if defined(MULTIPLAYER_BETA_BUILD) || defined(E3_BUILD) || defined(RELEASE_REAL)
235         #define GAME_CD_CHECK
236 #endif
237
238 // 4127 is constant conditional (assert)
239 // 4100 is unreferenced formal parameters,
240 // 4514 is unreferenced inline function removed, 
241 // 4201 is nameless struct extension used. (used by windows header files)
242 // 4410 illegal size for operand... ie...       fxch st(1)
243 // 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.
244 // 4725 is the pentium division bug warning, and I can't seem to get rid of it, even with this pragma.
245 //      JS: I figured out the disabling 4725 works, but not on the first function in the module.
246 //      So to disable this, I add in a stub function at the top of each module that does nothing.
247 // 4710 is inline function not expanded (who cares?)
248 // 4711 tells us an inline function was expanded (who cares?)
249 // 4702 unreachable code.  I care, but too many to deal with
250 // 4201 nonstandard extension used : nameless struct/union (happens a lot in Windows include headers)
251 // 4390 emptry control statement (triggered by nprintf and mprintf's inside of one-line if's, etc)
252 #ifndef PLAT_UNIX
253 #pragma warning(disable: 4127 4100 4514 4201 4410 4611 4725 4710 4711 4702 4201 4390)
254 #endif
255
256 #include "SDL.h"
257
258 #include <stdio.h>      // For NULL, etc
259 #include <stdlib.h>
260 #include <memory.h>
261
262 #ifndef __APPLE__
263 #include <malloc.h>
264 #endif
265
266 #include <string.h>
267
268 #ifdef PLAT_UNIX
269 #include "unix.h"
270 #endif
271
272 // same thing that's in FS2_Open (credit: Mike Harris)
273 #ifdef PLAT_UNIX
274 #define DIR_SEPARATOR_CHAR '/'
275 #define DIR_SEPARATOR_STR "/"
276 #else
277 #define DIR_SEPARATOR_CHAR '\\'
278 #define DIR_SEPARATOR_STR "\\"
279 #endif
280
281 // value to represent an uninitialized state in any int or uint
282 #define UNINITIALIZED 0x7f8e6d9c
283
284 #if defined(DEMO) || defined(OEM_BUILD) // no change for FS2_DEMO
285         #define MAX_PLAYERS     1
286 #else
287         #define MAX_PLAYERS     12
288 #endif
289
290 #define MAX_TEAMS               3
291
292 #define USE_INLINE_ASM 1                // Define this to use inline assembly
293 #define STRUCT_CMP(a, b) memcmp((void *) &a, (void *) &b, sizeof(a))
294
295 #define LOCAL static                    // make module local varilable static.
296
297 typedef Sint32 fix;
298 typedef Uint8 ubyte;
299 typedef Uint16 ushort;
300 typedef Uint32 uint;
301 typedef Sint32 fs_time_t;       // forced 32-bit version of time_t - **don't use this unless required**
302
303 // ptr_? is a value matching the size of a pointer on this specific platform
304 #if ( defined(__x86_64__) || defined(_WIN64) )
305 typedef Sint64 ptr_s;
306 typedef Uint64 ptr_u;
307 #else
308 typedef Sint32 ptr_s;
309 typedef Uint32 ptr_u;
310 #endif
311
312 //Stucture to store clipping codes in a word
313 typedef struct ccodes {
314         ubyte vor,vand; //or is low byte, and is high byte
315 } ccodes;
316
317 typedef struct vector {
318         union {
319                 struct {
320                         float x,y,z;
321                 } xyz;
322                 float a1d[3];
323         };
324 } vector;
325
326 // A vector referenced as an array
327 typedef struct vectora {
328         float   xyz[3];
329 } vectora;
330
331 typedef struct vec2d {
332         float i,j;
333 } vec2d;
334
335 // Used for some 2d primitives, like gr_poly
336 typedef struct vert2df {
337         float x, y;
338 } vert2df;
339
340 typedef struct angles {
341         float   p, b, h;
342 } angles_t;
343
344 typedef struct matrix {
345         union {
346                 struct {
347                         vector  rvec, uvec, fvec;
348                 } v;
349                 float a2d[3][3];
350                 float a1d[9];
351         };
352 } matrix;
353
354 typedef struct uv_pair {
355         float u,v;
356 } uv_pair;
357
358 // Used to store rotated points for mines.
359 // Has flag to indicate if projected.
360 typedef struct vertex {
361         float           x, y, z;                                // world space position
362         float           sx, sy, sw;                     // screen space position (sw == 1/z)
363         float           u, v;                                   // texture position
364         ubyte           r, g, b, a;                     // color.  Use b for darkening;
365         ubyte           codes;                          // what sides of view pyramid this point is on/off.  0 = Inside view pyramid.
366         ubyte           flags;                          // Projection flags.  Indicates whether it is projected or not or if projection overflowed.
367         ubyte           pad[2];                         // pad structure to be 4 byte aligned.
368 } vertex;
369
370 #define BMP_AABITMAP            (1<<0)                          // antialiased bitmap
371 #define BMP_TEX_XPARENT         (1<<1)                          // transparent texture
372 #define BMP_TEX_OTHER           (1<<2)                          // so we can identify all "normal" textures
373
374 // any texture type
375 #define BMP_TEX_ANY                             ( BMP_TEX_XPARENT | BMP_TEX_OTHER )
376
377 // max res == 1024x768. max texture size == 256
378 #define MAX_BMAP_SECTIONS_X                             4
379 #define MAX_BMAP_SECTIONS_Y                             3
380 #define MAX_BMAP_SECTION_SIZE                           256
381 typedef struct bitmap_section_info {
382         ushort sx[MAX_BMAP_SECTIONS_X];         // x offset of each section
383         ushort sy[MAX_BMAP_SECTIONS_Y];         // y offset of each section
384
385         ubyte num_x, num_y;                                             // number of x and y sections
386 } bitmap_section_info;
387
388 typedef struct bitmap {
389         short   w, h;           // Width and height
390         short   rowsize;        // What you need to add to go to next row
391         ubyte   bpp;            // How many bits per pixel it is. (7,8,15,16,24,32)
392         ubyte   flags;  // See the BMP_???? defines for values
393         ptr_u   data;           // Pointer to data, or maybe offset into VRAM.
394         ubyte *palette; // If bpp==8, this is pointer to palette.   If the BMP_NO_PALETTE_MAP flag
395                                                         // is not set, this palette just points to the screen palette. (gr_palette)
396
397         bitmap_section_info sections;
398 } bitmap;
399
400 //This are defined in MainWin.c
401 extern void __cdecl Error( const char * filename, int line, const char * format, ... );
402 extern void __cdecl Warning( const char * filename, int line, const char * format, ... );
403
404 #include "outwnd.h"
405
406 // To debug printf do this:
407 // mprintf(( "Error opening %s\n", filename ));
408 #ifndef NDEBUG
409 #define mprintf(args) outwnd_printf2 args
410 #define nprintf(args) outwnd_printf args
411 #else
412 #define mprintf(args) 
413 #define nprintf(args) 
414 #endif
415
416 #define LOCATION __FILE__,__LINE__
417
418 // To flag an error, you can do this:
419 // Error( __FILE__, __LINE__, "Error opening %s", filename );
420 // or, 
421 // Error( LOCATION, "Error opening %s", filename );
422
423 #if defined(NDEBUG)
424 #define STUB_FUNCTION
425 #else
426 void gr_activate(int);
427 #define STUB_FUNCTION mprintf(("STUB: %s at %s, line %d\n", __FUNCTION__, LOCATION))
428 #endif
429
430 //#define Int3() _asm { int 3 }
431
432 #ifdef INTERPLAYQA
433         // Interplay QA version of Int3
434         #define Int3() do { } while (0) 
435
436         // define to call from Warning function above since it calls Int3, so without this, we
437         // get put into infinite dialog boxes
438         #define AsmInt3() _asm { int 3 }
439
440 #else
441         #if defined(NDEBUG)
442                 // No debug version of Int3
443                 #define Int3() do { } while (0) 
444         #else
445                 void debug_int3();
446
447                 // Debug version of Int3
448                 #define Int3() debug_int3()
449         #endif  // NDEBUG && DEMO
450 #endif  // INTERPLAYQA
451
452 #define min(a,b) (((a) < (b)) ? (a) : (b))
453 #define max(a,b) (((a) > (b)) ? (a) : (b))
454
455 #define PI                                      3.141592654f
456 #define PI2                                     (3.141592654f*2.0f)     // PI*2
457 #define ANG_TO_RAD(x)   ((x)*PI/180)
458
459
460 extern int      Fred_running;  // Is Fred running, or FreeSpace?
461 extern int Pofview_running;
462 extern int Nebedit_running;
463
464
465 //======================================================================================
466 //======          D E B U G    C O N S O L E   S T U F F        ========================
467 //======================================================================================
468
469 // Here is a a sample command to toggle something that would
470 // be called by doing "toggle it" from the debug console command window/
471
472 /*
473 DCF(toggle_it,"description")
474 {
475         if (Dc_command) {
476                 This_var = !This_var;
477         }
478
479         if (Dc_help)    {
480                 dc_printf( "Usage: sample\nToggles This_var on/off.\n" );
481         }
482
483         if (Dc_status)  {
484                 dc_printf( "The status is %d.\n", This_var );
485         }
486 */
487
488 class debug_command {
489         public:
490         const char *name;
491         const char *help;
492         void (*func)();
493         debug_command(const char *name, const char *help, void (*func)());      // constructor
494 };
495
496 #define DCF(function_name,help_text)                    \
497                 void dcf_##function_name();     \
498                 debug_command dc_##function_name(#function_name,help_text,dcf_##function_name); \
499                 void dcf_##function_name()              
500
501 // Starts the debug console
502 extern void debug_console( void (*func)() = NULL );
503
504 // The next three variables tell your function what to do.  It should
505 // only change something if the dc_command is set.   A minimal function
506 // needs to process the dc_command.   Usually, these will be called in
507 // these combinations:
508 // dc_command=true, dc_status=true  means process it and show status
509 // dc_help=true means show help only
510 // dc_status=true means show status only
511 // I would recommend doing this in each function:
512 // if (dc_command) { process command }
513 // if (dc_help) { print out help }
514 // if (dc_status) { print out status }
515 // with the last two being optional
516
517 extern int Dc_command;  // If this is set, then process the command
518 extern int Dc_help;             // If this is set, then print out the help text in the form, "usage: ... \nLong description\n" );
519 extern int Dc_status;           // If this is set, then print out the current status of the command.
520
521 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.
522 extern char *Dc_arg;            // The (lowercased) string value of the argument retrieved from dc_arg
523 extern char *Dc_arg_org;        // Dc_arg before it got converted to lowercase
524 extern uint Dc_arg_type;        // The type of dc_arg.
525 extern const char *Dc_command_line;             // The rest of the command line, from the end of the last processed arg on.
526 extern int Dc_arg_int;          // If Dc_arg_type & ARG_INT or ARG_HEX is set, then this is the value
527 extern float Dc_arg_float;      // If Dc_arg_type & ARG_FLOAT is set, then this is the value
528
529 // Outputs text to the console
530 void dc_printf( const char *format, ... );
531
532 // Each dc_arg_type can have one or more of these flags set.
533 // This is because some things can fit into two catagories.
534 // Like 1 can be an integer, a float, a string, or a true boolean
535 // value.
536 #define ARG_NONE                (1<<0)  // no argument
537 #define ARG_ANY         0xFFFFFFFF      // Anything.
538 #define ARG_STRING      (1<<1)  // any valid string
539 #define ARG_QUOTE               (1<<2)  // a quoted string
540 #define ARG_INT         (1<<3)  // a valid integer
541 #define ARG_FLOAT               (1<<4)  // a valid floating point number
542
543 // some specific commonly used predefined types. Can add up to (1<<31)
544 #define ARG_HEX         (1<<5)  // a valid hexadecimal integer. Note that ARG_INT will always be set also in this case.
545 #define ARG_TRUE                (1<<6)  // on, true, non-zero number
546 #define ARG_FALSE               (1<<7)  // off, false, zero
547 #define ARG_PLUS                (1<<8)  // Plus sign
548 #define ARG_MINUS               (1<<9)  // Minus sign
549 #define ARG_COMMA               (1<<10) // a comma
550
551 // A shortcut for boolean only variables.
552 // Example:  
553 // DCF_BOOL( lighting, Show_lighting )
554 //
555 #define DCF_BOOL( function_name, bool_variable )        \
556         void dcf_##function_name();     \
557         debug_command dc_##function_name(#function_name,"Toggles "#bool_variable,dcf_##function_name ); \
558         void dcf_##function_name()      {       \
559         if ( Dc_command )       {       \
560                 dc_get_arg(ARG_TRUE|ARG_FALSE|ARG_NONE);                \
561                 if ( Dc_arg_type & ARG_TRUE )   bool_variable = 1;      \
562                 else if ( Dc_arg_type & ARG_FALSE ) bool_variable = 0;  \
563                 else if ( Dc_arg_type & ARG_NONE ) bool_variable ^= 1;  \
564         }       \
565         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 );      \
566         if ( Dc_status )        dc_printf( "%s is %s\n", #function_name, (bool_variable?"TRUE":"FALSE") );      \
567 }
568
569
570 //======================================================================================
571 //======================================================================================
572 //======================================================================================
573
574 inline int mul_div(int n, int num, int dem)
575 {
576         Sint64 ret = n;
577         ret *= num;
578         ret /= dem;
579         return (int)ret;
580 }
581
582 #include "fix.h"
583 #include "floating.h"
584
585 // Some constants for stuff
586 #define MAX_FILENAME_LEN        32                      // Length for filenames, ie "title.pcx"
587 #define MAX_PATH_LEN                    128             // Length for pathnames, ie "c:\bitmaps\title.pcx"
588
589 // contants and defined for byteswapping routines (useful for mac)
590
591 #define INTEL_INT(x)    SDL_SwapLE32(x)
592 #define INTEL_SHORT(x)  SDL_SwapLE16(x)
593 #define INTEL_FLOAT(x)  SDL_SwapFloatLE(x)
594
595 #define TRUE    1
596 #define FALSE   0
597
598 #define MY_RAND_MAX             0x7fff
599 int myrand();
600
601
602
603 // Callback Loading function. 
604 // If you pass a function to this, that function will get called
605 // around 10x per second, so you can update the screen.
606 // Pass NULL to turn it off.
607 // Call this with the name of a function.  That function will
608 // then get called around 10x per second.  The callback function
609 // gets passed a 'count' which is how many times game_busy has
610 // been called since the callback was set.   It gets called
611 // one last time with count=-1 when you turn off the callback
612 // by calling game_busy_callback(NULL).   Game_busy_callback
613 // returns the current count, so you can tell how many times
614 // game_busy got called.
615 // If delta_step is above 0, then it will also make sure it 
616 // calls the callback each time count steps 'delta_step' even
617 // if 1/10th of a second hasn't elapsed.
618 extern int game_busy_callback( void (*callback)(int count), int delta_step = -1 );
619
620 // Call whenever loading to display cursor
621 extern void game_busy();
622
623
624 //=========================================================
625 // Functions to monitor performance
626 #ifndef NDEBUG
627
628 class monitor {
629         public:
630         const char      *name;                  
631         int     value;                  // Value that gets cleared to 0 each frame.
632         int     min, max, sum, cnt;             // Min & Max of value.  Sum is used to calculate average 
633         monitor(const char *name);      // constructor
634 };
635
636 // Creates a monitor variable
637 #define MONITOR(function_name)                          monitor mon_##function_name(#function_name)
638
639 // Increments a monitor variable
640 #define MONITOR_INC(function_name,inc)          do { mon_##function_name.value+=(inc); } while(0)
641
642 // Call this once per frame to update monitor file
643 void monitor_update();
644
645 #else
646
647 #define MONITOR(function_name)
648
649 #define MONITOR_INC(function_name,inc)          do { } while(0)
650
651 // Call this once per frame to update monitor file
652 #define monitor_update() do { } while(0)
653
654 #endif
655
656 #define NOX(s) s
657
658 const char *XSTR(const char *str, int index);
659
660 // Caps V between MN and MX.
661 template <class T> void CAP( T& v, T mn, T mx )
662 {
663         if ( v < mn )   {
664                 v = mn;
665         } else if ( v > mx )    {
666                 v = mx;
667         }
668 }
669
670 // ========================================================
671 // stamp checksum stuff
672 // ========================================================
673
674 // here is the define for the stamp for this set of code
675 #define STAMP_STRING "\001\001\001\001\002\002\002\002Read the Foundation Novels from Asimov.  I liked them." 
676 #define STAMP_STRING_LENGTH     80
677 #define DEFAULT_CHECKSUM_STRING         "\001\001\001\001"
678 #define DEFAULT_TIME_STRING                     "\002\002\002\002"
679
680 // macro to calculate the checksum for the stamp.  Put here so that we can use different methods
681 // for different applications.  Requires the local variable 'checksum' to be defined!!!
682 #define CALCULATE_STAMP_CHECKSUM() do { \
683                 int i, found;   \
684                                                         \
685                 checksum = 0;   \
686                 for ( i = 0; i < (int)strlen(ptr); i++ ) {      \
687                         found = 0;      \
688                         checksum += ptr[i];     \
689                         if ( checksum & 0x01 )  \
690                                 found = 1;      \
691                         checksum = checksum >> 1;       \
692                         if (found)      \
693                                 checksum |= 0x80000000; \
694                 }       \
695                 checksum |= 0x80000000; \
696         } while (0) ;
697
698 //=========================================================
699 // Memory management functions
700 //=========================================================
701
702 #ifndef NDEBUG
703         // Debug versions
704
705         // Returns 0 if not enough RAM.
706         int vm_init(int min_heap_size);
707
708         // Allocates some RAM.
709         void *vm_malloc( int size, const char *filename=NULL, int line=-1 );
710
711         // 
712         char *vm_strdup( const char *ptr, const char *filename, int line );
713
714         // Frees some RAM. 
715         void vm_free( void *ptr, const char *filename=NULL, int line=-1 );
716
717         // Frees all RAM.
718         void vm_free_all();
719
720         // Easy to use macros
721         #define VM_MALLOC(size) vm_malloc((size),__FILE__,__LINE__)
722         #define VM_FREE(ptr) vm_free((ptr),__FILE__,__LINE__)
723
724         #define malloc(size) vm_malloc((size),__FILE__,__LINE__)
725         #define free(ptr) vm_free((ptr),__FILE__,__LINE__)
726         #define strdup(ptr) vm_strdup((ptr),__FILE__,__LINE__)
727         
728 #else
729         // Release versions
730
731         // Returns 0 if not enough RAM.
732         int vm_init(int min_heap_size);
733
734         // Allocates some RAM.
735         void *vm_malloc( int size );
736
737         // 
738         char *vm_strdup( const char *ptr );
739
740         // Frees some RAM. 
741         void vm_free( void *ptr );
742
743         // Frees all RAM.
744         void vm_free_all();
745
746         // Easy to use macros
747         #define VM_MALLOC(size) vm_malloc(size)
748         #define VM_FREE(ptr) vm_free(ptr)
749
750         #define malloc(size) vm_malloc(size)
751         #define free(ptr) vm_free(ptr)
752         #define strdup(ptr) vm_strdup(ptr)
753
754 #endif
755
756
757 #endif          // PS_TYPES_H
758