]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - common.h
eliminated qbyte type, now uses unsigned char throughout the engine for this purpose
[xonotic/darkplaces.git] / common.h
index d9e93145b3054005c0b079affc23a0f5774389b4..3f6c0ddebe2825dcc9efe3856ca4521e75d1bf1b 100644 (file)
--- a/common.h
+++ b/common.h
@@ -21,14 +21,22 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifndef COMMON_H
 #define COMMON_H
 
+
 // MSVC has a different name for several standard functions
 #ifdef WIN32
-# define snprintf _snprintf
-# define vsnprintf _vsnprintf
 # define strcasecmp stricmp
 # define strncasecmp strnicmp
 #endif
 
+// Create our own define for Mac OS X
+#if defined(__APPLE__) && defined(__MACH__)
+# define MACOSX
+#endif
+
+#ifdef SUNOS
+#include <sys/file.h>          // Needed for FNDELAY
+# define model_t dp_model_t // Workaround conflict with /usr/include/sys/model.h
+#endif
 
 //============================================================================
 
@@ -36,21 +44,19 @@ 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;
+       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);
 
 
 //============================================================================
@@ -73,8 +79,16 @@ void Com_HexDumpToConsole(const qbyte *data, int size);
 # if defined(WIN32)
 #  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
 
@@ -101,24 +115,48 @@ 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);
+unsigned int BuffBigLong (const unsigned char *buffer);
+unsigned short BuffBigShort (const unsigned char *buffer);
+unsigned int BuffLittleLong (const unsigned char *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
+}
+protocolversion_t;
+
 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_WriteCoord (sizebuf_t *sb, float f);
-void MSG_WriteAngle (sizebuf_t *sb, float f);
-void MSG_WritePreciseAngle (sizebuf_t *sb, float f);
-void MSG_WriteDPCoord (sizebuf_t *sb, float f);
+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
@@ -139,12 +177,15 @@ int MSG_ReadBytes (int numbytes, unsigned char *out);
 #define MSG_ReadLong MSG_ReadLittleLong
 #define MSG_ReadFloat MSG_ReadLittleFloat
 
-float MSG_ReadCoord (void);
-
-#define MSG_ReadAngle() (MSG_ReadByte() * (360.0f / 256.0f))
-#define MSG_ReadPreciseAngle() (MSG_ReadShort() * (360.0f / 65536.0f))
-
-#define MSG_ReadVector(v) ((v)[0] = MSG_ReadCoord(), (v)[1] = MSG_ReadCoord(), (v)[2] = MSG_ReadCoord())
+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);
 
 //============================================================================
 
@@ -158,6 +199,7 @@ 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);
 
@@ -165,29 +207,54 @@ char      *va(const char *format, ...);
 // does a varargs printf into a temp buffer
 
 
+// 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
+
+// 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 dpvsnprintf (char *buffer, size_t buffersize, const char *format, va_list args);
+
+
 //============================================================================
 
 extern struct cvar_s   registered;
 extern struct cvar_s   cmdline;
 
-#define GAME_NORMAL 0
-#define GAME_HIPNOTIC 1
-#define GAME_ROGUE 2
-#define GAME_NEHAHRA 3
-#define GAME_NEXUIZ 4
-#define GAME_TRANSFUSION 5
-#define GAME_GOODVSBAD2 6
-#define GAME_TEU 7
-#define GAME_BATTLEMECH 8
-#define GAME_ZYMOTIC 9
-#define GAME_FNIGGIUM 10
-#define GAME_SETHERAL 11
-#define GAME_SOM 12
-#define GAME_TENEBRAE 13 // full of evil hackery
-
-extern int gamemode;
-extern char *gamename;
-extern char *gamedirname;
+typedef enum gamemode_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,
+       GAME_DEFEATINDETAIL2,
+}
+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];
 
 void COM_ToLowerString (const char *in, char *out, size_t size_out);
@@ -206,7 +273,7 @@ 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(char *path);
+stringlist_t *listdirectory(const char *path);
 void freedirectory(stringlist_t *list);
 
 char *SearchInfostring(const char *infostring, const char *key);
@@ -214,7 +281,7 @@ char *SearchInfostring(const char *infostring, const char *key);
 
 // strlcat and strlcpy, from OpenBSD
 // Most (all?) BSDs already have them
-#if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || (defined(__APPLE__) && defined(__MACH__))
+#if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX)
 # define HAVE_STRLCAT 1
 # define HAVE_STRLCPY 1
 #endif