Drop macros AGREE_FREE, AGREE_PROPOSED, AGREE_SIGNED

[empserver] / include / misc.h

diff --git a/include/misc.h b/include/misc.h
index 32817f825fa9866d85fdd49a425c13a6c9c6aad4..9f4771b3e27431b6c151a211a4d7897e7c02d50c 100644 (file)
--- a/include/misc.h
+++ b/include/misc.h
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2010, 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,
@@ -14,8 +14,7 @@
  *  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/>.
  *
  *  ---
  *
@@ -29,7 +28,8 @@
  *          but have to go somewhere!
  *
  *  Known contributors to this file:
- *       Doug Hay, 1998
+ *     Doug Hay, 1998
+ *     Markus Armbruster, 2004-2020
  */
 
 #ifndef MISC_H
@@ -38,6 +38,9 @@
 #define MAX(a,b) ((a) > (b) ? (a) : (b))
 #define MIN(a,b) ((a) < (b) ? (a) : (b))
 
+#define LIMIT_TO(val, min, max) \
+    ((val) < (min) ? (min) : (val) > (max) ? (max) : (val))
+
 #ifdef _WIN32
 #include "w32misc.h"
 #endif /* _WIN32 */
@@ -48,17 +51,8 @@
 #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 */
-#endif
-
 #ifndef bit
-#define        bit(x)          (1<<(x))
+#define bit(x)         (1U<<(x))
 #endif
 
 #define minutes(x)     (60*(x))
@@ -66,27 +60,46 @@
 #define days(x)                (60*60*24*(x))
 
 /*
- * If EXPR is true, an internal error occured.
- * Return EXPR != 0.
+ * If @expr is true, an internal error occured.
+ * Return @expr != 0.
  * Usage: if (CANT_HAPPEN(...)) <recovery code>;
  */
-#define CANT_HAPPEN(expr) ((expr) ? oops(#expr, __FILE__, __LINE__) : 0)
+#define CANT_HAPPEN(expr) ((expr) ? oops(#expr, __FILE__, __LINE__), 1 : 0)
 
 /*
  * Report internal error.
  * Usage: CANT_REACH(); <recovery code>;
  */
-#define CANT_REACH() (void)oops(NULL, __FILE__, __LINE__)
+#define CANT_REACH() oops(NULL, __FILE__, __LINE__)
 
-extern int oops(char *, char *, int);
+extern void oops(char *, char *, int);
 extern void (*oops_handler)(void);
 
+/*
+ * Assert constant expression @cond, return 1.
+ * If @cond is zero, force a compilation error.
+ */
+#define BUILD_ASSERT_ONE(cond) \
+    (sizeof(char[1 - 2 * !(cond)]))
+
+/*
+ * Assert constant expression @cond.
+ * If @cond is zero, force a compilation error.
+ */
+#define BUILD_ASSERT(cond) \
+    ((void)BUILD_ASSERT_ONE(cond))
+
+/*
+ * Number of elements in ARRAY.
+ */
+#define ARRAY_SIZE(array) (sizeof(array) / sizeof(array[0]))
+
 void exit_nomem(void) ATTRIBUTE((noreturn));
 
        /* 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_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[]);
@@ -95,8 +108,4 @@ 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