]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - common.h
made darkplaces compile successfully with g++ to test for errors C doesn't care about...
[xonotic/darkplaces.git] / common.h
index ad55254f6560dbfc2fe474c45209ad7637042c99..699c45987cf011e0d0b16c4f0c4c996e119c0c5d 100644 (file)
--- a/common.h
+++ b/common.h
@@ -8,7 +8,7 @@ of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
 See the GNU General Public License for more details.
 
@@ -17,22 +17,26 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 */
-// comndef.h  -- general definitions
 
-#if !defined BYTE_DEFINED
-typedef unsigned char          byte;
-#define BYTE_DEFINED 1
-#endif
+#ifndef COMMON_H
+#define COMMON_H
 
-#undef true
-#undef false
 
-typedef enum {false, true}     qboolean;
+// MSVC has a different name for several standard functions
+#ifdef WIN32
+# define strcasecmp stricmp
+# define strncasecmp strnicmp
+#endif
 
-//============================================================================
+// Create our own define for Mac OS X
+#if defined(__APPLE__) && defined(__MACH__)
+# define MACOSX
+#endif
 
-extern void *qmalloc(unsigned int size);
-extern void qfree(void *mem);
+#ifdef SUNOS
+#include <sys/file.h>          // Needed for FNDELAY
+# define model_t dp_model_t // Workaround conflict with /usr/include/sys/model.h
+#endif
 
 //============================================================================
 
@@ -40,59 +44,61 @@ typedef struct sizebuf_s
 {
        qboolean        allowoverflow;  // if false, do a Sys_Error
        qboolean        overflowed;             // set to true if the buffer size failed
-       byte    *data;
-       int             maxsize;
-       int             cursize;
+       qbyte           *data;
+       int                     maxsize;
+       int                     cursize;
 } sizebuf_t;
 
-void SZ_Alloc (sizebuf_t *buf, int startsize);
-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, void *data, int length);
-void SZ_Print (sizebuf_t *buf, char *data);    // strcats onto the sizebuf
+qbyte *SZ_GetSpace (sizebuf_t *buf, int length);
+void SZ_Write (sizebuf_t *buf, const qbyte *data, int length);
+void SZ_HexDumpToConsole(const sizebuf_t *buf);
 
-//============================================================================
-
-typedef struct link_s
-{
-       struct link_s   *prev, *next;
-} link_t;
+void Com_HexDumpToConsole(const qbyte *data, int size);
 
+unsigned short CRC_Block(const qbyte *data, size_t size);
 
-void ClearLink (link_t *l);
-void RemoveLink (link_t *l);
-void InsertLinkBefore (link_t *l, link_t *before);
-void InsertLinkAfter (link_t *l, link_t *after);
-
-// (type *)STRUCT_FROM_LINK(link_t *link, type, member)
-// ent = STRUCT_FROM_LINK(link,entity_t,order)
-// FIXME: remove this mess!
-#define        STRUCT_FROM_LINK(l,t,m) ((t *)((byte *)l - (int)&(((t *)0)->m)))
 
+//============================================================================
+//                                                     Endianess handling
 //============================================================================
 
-#ifndef NULL
-#define NULL ((void *)0)
+// We use BSD-style defines: BYTE_ORDER is defined to either BIG_ENDIAN or LITTLE_ENDIAN
+
+// 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
 
-#define Q_MAXCHAR ((char)0x7f)
-#define Q_MAXSHORT ((short)0x7fff)
-#define Q_MAXINT       ((int)0x7fffffff)
-#define Q_MAXLONG ((int)0x7fffffff)
-#define Q_MAXFLOAT ((int)0x7fffffff)
+// 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
 
-#define Q_MINCHAR ((char)0x80)
-#define Q_MINSHORT ((short)0x8000)
-#define Q_MININT       ((int)0x80000000)
-#define Q_MINLONG ((int)0x80000000)
-#define Q_MINFLOAT ((int)0x7fffffff)
 
-//============================================================================
-#ifdef WIN32
-short   ShortSwap (short l);
-int    LongSwap (int l);
+short ShortSwap (short l);
+int LongSwap (int l);
 float FloatSwap (float f);
+
+#if BYTE_ORDER == LITTLE_ENDIAN
+// little endian
 #define BigShort(l) ShortSwap(l)
 #define LittleShort(l) (l)
 #define BigLong(l) LongSwap(l)
@@ -100,115 +106,206 @@ float FloatSwap (float f);
 #define BigFloat(l) FloatSwap(l)
 #define LittleFloat(l) (l)
 #else
-extern short   (*BigShort) (short l);
-extern short   (*LittleShort) (short l);
-extern int     (*BigLong) (int l);
-extern int     (*LittleLong) (int l);
-extern float   (*BigFloat) (float l);
-extern float   (*LittleFloat) (float l);
+// 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
 
