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