]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/filetable.c
Update copyright notice
[empserver] / src / lib / common / filetable.c
index 100c3f4700d4daea20d1b5ca0f3c54b9a93e3251..fd9fd39e423449bde15d47c78079e36222444c2c 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2009, 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/>.
  *
  *  ---
  *
  *  filetable.c: Empire game data file descriptions.
  *
  *  Known contributors to this file:
- *     Markus Armbruster, 2005-2008
+ *     Markus Armbruster, 2005-2016
  */
 
 #include <config.h>
 
+#include <assert.h>
 #include <stddef.h>
+#include <string.h>
 #include "commodity.h"
-#include "file.h"
 #include "game.h"
 #include "land.h"
 #include "loan.h"
 #include "ship.h"
 #include "server.h"
 #include "trade.h"
-#include "treaty.h"
-#include "version.h"
 #include "xy.h"
 
-/* Number of elements in ARRAY.  */
+static void sct_oninit(void *);
+static void pln_oninit(void *);
+static void lnd_oninit(void *);
+static void nuk_oninit(void *);
+static void nat_oninit(void *);
+static void contact_oninit(void *);
+static void realm_oninit(void *);
+static void game_oninit(void *);
+static void pchr_oninit(void *);
+static void mchr_oninit(void *);
+static void plchr_oninit(void *);
+static void lchr_oninit(void *);
+static void nchr_oninit(void *);
+
+static char dummy_cache;
+
+/* Number of elements in ARRAY. */
 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
 
 /* Initializers for members flags... */
 /* Unmapped cache */
-#define UNMAPPED_CACHE(type, flags) \
-    sizeof(type), (flags), NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL
+#define UNMAPPED_CACHE(type, nent, flags)      \
+    sizeof(type), (nent), (flags), NULL,       \
+    0, 0, 0, 0, -1
 /*
  * Mapped cache, array with known size.
- * Members cids, fids are not set.
+ * Members cids, fids are zero, i.e. cache is empty.
  */
 #define ARRAY_CACHE(array, flags) \
-    sizeof(*(array)), (flags), (char *)(array), \
-    SZ((array)), 0, 0, 0, -1, NULL, NULL, NULL, NULL
+    sizeof(*(array)), -1, (flags), (char *)(array),    \
+    SZ((array)), 0, 0, 0, -1
 /*
  * Mapped cache, array with unknown size.
- * Members csize, cids, fids are not set.
+ * Member csize gets a bogus value, needs to be fixed up.
+ * Members cids, fids are zero, i.e. cache is empty.
  */
 #define PTR_CACHE(ptr, flags) \
-    sizeof(*(ptr)), (flags), (char *)(ptr), \
-    0, 0, 0, 0, -1, NULL, NULL, NULL, NULL
+    sizeof(*(ptr)), -1, (flags), (char *)(ptr),        \
+    0, 0, 0, 0, -1
 /*
- * Array-backed table.
- * The array's last element is the sentinel.
+ * Array-backed table of fixed size.
  */
-#define ARRAY_TABLE(array, flags)                              \
-    sizeof(*(array)), (flags), (char *)(array),                        \
-    SZ((array)), 0, SZ((array)) - 1, SZ((array)) - 1, -1,      \
-    NULL, NULL, NULL, NULL
+#define ARRAY_TABLE(array, nent, flags)                        \
+    sizeof(*(array)), (nent), (flags), (char *)(array),        \
+    SZ((array)), 0, (nent), (nent), -1
 
 /* Common configuration table flags */
 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
