]> git.pond.sub.org Git - empserver/blobdiff - include/nat.h
Move setting nat_cnam, nat_pnam into nat_reset()
[empserver] / include / nat.h
index 891715a68ab3d9fcd826b51e93f791d31cb2446d..21a6d0b2ebb90abaf6d63187503b5398517085d5 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2000, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2011, 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.
  *
  *  ---
  *
  *  nat.h: Definitions for things having to do with nations
- * 
+ *
  *  Known contributors to this file:
- *     Thomas Rushack
+ *     Thomas Ruschak
  *     Ken Stevens, 1995
  *     Steve McClure, 1998-2000
+ *     Ron Koenderink, 2005-2008
+ *     Markus Armbruster, 2005-2011
  */
 
-#ifndef _NAT_H_
-#define _NAT_H_
+#ifndef NAT_H
+#define NAT_H
+
+#include <time.h>
+#include "types.h"
 
-#include "mission.h"
-#include "sect.h"
+#define NATID_BAD 255
 
-#define        MAXNOR          50      /* max # realms */
+#define MAXNOR         50      /* max # realms */
 
-struct boundstr {
-    short b_xl, b_xh;          /* horizontal bounds */
-    short b_yl, b_yh;          /* vertical bounds */
+/* Nation status */
+enum nat_status {
+    /*
+     * Don't change order without checking inequality comparisons and
+     * array initializers!
+     */
+    STAT_UNUSED,               /* not in use */
+    STAT_NEW,                  /* just initialized */
+    STAT_VIS,                  /* visitor */
+    STAT_SANCT,                        /* still in sanctuary */
+    STAT_ACTIVE,               /* active (sanctuary broken) */
+    STAT_GOD                   /* deity powers */
+};
+
+
+/*
+ * TODO
+ *
+ * One of (r_cnum, r_realm) and r_uid is redundant, provided MAXNOR is known.
+ *
+ * The only user of r_cnum and r_realm appears to be xdump.
+ * If we had working virtual selectors, we could remove r_cnum and r_realm.
+ */
+struct realmstr {
+    /* initial part must match struct empobj */
+    signed ef_type: 8;
+    unsigned r_seqno: 12;
+    unsigned r_generation: 12;
+    int r_uid;                 /* realm table index */
+    time_t r_timestamp;                /* Last time this realm was touched */
+    natid r_cnum;              /* country number */
+    /* end of part matching struct empobj */
+    unsigned short r_realm;    /* realm number */
+    coord r_xl, r_xh;          /* horizontal bounds */
+    coord r_yl, r_yh;          /* vertical bounds */
 };
 
 struct natstr {
-    short ef_type;
-    s_char nat_cnam[20];       /* country name */
-    s_char nat_pnam[20];       /* representative */
-    s_char nat_hostaddr[32];   /* host addr of last user */
-    s_char nat_hostname[512];  /* hostname of last user */
-    s_char nat_userid[32];     /* userid of last user */
-    coord nat_xstart, nat_ystart;      /* cap location at start */
+    /* initial part must match struct empobj */
+    signed ef_type: 8;
+    unsigned nat_seqno: 12;
+    unsigned nat_generation: 12;
+    int nat_uid;               /* equals nat_cnum */
+    time_t nat_timestamp;
+    natid nat_cnum;            /* our country number */
+    /* end of part matching struct empobj */
+    enum nat_status nat_stat;
+    char nat_cnam[20];         /* country name */
+    char nat_pnam[20];         /* representative */
+    char nat_hostaddr[32];     /* host addr of last user */
+    char nat_hostname[512];    /* hostname of last user, may be empty */
+    char nat_userid[32];       /* userid of last user, may be empty */
     coord nat_xcap, nat_ycap;  /* cap location in abs coords */
     coord nat_xorg, nat_yorg;  /* origin location in abs coords */
-    natid nat_cnum;            /* our country number */
-    s_char nat_stat;           /* inuse, norm, god, abs */
-    s_char nat_dayno;          /* day of the year mod 128 */
-    s_char nat_connected;      /* connected or not? */
-    s_char nat_update;         /* Want an update or not. */
-    u_char nat_missed;         /* How many updates missed */
-    u_short nat_tgms;          /* # of telegrams to be announced */
-    u_short nat_ann;           /* # of annos pending */
-    u_short nat_minused;       /* number of minutes used today */
+    signed char nat_update;    /* Want an update or not. */
+    unsigned short nat_tgms;   /* # of telegrams to be announced */
+    unsigned short nat_ann;    /* # of annos pending */
+    int nat_timeused;          /* number of seconds used today */
     short nat_btu;             /* bureaucratic time units */
+    short nat_access;          /* The tick when BTUs were last updated */
     long nat_reserve;          /* military reserves */
     long nat_money;            /* moola */
-    time_t nat_last_login;     /* time of last login */
-    time_t nat_last_logout;    /* time of last logout */
+    time_t nat_last_login;     /* time of last login, 0 menas never */
+    time_t nat_last_logout;    /* time of last logout, 0 means never */
     time_t nat_newstim;                /* date news last read */
     time_t nat_annotim;                /* date annos last read */
     float nat_level[4];                /* technology, etc */
-    struct boundstr nat_b[MAXNOR];     /* realm bounds */
-    short nat_relate[MAXNOC];
-    short nat_contact[MAXNOC]; /* short for everyone */
-    short nat_rejects[(MAXNOC + 3) / 4];       /* four bits for each country */
-    s_char nat_priorities[SCT_MAXDEF + 8];     /* priority for each SCT_MAXDEF+8 */
+    unsigned char nat_relate[MAXNOC];
+    unsigned char nat_contact[MAXNOC];
+    unsigned char nat_rejects[MAXNOC];
     long nat_flags;            /* nation flags */
-    s_char nat_mission_trigger[MI_MAX];        /* not used -- relation to trig */
 };
 
-       /* Priorities */
-#define        PRI_SMAINT      SCT_MAXDEF+2
-#define PRI_PMAINT     SCT_MAXDEF+3
-#define PRI_LMAINT     SCT_MAXDEF+4
-#define PRI_SBUILD     SCT_MAXDEF+5
-#define PRI_PBUILD     SCT_MAXDEF+6
-#define PRI_LBUILD     SCT_MAXDEF+7
-
-       /* nation status types */
-#define STAT_INUSE     bit(0)  /* cnum in use */
-#define STAT_SANCT     bit(1)  /* country in sanctuary */
-#define STAT_NORM      bit(2)  /* normal country */
-#define STAT_GOD       bit(3)  /* deity powers */
-#define STAT_ABS       bit(4)  /* abs coords */
-#define STAT_NEW       bit(5)  /* just initialized */
-
-       /* Update fields. */
-#define        WUPD_WANT       bit(0)
-
-       /* nstat values */
-#define VIS            STAT_INUSE
-#define        NORM            (STAT_INUSE|STAT_NORM)
-#define        GOD             (STAT_INUSE|STAT_GOD)
-#define        SANCT           (STAT_INUSE|STAT_SANCT)
-#define        CAP             bit(6)
-#define        MONEY           bit(7)
-
        /* nation relation codes */
-#define        AT_WAR          0
-#define SITZKRIEG       1
-#define MOBILIZATION    2
-#define        HOSTILE         3
-#define        NEUTRAL         4
-#define FRIENDLY        5
-#define        ALLIED          6
+#define AT_WAR         0
+#define HOSTILE                1
+#define NEUTRAL                2
+#define FRIENDLY       3
+#define ALLIED         4
 
        /* nation reject codes */
-#define        REJ_TELE        bit(0)  /* dont allow telegrams to be sent */
-#define        REJ_TREA        bit(1)  /* dont allow treaties to be offered */
-#define        REJ_ANNO        bit(2)  /* don't receive announcements */
-#define        REJ_LOAN        bit(3)  /* don't allow loans to be offered */
-
-#define        NAT_TLEV        0
-#define        NAT_RLEV        1
-#define        NAT_ELEV        2
-#define        NAT_HLEV        3
-
-#define        NF_CHAR         1
-#define        NF_UCHAR        2
-#define        NF_SHORT        3
-#define        NF_LONG         4
-#define        NF_STRING       5
-#define        NF_FLOAT        6
-#define        NF_DOUBLE       7
-#define        NF_BOUND        8
-
-#define NF_NOTIFY      1
-#define NF_PRIVATE     2
-
-#define NF_NATID       NF_UCHAR
-#define NF_COORD       NF_SHORT
-
-#define FOUND_FLY      3       /* Number of updates contact lasts */
-#define FOUND_LOOK     5       /* These are only useful with the */
-#define FOUND_SPY      6       /* LOSE_CONTACT option (and HIDDEN) */
-#define FOUND_MAP      6
+#define REJ_TELE       bit(0)  /* dont allow telegrams to be sent */
+#define REJ_TREA       bit(1)  /* dont allow treaties to be offered */
+#define REJ_ANNO       bit(2)  /* don't receive announcements */
+#define REJ_LOAN       bit(3)  /* don't allow loans to be offered */
+
+#define NAT_TLEV       0
+#define NAT_RLEV       1
+#define NAT_ELEV       2
+#define NAT_HLEV       3
+
+/*
+ * Number of updates contact lasts for various ways of making contact.
+ * These are only useful with option LOSE_CONTACT option, which
+ * implies option HIDDEN.
+ */
+/* Planes spotting and being spotted */
+#define FOUND_FLY      3
+/* Lookout */
+#define FOUND_LOOK     5
+/* Spies and ground combat */
+#define FOUND_SPY      6
+/* Communication */
 #define FOUND_TELE     3
+/* Coastwatch and skywatch */
 #define FOUND_COAST    3
 
-struct fixnat {
-    s_char *name;
-    int type;
-    int index;
-    int notify;
-    int offset;
-};
+extern char *relates[];
 
 /* procedures relating to nation stuff */
 
-#define putnat(n) \
-       ef_write(EF_NATION, n->nat_cnum, (caddr_t)n)
-#define getnatp(n) \
-       (struct natstr *) ef_ptr(EF_NATION, (int)n)
+#define putnat(p) ef_write(EF_NATION, (p)->nat_cnum, (p))
+#define getnatp(n) ((struct natstr *)ef_ptr(EF_NATION, (n)))
+
+#define getrealm(r, n, p) ef_read(EF_REALM, ((r) + ((n) * MAXNOR)), (p))
+#define putrealm(p) ef_write(EF_REALM, (p)->r_uid, (p))
 
 extern double tfact(natid cn, double mult);
-extern double tfactfire(natid cn, double mult);
 extern double techfact(int level, double mult);
-extern double techfactfire(int level, double mult);
-extern double reltech(int level1, int level2, double mult);
-/* src/lib/subs/comsub.c */
-extern double multread(natid, natid);
-extern int commread(void);
-extern int commwrite(void);
-extern int commamt(natid, int, float *);
-extern void commset(natid, int, int);
-extern void multset(natid, float);
-extern void commprice(int, float *);
-
-extern s_char *cname(natid n);
-extern s_char *relatename(struct natstr *np, natid other);
-extern s_char *rejectname(struct natstr *np, natid other);
-extern s_char *natstate(struct natstr *np);
+
+extern char *cname(natid n);
+extern char *relatename(struct natstr *np, natid other);
+extern char *rejectname(struct natstr *np, natid other);
+extern char *natstate(struct natstr *np);
 extern int getrel(struct natstr *np, natid them);
+extern int relations_with(natid, natid);
 extern int getrejects(natid them, struct natstr *np);
 extern int getcontact(struct natstr *np, natid them);
 extern void putrel(struct natstr *np, natid them, int relate);
 extern void putreject(struct natstr *np, natid them, int how, int what);
 extern void putcontact(struct natstr *np, natid them, int contact);
 extern void agecontact(struct natstr *np);
-extern struct fixnat *natfield();
+extern int influx(struct natstr *np);
+extern struct natstr *nat_reset(struct natstr *, natid, char *, char *,
+                               enum nat_status);
+
+extern int check_nat_name(char *, natid);
+
+extern int grant_btus(struct natstr *, int);
 
-#define NF_INFORM      bit(0)  /* Inform me of telegrams right away */
-#define NF_FLASH       bit(1)  /* Allow other players to flash me (sicko :) */
-#define NF_BEEP        bit(2)  /* Make beeping sounds when appropriate */
+/* nation flags */
+#define NF_INFORM      bit(0)  /* Inform me of telegrams right away */
+#define NF_FLASH       bit(1)  /* Allow other players to flash me (sicko :) */
+#define NF_BEEP                bit(2)  /* Make beeping sounds when appropriate */
 #define NF_COASTWATCH  bit(3)  /* Turn auto-coastwatch on */
 #define NF_SONAR       bit(4)  /* Turn auto-sonar on */
-#define NF_TECHLISTS    bit(5) /* Sort lists by tech not type */
-#define NF_SACKED       bit(6) /* Capital was sacked, and hasn't been reset yet */
+#define NF_TECHLISTS   bit(5)  /* Sort lists by tech not type */
+#define NF_SACKED      bit(6)  /* Capital was sacked, and hasn't been reset yet */
 
-#endif /* _NAT_H_ */
+#endif