]> git.pond.sub.org Git - empserver/blobdiff - include/misc.h
Drop macros AGREE_FREE, AGREE_PROPOSED, AGREE_SIGNED
[empserver] / include / misc.h
index 7ae70273fee444f54d05d7749180ef5ef347176f..9f4771b3e27431b6c151a211a4d7897e7c02d50c 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2005, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2020, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                Ken Stevens, Steve McClure, Markus Armbruster
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  Empire is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *  ---
  *
- *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- *  related information and legal notices. It is expected that any future
- *  projects/authors will amend these files as needed.
+ *  See files README, COPYING and CREDITS in the root of the source
+ *  tree for related information and legal notices.  It is expected
+ *  that future projects/authors will amend these files as needed.
  *
  *  ---
  *
  *  misc.h: Misc. definitions which don't really belong anywhere,
  *          but have to go somewhere!
- * 
+ *
  *  Known contributors to this file:
- *       Doug Hay, 1998
+ *     Doug Hay, 1998
+ *     Markus Armbruster, 2004-2020
  */
 
 #ifndef MISC_H
 #define MISC_H
 
-#include <ctype.h>
-#include <string.h>
-#include <sys/types.h>
-
-#if defined(_WIN32)
-typedef unsigned char u_char;
-typedef unsigned short u_short;
-typedef unsigned int u_int;
-typedef long ssize_t;
-
-/* integral mismatch, due to misuse of sector short */
-#ifndef __GNUC__
-#pragma warning (disable : 4761 )
-#endif
-
-#include <windef.h>
-#include <io.h>
+#define MAX(a,b) ((a) > (b) ? (a) : (b))
+#define MIN(a,b) ((a) < (b) ? (a) : (b))
 
-#define random rand
-#define srandom srand
-
-#define strncasecmp(s1, s2, s3) _strnicmp(s1, s2, s3)
-#define mkdir(dir,perm) _mkdir(dir)
-/* used for access */
-#ifndef F_OK
-#define F_OK 0  /* FILE existence */
-#endif
-#ifndef W_OK
-#define W_OK 02 /* Write permission */
-#endif
-#ifndef R_OK
-#define R_OK 04 /* Read permission */
-#endif
+#define LIMIT_TO(val, min, max) \
+    ((val) < (min) ? (min) : (val) > (max) ? (max) : (val))
 
-typedef int pid_t;
-#define vsnprintf _vsnprintf
-
-/*#define _POSIX_ */
-#endif
-
-/* This is the structure we use to keep track of the global mobility
-   things, such as when the server is supposed to start/stop updating
-   mobility and the timestamp of when the game was last up.  These
-   times are in seconds. */
-struct mob_acc_globals {
-    time_t timestamp;          /* Last timestamp of when the game was up */
-    time_t starttime;          /* When we should start updating mobility again. */
-};
+#ifdef _WIN32
+#include "w32misc.h"
+#endif /* _WIN32 */
 
 #ifdef __GNUC__
 #define ATTRIBUTE(attrs) __attribute__ (attrs)
@@ -90,64 +51,61 @@ struct mob_acc_globals {
 #define ATTRIBUTE(attrs)
 #endif
 
-/* This uses a lot of thread stack with some versions of GNU libc,
-   which can lead to nasty heap smashes (observed with 2.2.93).
-   Disabled for now, until we readjust thread stack sizes.  */
-#if 0
-#define RESOLVE_IPADDRESS      /* resolve ip addresses into hostnames */
+#ifndef bit
+#define bit(x)         (1U<<(x))
 #endif
 
-typedef u_char natid;          /* NSC_NATID must match this */
+#define minutes(x)     (60*(x))
+#define hours(x)       (60*60*(x))
+#define days(x)                (60*60*24*(x))
 
 /*
- * TODO s_char has to go.  Use plain char for characters and strings,
- * signed char for small integers.
+ * If @expr is true, an internal error occured.
+ * Return @expr != 0.
+ * Usage: if (CANT_HAPPEN(...)) <recovery code>;
  */
-#ifdef __CHAR_UNSIGNED__
-typedef signed char s_char;
-#else
-typedef char s_char;
-#endif
+#define CANT_HAPPEN(expr) ((expr) ? oops(#expr, __FILE__, __LINE__), 1 : 0)
 
-typedef short coord;
+/*
+ * Report internal error.
+ * Usage: CANT_REACH(); <recovery code>;
+ */
+#define CANT_REACH() oops(NULL, __FILE__, __LINE__)
 
-#ifndef bit
-#define        bit(x)          (1<<(x))
-#endif
+extern void oops(char *, char *, int);
+extern void (*oops_handler)(void);
 
-#define minutes(x)     (60*(x))
-#define hours(x)       (60*60*(x))
-#define days(x)                (60*60*24*(x))
+/*
+ * Assert constant expression @cond, return 1.
+ * If @cond is zero, force a compilation error.
+ */
+#define BUILD_ASSERT_ONE(cond) \
+    (sizeof(char[1 - 2 * !(cond)]))
 
-extern int debug;
-extern int daemonize;
+/*
+ * Assert constant expression @cond.
+ * If @cond is zero, force a compilation error.
+ */
+#define BUILD_ASSERT(cond) \
+    ((void)BUILD_ASSERT_ONE(cond))
 
 /*
- * If EXPR is true, an internal error occured.
- * Return EXPR != 0.
- * Usage: if (CANT_HAPPEN(...)) recovery_code();
+ * Number of elements in ARRAY.
  */
-#define CANT_HAPPEN(expr) ((expr) ? oops(#expr, __FILE__, __LINE__) : 0)
-extern int oops(char *, char *, int);
+#define ARRAY_SIZE(array) (sizeof(array) / sizeof(array[0]))
 
-       /* return codes from command routines */
-#define        RET_OK          0       /* command completed sucessfully */
-#define        RET_FAIL        1       /* command completed unsucessfully [?] */
-#define        RET_SYN         2       /* syntax error in command */
-#define        RET_SYS         3       /* system error (missing file, etc) */
+void exit_nomem(void) ATTRIBUTE((noreturn));
 
-double dmax(double n1, double n2);
-double dmin(double n1, double n2);
+       /* return codes from command routines */
+#define RET_OK         0       /* command completed sucessfully */
+#define RET_FAIL       1       /* command completed unsucessfully [?] */
+#define RET_SYN                2       /* syntax error in command */
 
 extern char *getstarg(char *input, char *prompt, char buf[]);
 extern char *getstring(char *prompt, char buf[]);
 extern char *ugetstring(char *prompt, char buf[]);
-             
+
 extern char *prbuf(char *format, ...)
     ATTRIBUTE((format (printf, 1, 2)));
 
-#define AGREE_FREE     0
-#define AGREE_PROPOSED 1
-#define AGREE_SIGNED   2
-
 #endif