major overhaul for thread-safety - many global variables and static
[xonotic/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         int                     readcount;
50         qboolean        badread;                // set if a read goes beyond end of message
51 } sizebuf_t;
52
53 void SZ_Clear (sizebuf_t *buf);
54 unsigned char *SZ_GetSpace (sizebuf_t *buf, int length);
55 void SZ_Write (sizebuf_t *buf, const unsigned char *data, int length);
56 void SZ_HexDumpToConsole(const sizebuf_t *buf);
57
58 void Com_HexDumpToConsole(const unsigned char *data, int size);
59
60 unsigned short CRC_Block(const unsigned char *data, size_t size);
61 unsigned short CRC_Block_CaseInsensitive(const unsigned char *data, size_t size); // for hash lookup functions that use strcasecmp for comparison
62
63 unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int sequence);
64
65 // these are actually md4sum (mdfour.c)
66 unsigned Com_BlockChecksum (void *buffer, int length);
67 void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf);
68
69 void COM_Init_Commands(void);
70
71
72 //============================================================================
73 //                                                      Endianess handling
74 //============================================================================
75
76 // check mem_bigendian if you need to know the system byte order
77
78 /*! \name Byte order functions.
79  * @{
80  */
81
82 // unaligned memory access crashes on some platform, so always read bytes...
83 #define BigShort(l) BuffBigShort((unsigned char *)&(l))
84 #define LittleShort(l) BuffLittleShort((unsigned char *)&(l))
85 #define BigLong(l) BuffBigLong((unsigned char *)&(l))
86 #define LittleLong(l) BuffLittleLong((unsigned char *)&(l))
87 #define BigFloat(l) BuffBigFloat((unsigned char *)&(l))
88 #define LittleFloat(l) BuffLittleFloat((unsigned char *)&(l))
89
90 /// Extract a big endian 32bit float from the given \p buffer.
91 float BuffBigFloat (const unsigned char *buffer);
92
93 /// Extract a big endian 32bit int from the given \p buffer.
94 int BuffBigLong (const unsigned char *buffer);
95
96 /// Extract a big endian 16bit short from the given \p buffer.
97 short BuffBigShort (const unsigned char *buffer);
98
99 /// Extract a little endian 32bit float from the given \p buffer.
100 float BuffLittleFloat (const unsigned char *buffer);
101
102 /// Extract a little endian 32bit int from the given \p buffer.
103 int BuffLittleLong (const unsigned char *buffer);
104
105 /// Extract a little endian 16bit short from the given \p buffer.
106 short BuffLittleShort (const unsigned char *buffer);
107
108 /// Encode a big endian 32bit int to the given \p buffer
109 void StoreBigLong (unsigned char *buffer, unsigned int i);
110
111 /// Encode a big endian 16bit int to the given \p buffer
112 void StoreBigShort (unsigned char *buffer, unsigned short i);
113
114 /// Encode a little endian 32bit int to the given \p buffer
115 void StoreLittleLong (unsigned char *buffer, unsigned int i);
116
117 /// Encode a little endian 16bit int to the given \p buffer
118 void StoreLittleShort (unsigned char *buffer, unsigned short i);
119 //@}
120
121 //============================================================================
122
123 // these versions are purely for internal use, never sent in network protocol
124 // (use Protocol_EnumForNumber and Protocol_NumberToEnum to convert)
125 typedef enum protocolversion_e
126 {
127         PROTOCOL_UNKNOWN,
128         PROTOCOL_DARKPLACES7, ///< added QuakeWorld-style movement protocol to allow more consistent prediction
129         PROTOCOL_DARKPLACES6, ///< various changes
130         PROTOCOL_DARKPLACES5, ///< uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/
131         PROTOCOL_DARKPLACES4, ///< various changes
132         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
133         PROTOCOL_DARKPLACES2, ///< various changes
134         PROTOCOL_DARKPLACES1, ///< uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method
135         PROTOCOL_QUAKEDP, ///< darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used
136         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)
137         PROTOCOL_QUAKE, ///< quake (aka netquake/normalquake/nq) protocol
138         PROTOCOL_QUAKEWORLD, ///< quakeworld protocol
139         PROTOCOL_NEHAHRABJP, ///< same as QUAKEDP but with 16bit modelindex
140         PROTOCOL_NEHAHRABJP2, ///< same as NEHAHRABJP but with 16bit soundindex
141         PROTOCOL_NEHAHRABJP3 ///< same as NEHAHRABJP2 but with some changes
142 }
143 protocolversion_t;
144
145 /*! \name Message IO functions.
146  * Handles byte ordering and avoids alignment errors
147  * @{
148  */
149
150 void MSG_WriteChar (sizebuf_t *sb, int c);
151 void MSG_WriteByte (sizebuf_t *sb, int c);
152 void MSG_WriteShort (sizebuf_t *sb, int c);
153 void MSG_WriteLong (sizebuf_t *sb, int c);
154 void MSG_WriteFloat (sizebuf_t *sb, float f);
155 void MSG_WriteString (sizebuf_t *sb, const char *s);
156 void MSG_WriteUnterminatedString (sizebuf_t *sb, const char *s);
157 void MSG_WriteAngle8i (sizebuf_t *sb, float f);
158 void MSG_WriteAngle16i (sizebuf_t *sb, float f);
159 void MSG_WriteAngle32f (sizebuf_t *sb, float f);
160 void MSG_WriteCoord13i (sizebuf_t *sb, float f);
161 void MSG_WriteCoord16i (sizebuf_t *sb, float f);
162 void MSG_WriteCoord32f (sizebuf_t *sb, float f);
163 void MSG_WriteCoord (sizebuf_t *sb, float f, protocolversion_t protocol);
164 void MSG_WriteVector (sizebuf_t *sb, float *v, protocolversion_t protocol);
165 void MSG_WriteAngle (sizebuf_t *sb, float f, protocolversion_t protocol);
166
167 void MSG_BeginReading (sizebuf_t *sb);
168 int MSG_ReadLittleShort (sizebuf_t *sb);
169 int MSG_ReadBigShort (sizebuf_t *sb);
170 int MSG_ReadLittleLong (sizebuf_t *sb);
171 int MSG_ReadBigLong (sizebuf_t *sb);
172 float MSG_ReadLittleFloat (sizebuf_t *sb);
173 float MSG_ReadBigFloat (sizebuf_t *sb);
174 char *MSG_ReadString (sizebuf_t *sb, char *string, size_t maxstring);
175 int MSG_ReadBytes (sizebuf_t *sb, int numbytes, unsigned char *out);
176
177 #define MSG_ReadChar(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (signed char)(sb)->data[(sb)->readcount++])
178 #define MSG_ReadByte(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (unsigned char)(sb)->data[(sb)->readcount++])
179 #define MSG_ReadShort MSG_ReadLittleShort
180 #define MSG_ReadLong MSG_ReadLittleLong
181 #define MSG_ReadFloat MSG_ReadLittleFloat
182
183 float MSG_ReadAngle8i (sizebuf_t *sb);
184 float MSG_ReadAngle16i (sizebuf_t *sb);
185 float MSG_ReadAngle32f (sizebuf_t *sb);
186 float MSG_ReadCoord13i (sizebuf_t *sb);
187 float MSG_ReadCoord16i (sizebuf_t *sb);
188 float MSG_ReadCoord32f (sizebuf_t *sb);
189 float MSG_ReadCoord (sizebuf_t *sb, protocolversion_t protocol);
190 void MSG_ReadVector (sizebuf_t *sb, float *v, protocolversion_t protocol);
191 float MSG_ReadAngle (sizebuf_t *sb, protocolversion_t protocol);
192 //@}
193 //============================================================================
194
195 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
196 typedef int (*COM_LineProcessorFunc) (void *passthrough, const char *line, size_t length, float width, qboolean isContination);
197 int COM_Wordwrap(const char *string, size_t length, float continuationSize, float maxWidth, COM_WordWidthFunc_t wordWidth, void *passthroughCW, COM_LineProcessorFunc processLine, void *passthroughPL);
198
199 extern char com_token[MAX_INPUTLINE];
200
201 int COM_ParseToken_Simple(const char **datapointer, qboolean returnnewline, qboolean parsebackslash);
202 int COM_ParseToken_QuakeC(const char **datapointer, qboolean returnnewline);
203 int COM_ParseToken_VM_Tokenize(const char **datapointer, qboolean returnnewline);
204 int COM_ParseToken_Console(const char **datapointer);
205
206 extern int com_argc;
207 extern const char **com_argv;
208 extern int com_selffd;
209
210 int COM_CheckParm (const char *parm);
211 void COM_Init (void);
212 void COM_Shutdown (void);
213 void COM_InitGameType (void);
214
215 char *va(char *buf, size_t buflen, const char *format, ...) DP_FUNC_PRINTF(3);
216 // does a varargs printf into provided buffer, returns buffer (so it can be called in-line unlike dpsnprintf)
217
218
219 // snprintf and vsnprintf are NOT portable. Use their DP counterparts instead
220 #ifdef snprintf
221 # undef snprintf
222 #endif
223 #define snprintf DO_NOT_USE_SNPRINTF__USE_DPSNPRINTF
224 #ifdef vsnprintf
225 # undef vsnprintf
226 #endif
227 #define vsnprintf DO_NOT_USE_VSNPRINTF__USE_DPVSNPRINTF
228
229 // dpsnprintf and dpvsnprintf
230 // return the number of printed characters, excluding the final '\0'
231 // or return -1 if the buffer isn't big enough to contain the entire string.
232 // buffer is ALWAYS null-terminated
233 extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...) DP_FUNC_PRINTF(3);
234 extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args);
235
236 // A bunch of functions are forbidden for security reasons (and also to please MSVS 2005, for some of them)
237 // LordHavoc: added #undef lines here to avoid warnings in Linux
238 #undef strcat
239 #define strcat DO_NOT_USE_STRCAT__USE_STRLCAT_OR_MEMCPY
240 #undef strncat
241 #define strncat DO_NOT_USE_STRNCAT__USE_STRLCAT_OR_MEMCPY
242 #undef strcpy
243 #define strcpy DO_NOT_USE_STRCPY__USE_STRLCPY_OR_MEMCPY
244 #undef strncpy
245 #define strncpy DO_NOT_USE_STRNCPY__USE_STRLCPY_OR_MEMCPY
246 //#undef sprintf
247 //#define sprintf DO_NOT_USE_SPRINTF__USE_DPSNPRINTF
248
249
250 //============================================================================
251
252 extern  struct cvar_s   registered;
253 extern  struct cvar_s   cmdline;
254
255 typedef enum userdirmode_e
256 {
257         USERDIRMODE_NOHOME, // basedir only
258         USERDIRMODE_HOME, // Windows basedir, general POSIX (~/.)
259         USERDIRMODE_MYGAMES, // pre-Vista (My Documents/My Games/), general POSIX (~/.)
260         USERDIRMODE_SAVEDGAMES, // Vista (%USERPROFILE%/Saved Games/), OSX (~/Library/Application Support/), Linux (~/.config)
261         USERDIRMODE_COUNT
262 }
263 userdirmode_t;
264
265 typedef enum gamemode_e
266 {
267         GAME_NORMAL,
268         GAME_HIPNOTIC,
269         GAME_ROGUE,
270         GAME_NEHAHRA,
271         GAME_NEXUIZ,
272         GAME_XONOTIC,
273         GAME_TRANSFUSION,
274         GAME_GOODVSBAD2,
275         GAME_TEU,
276         GAME_BATTLEMECH,
277         GAME_ZYMOTIC,
278         GAME_SETHERAL,
279         GAME_SOM,
280         GAME_TENEBRAE, // full of evil hackery
281         GAME_NEOTERIC,
282         GAME_OPENQUARTZ, //this game sucks
283         GAME_PRYDON,
284         GAME_DELUXEQUAKE,
285         GAME_THEHUNTED,
286         GAME_DEFEATINDETAIL2,
287         GAME_DARSANA,
288         GAME_CONTAGIONTHEORY,
289         GAME_EDU2P,
290         GAME_PROPHECY,
291         GAME_BLOODOMNICIDE,
292         GAME_STEELSTORM, // added by motorsep
293         GAME_STRAPBOMB, // added by motorsep for Urre
294         GAME_MOONHELM,
295         GAME_COUNT
296 }
297 gamemode_t;
298
299 extern gamemode_t gamemode;
300 extern const char *gamename;
301 extern const char *gamedirname1;
302 extern const char *gamedirname2;
303 extern const char *gamescreenshotname;
304 extern const char *gameuserdirname;
305 extern char com_modname[MAX_OSPATH];
306
307 void COM_ChangeGameTypeForGameDirs(void);
308
309 void COM_ToLowerString (const char *in, char *out, size_t size_out);
310 void COM_ToUpperString (const char *in, char *out, size_t size_out);
311 int COM_StringBeginsWith(const char *s, const char *match);
312
313 int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix);
314
315 size_t COM_StringLengthNoColors(const char *s, size_t size_s, qboolean *valid);
316 qboolean COM_StringDecolorize(const char *in, size_t size_in, char *out, size_t size_out, qboolean escape_carets);
317 void COM_ToLowerString (const char *in, char *out, size_t size_out);
318 void COM_ToUpperString (const char *in, char *out, size_t size_out);
319
320 typedef struct stringlist_s
321 {
322         /// maxstrings changes as needed, causing reallocation of strings[] array
323         int maxstrings;
324         int numstrings;
325         char **strings;
326 } stringlist_t;
327
328 int matchpattern(const char *in, const char *pattern, int caseinsensitive);
329 int matchpattern_with_separator(const char *in, const char *pattern, int caseinsensitive, const char *separators, qboolean wildcard_least_one);
330 void stringlistinit(stringlist_t *list);
331 void stringlistfreecontents(stringlist_t *list);
332 void stringlistappend(stringlist_t *list, const char *text);
333 void stringlistsort(stringlist_t *list, qboolean uniq);
334 void listdirectory(stringlist_t *list, const char *basepath, const char *path);
335
336 char *InfoString_GetValue(const char *buffer, const char *key, char *value, size_t valuelength);
337 void InfoString_SetValue(char *buffer, size_t bufferlength, const char *key, const char *value);
338 void InfoString_Print(char *buffer);
339
340 // strlcat and strlcpy, from OpenBSD
341 // Most (all?) BSDs already have them
342 #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX)
343 # define HAVE_STRLCAT 1
344 # define HAVE_STRLCPY 1
345 #endif
346
347 #ifndef HAVE_STRLCAT
348 /*!
349  * Appends src to string dst of size siz (unlike strncat, siz is the
350  * full size of dst, not space left).  At most siz-1 characters
351  * will be copied.  Always NUL terminates (unless siz <= strlen(dst)).
352  * Returns strlen(src) + MIN(siz, strlen(initial dst)).
353  * If retval >= siz, truncation occurred.
354  */
355 size_t strlcat(char *dst, const char *src, size_t siz);
356 #endif  // #ifndef HAVE_STRLCAT
357
358 #ifndef HAVE_STRLCPY
359 /*!
360  * Copy src to string dst of size siz.  At most siz-1 characters
361  * will be copied.  Always NUL terminates (unless siz == 0).
362  * Returns strlen(src); if retval >= siz, truncation occurred.
363  */
364 size_t strlcpy(char *dst, const char *src, size_t siz);
365
366 #endif  // #ifndef HAVE_STRLCPY
367
368 void FindFraction(double val, int *num, int *denom, int denomMax);
369
370 // decodes XPM file to XPM array (as if #include'd)
371 char **XPM_DecodeString(const char *in);
372
373 size_t base64_encode(unsigned char *buf, size_t buflen, size_t outbuflen);
374
375 #endif
376