git.pond.sub.org Git - empserver/blob - include/misc.h

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                Ken Stevens, Steve McClure, Markus Armbruster
   5  *
   6  *  Empire is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  *  ---
  20  *
  21  *  See files README, COPYING and CREDITS in the root of the source
  22  *  tree for related information and legal notices.  It is expected
  23  *  that future projects/authors will amend these files as needed.
  24  *
  25  *  ---
  26  *
  27  *  misc.h: Misc. definitions which don't really belong anywhere,
  28  *          but have to go somewhere!
  29  *
  30  *  Known contributors to this file:
  31  *     Doug Hay, 1998
  32  *     Markus Armbruster, 2004-2014
  33  */
  34
  35 #ifndef MISC_H
  36 #define MISC_H
  37
  38 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  39 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  40
  41 #define LIMIT_TO(val, min, max) \
  42     ((val) < (min) ? (min) : (val) > (max) ? (max) : (val))
  43
  44 #ifdef _WIN32
  45 #include "w32misc.h"
  46 #endif /* _WIN32 */
  47
  48 #ifdef __GNUC__
  49 #define ATTRIBUTE(attrs) __attribute__ (attrs)
  50 #else
  51 #define ATTRIBUTE(attrs)
  52 #endif
  53
  54 #ifndef bit
  55 #define bit(x)          (1<<(x))
  56 #endif
  57
  58 #define minutes(x)      (60*(x))
  59 #define hours(x)        (60*60*(x))
  60 #define days(x)         (60*60*24*(x))
  61
  62 /*
  63  * If @expr is true, an internal error occured.
  64  * Return @expr != 0.
  65  * Usage: if (CANT_HAPPEN(...)) <recovery code>;
  66  */
  67 #define CANT_HAPPEN(expr) ((expr) ? oops(#expr, __FILE__, __LINE__), 1 : 0)
  68
  69 /*
  70  * Report internal error.
  71  * Usage: CANT_REACH(); <recovery code>;
  72  */
  73 #define CANT_REACH() oops(NULL, __FILE__, __LINE__)
  74
  75 extern void oops(char *, char *, int);
  76 extern void (*oops_handler)(void);
  77
  78 /*
  79  * Assert constant expression @cond, return 1.
  80  * If @cond is zero, force a compilation error.
  81  */
  82 #define BUILD_ASSERT_ONE(cond) \
  83     (sizeof(char[1 - 2 * !(cond)]))
  84
  85 /*
  86  * Assert constant expression @cond.
  87  * If @cond is zero, force a compilation error.
  88  */
  89 #define BUILD_ASSERT(cond) \
  90     ((void)BUILD_ASSERT_ONE(cond))
  91
  92 void exit_nomem(void) ATTRIBUTE((noreturn));
  93
  94         /* return codes from command routines */
  95 #define RET_OK          0       /* command completed sucessfully */
  96 #define RET_FAIL        1       /* command completed unsucessfully [?] */
  97 #define RET_SYN         2       /* syntax error in command */
  98
  99 extern char *getstarg(char *input, char *prompt, char buf[]);
 100 extern char *getstring(char *prompt, char buf[]);
 101 extern char *ugetstring(char *prompt, char buf[]);
 102
 103 extern char *prbuf(char *format, ...)
 104     ATTRIBUTE((format (printf, 1, 2)));
 105
 106 #define AGREE_FREE      0
 107 #define AGREE_PROPOSED  1
 108 #define AGREE_SIGNED    2
 109
 110 #endif