Major update, been neglecting CVS for some time...
[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 // comndef.h  -- general definitions
21
22 #if !defined BYTE_DEFINED
23 typedef unsigned char           byte;
24 #define BYTE_DEFINED 1
25 #endif
26
27 #undef true
28 #undef false
29
30 typedef enum {false, true}      qboolean;
31
32 #include "quakeio.h"
33
34 //============================================================================
35
36 extern void *qmalloc(unsigned int size);
37 extern void qfree(void *mem);
38
39 //============================================================================
40
41 typedef struct sizebuf_s
42 {
43         qboolean        allowoverflow;  // if false, do a Sys_Error
44         qboolean        overflowed;             // set to true if the buffer size failed
45         byte    *data;
46         int             maxsize;
47         int             cursize;
48 } sizebuf_t;
49
50 void SZ_Alloc (sizebuf_t *buf, int startsize);
51 void SZ_Free (sizebuf_t *buf);
52 void SZ_Clear (sizebuf_t *buf);
53 void *SZ_GetSpace (sizebuf_t *buf, int length);
54 void SZ_Write (sizebuf_t *buf, void *data, int length);
55 void SZ_Print (sizebuf_t *buf, char *data);     // strcats onto the sizebuf
56
57 //============================================================================
58
59 #ifndef NULL
60 #define NULL ((void *)0)
61 #endif
62
63 //============================================================================
64 #if !defined(ENDIAN_LITTLE) && !defined(ENDIAN_BIG)
65 #if  defined(__i386__) || defined(__ia64__) || defined(WIN32) || (defined(__alpha__) || defined(__alpha)) || defined(__arm__) || (defined(__mips__) && defined(__MIPSEL__)) || defined(__LITTLE_ENDIAN__)
66 #define ENDIAN_LITTLE
67 #else
68 #define ENDIAN_BIG
69 #endif
70 #endif
71
72 short ShortSwap (short l);
73 int LongSwap (int l);
74 float FloatSwap (float f);
75
76 #ifdef ENDIAN_LITTLE
77 // little endian
78 #define BigShort(l) ShortSwap(l)
79 #define LittleShort(l) (l)
80 #define BigLong(l) LongSwap(l)
81 #define LittleLong(l) (l)
82 #define BigFloat(l) FloatSwap(l)
83 #define LittleFloat(l) (l)
84 #elif ENDIAN_BIG
85 // big endian
86 #define BigShort(l) (l)
87 #define LittleShort(l) ShortSwap(l)
88 #define BigLong(l) (l)
89 #define LittleLong(l) LongSwap(l)
90 #define BigFloat(l) (l)
91 #define LittleFloat(l) FloatSwap(l)
92 #else
93 // figure it out at runtime
94 extern short (*BigShort) (short l);
95 extern short (*LittleShort) (short l);
96 extern int (*BigLong) (int l);
97 extern int (*LittleLong) (int l);
98 extern float (*BigFloat) (float l);
99 extern float (*LittleFloat) (float l);
100 #endif
101
102 //============================================================================
103
104 void MSG_WriteChar (sizebuf_t *sb, int c);
105 void MSG_WriteByte (sizebuf_t *sb, int c);
106 void MSG_WriteShort (sizebuf_t *sb, int c);
107 void MSG_WriteLong (sizebuf_t *sb, int c);
108 void MSG_WriteFloat (sizebuf_t *sb, float f);
109 void MSG_WriteString (sizebuf_t *sb, char *s);
110 void MSG_WriteCoord (sizebuf_t *sb, float f);
111 void MSG_WriteAngle (sizebuf_t *sb, float f);
112 void MSG_WritePreciseAngle (sizebuf_t *sb, float f);
113
114 #define MSG_WriteFloatCoord MSG_WriteFloat
115
116 extern  int                     msg_readcount;
117 extern  qboolean        msg_badread;            // set if a read goes beyond end of message
118
119 void MSG_BeginReading (void);
120 //int MSG_ReadChar (void);
121 //int MSG_ReadByte (void);
122 int MSG_ReadShort (void);
123 int MSG_ReadLong (void);
124 float MSG_ReadFloat (void);
125 char *MSG_ReadString (void);
126
127 #define MSG_ReadChar() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (signed char)net_message.data[msg_readcount++])
128 #define MSG_ReadByte() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (unsigned char)net_message.data[msg_readcount++])
129 //#define MSG_ReadShort() ((msg_readcount + 2) > net_message.cursize ? (msg_badread = true, -1) : (short)net_message.data[msg_readcount+=2, msg_readcount-2] | (net_message.data[msg_readcount-1] << 8))
130 //#define MSG_ReadLong() ((msg_readcount + 4) > net_message.cursize ? (msg_badread = true, -1) : (int)net_message.data[msg_readcount+=4, msg_readcount-4] | (net_message.data[msg_readcount-3] << 8) | (net_message.data[msg_readcount-2] << 16) | (net_message.data[msg_readcount-1] << 24))
131
132 float MSG_ReadCoord (void);
133 //float MSG_ReadAngle (void);
134
135 #define MSG_ReadFloatCoord MSG_ReadFloat
136
137 #define MSG_ReadAngle() (MSG_ReadByte() * (360.0f / 256.0f))
138 #define MSG_ReadPreciseAngle() (MSG_ReadShort() * (360.0f / 65536.0f))
139
140 #define MSG_ReadVector(v) {(v)[0] = MSG_ReadCoord();(v)[1] = MSG_ReadCoord();(v)[2] = MSG_ReadCoord();}
141
142 extern qboolean dpprotocol;
143
144 //============================================================================
145
146 /*
147 void Q_memset (void *dest, int fill, int count);
148 void Q_memcpy (void *dest, void *src, int count);
149 int Q_memcmp (void *m1, void *m2, int count);
150 void Q_strcpy (char *dest, char *src);
151 void Q_strncpy (char *dest, char *src, int count);
152 int Q_strlen (char *str);
153 char *Q_strrchr (char *s, char c);
154 void Q_strcat (char *dest, char *src);
155 int Q_strcmp (char *s1, char *s2);
156 int Q_strncmp (char *s1, char *s2, int count);
157 */
158 int Q_strcasecmp (char *s1, char *s2);
159 int Q_strncasecmp (char *s1, char *s2, int n);
160 /*
161 int     Q_atoi (char *str);
162 float Q_atof (char *str);
163 */
164
165 //============================================================================
166
167 extern  char            com_token[1024];
168 extern  qboolean        com_eof;
169
170 char *COM_Parse (char *data);
171
172
173 extern  int             com_argc;
174 extern  char    **com_argv;
175
176 int COM_CheckParm (char *parm);
177 void COM_Init (char *path);
178 void COM_InitArgv (int argc, char **argv);
179
180 char *COM_SkipPath (char *pathname);
181 void COM_StripExtension (char *in, char *out);
182 void COM_FileBase (char *in, char *out);
183 void COM_DefaultExtension (char *path, char *extension);
184
185 char    *va(char *format, ...);
186 // does a varargs printf into a temp buffer
187
188
189 //============================================================================
190
191 extern int com_filesize;
192 struct cache_user_s;
193
194 extern  char    com_gamedir[MAX_OSPATH];
195
196 void COM_WriteFile (char *filename, void *data, int len);
197 int COM_FOpenFile (char *filename, QFile **file, qboolean quiet, qboolean zip);
198
199 // set by COM_LoadFile functions
200 extern int loadsize;
201 byte *COM_LoadHunkFile (char *path, qboolean quiet);
202 byte *COM_LoadMallocFile (char *path, qboolean quiet);
203 //void COM_LoadCacheFile (char *path, struct cache_user_s *cu, qboolean quiet);
204
205 byte *COM_LoadFile (char *path, int usehunk, qboolean quiet);
206
207 int COM_FileExists(char *filename);
208
209 extern  struct cvar_s   registered;
210
211 extern qboolean         standard_quake, rogue, hipnotic, nehahra;
212
213 // LordHavoc: useful...
214 extern void COM_ToLowerString(char *in, char *out);
215 extern void COM_ToUpperString(char *in, char *out);