X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=common.h;h=0fdf97ce59a3e0f982a7c247198c7a7671707c20;hp=507d3f7dceb86fb80d4833e88eef0bfc044baf6a;hb=90ab66ba6bfed05c0ce331d321ff63eba7912637;hpb=31bc6f42205f75d58be52a0059c95cdbe90679af diff --git a/common.h b/common.h index 507d3f7d..0fdf97ce 100644 --- a/common.h +++ b/common.h @@ -1,5 +1,6 @@ /* Copyright (C) 1996-1997 Id Software, Inc. +Copyright (C) 2000-2020 DarkPlaces contributors This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License @@ -21,11 +22,17 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #ifndef COMMON_H #define COMMON_H +#include +#include +#include "qtypes.h" +#include "qdefs.h" -// MSVC has a different name for several standard functions +/// MSVC has a different name for several standard functions #ifdef WIN32 -# define strcasecmp stricmp -# define strncasecmp strnicmp +# define strcasecmp _stricmp +# define strncasecmp _strnicmp +#else +#include "strings.h" #endif // Create our own define for Mac OS X @@ -33,94 +40,89 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # define MACOSX #endif -#ifdef SUNOS -#include // Needed for FNDELAY -# define model_t dp_model_t // Workaround conflict with /usr/include/sys/model.h -#endif //============================================================================ +#define ContainerOf(ptr, type, member) ((type *)((char *)(ptr) - offsetof(type, member))) + typedef struct sizebuf_s { - qboolean allowoverflow; // if false, do a Sys_Error - qboolean overflowed; // set to true if the buffer size failed - qbyte *data; + qbool allowoverflow; ///< if false, do a Sys_Error + qbool overflowed; ///< set to true if the buffer size failed + unsigned char *data; int maxsize; int cursize; + int readcount; + qbool badread; // set if a read goes beyond end of message } sizebuf_t; void SZ_Clear (sizebuf_t *buf); -void *SZ_GetSpace (sizebuf_t *buf, int length); -void SZ_Write (sizebuf_t *buf, const void *data, int length); -void SZ_Print(sizebuf_t *buf, const char *data); // strcats onto the sizebuf +unsigned char *SZ_GetSpace (sizebuf_t *buf, int length); +void SZ_Write (sizebuf_t *buf, const unsigned char *data, int length); void SZ_HexDumpToConsole(const sizebuf_t *buf); -void Com_HexDumpToConsole(const qbyte *data, int size); +void Com_HexDumpToConsole(const unsigned char *data, int size); + +unsigned short CRC_Block(const unsigned char *data, size_t size); +unsigned short CRC_Block_CaseInsensitive(const unsigned char *data, size_t size); // for hash lookup functions that use strcasecmp for comparison + +unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int sequence); -unsigned short CRC_Block(const qbyte *data, size_t size); +// these are actually md4sum (mdfour.c) +unsigned Com_BlockChecksum (void *buffer, int length); +void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf); + +void COM_Init_Commands(void); //============================================================================ // Endianess handling //============================================================================ -// We use BSD-style defines: BYTE_ORDER is defined to either BIG_ENDIAN or LITTLE_ENDIAN +// check mem_bigendian if you need to know the system byte order -// Initializations -#if !defined(BYTE_ORDER) || !defined(LITTLE_ENDIAN) || !defined(BIG_ENDIAN) || (BYTE_ORDER != LITTLE_ENDIAN && BYTE_ORDER != BIG_ENDIAN) -# undef BYTE_ORDER -# undef LITTLE_ENDIAN -# undef BIG_ENDIAN -# define LITTLE_ENDIAN 1234 -# define BIG_ENDIAN 4321 -#endif +/*! \name Byte order functions. + * @{ + */ -// If we still don't know the CPU endianess at this point, we try to guess -#ifndef BYTE_ORDER -# if defined(WIN32) -# define BYTE_ORDER LITTLE_ENDIAN -# else -# if defined(SUNOS) -# if defined(__i386) || defined(__amd64) -# define BYTE_ORDER LITTLE_ENDIAN -# else -# define BYTE_ORDER BIG_ENDIAN -# endif -# else -# warning "Unable to determine the CPU endianess. Defaulting to little endian" -# define BYTE_ORDER LITTLE_ENDIAN -# endif -# endif -#endif +// unaligned memory access crashes on some platform, so always read bytes... +#define BigShort(l) BuffBigShort((unsigned char *)&(l)) +#define LittleShort(l) BuffLittleShort((unsigned char *)&(l)) +#define BigLong(l) BuffBigLong((unsigned char *)&(l)) +#define LittleLong(l) BuffLittleLong((unsigned char *)&(l)) +#define BigFloat(l) BuffBigFloat((unsigned char *)&(l)) +#define LittleFloat(l) BuffLittleFloat((unsigned char *)&(l)) +/// Extract a big endian 32bit float from the given \p buffer. +float BuffBigFloat (const unsigned char *buffer); -short ShortSwap (short l); -int LongSwap (int l); -float FloatSwap (float f); +/// Extract a big endian 32bit int from the given \p buffer. +int BuffBigLong (const unsigned char *buffer); -#if BYTE_ORDER == LITTLE_ENDIAN -// little endian -#define BigShort(l) ShortSwap(l) -#define LittleShort(l) (l) -#define BigLong(l) LongSwap(l) -#define LittleLong(l) (l) -#define BigFloat(l) FloatSwap(l) -#define LittleFloat(l) (l) -#else -// big endian -#define BigShort(l) (l) -#define LittleShort(l) ShortSwap(l) -#define BigLong(l) (l) -#define LittleLong(l) LongSwap(l) -#define BigFloat(l) (l) -#define LittleFloat(l) FloatSwap(l) -#endif +/// Extract a big endian 16bit short from the given \p buffer. +short BuffBigShort (const unsigned char *buffer); + +/// Extract a little endian 32bit float from the given \p buffer. +float BuffLittleFloat (const unsigned char *buffer); + +/// Extract a little endian 32bit int from the given \p buffer. +int BuffLittleLong (const unsigned char *buffer); + +/// Extract a little endian 16bit short from the given \p buffer. +short BuffLittleShort (const unsigned char *buffer); + +/// Encode a big endian 32bit int to the given \p buffer +void StoreBigLong (unsigned char *buffer, unsigned int i); -unsigned int BuffBigLong (const qbyte *buffer); -unsigned short BuffBigShort (const qbyte *buffer); -unsigned int BuffLittleLong (const qbyte *buffer); -unsigned short BuffLittleShort (const qbyte *buffer); +/// Encode a big endian 16bit int to the given \p buffer +void StoreBigShort (unsigned char *buffer, unsigned short i); +/// Encode a little endian 32bit int to the given \p buffer +void StoreLittleLong (unsigned char *buffer, unsigned int i); + +/// Encode a little endian 16bit int to the given \p buffer +void StoreLittleShort (unsigned char *buffer, unsigned short i); +//@} //============================================================================ @@ -129,132 +131,144 @@ unsigned short BuffLittleShort (const qbyte *buffer); typedef enum protocolversion_e { PROTOCOL_UNKNOWN, - PROTOCOL_DARKPLACES7, // added QuakeWorld-style movement protocol to allow more consistent prediction - PROTOCOL_DARKPLACES6, // various changes - PROTOCOL_DARKPLACES5, // uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/ - PROTOCOL_DARKPLACES4, // various changes - 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 - PROTOCOL_DARKPLACES2, // various changes - PROTOCOL_DARKPLACES1, // uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method - PROTOCOL_QUAKEDP, // darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used - 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) - PROTOCOL_QUAKE, // quake (aka netquake/normalquake/nq) protocol + PROTOCOL_DARKPLACES8, ///< added parting messages. WIP + PROTOCOL_DARKPLACES7, ///< added QuakeWorld-style movement protocol to allow more consistent prediction + PROTOCOL_DARKPLACES6, ///< various changes + PROTOCOL_DARKPLACES5, ///< uses EntityFrame5 entity snapshot encoder/decoder which is based on a Tribes networking article at http://www.garagegames.com/articles/networking1/ + PROTOCOL_DARKPLACES4, ///< various changes + 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 + PROTOCOL_DARKPLACES2, ///< various changes + PROTOCOL_DARKPLACES1, ///< uses EntityFrame entity snapshot encoder/decoder which is a QuakeWorld-like entity snapshot delta compression method + PROTOCOL_QUAKEDP, ///< darkplaces extended quake protocol (used by TomazQuake and others), backwards compatible as long as no extended features are used + 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) + PROTOCOL_QUAKE, ///< quake (aka netquake/normalquake/nq) protocol + PROTOCOL_QUAKEWORLD, ///< quakeworld protocol + PROTOCOL_NEHAHRABJP, ///< same as QUAKEDP but with 16bit modelindex + PROTOCOL_NEHAHRABJP2, ///< same as NEHAHRABJP but with 16bit soundindex + PROTOCOL_NEHAHRABJP3 ///< same as NEHAHRABJP2 but with some changes } protocolversion_t; +/*! \name Message IO functions. + * Handles byte ordering and avoids alignment errors + * @{ + */ + +void MSG_InitReadBuffer (sizebuf_t *buf, unsigned char *data, int size); void MSG_WriteChar (sizebuf_t *sb, int c); void MSG_WriteByte (sizebuf_t *sb, int c); void MSG_WriteShort (sizebuf_t *sb, int c); void MSG_WriteLong (sizebuf_t *sb, int c); -void MSG_WriteFloat (sizebuf_t *sb, float f); +void MSG_WriteFloat (sizebuf_t *sb, vec_t f); void MSG_WriteString (sizebuf_t *sb, const char *s); -void MSG_WriteAngle8i (sizebuf_t *sb, float f); -void MSG_WriteAngle16i (sizebuf_t *sb, float f); -void MSG_WriteAngle32f (sizebuf_t *sb, float f); -void MSG_WriteCoord13i (sizebuf_t *sb, float f); -void MSG_WriteCoord16i (sizebuf_t *sb, float f); -void MSG_WriteCoord32f (sizebuf_t *sb, float f); -void MSG_WriteCoord (sizebuf_t *sb, float f, protocolversion_t protocol); -void MSG_WriteVector (sizebuf_t *sb, float *v, protocolversion_t protocol); -void MSG_WriteAngle (sizebuf_t *sb, float f, protocolversion_t protocol); - -extern int msg_readcount; -extern qboolean msg_badread; // set if a read goes beyond end of message - -void MSG_BeginReading (void); -int MSG_ReadLittleShort (void); -int MSG_ReadBigShort (void); -int MSG_ReadLittleLong (void); -int MSG_ReadBigLong (void); -float MSG_ReadLittleFloat (void); -float MSG_ReadBigFloat (void); -char *MSG_ReadString (void); -int MSG_ReadBytes (int numbytes, unsigned char *out); - -#define MSG_ReadChar() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (signed char)net_message.data[msg_readcount++]) -#define MSG_ReadByte() (msg_readcount >= net_message.cursize ? (msg_badread = true, -1) : (unsigned char)net_message.data[msg_readcount++]) +void MSG_WriteUnterminatedString (sizebuf_t *sb, const char *s); +void MSG_WriteAngle8i (sizebuf_t *sb, vec_t f); +void MSG_WriteAngle16i (sizebuf_t *sb, vec_t f); +void MSG_WriteAngle32f (sizebuf_t *sb, vec_t f); +void MSG_WriteCoord13i (sizebuf_t *sb, vec_t f); +void MSG_WriteCoord16i (sizebuf_t *sb, vec_t f); +void MSG_WriteCoord32f (sizebuf_t *sb, vec_t f); +void MSG_WriteCoord (sizebuf_t *sb, vec_t f, protocolversion_t protocol); +void MSG_WriteVector (sizebuf_t *sb, const vec3_t v, protocolversion_t protocol); +void MSG_WriteAngle (sizebuf_t *sb, vec_t f, protocolversion_t protocol); + +void MSG_BeginReading (sizebuf_t *sb); +int MSG_ReadLittleShort (sizebuf_t *sb); +int MSG_ReadBigShort (sizebuf_t *sb); +int MSG_ReadLittleLong (sizebuf_t *sb); +int MSG_ReadBigLong (sizebuf_t *sb); +float MSG_ReadLittleFloat (sizebuf_t *sb); +float MSG_ReadBigFloat (sizebuf_t *sb); +char *MSG_ReadString (sizebuf_t *sb, char *string, size_t maxstring); +int MSG_ReadBytes (sizebuf_t *sb, int numbytes, unsigned char *out); + +#define MSG_ReadChar(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (signed char)(sb)->data[(sb)->readcount++]) +#define MSG_ReadByte(sb) ((sb)->readcount >= (sb)->cursize ? ((sb)->badread = true, -1) : (unsigned char)(sb)->data[(sb)->readcount++]) #define MSG_ReadShort MSG_ReadLittleShort #define MSG_ReadLong MSG_ReadLittleLong #define MSG_ReadFloat MSG_ReadLittleFloat -float MSG_ReadAngle8i (void); -float MSG_ReadAngle16i (void); -float MSG_ReadAngle32f (void); -float MSG_ReadCoord13i (void); -float MSG_ReadCoord16i (void); -float MSG_ReadCoord32f (void); -float MSG_ReadCoord (protocolversion_t protocol); -void MSG_ReadVector (float *v, protocolversion_t protocol); -float MSG_ReadAngle (protocolversion_t protocol); - +float MSG_ReadAngle8i (sizebuf_t *sb); +float MSG_ReadAngle16i (sizebuf_t *sb); +float MSG_ReadAngle32f (sizebuf_t *sb); +float MSG_ReadCoord13i (sizebuf_t *sb); +float MSG_ReadCoord16i (sizebuf_t *sb); +float MSG_ReadCoord32f (sizebuf_t *sb); +float MSG_ReadCoord (sizebuf_t *sb, protocolversion_t protocol); +void MSG_ReadVector (sizebuf_t *sb, vec3_t v, protocolversion_t protocol); +float MSG_ReadAngle (sizebuf_t *sb, protocolversion_t protocol); +//@} //============================================================================ -extern char com_token[1024]; +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 +typedef int (*COM_LineProcessorFunc) (void *passthrough, const char *line, size_t length, float width, qbool isContination); +int COM_Wordwrap(const char *string, size_t length, float continuationSize, float maxWidth, COM_WordWidthFunc_t wordWidth, void *passthroughCW, COM_LineProcessorFunc processLine, void *passthroughPL); -int COM_ParseToken(const char **datapointer, int returnnewline); -int COM_ParseTokenConsole(const char **datapointer); +extern char com_token[MAX_INPUTLINE]; -extern int com_argc; -extern const char **com_argv; +int COM_ParseToken_Simple(const char **datapointer, qbool returnnewline, qbool parsebackslash, qbool parsecomments); +int COM_ParseToken_QuakeC(const char **datapointer, qbool returnnewline); +int COM_ParseToken_VM_Tokenize(const char **datapointer, qbool returnnewline); +int COM_ParseToken_Console(const char **datapointer); -int COM_CheckParm (const char *parm); void COM_Init (void); void COM_Shutdown (void); -void COM_InitArgv (void); -void COM_InitGameType (void); -char *va(const char *format, ...); -// does a varargs printf into a temp buffer +char *va(char *buf, size_t buflen, const char *format, ...) DP_FUNC_PRINTF(3); +// does a varargs printf into provided buffer, returns buffer (so it can be called in-line unlike dpsnprintf) +// GCC with -Werror=c++-compat will error out if static_assert is used even though the macro is valid C11... +#ifndef __cplusplus +#define DP_STATIC_ASSERT(expr, str) _Static_assert(expr, str) +#else +#define DP_STATIC_ASSERT(expr, str) static_assert(expr, str) +#endif // snprintf and vsnprintf are NOT portable. Use their DP counterparts instead -#define snprintf DO_NOT_USE_SNPRINTF__USE_DPSNPRINTF -#define vsnprintf DO_NOT_USE_VSNPRINTF__USE_DPVSNPRINTF +#ifdef snprintf +# undef snprintf +#endif +#define snprintf DP_STATIC_ASSERT(0, "snprintf is forbidden for portability reasons. Use dpsnprintf instead.") +#ifdef vsnprintf +# undef vsnprintf +#endif +#define vsnprintf DP_STATIC_ASSERT(0, "vsnprintf is forbidden for portability reasons. Use dpvsnprintf instead.") // dpsnprintf and dpvsnprintf // return the number of printed characters, excluding the final '\0' // or return -1 if the buffer isn't big enough to contain the entire string. // buffer is ALWAYS null-terminated -extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...); +extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...) DP_FUNC_PRINTF(3); extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args); +// A bunch of functions are forbidden for security reasons (and also to please MSVS 2005, for some of them) +// LadyHavoc: added #undef lines here to avoid warnings in Linux +#undef strcat +#define strcat DP_STATIC_ASSERT(0, "strcat is forbidden for security reasons. Use strlcat or memcpy instead.") +#undef strncat +#define strncat DP_STATIC_ASSERT(0, "strncat is forbidden for security reasons. Use strlcat or memcpy instead.") +#undef strcpy +#define strcpy DP_STATIC_ASSERT(0, "strcpy is forbidden for security reasons. Use strlcpy or memcpy instead.") +#undef strncpy +#define strncpy DP_STATIC_ASSERT(0, "strncpy is forbidden for security reasons. Use strlcpy or memcpy instead.") +#undef sprintf +#define sprintf DP_STATIC_ASSERT(0, "sprintf is forbidden for security reasons. Use dpsnprintf instead.") + //============================================================================ extern struct cvar_s registered; extern struct cvar_s cmdline; -typedef enum gamemode_e +typedef enum userdirmode_e { - GAME_NORMAL, - GAME_HIPNOTIC, - GAME_ROGUE, - GAME_NEHAHRA, - GAME_NEXUIZ, - GAME_TRANSFUSION, - GAME_GOODVSBAD2, - GAME_TEU, - GAME_BATTLEMECH, - GAME_ZYMOTIC, - GAME_FNIGGIUM, - GAME_SETHERAL, - GAME_SOM, - GAME_TENEBRAE, // full of evil hackery - GAME_NEOTERIC, - GAME_OPENQUARTZ, //this game sucks - GAME_PRYDON, - GAME_NETHERWORLD, - GAME_THEHUNTED, + USERDIRMODE_NOHOME, // basedir only + USERDIRMODE_HOME, // Windows basedir, general POSIX (~/.) + USERDIRMODE_MYGAMES, // pre-Vista (My Documents/My Games/), general POSIX (~/.) + USERDIRMODE_SAVEDGAMES, // Vista (%USERPROFILE%/Saved Games/), OSX (~/Library/Application Support/), Linux (~/.config) + USERDIRMODE_COUNT } -gamemode_t; - -extern gamemode_t gamemode; -extern const char *gamename; -extern const char *gamedirname1; -extern const char *gamedirname2; -extern const char *gamescreenshotname; -extern const char *gameuserdirname; -extern char com_modname[MAX_OSPATH]; +userdirmode_t; void COM_ToLowerString (const char *in, char *out, size_t size_out); void COM_ToUpperString (const char *in, char *out, size_t size_out); @@ -262,21 +276,10 @@ int COM_StringBeginsWith(const char *s, const char *match); int COM_ReadAndTokenizeLine(const char **text, char **argv, int maxargc, char *tokenbuf, int tokenbufsize, const char *commentprefix); -typedef struct stringlist_s -{ - struct stringlist_s *next; - char *text; -} stringlist_t; - -int matchpattern(char *in, char *pattern, int caseinsensitive); -stringlist_t *stringlistappend(stringlist_t *current, char *text); -void stringlistfree(stringlist_t *current); -stringlist_t *stringlistsort(stringlist_t *start); -stringlist_t *listdirectory(const char *path); -void freedirectory(stringlist_t *list); - -char *SearchInfostring(const char *infostring, const char *key); - +size_t COM_StringLengthNoColors(const char *s, size_t size_s, qbool *valid); +qbool COM_StringDecolorize(const char *in, size_t size_in, char *out, size_t size_out, qbool escape_carets); +void COM_ToLowerString (const char *in, char *out, size_t size_out); +void COM_ToUpperString (const char *in, char *out, size_t size_out); // strlcat and strlcpy, from OpenBSD // Most (all?) BSDs already have them @@ -286,25 +289,36 @@ char *SearchInfostring(const char *infostring, const char *key); #endif #ifndef HAVE_STRLCAT -/* - * Appends src to string dst of size siz (unlike strncat, siz is the - * full size of dst, not space left). At most siz-1 characters - * will be copied. Always NUL terminates (unless siz <= strlen(dst)). - * Returns strlen(src) + MIN(siz, strlen(initial dst)). - * If retval >= siz, truncation occurred. +/*! + * Appends src to string dst of size dsize (unlike strncat, dsize is the + * full size of dst, not space left). At most dsize-1 characters + * will be copied. Always NUL terminates (unless dsize <= strlen(dst)). + * Returns strlen(src) + MIN(dsize, strlen(initial dst)). + * If retval >= dsize, truncation occurred. */ -size_t strlcat(char *dst, const char *src, size_t siz); +size_t strlcat(char *dst, const char *src, size_t dsize); #endif // #ifndef HAVE_STRLCAT #ifndef HAVE_STRLCPY -/* - * Copy src to string dst of size siz. At most siz-1 characters - * will be copied. Always NUL terminates (unless siz == 0). - * Returns strlen(src); if retval >= siz, truncation occurred. +/*! + * Copy string src to buffer dst of size dsize. At most dsize-1 + * chars will be copied. Always NUL terminates (unless dsize == 0). + * Returns strlen(src); if retval >= dsize, truncation occurred. */ -size_t strlcpy(char *dst, const char *src, size_t siz); +size_t strlcpy(char *dst, const char *src, size_t dsize); #endif // #ifndef HAVE_STRLCPY +void FindFraction(double val, int *num, int *denom, int denomMax); + +// decodes XPM file to XPM array (as if #include'd) +char **XPM_DecodeString(const char *in); + +size_t base64_encode(unsigned char *buf, size_t buflen, size_t outbuflen); + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) + +float Com_CalcRoll (const vec3_t angles, const vec3_t velocity, const vec_t angleval, const vec_t velocityval); + #endif