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

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program 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 2 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, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  nat.h: Definitions for things having to do with nations
  29  *
  30  *  Known contributors to this file:
  31  *     Thomas Ruschak
  32  *     Ken Stevens, 1995
  33  *     Steve McClure, 1998-2000
  34  */
  35
  36 #ifndef NAT_H
  37 #define NAT_H
  38
  39 #include "sect.h"
  40
  41 #define MAXNOR          50      /* max # realms */
  42
  43 /* Nation status */
  44 typedef enum {
  45     /*
  46      * Don't change order without checking inequality comparisons and
  47      * array initializers!
  48      */
  49     STAT_UNUSED,                /* not in use */
  50     STAT_NEW,                   /* just initialized */
  51     STAT_VIS,                   /* visitor */
  52     STAT_SANCT,                 /* still in sanctuary */
  53     STAT_ACTIVE,                /* active (sanctuary broken) */
  54     STAT_GOD                    /* deity powers */
  55 } nat_status;
  56
  57 enum {                          /* Priorities */
  58     /* sector types are also priorities */
  59     PRI_SMAINT = SCT_MAXDEF+1,  /* ship maintenance */
  60     PRI_PMAINT,                 /* plane maintenance */
  61     PRI_LMAINT,                 /* land unit maintenance */
  62     PRI_SBUILD,                 /* ship building */
  63     PRI_PBUILD,                 /* plane building */
  64     PRI_LBUILD,                 /* land building */
  65     PRI_MAX = PRI_LBUILD
  66 };
  67
  68
  69 /*
  70  * TODO
  71  *
  72  * One of (r_cnum, r_realm) and r_uid is redundant, provided MAXNOR is known.
  73  *
  74  * The only user of b_cnum and b_realm appears to be xdump.
  75  * If we had working virtual selectors, we could remove b_cnum and b_realm.
  76  *
  77  */
  78 struct realmstr {
  79     short ef_type;
  80     natid r_cnum;               /* country number */
  81     short r_uid;                /* realm table index */
  82     unsigned short r_realm;     /* realm number */
  83     short r_xl, r_xh;           /* horizontal bounds */
  84     short r_yl, r_yh;           /* vertical bounds */
  85     time_t r_timestamp; /* Last time this realm was touched */
  86 };
  87
  88 struct natstr {
  89     /* initial part must match struct genitem */
  90     short ef_type;
  91     natid nat_cnum;             /* our country number */
  92     /* end of part matching struct genitem */
  93     nat_status nat_stat;
  94     char nat_cnam[20];          /* country name */
  95     char nat_pnam[20];          /* representative */
  96     char nat_hostaddr[32];      /* host addr of last user */
  97     char nat_hostname[512];     /* hostname of last user, may be empty */
  98     char nat_userid[32];        /* userid of last user, may be empty */
  99     coord nat_xcap, nat_ycap;   /* cap location in abs coords */
 100     coord nat_xorg, nat_yorg;   /* origin location in abs coords */
 101     s_char nat_dayno;           /* day of the year mod 128 */
 102     s_char nat_update;          /* Want an update or not. */
 103     u_char nat_missed;          /* How many updates missed */
 104     u_short nat_tgms;           /* # of telegrams to be announced */
 105     u_short nat_ann;            /* # of annos pending */
 106     u_short nat_minused;        /* number of minutes used today */
 107     short nat_btu;              /* bureaucratic time units */
 108     long nat_reserve;           /* military reserves */
 109     long nat_money;             /* moola */
 110     time_t nat_last_login;      /* time of last login, 0 menas never */
 111     time_t nat_last_logout;     /* time of last logout, 0 means never */
 112     time_t nat_newstim;         /* date news last read */
 113     time_t nat_annotim;         /* date annos last read */
 114     float nat_level[4];         /* technology, etc */
 115     short nat_relate[MAXNOC];
 116     unsigned char nat_contact[MAXNOC];
 117     short nat_rejects[(MAXNOC + 3) / 4]; /* four bits for each country */
 118     s_char nat_priorities[PRI_MAX+1]; /* budget priority */
 119     long nat_flags;             /* nation flags */
 120     char nat_spare[15];
 121 };
 122
 123         /* Update fields. */
 124 #define WUPD_WANT       bit(0)
 125
 126         /* nstat values */
 127 #define VIS             bit(0)
 128 #define SANCT           (bit(1) | VIS)
 129 #define NORM            (bit(2) | VIS)
 130 #define GOD             (bit(3) | NORM | VIS)
 131 #define CAP             bit(6)
 132 #define MONEY           bit(7)
 133
 134         /* nation relation codes */
 135 #define AT_WAR          0
 136 #define SITZKRIEG       1
 137 #define MOBILIZATION    2
 138 #define HOSTILE         3
 139 #define NEUTRAL         4
 140 #define FRIENDLY        5
 141 #define ALLIED          6
 142
 143         /* nation reject codes */
 144 #define REJ_TELE        bit(0)  /* dont allow telegrams to be sent */
 145 #define REJ_TREA        bit(1)  /* dont allow treaties to be offered */
 146 #define REJ_ANNO        bit(2)  /* don't receive announcements */
 147 #define REJ_LOAN        bit(3)  /* don't allow loans to be offered */
 148
 149 #define NAT_TLEV        0
 150 #define NAT_RLEV        1
 151 #define NAT_ELEV        2
 152 #define NAT_HLEV        3
 153
 154 /*
 155  * Number of updates contact lasts for various ways of making contact.
 156  * These are only useful with option LOSE_CONTACT option, which
 157  * implies option HIDDEN.
 158  */
 159 /* Planes spotting and being spotted */
 160 #define FOUND_FLY       3
 161 /* Lookout */
 162 #define FOUND_LOOK      5
 163 /* Spies and ground combat */
 164 #define FOUND_SPY       6
 165 /* Communication */
 166 #define FOUND_TELE      3
 167 /* Coastwatch and skywatch */
 168 #define FOUND_COAST     3
 169
 170 extern char *relates[];
 171
 172 /* procedures relating to nation stuff */
 173
 174 #define putnat(n) \
 175         ef_write(EF_NATION, n->nat_cnum, n)
 176 #define getnatp(n) \
 177         (struct natstr *) ef_ptr(EF_NATION, (int)n)
 178
 179 #define putrealm(p) \
 180         ef_write(EF_REALM, (int)(p)->r_uid, p)
 181 #define getrealm(r, n, p) \
 182         ef_read(EF_REALM, (int)(r + (n * MAXNOR)), p)
 183
 184 extern double tfact(natid cn, double mult);
 185 extern double tfactfire(natid cn, double mult);
 186 extern double techfact(int level, double mult);
 187
 188 extern char *cname(natid n);
 189 extern char *relatename(struct natstr *np, natid other);
 190 extern char *rejectname(struct natstr *np, natid other);
 191 extern char *natstate(struct natstr *np);
 192 extern int getrel(struct natstr *np, natid them);
 193 extern int getrejects(natid them, struct natstr *np);
 194 extern int getcontact(struct natstr *np, natid them);
 195 extern void putrel(struct natstr *np, natid them, int relate);
 196 extern void putreject(struct natstr *np, natid them, int how, int what);
 197 extern void putcontact(struct natstr *np, natid them, int contact);
 198 extern void agecontact(struct natstr *np);
 199 extern int influx(struct natstr *np);
 200
 201 /* nation flags */
 202 #define NF_INFORM       bit(0)  /* Inform me of telegrams right away */
 203 #define NF_FLASH        bit(1)  /* Allow other players to flash me (sicko :) */
 204 #define NF_BEEP         bit(2)  /* Make beeping sounds when appropriate */
 205 #define NF_COASTWATCH   bit(3)  /* Turn auto-coastwatch on */
 206 #define NF_SONAR        bit(4)  /* Turn auto-sonar on */
 207 #define NF_TECHLISTS    bit(5)  /* Sort lists by tech not type */
 208 #define NF_SACKED       bit(6)  /* Capital was sacked, and hasn't been reset yet */
 209
 210 #endif