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