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