X-Git-Url: http://de.git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=common.h;h=cc5029ea24b2ac2c470ae3e80699d8510887c3bd;hp=990ab6ded12a252b2197bc2838eeb6bb33bbba74;hb=980ac035e70ad26a44913dabebe4be5726f966ac;hpb=5ff9dbf2dc269135dd6cf59e93b50da73536f35b diff --git a/common.h b/common.h index 990ab6de..cc5029ea 100644 --- a/common.h +++ b/common.h @@ -21,11 +21,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #ifndef COMMON_H #define COMMON_H +/// many buffers use this size +#define MAX_INPUTLINE 16384 -// 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 #endif // Create our own define for Mac OS X @@ -33,30 +36,36 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # define MACOSX #endif +#ifdef SUNOS +#include ///< Needed for FNDELAY +#endif //============================================================================ typedef struct sizebuf_s { - qboolean allowoverflow; // if false, do a Sys_Error - qboolean overflowed; // set to true if the buffer size failed - qbyte *data; - mempool_t *mempool; + qboolean allowoverflow; ///< if false, do a Sys_Error + qboolean overflowed; ///< set to true if the buffer size failed + unsigned char *data; int maxsize; int cursize; } sizebuf_t; -void SZ_Alloc (sizebuf_t *buf, int startsize, const char *name); -void SZ_Free (sizebuf_t *buf); 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 short CRC_Block(qbyte *data, int size); +unsigned char COM_BlockSequenceCRCByteQW(unsigned char *base, int length, int sequence); + +// these are actually md4sum (mdfour.c) +unsigned Com_BlockChecksum (void *buffer, int length); +void Com_BlockFullChecksum (void *buffer, int len, unsigned char *outbuf); //============================================================================ @@ -75,18 +84,35 @@ unsigned short CRC_Block(qbyte *data, int size); #endif // If we still don't know the CPU endianess at this point, we try to guess +// normally including sys/types.h includes endian.h for the platform, which defines BYTE_ORDER, LITTLE_ENDIAN, and BIG_ENDIAN, however endian.h is a BSD-ism, and may not be present on all platforms (particularly windows) #ifndef BYTE_ORDER -# if defined(WIN32) +# if defined(WIN32) || defined (__i386) || defined(__amd64) # define BYTE_ORDER LITTLE_ENDIAN # else -# warning "Unable to determine the CPU endianess. Defaulting to little endian" -# define BYTE_ORDER LITTLE_ENDIAN +# 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 +/*! \name Byte order functions. + * @{ + */ +/// Swaps the byte order of the given short \p l. short ShortSwap (short l); + +/// Swaps the byte order of the given long \p l. int LongSwap (int l); + +/// Swaps the byte order of the given float \p f. float FloatSwap (float f); #if BYTE_ORDER == LITTLE_ENDIAN @@ -107,29 +133,64 @@ float FloatSwap (float f); #define LittleFloat(l) FloatSwap(l) #endif -unsigned int BuffBigLong (const qbyte *buffer); -unsigned short BuffBigShort (const qbyte *buffer); -unsigned int BuffLittleLong (const qbyte *buffer); -unsigned short BuffLittleShort (const qbyte *buffer); +/// Extract a big endian long from the given \p buffer. +unsigned int BuffBigLong (const unsigned char *buffer); + +/// Extract a big endian short from the given \p buffer. +unsigned short BuffBigShort (const unsigned char *buffer); +/// Extract a little endian long from the given \p buffer. +unsigned int BuffLittleLong (const unsigned char *buffer); + +/// Extract a little endian short from the given \p buffer. +unsigned short BuffLittleShort (const unsigned char *buffer); +//@} //============================================================================ +// these versions are purely for internal use, never sent in network protocol +// (use Protocol_EnumForNumber and Protocol_NumberToEnum to convert) +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_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_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_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, int protocol); -void MSG_WriteVector (sizebuf_t *sb, float *v, int protocol); -void MSG_WriteAngle (sizebuf_t *sb, float f, int protocol); +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 @@ -156,16 +217,22 @@ float MSG_ReadAngle32f (void); float MSG_ReadCoord13i (void); float MSG_ReadCoord16i (void); float MSG_ReadCoord32f (void); -float MSG_ReadCoord (int protocol); -void MSG_ReadVector (float *v, int protocol); -float MSG_ReadAngle (int protocol); - +float MSG_ReadCoord (protocolversion_t protocol); +void MSG_ReadVector (float *v, protocolversion_t protocol); +float MSG_ReadAngle (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, qboolean 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(const char **datapointer, int returnnewline); -int COM_ParseTokenConsole(const char **datapointer); +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_Console(const char **datapointer); extern int com_argc; extern const char **com_argv; @@ -173,10 +240,9 @@ extern const char **com_argv; 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, ...); +char *va(const char *format, ...) DP_FUNC_PRINTF(1); // does a varargs printf into a temp buffer @@ -188,9 +254,22 @@ char *va(const char *format, ...); // 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) +// LordHavoc: added #undef lines here to avoid warnings in Linux +#undef strcat +#define strcat DO_NOT_USE_STRCAT__USE_STRLCAT_OR_MEMCPY +#undef strncat +#define strncat DO_NOT_USE_STRNCAT__USE_STRLCAT_OR_MEMCPY +#undef strcpy +#define strcpy DO_NOT_USE_STRCPY__USE_STRLCPY_OR_MEMCPY +#undef strncpy +#define strncpy DO_NOT_USE_STRNCPY__USE_STRLCPY_OR_MEMCPY +//#undef sprintf +//#define sprintf DO_NOT_USE_SPRINTF__USE_DPSNPRINTF + //============================================================================ @@ -209,15 +288,22 @@ typedef enum gamemode_e 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_DELUXEQUAKE, GAME_THEHUNTED, + GAME_DEFEATINDETAIL2, + GAME_DARSANA, + GAME_CONTAGIONTHEORY, + GAME_EDU2P, + GAME_BLADEMASTER, + GAME_PROPHECY, + GAME_BLOODOMNICIDE, + GAME_COUNT } gamemode_t; @@ -235,21 +321,32 @@ 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); +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 { - struct stringlist_s *next; - char *text; + /// maxstrings changes as needed, causing reallocation of strings[] array + int maxstrings; + int numstrings; + char **strings; } 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); +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 @@ -259,7 +356,7 @@ 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)). @@ -270,7 +367,7 @@ size_t strlcat(char *dst, const char *src, size_t siz); #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. @@ -279,5 +376,7 @@ size_t strlcpy(char *dst, const char *src, size_t siz); #endif // #ifndef HAVE_STRLCPY +void FindFraction(double val, int *num, int *denom, int denomMax); + #endif