+unsigned int BuffBigLong (const qbyte *buffer);
+unsigned short BuffBigShort (const qbyte *buffer);
+unsigned int BuffLittleLong (const qbyte *buffer);
+unsigned short BuffLittleShort (const qbyte *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, 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_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_ReadChar (void);
-//int MSG_ReadByte (void);
-int MSG_ReadShort (void);
-int MSG_ReadLong (void);
-float MSG_ReadFloat (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++])
-//#define MSG_ReadShort() ((msg_readcount + 2) > net_message.cursize ? (msg_badread = true, -1) : (short)net_message.data[msg_readcount+=2, msg_readcount-2] | (net_message.data[msg_readcount-1] << 8))
-//#define MSG_ReadLong() ((msg_readcount + 4) > net_message.cursize ? (msg_badread = true, -1) : (int)net_message.data[msg_readcount+=4, msg_readcount-4] | (net_message.data[msg_readcount-3] << 8) | (net_message.data[msg_readcount-2] << 16) | (net_message.data[msg_readcount-1] << 24))
-
-float MSG_ReadCoord (void);
-//float MSG_ReadAngle (void);
-
-#define MSG_ReadAngle() (MSG_ReadByte() * (360.0f / 256.0f))
-#define MSG_ReadPreciseAngle() (MSG_ReadShort() * (360.0f / 65536.0f))
-
-extern qboolean dpprotocol;
+#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);
 
 //============================================================================
 
-/*
-void Q_memset (void *dest, int fill, int count);
-void Q_memcpy (void *dest, void *src, int count);
-int Q_memcmp (void *m1, void *m2, int count);
-void Q_strcpy (char *dest, char *src);
-void Q_strncpy (char *dest, char *src, int count);
-int Q_strlen (char *str);
-char *Q_strrchr (char *s, char c);
-void Q_strcat (char *dest, char *src);
-int Q_strcmp (char *s1, char *s2);
-int Q_strncmp (char *s1, char *s2, int count);
-*/
-int Q_strcasecmp (char *s1, char *s2);
-int Q_strncasecmp (char *s1, char *s2, int n);
-/*
-int    Q_atoi (char *str);
-float Q_atof (char *str);
-*/
-
-//============================================================================
+extern char com_token[1024];
 
-extern char            com_token[1024];
-extern qboolean        com_eof;
+int COM_ParseToken(const char **datapointer, int returnnewline);
+int COM_ParseTokenConsole(const char **datapointer);
 
-char *COM_Parse (char *data);
+extern int com_argc;
+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);
 
-extern int             com_argc;
-extern char    **com_argv;
+char   *va(const char *format, ...);
+// does a varargs printf into a temp buffer
 
-int COM_CheckParm (char *parm);
-void COM_Init (char *path);
-void COM_InitArgv (int argc, char **argv);
 
-char *COM_SkipPath (char *pathname);
-void COM_StripExtension (char *in, char *out);
-void COM_FileBase (char *in, char *out);
-void COM_DefaultExtension (char *path, char *extension);
+// 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
 
-char   *va(char *format, ...);
-// does a varargs printf into a temp buffer
+// 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 int com_filesize;
-struct cache_user_s;
+extern struct cvar_s   registered;
+extern struct cvar_s   cmdline;
 
-extern char    com_gamedir[MAX_OSPATH];
+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);
+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);
+
+typedef struct stringlist_s
+{
+       struct stringlist_s *next;
+       char *text;
+} stringlist_t;
 
-void COM_WriteFile (char *filename, void *data, int len);
-int COM_OpenFile (char *filename, int *hndl, qboolean quiet);
-int COM_FOpenFile (char *filename, FILE **file, qboolean quiet);
-void COM_CloseFile (int h);
+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);
 
-byte *COM_LoadHunkFile (char *path, qboolean quiet);
-byte *COM_LoadMallocFile (char *path, qboolean quiet);
-void COM_LoadCacheFile (char *path, struct cache_user_s *cu, qboolean quiet);
+char *SearchInfostring(const char *infostring, const char *key);
 
-byte *COM_LoadFile (char *path, int usehunk, qboolean quiet);
 
-int COM_FileExists(char *filename);
+// strlcat and strlcpy, from OpenBSD
+// Most (all?) BSDs already have them
+#if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(MACOSX)
+# define HAVE_STRLCAT 1
+# define HAVE_STRLCPY 1
+#endif
 
-extern struct cvar_s   registered;
+#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.
+ */
+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.
+ */
+size_t strlcpy(char *dst, const char *src, size_t siz);
+
+#endif  // #ifndef HAVE_STRLCPY
+
+#endif
 
-extern qboolean                standard_quake, rogue, hipnotic, nehahra;