common.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3 Copyright (C) 2000-2020 DarkPlaces contributors
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13
  14 See the GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 */
  21
  22 #ifndef COMMON_H
  23 #define COMMON_H
  24
  25 #include <stdarg.h>
  26 #include <assert.h>
  27 #include "qtypes.h"
  28 #include "qdefs.h"
  29
  30 /// MSVC has a different name for several standard functions
  31 #ifdef WIN32
  32 # define strcasecmp _stricmp
  33 # define strncasecmp _strnicmp
  34 #else
  35 #include "strings.h"
  36 #endif
  37
  38 // Create our own define for Mac OS X
  39 #if defined(__APPLE__) && defined(__MACH__)
  40 # define MACOSX
  41 #endif
  42
  43
  44 //============================================================================
  45
  46 #define ContainerOf(ptr, type, member) ((type *)((char *)(ptr) - offsetof(type, member)))
  47
  48 typedef struct sizebuf_s
  49 {
  50         qbool   allowoverflow;  ///< if false, do a Sys_Error
  51         qbool   overflowed;             ///< set to true if the buffer size failed
  52         unsigned char           *data;
  53         int                     maxsize;
  54         int                     cursize;
  55         int                     readcount;
  56         qbool   badread;                // set if a read goes beyond end of message
  57 } sizebuf_t;
  58
  59 void SZ_Clear (sizebuf_t *buf);
  60 unsigned char *SZ_GetSpace (sizebuf_t *buf, int length);
  61 void SZ_Write (sizebuf_t *buf, const unsigned char *data, int length);
  62 void SZ_HexDumpToConsole(const sizebuf_t *buf);
  63
  64 void Com_HexDumpToConsole(const unsigned char *data, int size);
  65
  66 unsigned short CRC_Block(const unsigned char *data, size_t size);
  67 unsigned short CRC_Block_CaseInsensitive(const unsigned char *data, size_t size); // for hash lookup functions that use strcasecmp for comparison
  68
  69 unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int sequence);
  70
  71 // these are actually md4sum (mdfour.c)
  72 unsigned Com_BlockChecksum (void *buffer, int length);
  73 void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf);
  74
  75 void COM_Init_Commands(void);
  76
  77
  78 //============================================================================
  79 //                                                      Endianess handling
  80 //============================================================================
  81
  82 // check mem_bigendian if you need to know the system byte order
  83
  84 /*! \name Byte order functions.
  85  * @{
  86  */
  87
  88 // unaligned memory access crashes on some platform, so always read bytes...
  89 #define BigShort(l) BuffBigShort((unsigned char *)&(l))
  90 #define LittleShort(l) BuffLittleShort((unsigned char *)&(l))
  91 #define BigLong(l) BuffBigLong((unsigned char *)&(l))
  92 #define LittleLong(l) BuffLittleLong((unsigned char *)&(l))
  93 #define BigFloat(l) BuffBigFloat((unsigned char *)&(l))
  94 #define LittleFloat(l) BuffLittleFloat((unsigned char *)&(l))
  95
  96 /// Extract a big endian 32bit float from the given \p buffer.
  97 float BuffBigFloat (const unsigned char *buffer);
  98
  99 /// Extract a big endian 32bit int from the given \p buffer.
 100 int BuffBigLong (const unsigned char *buffer);
 101
 102 /// Extract a big endian 16bit short from the given \p buffer.
 103 short BuffBigShort (const unsigned char *buffer);
 104
 105 /// Extract a little endian 32bit float from the given \p buffer.
 106 float BuffLittleFloat (const unsigned char *buffer);
 107
 108 /// Extract a little endian 32bit int from the given \p buffer.
 109 int BuffLittleLong (const unsigned char *buffer);
 110
 111 /// Extract a little endian 16bit short from the given \p buffer.
 112 short BuffLittleShort (const unsigned char *buffer);
 113
 114 /// Encode a big endian 32bit int to the given \p buffer
 115 void StoreBigLong (unsigned char *buffer, unsigned int i);
 116
 117 /// Encode a big endian 16bit int to the given \p buffer
 118 void StoreBigShort (unsigned char *buffer, unsigned short i);
 119
 120 /// Encode a little endian 32bit int to the given \p buffer
 121 void StoreLittleLong (unsigned char *buffer, unsigned int i);
 122
 123 /// Encode a little endian 16bit int to the given \p buffer
 124 void StoreLittleShort (unsigned char *buffer, unsigned short i);
 125 //@}
 126
 127 //============================================================================
 128
 129 // these versions are purely for internal use, never sent in network protocol
 130 // (use Protocol_EnumForNumber and Protocol_NumberToEnum to convert)
 131 typedef enum protocolversion_e
 132 {
 133         PROTOCOL_UNKNOWN,
 134         PROTOCOL_DARKPLACES8, ///< added parting messages. WIP
 135         PROTOCOL_DARKPLACES7, ///< added QuakeWorld-style movement protocol to allow more consistent prediction
 136         PROTOCOL_DARKPLACES6, ///< various changes
 137         PROTOCOL_DARKPLACES5, ///< uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/
 138         PROTOCOL_DARKPLACES4, ///< various changes
 139         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
 140         PROTOCOL_DARKPLACES2, ///< various changes
 141         PROTOCOL_DARKPLACES1, ///< uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method
 142         PROTOCOL_QUAKEDP, ///< darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used
 143         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)
 144         PROTOCOL_QUAKE, ///< quake (aka netquake/normalquake/nq) protocol
 145         PROTOCOL_QUAKEWORLD, ///< quakeworld protocol
 146         PROTOCOL_NEHAHRABJP, ///< same as QUAKEDP but with 16bit modelindex
 147         PROTOCOL_NEHAHRABJP2, ///< same as NEHAHRABJP but with 16bit soundindex
 148         PROTOCOL_NEHAHRABJP3 ///< same as NEHAHRABJP2 but with some changes
 149 }
 150 protocolversion_t;
 151
 152 /*! \name Message IO functions.
 153  * Handles byte ordering and avoids alignment errors
 154  * @{
 155  */
 156
 157 void MSG_InitReadBuffer (sizebuf_t *buf, unsigned char *data, int size);
 158 void MSG_WriteChar (sizebuf_t *sb, int c);
 159 void MSG_WriteByte (sizebuf_t *sb, int c);
 160 void MSG_WriteShort (sizebuf_t *sb, int c);
 161 void MSG_WriteLong (sizebuf_t *sb, int c);
 162 void MSG_WriteFloat (sizebuf_t *sb, vec_t f);
 163 void MSG_WriteString (sizebuf_t *sb, const char *s);
 164 void MSG_WriteUnterminatedString (sizebuf_t *sb, const char *s);
 165 void MSG_WriteAngle8i (sizebuf_t *sb, vec_t f);
 166 void MSG_WriteAngle16i (sizebuf_t *sb, vec_t f);
 167 void MSG_WriteAngle32f (sizebuf_t *sb, vec_t f);
 168 void MSG_WriteCoord13i (sizebuf_t *sb, vec_t f);
 169 void MSG_WriteCoord16i (sizebuf_t *sb, vec_t f);
 170 void MSG_WriteCoord32f (sizebuf_t *sb, vec_t f);
 171 void MSG_WriteCoord (sizebuf_t *sb, vec_t f, protocolversion_t protocol);
 172 void MSG_WriteVector (sizebuf_t *sb, const vec3_t v, protocolversion_t protocol);
 173 void MSG_WriteAngle (sizebuf_t *sb, vec_t f, protocolversion_t protocol);
 174
 175 void MSG_BeginReading (sizebuf_t *sb);
 176 int MSG_ReadLittleShort (sizebuf_t *sb);
 177 int MSG_ReadBigShort (sizebuf_t *sb);
 178 int MSG_ReadLittleLong (sizebuf_t *sb);
 179 int MSG_ReadBigLong (sizebuf_t *sb);
 180 float MSG_ReadLittleFloat (sizebuf_t *sb);
 181 float MSG_ReadBigFloat (sizebuf_t *sb);
 182 char *MSG_ReadString (sizebuf_t *sb, char *string, size_t maxstring);
 183 /// Same as MSG_ReadString except it returns the number of bytes written to *string excluding the \0 terminator.
 184 size_t MSG_ReadString_len (sizebuf_t *sb, char *string, size_t maxstring);
 185 size_t MSG_ReadBytes (sizebuf_t *sb, size_t numbytes, unsigned char *out);
 186
 187 #define MSG_ReadChar(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (signed char)(sb)->data[(sb)->readcount++])
 188 #define MSG_ReadByte(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (unsigned char)(sb)->data[(sb)->readcount++])
 189 /// Same as MSG_ReadByte but with no need to copy twice (first to `int` to check for -1) so each byte can be copied directly to a string[]
 190 #define MSG_ReadByte_opt(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, '\0') : (unsigned char)(sb)->data[(sb)->readcount++])
 191 #define MSG_ReadShort MSG_ReadLittleShort
 192 #define MSG_ReadLong MSG_ReadLittleLong
 193 #define MSG_ReadFloat MSG_ReadLittleFloat
 194
 195 float MSG_ReadAngle8i (sizebuf_t *sb);
 196 float MSG_ReadAngle16i (sizebuf_t *sb);
 197 float MSG_ReadAngle32f (sizebuf_t *sb);
 198 float MSG_ReadCoord13i (sizebuf_t *sb);
 199 float MSG_ReadCoord16i (sizebuf_t *sb);
 200 float MSG_ReadCoord32f (sizebuf_t *sb);
 201 float MSG_ReadCoord (sizebuf_t *sb, protocolversion_t protocol);
 202 void MSG_ReadVector (sizebuf_t *sb, vec3_t v, protocolversion_t protocol);
 203 float MSG_ReadAngle (sizebuf_t *sb, protocolversion_t protocol);
 204 //@}
 205 //============================================================================
 206
 207 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
 208 typedef int (*COM_LineProcessorFunc) (void *passthrough, const char *line, size_t length, float width, qbool isContination);
 209 int COM_Wordwrap(const char *string, size_t length, float continuationSize, float maxWidth, COM_WordWidthFunc_t wordWidth, void *passthroughCW, COM_LineProcessorFunc processLine, void *passthroughPL);
 210
 211 extern char com_token[MAX_INPUTLINE];
 212 extern unsigned com_token_len;
 213 qbool COM_ParseToken_Simple(const char **datapointer, qbool returnnewline, qbool parsebackslash, qbool parsecomments);
 214 qbool COM_ParseToken_QuakeC(const char **datapointer, qbool returnnewline);
 215 qbool COM_ParseToken_VM_Tokenize(const char **datapointer, qbool returnnewline);
 216 qbool COM_ParseToken_Console(const char **datapointer);
 217
 218 void COM_Init (void);
 219 void COM_Shutdown (void);
 220
 221 char *va(char *buf, size_t buflen, const char *format, ...) DP_FUNC_PRINTF(3);
 222 // does a varargs printf into provided buffer, returns buffer (so it can be called in-line unlike dpsnprintf)
 223
 224 // GCC with -Werror=c++-compat will error out if static_assert is used even though the macro is valid C11...
 225 #ifndef __cplusplus
 226 #define DP_STATIC_ASSERT(expr, str) _Static_assert(expr, str)
 227 #else
 228 #define DP_STATIC_ASSERT(expr, str) static_assert(expr, str)
 229 #endif
 230
 231 // snprintf and vsnprintf are NOT portable. Use their DP counterparts instead
 232 #undef snprintf
 233 #define snprintf DP_STATIC_ASSERT(0, "snprintf is forbidden for portability reasons. Use dpsnprintf instead.")
 234 #undef vsnprintf
 235 #define vsnprintf DP_STATIC_ASSERT(0, "vsnprintf is forbidden for portability reasons. Use dpvsnprintf instead.")
 236
 237 // documentation duplicated deliberately for the benefit of IDEs that support https://www.doxygen.nl/manual/docblocks.html
 238 /// Returns the number of printed characters, excluding the final '\0'
 239 /// or returns -1 if the buffer isn't big enough to contain the entire string.
 240 /// Buffer is ALWAYS null-terminated.
 241 extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...) DP_FUNC_PRINTF(3);
 242 /// Returns the number of printed characters, excluding the final '\0'
 243 /// or returns -1 if the buffer isn't big enough to contain the entire string.
 244 /// Buffer is ALWAYS null-terminated.
 245 extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args);
 246
 247 // A bunch of functions are forbidden for security reasons (and also to please MSVS 2005, for some of them)
 248 // LadyHavoc: added #undef lines here to avoid warnings in Linux
 249 #undef strcat
 250 #define strcat DP_STATIC_ASSERT(0, "strcat is forbidden for security reasons. Use dp_strlcat or memcpy instead.")
 251 #undef strncat
 252 #define strncat DP_STATIC_ASSERT(0, "strncat is forbidden for security reasons. Use dp_strlcat or memcpy instead.")
 253 #undef strcpy
 254 #define strcpy DP_STATIC_ASSERT(0, "strcpy is forbidden for security reasons. Use dp_strlcpy or memcpy instead.")
 255 #undef strncpy
 256 #define strncpy DP_STATIC_ASSERT(0, "strncpy is forbidden for security reasons. Use dp_strlcpy or memcpy instead.")
 257 #undef stpcpy
 258 #define stpcpy DP_STATIC_ASSERT(0, "stpcpy is forbidden for security reasons. Use dp_stpecpy or memcpy instead.")
 259 #undef ustpcpy
 260 #define ustpcpy DP_STATIC_ASSERT(0, "ustpcpy is forbidden for security reasons. Use dp_ustr2stp or memcpy instead.")
 261 #undef ustr2stp
 262 #define ustr2stp DP_STATIC_ASSERT(0, "ustr2stp is forbidden for security reasons. Use dp_ustr2stp or memcpy instead.")
 263 #undef sprintf
 264 #define sprintf DP_STATIC_ASSERT(0, "sprintf is forbidden for security reasons. Use dpsnprintf instead.")
 265
 266 #undef strlcpy
 267 #define strlcpy DP_STATIC_ASSERT(0, "strlcpy is forbidden for stability and correctness. See common.h and common.c comments.")
 268 #undef strlcat
 269 #define strlcat DP_STATIC_ASSERT(0, "strlcat is forbidden for stability and correctness. See common.h and common.c comments.")
 270
 271
 272 //============================================================================
 273
 274 extern  struct cvar_s   registered;
 275 extern  struct cvar_s   cmdline;
 276
 277 typedef enum userdirmode_e
 278 {
 279         USERDIRMODE_NOHOME, // basedir only
 280         USERDIRMODE_HOME, // Windows basedir, general POSIX (~/.)
 281         USERDIRMODE_MYGAMES, // pre-Vista (My Documents/My Games/), general POSIX (~/.)
 282         USERDIRMODE_SAVEDGAMES, // Vista (%USERPROFILE%/Saved Games/), OSX (~/Library/Application Support/), Linux (~/.config)
 283         USERDIRMODE_COUNT
 284 }
 285 userdirmode_t;
 286
 287 /// Returns the number of bytes written to *out excluding the \0 terminator.
 288 size_t COM_ToLowerString(const char *in, char *out, size_t size_out);
 289 /// Returns the number of bytes written to *out excluding the \0 terminator.
 290 size_t COM_ToUpperString(const char *in, char *out, size_t size_out);
 291 int COM_StringBeginsWith(const char *s, const char *match);
 292 int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix);
 293 size_t COM_StringLengthNoColors(const char *s, size_t size_s, qbool *valid);
 294 size_t COM_StringDecolorize(const char *in, size_t size_in, char *out, size_t size_out, qbool escape_carets);
 295
 296
 297
 298 #define dp_strlcpy(dst, src, dsize) dp__strlcpy(dst, src, dsize, __func__, __LINE__)
 299 #define dp_strlcat(dst, src, dsize) dp__strlcat(dst, src, dsize, __func__, __LINE__)
 300 size_t dp__strlcpy(char *dst, const char *src, size_t dsize, const char *func, unsigned line);
 301 size_t dp__strlcat(char *dst, const char *src, size_t dsize, const char *func, unsigned line);
 302 char *dp_stpecpy(char *dst, char *end, const char *src);
 303 char *dp_ustr2stp(char *dst, size_t dsize, const char *src, size_t slen);
 304
 305
 306 void FindFraction(double val, int *num, int *denom, int denomMax);
 307
 308 // decodes XPM file to XPM array (as if #include'd)
 309 char **XPM_DecodeString(const char *in);
 310
 311 size_t base64_encode(unsigned char *buf, size_t buflen, size_t outbuflen);
 312
 313 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 314
 315 float Com_CalcRoll (const vec3_t angles, const vec3_t velocity, const vec_t angleval, const vec_t velocityval);
 316
 317 #endif
 318