@@ -116,46 +130,70 @@ struct empfile empfile[] = {
     /*
      * Dynamic game data
      *
-     * All caches unmapped.  EF_MAP and EF_BMAP get a bogus size here.
-     * Fixed up by empfile_fixup().
+     * All caches unmapped.  EF_SECTOR gets bogus nent here.  EF_MAP
+     * and EF_BMAP get a bogus size here.  Fixed up by
+     * empfile_fixup().
      */
-    {EF_SECTOR, "sect", "sector", sect_ca,
-     UNMAPPED_CACHE(struct sctstr, EFF_TYPED | EFF_XY | EFF_OWNER)},
-    {EF_SHIP, "ship", "ship", ship_ca,
-     UNMAPPED_CACHE(struct shpstr,
-                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
-    {EF_PLANE, "plane", "plane", plane_ca,
-     UNMAPPED_CACHE(struct plnstr,
-                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
-    {EF_LAND, "land", "land", land_ca,
-     UNMAPPED_CACHE(struct lndstr,
-                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
-    {EF_NUKE, "nuke", "nuke", nuke_ca,
-     UNMAPPED_CACHE(struct nukstr, EFF_TYPED | EFF_XY | EFF_OWNER)},
-    {EF_NEWS, "news", "news", news_ca,
-     UNMAPPED_CACHE(struct nwsstr, EFF_TYPED)},
-    {EF_TREATY, "treaty", "treaty", treaty_ca,
-     UNMAPPED_CACHE(struct trtstr, EFF_TYPED)},
-    {EF_TRADE, "trade", "trade", trade_ca,
-     UNMAPPED_CACHE(struct trdstr, EFF_TYPED | EFF_OWNER)},
-    {EF_POWER, "pow", "power", NULL,
-     UNMAPPED_CACHE(struct powstr, 0)},
-    {EF_NATION, "nat", "nation", nat_ca,
-     UNMAPPED_CACHE(struct natstr, EFF_TYPED | EFF_OWNER)},
-    {EF_LOAN, "loan", "loan", loan_ca,
-     UNMAPPED_CACHE(struct lonstr, EFF_TYPED)},
-    {EF_MAP, "map", "map", NULL,
-     0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
-    {EF_BMAP, "bmap", "bmap", NULL,
-     0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
-    {EF_COMM, "commodity", "commodity", commodity_ca,
-     UNMAPPED_CACHE(struct comstr, EFF_TYPED | EFF_OWNER)},
-    {EF_LOST, "lost", "lostitems", lost_ca,
-     UNMAPPED_CACHE(struct loststr, EFF_TYPED | EFF_OWNER)},
-    {EF_REALM, "realm", "realms", realm_ca,
-     UNMAPPED_CACHE(struct realmstr, EFF_TYPED | EFF_OWNER)},
-    {EF_GAME, "game", "game", game_ca,
-     UNMAPPED_CACHE(struct gamestr, EFF_TYPED)},
+    {EF_SECTOR, "sect", "sector", "sector", sect_ca, EF_BAD,
+     UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
+     sct_oninit, NULL, NULL, NULL},
+    {EF_SHIP, "ship", NULL, "ship", ship_ca, EF_BAD,
+     UNMAPPED_CACHE(struct shpstr, -1,
+                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
+     NULL, NULL, NULL, NULL},
+    {EF_PLANE, "plane", NULL, "plane", plane_ca, EF_BAD,
+     UNMAPPED_CACHE(struct plnstr, -1,
+                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
+     pln_oninit, NULL, NULL, NULL},
+    {EF_LAND, "land", "land unit", "land", land_ca, EF_BAD,
+     UNMAPPED_CACHE(struct lndstr, -1,
+                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
+     lnd_oninit, NULL, NULL, NULL},
+    {EF_NUKE, "nuke", NULL, "nuke", nuke_ca, EF_BAD,
+     UNMAPPED_CACHE(struct nukstr, -1,
+                   EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
+     nuk_oninit, NULL, NULL, NULL},
+    {EF_NEWS, "news", NULL, "news", news_ca, EF_BAD,
+     UNMAPPED_CACHE(struct nwsstr, -1, 0),
+     NULL, NULL, NULL, NULL},
+    {EF_TRADE, "trade", "trade lot", "trade", trade_ca, EF_BAD,
+     UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
+     NULL, NULL, NULL, NULL},
+    {EF_POWER, "pow", NULL, "power", NULL, EF_BAD,
+     UNMAPPED_CACHE(struct powstr, -1, 0),
+     NULL, NULL, NULL, NULL},
+    {EF_NATION, "nat", "nation", "nation", nat_ca, EF_BAD,
+     UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
+     nat_oninit, NULL, NULL, NULL},
+    {EF_RELAT, "relat", NULL, "relat", relat_ca, EF_BAD,
+     UNMAPPED_CACHE(struct relatstr, MAXNOC, EFF_TYPED),
+     NULL, NULL, NULL, NULL},
+    {EF_CONTACT, "contact", NULL, "contact", contact_ca, EF_BAD,
+     UNMAPPED_CACHE(struct contactstr, MAXNOC, EFF_TYPED),
+     contact_oninit, NULL, NULL, NULL},
+    {EF_REJECT, "reject", NULL, "reject", reject_ca, EF_BAD,
+     UNMAPPED_CACHE(struct rejectstr, MAXNOC, EFF_TYPED),
+     NULL, NULL, NULL, NULL},
+    {EF_LOAN, "loan", NULL, "loan", loan_ca, EF_BAD,
+     UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED),
+     NULL, NULL, NULL, NULL},
+    {EF_MAP, "map", NULL, "map", NULL, EF_BAD,
+     0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
+    {EF_BMAP, "bmap", NULL, "bmap", NULL, EF_BAD,
+     0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
+    {EF_COMM, "commodity", NULL, "commodity", commodity_ca, EF_BAD,
+     UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER),
+     NULL, NULL, NULL, NULL},
+    {EF_LOST, "lost", "lost item", "lostitems", lost_ca, EF_BAD,
+     UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER),
+     NULL, NULL, NULL, NULL},
+    {EF_REALM, "realm", NULL, "realms", realm_ca, EF_BAD,
+     UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
+                   EFF_TYPED | EFF_OWNER),
+     realm_oninit, NULL, NULL, NULL},
+    {EF_GAME, "game", NULL, "game", game_ca, EF_BAD,
+     UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED),
+     game_oninit, NULL, NULL, NULL},
 
     /*
      * Static game data (configuration)
@@ -165,41 +203,45 @@ struct empfile empfile[] = {
      * member are compiled in.  The others are empty; use
      * read_builtin_tables() to fill them.
      */
-    {EF_ITEM, "item", "item.config", ichr_ca,
-     ARRAY_CACHE(ichr, EFF_CFG)},
-    {EF_PRODUCT, "product", "product.config", pchr_ca,
-     ARRAY_CACHE(pchr, EFF_CFG)},
-    {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca,
-     ARRAY_CACHE(dchr, EFF_CFG)},
-    {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca,
-     ARRAY_CACHE(mchr, EFF_CFG)},
-    {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca,
-     ARRAY_CACHE(plchr, EFF_CFG)},
-    {EF_LAND_CHR, "land-chr", "land.config", lchr_ca,
-     ARRAY_CACHE(lchr, EFF_CFG)},
-    {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca,
-     ARRAY_CACHE(nchr, EFF_CFG)},
-    {EF_NEWS_CHR, "news-chr", NULL, rpt_ca,
-     ARRAY_TABLE(rpt, EFF_CFG)},
-    {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca,
-     ARRAY_CACHE(intrchr, EFF_CFG)},
+    {EF_ITEM, "item", NULL, "item.config", ichr_ca, EF_BAD,
+     ARRAY_CACHE(ichr, EFF_CFG), NULL, NULL, NULL, NULL},
+    {EF_PRODUCT, "product", NULL, "product.config", pchr_ca, EF_BAD,
+     ARRAY_CACHE(pchr, EFF_CFG), pchr_oninit, NULL, NULL, NULL},
+    {EF_SECTOR_CHR, "sect-chr", NULL, "sect.config", dchr_ca, EF_BAD,
+     ARRAY_CACHE(dchr, EFF_CFG), NULL, NULL, NULL, NULL},
+    {EF_SHIP_CHR, "ship-chr", NULL, "ship.config", mchr_ca, EF_BAD,
+     ARRAY_CACHE(mchr, EFF_CFG), mchr_oninit, NULL, NULL, NULL},
+    {EF_PLANE_CHR, "plane-chr", NULL, "plane.config", plchr_ca, EF_BAD,
+     ARRAY_CACHE(plchr, EFF_CFG), plchr_oninit, NULL, NULL, NULL},
+    {EF_LAND_CHR, "land-chr", NULL, "land.config", lchr_ca, EF_BAD,
+     ARRAY_CACHE(lchr, EFF_CFG), lchr_oninit, NULL, NULL, NULL},
+    {EF_NUKE_CHR, "nuke-chr", NULL, "nuke.config", nchr_ca, EF_BAD,
+     ARRAY_CACHE(nchr, EFF_CFG), nchr_oninit, NULL, NULL, NULL},
+    {EF_NEWS_CHR, "news-chr", NULL, NULL, rpt_ca, EF_BAD,
+     ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG), NULL, NULL, NULL, NULL},
+    {EF_INFRASTRUCTURE, "infrastructure", NULL, "infra.config",
+     intrchr_ca, EF_BAD,
+     ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
     /*
      * Update schedule table.  Use read_schedule() to fill.
      */
-    {EF_UPDATES, "updates", NULL, update_ca,
-     ARRAY_TABLE(update_time, EFF_CFG)},
+    {EF_UPDATES, "updates", NULL, NULL, update_ca, EF_BAD,
+     ARRAY_CACHE(update_time, EFF_CFG),
+     NULL, NULL, NULL, NULL},
     /*
      * Special tables.  EF_META gets bogus size, cids and fids here.
      * Fixed up by empfile_init().  EF_VERSION's cadef is set by
      * nsc_init().
      */
-    {EF_TABLE, "table", NULL, empfile_ca,
-     ARRAY_TABLE(empfile, EFF_CFG)},
-    {EF_VERSION, "version", NULL, NULL,
-     sizeof(PACKAGE_STRING), EFF_STATIC, version, 1, 0, 1, 1, -1,
+    {EF_TABLE, "table", NULL, NULL, empfile_ca, EF_BAD,
+     ARRAY_TABLE(empfile, EF_MAX, EFF_CFG),
+     NULL, NULL, NULL, NULL},
+    {EF_VERSION, "version", NULL, NULL, NULL, EF_BAD,
+     0, -1, EFF_MEM | EFF_STATIC, &dummy_cache, 1, 0, 1, 1, -1,
+     NULL, NULL, NULL, NULL},
+    {EF_META, "meta", NULL, NULL, mdchr_ca, EF_BAD,
+     PTR_CACHE(mdchr_ca, EFF_CFG),
      NULL, NULL, NULL, NULL},
-    {EF_META, "meta", NULL, mdchr_ca,
-     PTR_CACHE(mdchr_ca, EFF_CFG)},
 
     /*
      * Symbol tables
@@ -207,8 +249,10 @@ struct empfile empfile[] = {
      * These get bogus csize, cids and fids here.  Fixed up by
      * empfile_init().
      */
-#define SYMTAB(type, name, tab) \
-       {(type), (name), NULL, symbol_ca, PTR_CACHE((tab), EFF_CFG)}
+#define SYMTAB(type, name, tab)                                \
+    {(type), (name), NULL, NULL, symbol_ca, EF_BAD,    \
+     PTR_CACHE((tab), EFF_CFG), NULL, NULL, NULL, NULL}
+
     SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
     SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
     SYMTAB(EF_LEVEL, "level", level),
@@ -228,22 +272,124 @@ struct empfile empfile[] = {
     SYMTAB(EF_RESOURCES, "resources", resources),
     SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
     SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
+    SYMTAB(EF_SECTOR_CHR_FLAGS, "sect-chr-flags", sect_chr_flags),
     SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
-    SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
 
     /* Views */
-    {EF_COUNTRY, "country", NULL, cou_ca,
-     UNMAPPED_CACHE(struct natstr, EFF_TYPED | EFF_OWNER)},
+    {EF_COUNTRY, "country", NULL, NULL, cou_ca, EF_NATION,
+     UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
+     NULL, NULL, NULL, NULL},
 
     /* Sentinel */
-    {EF_BAD, NULL, NULL, NULL,
-     0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
+    {EF_BAD, NULL, NULL, NULL, NULL, EF_BAD,
+     0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 };
 
+static void
+sct_oninit(void *ptr)
+{
+    struct sctstr *sp = (struct sctstr *)ptr;
+
+    sctoff2xy(&sp->sct_x, &sp->sct_y, sp->sct_uid);
+    sp->sct_dist_x = sp->sct_x;
+    sp->sct_dist_y = sp->sct_y;
+    sp->sct_newtype = sp->sct_type = SCT_WATER;
+    sp->sct_work = 100;
+    sp->sct_coastal = 1;
+}
+
+static void
+pln_oninit(void *ptr)
+{
+    struct plnstr *pp = ptr;
+
+    pp->pln_ship = pp->pln_land = -1;
+}
+
+static void
+lnd_oninit(void *ptr)
+{
+    struct lndstr *lp = ptr;
+
+    lp->lnd_ship = lp->lnd_land = -1;
+}
+
+static void
+nuk_oninit(void *ptr)
+{
+    struct nukstr *np = ptr;
+
+    np->nuk_plane = -1;
+}
+
+static void
+nat_oninit(void *ptr)
+{
+    struct natstr *np = ptr;
+
+    np->nat_cnum = np->nat_uid;
+}
+
+static void
+contact_oninit(void *ptr)
+{
+    struct contactstr *cp = ptr;
+
+    if (opt_HIDDEN)
+       cp->con_contact[cp->con_uid] = 1;
+    else
+       memset(cp->con_contact, 1, sizeof(cp->con_contact));
+}
+
+static void
+realm_oninit(void *ptr)
+{
+    struct realmstr *realm = ptr;
+
+    realm->r_cnum = realm->r_uid / MAXNOR;
+    realm->r_realm = realm->r_uid % MAXNOR;
+}
+
+static void
+game_oninit(void *ptr)
+{
+    ((struct gamestr *)ptr)->game_turn = 1;
+}
+
+static void
+pchr_oninit(void *ptr)
+{
+    ((struct pchrstr *)ptr)->p_sname = "";
+}
+
+static void
+mchr_oninit(void *ptr)
+{
+    ((struct mchrstr *)ptr)->m_name = "";
+}
+
+static void
+plchr_oninit(void *ptr)
+{
+    ((struct plchrstr *)ptr)->pl_name = "";
+}
+
+static void
+lchr_oninit(void *ptr)
+{
+    ((struct lchrstr *)ptr)->l_name = "";
+}
+
+static void
+nchr_oninit(void *ptr)
+{
+    ((struct nchrstr *)ptr)->n_name = "";
+}
+
 static void
 ef_fix_size(struct empfile *ep, int n)
 {
-    ep->cids = ep->fids = n;
+    ep->nent = ep->cids = ep->fids = n;
     ep->csize = n + 1;
 }
 
@@ -260,6 +406,8 @@ empfile_init(void)
     ef_fix_size(&empfile[EF_META], i);
 
     for (ep = empfile; ep->uid >= 0; ep++) {
+       if (!ep->pretty_name)
+           ep->pretty_name = ep->name;
        if (ep->cadef == symbol_ca) {
            lup = (struct symbol *)ep->cache;
            for (i = 0; lup[i].name; i++) ;
@@ -271,5 +419,11 @@ empfile_init(void)
 void
 empfile_fixup(void)
 {
+    struct empfile *ep;
+
+    empfile[EF_SECTOR].nent = WORLD_SZ();
     empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();
+
+    for (ep = empfile; ep->uid >= 0; ep++)
+       assert(!ep->cadef || ep->size <= EF_WITH_CADEF_MAX_ENTRY_SIZE);
 }