implemented PRYDON_CLIENTCURSOR extension (clientside mouse pointer that feeds back...
[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 // MSVC has a different name for several standard functions
25 #ifdef WIN32
26 # define snprintf _snprintf
27 # define vsnprintf _vsnprintf
28 # define strcasecmp stricmp
29 # define strncasecmp strnicmp
30 #endif
31
32
33 //============================================================================
34
35 typedef struct sizebuf_s
36 {
37         qboolean        allowoverflow;  // if false, do a Sys_Error
38         qboolean        overflowed;             // set to true if the buffer size failed
39         qbyte           *data;
40         mempool_t       *mempool;
41         int                     maxsize;
42         int                     cursize;
43 } sizebuf_t;
44
45 void SZ_Alloc (sizebuf_t *buf, int startsize, const char *name);
46 void SZ_Free (sizebuf_t *buf);
47 void SZ_Clear (sizebuf_t *buf);
48 void *SZ_GetSpace (sizebuf_t *buf, int length);
49 void SZ_Write (sizebuf_t *buf, const void *data, int length);
50 void SZ_Print(sizebuf_t *buf, const char *data);        // strcats onto the sizebuf
51 void SZ_HexDumpToConsole(const sizebuf_t *buf);
52
53 void Com_HexDumpToConsole(const qbyte *data, int size);
54
55 unsigned short CRC_Block(qbyte *data, int size);
56
57
58 //============================================================================
59 //                                                      Endianess handling
60 //============================================================================
61
62 // We use BSD-style defines: BYTE_ORDER is defined to either BIG_ENDIAN or LITTLE_ENDIAN
63
64 // Initializations
65 #if !defined(BYTE_ORDER) || !defined(LITTLE_ENDIAN) || !defined(BIG_ENDIAN) || (BYTE_ORDER != LITTLE_ENDIAN && BYTE_ORDER != BIG_ENDIAN)
66 # undef BYTE_ORDER
67 # undef LITTLE_ENDIAN
68 # undef BIG_ENDIAN
69 # define LITTLE_ENDIAN 1234
70 # define BIG_ENDIAN 4321
71 #endif
72
73 // If we still don't know the CPU endianess at this point, we try to guess
74 #ifndef BYTE_ORDER
75 # if defined(WIN32)
76 #  define BYTE_ORDER LITTLE_ENDIAN
77 # else
78 #  warning "Unable to determine the CPU endianess. Defaulting to little endian"
79 #  define BYTE_ORDER LITTLE_ENDIAN
80 # endif
81 #endif
82
83
84 short ShortSwap (short l);
85 int LongSwap (int l);
86 float FloatSwap (float f);
87
88 #if BYTE_ORDER == LITTLE_ENDIAN
89 // little endian
90 #define BigShort(l) ShortSwap(l)
91 #define LittleShort(l) (l)
92 #define BigLong(l) LongSwap(l)
93 #define LittleLong(l) (l)
94 #define BigFloat(l) FloatSwap(l)
95 #define LittleFloat(l) (l)
96 #else
97 // big endian
98 #define BigShort(l) (l)
99 #define LittleShort(l) ShortSwap(l)
100 #define BigLong(l) (l)
101 #define LittleLong(l) LongSwap(l)
102 #define BigFloat(l) (l)
103 #define LittleFloat(l) FloatSwap(l)
104 #endif
105
106 unsigned int BuffBigLong (const qbyte *buffer);
107 unsigned short BuffBigShort (const qbyte *buffer);
108 unsigned int BuffLittleLong (const qbyte *buffer);
109 unsigned short BuffLittleShort (const qbyte *buffer);
110
111
112 //============================================================================
113
114 void MSG_WriteChar (sizebuf_t *sb, int c);
115 void MSG_WriteByte (sizebuf_t *sb, int c);
116 void MSG_WriteShort (sizebuf_t *sb, int c);
117 void MSG_WriteLong (sizebuf_t *sb, int c);
118 void MSG_WriteFloat (sizebuf_t *sb, float f);
119 void MSG_WriteString (sizebuf_t *sb, const char *s);
120 void MSG_WriteAngle8i (sizebuf_t *sb, float f);
121 void MSG_WriteAngle16i (sizebuf_t *sb, float f);
122 void MSG_WriteAngle32f (sizebuf_t *sb, float f);
123 void MSG_WriteCoord13i (sizebuf_t *sb, float f);
124 void MSG_WriteCoord16i (sizebuf_t *sb, float f);
125 void MSG_WriteCoord32f (sizebuf_t *sb, float f);
126 void MSG_WriteCoord (sizebuf_t *sb, float f, int protocol);
127 void MSG_WriteVector (sizebuf_t *sb, float *v, int protocol);
128 void MSG_WriteAngle (sizebuf_t *sb, float f, int protocol);
129
130 extern  int                     msg_readcount;
131 extern  qboolean        msg_badread;            // set if a read goes beyond end of message
132
133 void MSG_BeginReading (void);
134 int MSG_ReadLittleShort (void);
135 int MSG_ReadBigShort (void);
136 int MSG_ReadLittleLong (void);
137 int MSG_ReadBigLong (void);
138 float MSG_ReadLittleFloat (void);
139 float MSG_ReadBigFloat (void);
140 char *MSG_ReadString (void);
141 int MSG_ReadBytes (int numbytes, unsigned char *out);
142
143 #define MSG_ReadChar() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (signed char)net_message.data[msg_readcount++])
144 #define MSG_ReadByte() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (unsigned char)net_message.data[msg_readcount++])
145 #define MSG_ReadShort MSG_ReadLittleShort
146 #define MSG_ReadLong MSG_ReadLittleLong
147 #define MSG_ReadFloat MSG_ReadLittleFloat
148
149 float MSG_ReadAngle8i (void);
150 float MSG_ReadAngle16i (void);
151 float MSG_ReadAngle32f (void);
152 float MSG_ReadCoord13i (void);
153 float MSG_ReadCoord16i (void);
154 float MSG_ReadCoord32f (void);
155 float MSG_ReadCoord (int protocol);
156 void MSG_ReadVector (float *v, int protocol);
157 float MSG_ReadAngle (int protocol);
158
159 //============================================================================
160
161 extern char com_token[1024];
162
163 int COM_ParseToken(const char **datapointer, int returnnewline);
164 int COM_ParseTokenConsole(const char **datapointer);
165
166 extern int com_argc;
167 extern const char **com_argv;
168
169 int COM_CheckParm (const char *parm);
170 void COM_Init (void);
171 void COM_InitArgv (void);
172 void COM_InitGameType (void);
173
174 char    *va(const char *format, ...);
175 // does a varargs printf into a temp buffer
176
177
178 //============================================================================
179
180 extern  struct cvar_s   registered;
181 extern  struct cvar_s   cmdline;
182
183 #define GAME_NORMAL 0
184 #define GAME_HIPNOTIC 1
185 #define GAME_ROGUE 2
186 #define GAME_NEHAHRA 3
187 #define GAME_NEXUIZ 4
188 #define GAME_TRANSFUSION 5
189 #define GAME_GOODVSBAD2 6
190 #define GAME_TEU 7
191 #define GAME_BATTLEMECH 8
192 #define GAME_ZYMOTIC 9
193 #define GAME_FNIGGIUM 10
194 #define GAME_SETHERAL 11
195 #define GAME_SOM 12
196 #define GAME_TENEBRAE 13 // full of evil hackery
197 #define GAME_NEOTERIC 14
198 #define GAME_OPENQUARTZ 15 //this game sucks
199 #define GAME_PRYDON 16
200 #define GAME_NETHERWORLD 17
201
202 extern int gamemode;
203 extern const char *gamename;
204 extern const char *gamedirname;
205 extern const char *gamescreenshotname;
206 extern char com_modname[MAX_OSPATH];
207
208 void COM_ToLowerString (const char *in, char *out, size_t size_out);
209 void COM_ToUpperString (const char *in, char *out, size_t size_out);
210 int COM_StringBeginsWith(const char *s, const char *match);
211
212 int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix);
213
214 typedef struct stringlist_s
215 {
216         struct stringlist_s *next;
217         char *text;
218 } stringlist_t;
219
220 int matchpattern(char *in, char *pattern, int caseinsensitive);
221 stringlist_t *stringlistappend(stringlist_t *current, char *text);
222 void stringlistfree(stringlist_t *current);
223 stringlist_t *stringlistsort(stringlist_t *start);
224 stringlist_t *listdirectory(char *path);
225 void freedirectory(stringlist_t *list);
226
227 char *SearchInfostring(const char *infostring, const char *key);
228
229
230 // strlcat and strlcpy, from OpenBSD
231 // Most (all?) BSDs already have them
232 #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || (defined(__APPLE__) && defined(__MACH__))
233 # define HAVE_STRLCAT 1
234 # define HAVE_STRLCPY 1
235 #endif
236
237 #ifndef HAVE_STRLCAT
238 /*
239  * Appends src to string dst of size siz (unlike strncat, siz is the
240  * full size of dst, not space left).  At most siz-1 characters
241  * will be copied.  Always NUL terminates (unless siz <= strlen(dst)).
242  * Returns strlen(src) + MIN(siz, strlen(initial dst)).
243  * If retval >= siz, truncation occurred.
244  */
245 size_t strlcat(char *dst, const char *src, size_t siz);
246 #endif  // #ifndef HAVE_STRLCAT
247
248 #ifndef HAVE_STRLCPY
249 /*
250  * Copy src to string dst of size siz.  At most siz-1 characters
251  * will be copied.  Always NUL terminates (unless siz == 0).
252  * Returns strlen(src); if retval >= siz, truncation occurred.
253  */
254 size_t strlcpy(char *dst, const char *src, size_t siz);
255
256 #endif  // #ifndef HAVE_STRLCPY
257
258 #endif
259