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