X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=common.h;h=441d9ce9f221bf1322b51b3d25996206f6f8a42d;hp=f3516c5da03ce7d4241892f1bb40a71a9b096984;hb=00b6d96fd1220b1df82036c445389ae19a08709e;hpb=4bee24a5cf254a418660db56e4e67e105937565e diff --git a/common.h b/common.h index f3516c5d..441d9ce9 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 #ifdef WIN32 # define strcasecmp _stricmp # define strncasecmp _strnicmp +#else +#include "strings.h" #endif // Create our own define for Mac OS X @@ -33,19 +40,20 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # define MACOSX #endif -#ifdef SUNOS -#include ///< Needed for FNDELAY -#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 + 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); @@ -64,6 +72,8 @@ unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int se unsigned Com_BlockChecksum (void *buffer, int length); void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf); +void COM_Init_Commands(void); + //============================================================================ // Endianess handling @@ -121,6 +131,7 @@ void StoreLittleShort (unsigned char *buffer, unsigned short i); typedef enum protocolversion_e { PROTOCOL_UNKNOWN, + 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/ @@ -143,87 +154,86 @@ protocolversion_t; * @{ */ +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_WriteUnterminatedString (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_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); //@} //============================================================================ 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, qboolean isContination); +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); extern char com_token[MAX_INPUTLINE]; -int COM_ParseToken_Simple(const char **datapointer, qboolean returnnewline, qboolean parsebackslash); -int COM_ParseToken_QuakeC(const char **datapointer, qboolean returnnewline); -int COM_ParseToken_VM_Tokenize(const char **datapointer, qboolean returnnewline); +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); -extern int com_argc; -extern const char **com_argv; -extern int com_selffd; - -int COM_CheckParm (const char *parm); void COM_Init (void); void COM_Shutdown (void); void COM_InitGameType (void); -char *va(const char *format, ...) DP_FUNC_PRINTF(1); -// 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 #ifdef snprintf # undef snprintf #endif -#define snprintf DO_NOT_USE_SNPRINTF__USE_DPSNPRINTF +#define snprintf DP_STATIC_ASSERT(0, "snprintf is forbidden for portability reasons. Use dpsnprintf instead.") #ifdef vsnprintf # undef vsnprintf #endif -#define vsnprintf DO_NOT_USE_VSNPRINTF__USE_DPVSNPRINTF +#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' @@ -233,17 +243,17 @@ extern int dpsnprintf (char *buffer, size_t buffersize, const char *format, ...) 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) -// LordHavoc: added #undef lines here to avoid warnings in Linux +// LadyHavoc: added #undef lines here to avoid warnings in Linux #undef strcat -#define strcat DO_NOT_USE_STRCAT__USE_STRLCAT_OR_MEMCPY +#define strcat DP_STATIC_ASSERT(0, "strcat is forbidden for security reasons. Use strlcat or memcpy instead.") #undef strncat -#define strncat DO_NOT_USE_STRNCAT__USE_STRLCAT_OR_MEMCPY +#define strncat DP_STATIC_ASSERT(0, "strncat is forbidden for security reasons. Use strlcat or memcpy instead.") #undef strcpy -#define strcpy DO_NOT_USE_STRCPY__USE_STRLCPY_OR_MEMCPY +#define strcpy DP_STATIC_ASSERT(0, "strcpy is forbidden for security reasons. Use strlcpy or memcpy instead.") #undef strncpy -#define strncpy DO_NOT_USE_STRNCPY__USE_STRLCPY_OR_MEMCPY -//#undef sprintf -//#define sprintf DO_NOT_USE_SPRINTF__USE_DPSNPRINTF +#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.") //============================================================================ @@ -251,11 +261,22 @@ extern int dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_ extern struct cvar_s registered; extern struct cvar_s cmdline; +typedef enum userdirmode_e +{ + 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 +} +userdirmode_t; + typedef enum gamemode_e { GAME_NORMAL, GAME_HIPNOTIC, GAME_ROGUE, + GAME_QUOTH, GAME_NEHAHRA, GAME_NEXUIZ, GAME_XONOTIC, @@ -265,7 +286,6 @@ typedef enum gamemode_e GAME_BATTLEMECH, GAME_ZYMOTIC, GAME_SETHERAL, - GAME_SOM, GAME_TENEBRAE, // full of evil hackery GAME_NEOTERIC, GAME_OPENQUARTZ, //this game sucks @@ -279,53 +299,46 @@ typedef enum gamemode_e GAME_PROPHECY, GAME_BLOODOMNICIDE, GAME_STEELSTORM, // added by motorsep + GAME_STEELSTORM2, // added by motorsep + GAME_SSAMMO, // added by motorsep + GAME_STEELSTORMREVENANTS, // added by motorsep 07/19/2015 + GAME_TOMESOFMEPHISTOPHELES, // added by motorsep GAME_STRAPBOMB, // added by motorsep for Urre GAME_MOONHELM, + GAME_VORETOURNAMENT, + GAME_DOOMBRINGER, // added by Cloudwalk for kristus + GAME_BATTLEMETAL, // added by Cloudwalk for Subject9x GAME_COUNT } gamemode_t; +// Master switch for some hacks/changes that eventually should become cvars. +#define IS_NEXUIZ_DERIVED(g) ((g) == GAME_NEXUIZ || (g) == GAME_XONOTIC || (g) == GAME_VORETOURNAMENT) +// Pre-csqcmodels era. +#define IS_OLDNEXUIZ_DERIVED(g) ((g) == GAME_NEXUIZ || (g) == GAME_VORETOURNAMENT) + extern gamemode_t gamemode; extern const char *gamename; +extern const char *gamenetworkfiltername; extern const char *gamedirname1; extern const char *gamedirname2; extern const char *gamescreenshotname; extern const char *gameuserdirname; extern char com_modname[MAX_OSPATH]; +void COM_ChangeGameTypeForGameDirs(void); + void COM_ToLowerString (const char *in, char *out, size_t size_out); void COM_ToUpperString (const char *in, char *out, size_t size_out); 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); -size_t COM_StringLengthNoColors(const char *s, size_t size_s, qboolean *valid); -qboolean COM_StringDecolorize(const char *in, size_t size_in, char *out, size_t size_out, qboolean escape_carets); +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); -typedef struct stringlist_s -{ - /// maxstrings changes as needed, causing reallocation of strings[] array - int maxstrings; - int numstrings; - char **strings; -} stringlist_t; - -int matchpattern(const char *in, const char *pattern, int caseinsensitive); -int matchpattern_with_separator(const char *in, const char *pattern, int caseinsensitive, const char *separators, qboolean wildcard_least_one); -void stringlistinit(stringlist_t *list); -void stringlistfreecontents(stringlist_t *list); -void stringlistappend(stringlist_t *list, const char *text); -void stringlistsort(stringlist_t *list); -void listdirectory(stringlist_t *list, const char *basepath, const char *path); - -char *SearchInfostring(const char *infostring, const char *key); - -void InfoString_GetValue(const char *buffer, const char *key, char *value, size_t valuelength); -void InfoString_SetValue(char *buffer, size_t bufferlength, const char *key, const char *value); -void InfoString_Print(char *buffer); - // strlcat and strlcpy, from OpenBSD // Most (all?) BSDs already have them #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX) @@ -335,22 +348,22 @@ void InfoString_Print(char *buffer); #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 @@ -361,5 +374,9 @@ 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