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