2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
24 // many buffers use this size
25 #define MAX_INPUTLINE 16384
28 // MSVC has a different name for several standard functions
30 # define strcasecmp stricmp
31 # define strncasecmp strnicmp
34 // Create our own define for Mac OS X
35 #if defined(__APPLE__) && defined(__MACH__)
40 #include <sys/file.h> // Needed for FNDELAY
41 # define model_t dp_model_t // Workaround conflict with /usr/include/sys/model.h
44 //============================================================================
46 typedef struct sizebuf_s
48 qboolean allowoverflow; // if false, do a Sys_Error
49 qboolean overflowed; // set to true if the buffer size failed
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);
60 void Com_HexDumpToConsole(const unsigned char *data, int size);
62 unsigned short CRC_Block(const unsigned char *data, size_t size);
65 //============================================================================
67 //============================================================================
69 // We use BSD-style defines: BYTE_ORDER is defined to either BIG_ENDIAN or LITTLE_ENDIAN
72 #if !defined(BYTE_ORDER) || !defined(LITTLE_ENDIAN) || !defined(BIG_ENDIAN) || (BYTE_ORDER != LITTLE_ENDIAN && BYTE_ORDER != BIG_ENDIAN)
76 # define LITTLE_ENDIAN 1234
77 # define BIG_ENDIAN 4321
80 // If we still don't know the CPU endianess at this point, we try to guess
83 # define BYTE_ORDER LITTLE_ENDIAN
86 # if defined(__i386) || defined(__amd64)
87 # define BYTE_ORDER LITTLE_ENDIAN
89 # define BYTE_ORDER BIG_ENDIAN
92 # warning "Unable to determine the CPU endianess. Defaulting to little endian"
93 # define BYTE_ORDER LITTLE_ENDIAN
99 short ShortSwap (short l);
100 int LongSwap (int l);
101 float FloatSwap (float f);
103 #if BYTE_ORDER == LITTLE_ENDIAN
105 #define BigShort(l) ShortSwap(l)
106 #define LittleShort(l) (l)
107 #define BigLong(l) LongSwap(l)
108 #define LittleLong(l) (l)
109 #define BigFloat(l) FloatSwap(l)
110 #define LittleFloat(l) (l)
113 #define BigShort(l) (l)
114 #define LittleShort(l) ShortSwap(l)
115 #define BigLong(l) (l)
116 #define LittleLong(l) LongSwap(l)
117 #define BigFloat(l) (l)
118 #define LittleFloat(l) FloatSwap(l)
121 unsigned int BuffBigLong (const unsigned char *buffer);
122 unsigned short BuffBigShort (const unsigned char *buffer);
123 unsigned int BuffLittleLong (const unsigned char *buffer);
124 unsigned short BuffLittleShort (const unsigned char *buffer);
127 //============================================================================
129 // these versions are purely for internal use, never sent in network protocol
130 // (use Protocol_EnumForNumber and Protocol_NumberToEnum to convert)
131 typedef enum protocolversion_e
134 PROTOCOL_DARKPLACES7, // added QuakeWorld-style movement protocol to allow more consistent prediction
135 PROTOCOL_DARKPLACES6, // various changes
136 PROTOCOL_DARKPLACES5, // uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/
137 PROTOCOL_DARKPLACES4, // various changes
138 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
139 PROTOCOL_DARKPLACES2, // various changes
140 PROTOCOL_DARKPLACES1, // uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method
141 PROTOCOL_QUAKEDP, // darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used
142 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)
143 PROTOCOL_QUAKE, // quake (aka netquake/normalquake/nq) protocol
147 void MSG_WriteChar (sizebuf_t *sb, int c);
148 void MSG_WriteByte (sizebuf_t *sb, int c);
149 void MSG_WriteShort (sizebuf_t *sb, int c);
150 void MSG_WriteLong (sizebuf_t *sb, int c);
151 void MSG_WriteFloat (sizebuf_t *sb, float f);
152 void MSG_WriteString (sizebuf_t *sb, const char *s);
153 void MSG_WriteUnterminatedString (sizebuf_t *sb, const char *s);
154 void MSG_WriteAngle8i (sizebuf_t *sb, float f);
155 void MSG_WriteAngle16i (sizebuf_t *sb, float f);
156 void MSG_WriteAngle32f (sizebuf_t *sb, float f);
157 void MSG_WriteCoord13i (sizebuf_t *sb, float f);
158 void MSG_WriteCoord16i (sizebuf_t *sb, float f);
159 void MSG_WriteCoord32f (sizebuf_t *sb, float f);
160 void MSG_WriteCoord (sizebuf_t *sb, float f, protocolversion_t protocol);
161 void MSG_WriteVector (sizebuf_t *sb, float *v, protocolversion_t protocol);
162 void MSG_WriteAngle (sizebuf_t *sb, float f, protocolversion_t protocol);
164 extern int msg_readcount;
165 extern qboolean msg_badread; // set if a read goes beyond end of message
167 void MSG_BeginReading (void);
168 int MSG_ReadLittleShort (void);
169 int MSG_ReadBigShort (void);
170 int MSG_ReadLittleLong (void);
171 int MSG_ReadBigLong (void);
172 float MSG_ReadLittleFloat (void);
173 float MSG_ReadBigFloat (void);
174 char *MSG_ReadString (void);
175 int MSG_ReadBytes (int numbytes, unsigned char *out);
177 #define MSG_ReadChar() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (signed char)net_message.data[msg_readcount++])
178 #define MSG_ReadByte() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (unsigned char)net_message.data[msg_readcount++])
179 #define MSG_ReadShort MSG_ReadLittleShort
180 #define MSG_ReadLong MSG_ReadLittleLong
181 #define MSG_ReadFloat MSG_ReadLittleFloat
183 float MSG_ReadAngle8i (void);
184 float MSG_ReadAngle16i (void);
185 float MSG_ReadAngle32f (void);
186 float MSG_ReadCoord13i (void);
187 float MSG_ReadCoord16i (void);
188 float MSG_ReadCoord32f (void);
189 float MSG_ReadCoord (protocolversion_t protocol);
190 void MSG_ReadVector (float *v, protocolversion_t protocol);
191 float MSG_ReadAngle (protocolversion_t protocol);
193 //============================================================================
195 extern char com_token[MAX_INPUTLINE];
197 int COM_ParseToken(const char **datapointer, int returnnewline);
198 int COM_ParseTokenConsole(const char **datapointer);
201 extern const char **com_argv;
203 int COM_CheckParm (const char *parm);
204 void COM_Init (void);
205 void COM_Shutdown (void);
206 void COM_InitArgv (void);
207 void COM_InitGameType (void);
209 char *va(const char *format, ...);
210 // does a varargs printf into a temp buffer
213 // snprintf and vsnprintf are NOT portable. Use their DP counterparts instead
214 #define snprintf DO_NOT_USE_SNPRINTF__USE_DPSNPRINTF
215 #define vsnprintf DO_NOT_USE_VSNPRINTF__USE_DPVSNPRINTF
217 // dpsnprintf and dpvsnprintf
218 // return the number of printed characters, excluding the final '\0'
219 // or return -1 if the buffer isn't big enough to contain the entire string.
220 // buffer is ALWAYS null-terminated
221 extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...);
222 extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args);
225 //============================================================================
227 extern struct cvar_s registered;
228 extern struct cvar_s cmdline;
230 typedef enum gamemode_e
245 GAME_TENEBRAE, // full of evil hackery
247 GAME_OPENQUARTZ, //this game sucks
251 GAME_DEFEATINDETAIL2,
255 extern gamemode_t gamemode;
256 extern const char *gamename;
257 extern const char *gamedirname1;
258 extern const char *gamedirname2;
259 extern const char *gamescreenshotname;
260 extern const char *gameuserdirname;
261 extern char com_modname[MAX_OSPATH];
263 void COM_ToLowerString (const char *in, char *out, size_t size_out);
264 void COM_ToUpperString (const char *in, char *out, size_t size_out);
265 int COM_StringBeginsWith(const char *s, const char *match);
267 int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix);
269 typedef struct stringlist_s
271 struct stringlist_s *next;
275 int matchpattern(char *in, char *pattern, int caseinsensitive);
276 stringlist_t *stringlistappend(stringlist_t *current, char *text);
277 void stringlistfree(stringlist_t *current);
278 stringlist_t *stringlistsort(stringlist_t *start);
279 stringlist_t *listdirectory(const char *path);
280 void freedirectory(stringlist_t *list);
282 char *SearchInfostring(const char *infostring, const char *key);
285 // strlcat and strlcpy, from OpenBSD
286 // Most (all?) BSDs already have them
287 #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX)
288 # define HAVE_STRLCAT 1
289 # define HAVE_STRLCPY 1
294 * Appends src to string dst of size siz (unlike strncat, siz is the
295 * full size of dst, not space left). At most siz-1 characters
296 * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
297 * Returns strlen(src) + MIN(siz, strlen(initial dst)).
298 * If retval >= siz, truncation occurred.
300 size_t strlcat(char *dst, const char *src, size_t siz);
301 #endif // #ifndef HAVE_STRLCAT
305 * Copy src to string dst of size siz. At most siz-1 characters
306 * will be copied. Always NUL terminates (unless siz == 0).
307 * Returns strlen(src); if retval >= siz, truncation occurred.
309 size_t strlcpy(char *dst, const char *src, size_t siz);
311 #endif // #ifndef HAVE_STRLCPY