migrated a large number of #define MAX values to quakedef.h and added a
[divverent/darkplaces.git] / common.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20
21 #ifndef COMMON_H
22 #define COMMON_H
23
24
25 /// MSVC has a different name for several standard functions
26 #ifdef WIN32
27 # define strcasecmp _stricmp
28 # define strncasecmp _strnicmp
29 #endif
30
31 // Create our own define for Mac OS X
32 #if defined(__APPLE__) && defined(__MACH__)
33 # define MACOSX
34 #endif
35
36 #ifdef SUNOS
37 #include <sys/file.h>           ///< Needed for FNDELAY
38 #endif
39
40 //============================================================================
41
42 typedef struct sizebuf_s
43 {
44         qboolean        allowoverflow;  ///< if false, do a Sys_Error
45         qboolean        overflowed;             ///< set to true if the buffer size failed
46         unsigned char           *data;
47         int                     maxsize;
48         int                     cursize;
49 } sizebuf_t;
50
51 void SZ_Clear (sizebuf_t *buf);
52 unsigned char *SZ_GetSpace (sizebuf_t *buf, int length);
53 void SZ_Write (sizebuf_t *buf, const unsigned char *data, int length);
54 void SZ_HexDumpToConsole(const sizebuf_t *buf);
55
56 void Com_HexDumpToConsole(const unsigned char *data, int size);
57
58 unsigned short CRC_Block(const unsigned char *data, size_t size);
59 unsigned short CRC_Block_CaseInsensitive(const unsigned char *data, size_t size); // for hash lookup functions that use strcasecmp for comparison
60
61 unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int sequence);
62
63 // these are actually md4sum (mdfour.c)
64 unsigned Com_BlockChecksum (void *buffer, int length);
65 void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf);
66
67
68 //============================================================================
69 //                                                      Endianess handling
70 //============================================================================
71
72 // We use BSD-style defines: BYTE_ORDER is defined to either BIG_ENDIAN or LITTLE_ENDIAN
73
74 // Initializations
75 #if !defined(BYTE_ORDER) || !defined(LITTLE_ENDIAN) || !defined(BIG_ENDIAN) || (BYTE_ORDER != LITTLE_ENDIAN && BYTE_ORDER != BIG_ENDIAN)
76 # undef BYTE_ORDER
77 # undef LITTLE_ENDIAN
78 # undef BIG_ENDIAN
79 # define LITTLE_ENDIAN 1234
80 # define BIG_ENDIAN 4321
81 #endif
82
83 // If we still don't know the CPU endianess at this point, we try to guess
84 // normally including sys/types.h includes endian.h for the platform, which defines BYTE_ORDER, LITTLE_ENDIAN, and BIG_ENDIAN, however endian.h is a BSD-ism, and may not be present on all platforms (particularly windows)
85 #ifndef BYTE_ORDER
86 # if defined(WIN32) || defined (__i386) || defined(__amd64)
87 #  define BYTE_ORDER LITTLE_ENDIAN
88 # else
89 #  if defined(SUNOS)
90 #   if defined(__i386) || defined(__amd64)
91 #    define BYTE_ORDER LITTLE_ENDIAN
92 #   else
93 #    define BYTE_ORDER BIG_ENDIAN
94 #   endif
95 #  else
96 #   warning "Unable to determine the CPU endianess. Defaulting to little endian"
97 #   define BYTE_ORDER LITTLE_ENDIAN
98 #  endif
99 # endif
100 #endif
101
102 /*! \name Byte order functions.
103  * @{
104  */
105
106 /// Swaps the byte order of the given short \p l.
107 short ShortSwap (short l);
108
109 /// Swaps the byte order of the given long \p l.
110 int LongSwap (int l);
111
112 /// Swaps the byte order of the given float \p f.
113 float FloatSwap (float f);
114
115 #if BYTE_ORDER == LITTLE_ENDIAN
116 // little endian
117 #define BigShort(l) ShortSwap(l)
118 #define LittleShort(l) (l)
119 #define BigLong(l) LongSwap(l)
120 #define LittleLong(l) (l)
121 #define BigFloat(l) FloatSwap(l)
122 #define LittleFloat(l) (l)
123 #else
124 // big endian
125 #define BigShort(l) (l)
126 #define LittleShort(l) ShortSwap(l)
127 #define BigLong(l) (l)
128 #define LittleLong(l) LongSwap(l)
129 #define BigFloat(l) (l)
130 #define LittleFloat(l) FloatSwap(l)
131 #endif
132
133 /// Extract a big endian long from the given \p buffer.
134 unsigned int BuffBigLong (const unsigned char *buffer);
135
136 /// Extract a big endian short from the given \p buffer.
137 unsigned short BuffBigShort (const unsigned char *buffer);
138
139 /// Extract a little endian long from the given \p buffer.
140 unsigned int BuffLittleLong (const unsigned char *buffer);
141
142 /// Extract a little endian short from the given \p buffer.
143 unsigned short BuffLittleShort (const unsigned char *buffer);
144 //@}
145
146 //============================================================================
147
148 // these versions are purely for internal use, never sent in network protocol
149 // (use Protocol_EnumForNumber and Protocol_NumberToEnum to convert)
150 typedef enum protocolversion_e
151 {
152         PROTOCOL_UNKNOWN,
153         PROTOCOL_DARKPLACES7, ///< added QuakeWorld-style movement protocol to allow more consistent prediction
154         PROTOCOL_DARKPLACES6, ///< various changes
155         PROTOCOL_DARKPLACES5, ///< uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/
156         PROTOCOL_DARKPLACES4, ///< various changes
157         PROTOCOL_DARKPLACES3, ///< uses EntityFrame4 entity snapshot encoder/decoder which is broken, this attempted to do partial snapshot updates on a QuakeWorld-like protocol, but it is broken and impossible to fix
158         PROTOCOL_DARKPLACES2, ///< various changes
159         PROTOCOL_DARKPLACES1, ///< uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method
160         PROTOCOL_QUAKEDP, ///< darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used
161         PROTOCOL_NEHAHRAMOVIE, ///< Nehahra movie protocol, a big nasty hack dating back to early days of the Quake Standards Group (but only ever used by neh_gl.exe), this is potentially backwards compatible with quake protocol as long as no extended features are used (but in actuality the neh_gl.exe which wrote this protocol ALWAYS wrote the extended information)
162         PROTOCOL_QUAKE, ///< quake (aka netquake/normalquake/nq) protocol
163         PROTOCOL_QUAKEWORLD, ///< quakeworld protocol
164         PROTOCOL_NEHAHRABJP, ///< same as QUAKEDP but with 16bit modelindex
165         PROTOCOL_NEHAHRABJP2, ///< same as NEHAHRABJP but with 16bit soundindex
166         PROTOCOL_NEHAHRABJP3, ///< same as NEHAHRABJP2 but with some changes
167 }
168 protocolversion_t;
169
170 /*! \name Message IO functions.
171  * Handles byte ordering and avoids alignment errors
172  * @{
173  */
174
175 void MSG_WriteChar (sizebuf_t *sb, int c);
176 void MSG_WriteByte (sizebuf_t *sb, int c);
177 void MSG_WriteShort (sizebuf_t *sb, int c);
178 void MSG_WriteLong (sizebuf_t *sb, int c);
179 void MSG_WriteFloat (sizebuf_t *sb, float f);
180 void MSG_WriteString (sizebuf_t *sb, const char *s);
181 void MSG_WriteUnterminatedString (sizebuf_t *sb, const char *s);
182 void MSG_WriteAngle8i (sizebuf_t *sb, float f);
183 void MSG_WriteAngle16i (sizebuf_t *sb, float f);
184 void MSG_WriteAngle32f (sizebuf_t *sb, float f);
185 void MSG_WriteCoord13i (sizebuf_t *sb, float f);
186 void MSG_WriteCoord16i (sizebuf_t *sb, float f);
187 void MSG_WriteCoord32f (sizebuf_t *sb, float f);
188 void MSG_WriteCoord (sizebuf_t *sb, float f, protocolversion_t protocol);
189 void MSG_WriteVector (sizebuf_t *sb, float *v, protocolversion_t protocol);
190 void MSG_WriteAngle (sizebuf_t *sb, float f, protocolversion_t protocol);
191
192 extern  int                     msg_readcount;
193 extern  qboolean        msg_badread;            // set if a read goes beyond end of message
194
195 void MSG_BeginReading (void);
196 int MSG_ReadLittleShort (void);
197 int MSG_ReadBigShort (void);
198 int MSG_ReadLittleLong (void);
199 int MSG_ReadBigLong (void);
200 float MSG_ReadLittleFloat (void);
201 float MSG_ReadBigFloat (void);
202 char *MSG_ReadString (void);
203 int MSG_ReadBytes (int numbytes, unsigned char *out);
204
205 #define MSG_ReadChar() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (signed char)net_message.data[msg_readcount++])
206 #define MSG_ReadByte() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (unsigned char)net_message.data[msg_readcount++])
207 #define MSG_ReadShort MSG_ReadLittleShort
208 #define MSG_ReadLong MSG_ReadLittleLong
209 #define MSG_ReadFloat MSG_ReadLittleFloat
210
211 float MSG_ReadAngle8i (void);
212 float MSG_ReadAngle16i (void);
213 float MSG_ReadAngle32f (void);
214 float MSG_ReadCoord13i (void);
215 float MSG_ReadCoord16i (void);
216 float MSG_ReadCoord32f (void);
217 float MSG_ReadCoord (protocolversion_t protocol);
218 void MSG_ReadVector (float *v, protocolversion_t protocol);
219 float MSG_ReadAngle (protocolversion_t protocol);
220 //@}
221 //============================================================================
222
223 typedef float (*COM_WordWidthFunc_t) (void *passthrough, const char *w, size_t *length, float maxWidth); // length is updated to the longest fitting string into maxWidth; if maxWidth < 0, all characters are used and length is used as is
224 typedef int (*COM_LineProcessorFunc) (void *passthrough, const char *line, size_t length, float width, qboolean isContination);
225 int COM_Wordwrap(const char *string, size_t length, float continuationSize, float maxWidth, COM_WordWidthFunc_t wordWidth, void *passthroughCW, COM_LineProcessorFunc processLine, void *passthroughPL);
226
227 extern char com_token[MAX_INPUTLINE];
228
229 int COM_ParseToken_Simple(const char **datapointer, qboolean returnnewline, qboolean parsebackslash);
230 int COM_ParseToken_QuakeC(const char **datapointer, qboolean returnnewline);
231 int COM_ParseToken_VM_Tokenize(const char **datapointer, qboolean returnnewline);
232 int COM_ParseToken_Console(const char **datapointer);
233
234 extern int com_argc;
235 extern const char **com_argv;
236
237 int COM_CheckParm (const char *parm);
238 void COM_Init (void);
239 void COM_Shutdown (void);
240 void COM_InitGameType (void);
241
242 char    *va(const char *format, ...) DP_FUNC_PRINTF(1);
243 // does a varargs printf into a temp buffer
244
245
246 // snprintf and vsnprintf are NOT portable. Use their DP counterparts instead
247 #define snprintf DO_NOT_USE_SNPRINTF__USE_DPSNPRINTF
248 #define vsnprintf DO_NOT_USE_VSNPRINTF__USE_DPVSNPRINTF
249
250 // dpsnprintf and dpvsnprintf
251 // return the number of printed characters, excluding the final '\0'
252 // or return -1 if the buffer isn't big enough to contain the entire string.
253 // buffer is ALWAYS null-terminated
254 extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...) DP_FUNC_PRINTF(3);
255 extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args);
256
257 // A bunch of functions are forbidden for security reasons (and also to please MSVS 2005, for some of them)
258 // LordHavoc: added #undef lines here to avoid warnings in Linux
259 #undef strcat
260 #define strcat DO_NOT_USE_STRCAT__USE_STRLCAT_OR_MEMCPY
261 #undef strncat
262 #define strncat DO_NOT_USE_STRNCAT__USE_STRLCAT_OR_MEMCPY
263 #undef strcpy
264 #define strcpy DO_NOT_USE_STRCPY__USE_STRLCPY_OR_MEMCPY
265 #undef strncpy
266 #define strncpy DO_NOT_USE_STRNCPY__USE_STRLCPY_OR_MEMCPY
267 //#undef sprintf
268 //#define sprintf DO_NOT_USE_SPRINTF__USE_DPSNPRINTF
269
270
271 //============================================================================
272
273 extern  struct cvar_s   registered;
274 extern  struct cvar_s   cmdline;
275
276 typedef enum gamemode_e
277 {
278         GAME_NORMAL,
279         GAME_HIPNOTIC,
280         GAME_ROGUE,
281         GAME_NEHAHRA,
282         GAME_NEXUIZ,
283         GAME_TRANSFUSION,
284         GAME_GOODVSBAD2,
285         GAME_TEU,
286         GAME_BATTLEMECH,
287         GAME_ZYMOTIC,
288         GAME_SETHERAL,
289         GAME_SOM,
290         GAME_TENEBRAE, // full of evil hackery
291         GAME_NEOTERIC,
292         GAME_OPENQUARTZ, //this game sucks
293         GAME_PRYDON,
294         GAME_DELUXEQUAKE,
295         GAME_THEHUNTED,
296         GAME_DEFEATINDETAIL2,
297         GAME_DARSANA,
298         GAME_CONTAGIONTHEORY,
299         GAME_EDU2P,
300         GAME_BLADEMASTER,
301         GAME_PROPHECY,
302         GAME_BLOODOMNICIDE,
303         GAME_COUNT
304 }
305 gamemode_t;
306
307 extern gamemode_t gamemode;
308 extern const char *gamename;
309 extern const char *gamedirname1;
310 extern const char *gamedirname2;
311 extern const char *gamescreenshotname;
312 extern const char *gameuserdirname;
313 extern char com_modname[MAX_OSPATH];
314
315 void COM_ToLowerString (const char *in, char *out, size_t size_out);
316 void COM_ToUpperString (const char *in, char *out, size_t size_out);
317 int COM_StringBeginsWith(const char *s, const char *match);
318
319 int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix);
320
321 size_t COM_StringLengthNoColors(const char *s, size_t size_s, qboolean *valid);
322 qboolean COM_StringDecolorize(const char *in, size_t size_in, char *out, size_t size_out, qboolean escape_carets);
323 void COM_ToLowerString (const char *in, char *out, size_t size_out);
324 void COM_ToUpperString (const char *in, char *out, size_t size_out);
325
326 typedef struct stringlist_s
327 {
328         /// maxstrings changes as needed, causing reallocation of strings[] array
329         int maxstrings;
330         int numstrings;
331         char **strings;
332 } stringlist_t;
333
334 int matchpattern(const char *in, const char *pattern, int caseinsensitive);
335 int matchpattern_with_separator(const char *in, const char *pattern, int caseinsensitive, const char *separators, qboolean wildcard_least_one);
336 void stringlistinit(stringlist_t *list);
337 void stringlistfreecontents(stringlist_t *list);
338 void stringlistappend(stringlist_t *list, const char *text);
339 void stringlistsort(stringlist_t *list);
340 void listdirectory(stringlist_t *list, const char *basepath, const char *path);
341
342 char *SearchInfostring(const char *infostring, const char *key);
343
344 void InfoString_GetValue(const char *buffer, const char *key, char *value, size_t valuelength);
345 void InfoString_SetValue(char *buffer, size_t bufferlength, const char *key, const char *value);
346 void InfoString_Print(char *buffer);
347
348 // strlcat and strlcpy, from OpenBSD
349 // Most (all?) BSDs already have them
350 #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX)
351 # define HAVE_STRLCAT 1
352 # define HAVE_STRLCPY 1
353 #endif
354
355 #ifndef HAVE_STRLCAT
356 /*!
357  * Appends src to string dst of size siz (unlike strncat, siz is the
358  * full size of dst, not space left).  At most siz-1 characters
359  * will be copied.  Always NUL terminates (unless siz <= strlen(dst)).
360  * Returns strlen(src) + MIN(siz, strlen(initial dst)).
361  * If retval >= siz, truncation occurred.
362  */
363 size_t strlcat(char *dst, const char *src, size_t siz);
364 #endif  // #ifndef HAVE_STRLCAT
365
366 #ifndef HAVE_STRLCPY
367 /*!
368  * Copy src to string dst of size siz.  At most siz-1 characters
369  * will be copied.  Always NUL terminates (unless siz == 0).
370  * Returns strlen(src); if retval >= siz, truncation occurred.
371  */
372 size_t strlcpy(char *dst, const char *src, size_t siz);
373
374 #endif  // #ifndef HAVE_STRLCPY
375
376 void FindFraction(double val, int *num, int *denom, int denomMax);
377
378 #endif
379