git.pond.sub.org Git - empserver/blob - src/lib/common/filetable.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2020, 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  *  filetable.c: Empire game data file descriptions.
  28  *
  29  *  Known contributors to this file:
  30  *     Markus Armbruster, 2005-2020
  31  */
  32
  33 #include <config.h>
  34
  35 #include <assert.h>
  36 #include <stddef.h>
  37 #include <string.h>
  38 #include "commodity.h"
  39 #include "game.h"
  40 #include "land.h"
  41 #include "loan.h"
  42 #include "lost.h"
  43 #include "nat.h"
  44 #include "news.h"
  45 #include "nsc.h"
  46 #include "nuke.h"
  47 #include "optlist.h"
  48 #include "plane.h"
  49 #include "power.h"
  50 #include "product.h"
  51 #include "sect.h"
  52 #include "ship.h"
  53 #include "server.h"
  54 #include "trade.h"
  55 #include "xy.h"
  56
  57 static void sct_oninit(void *);
  58 static void pln_oninit(void *);
  59 static void lnd_oninit(void *);
  60 static void nuk_oninit(void *);
  61 static void nat_oninit(void *);
  62 static void contact_oninit(void *);
  63 static void realm_oninit(void *);
  64 static void game_oninit(void *);
  65 static void pchr_oninit(void *);
  66 static void mchr_oninit(void *);
  67 static void plchr_oninit(void *);
  68 static void lchr_oninit(void *);
  69 static void nchr_oninit(void *);
  70
  71 static char dummy_cache;
  72
  73 /* Initializers for members flags... */
  74 /* Unmapped cache */
  75 #define UNMAPPED_CACHE(type, nent, flags)       \
  76     sizeof(type), (nent), (flags), NULL,        \
  77     0, 0, 0, 0, -1
  78 /*
  79  * Mapped cache, array with known size.
  80  * Members cids, fids are zero, i.e. cache is empty.
  81  */
  82 #define ARRAY_CACHE(array, flags) \
  83     sizeof(*(array)), -1, (flags), (char *)(array),     \
  84     ARRAY_SIZE((array)), 0, 0, 0, -1
  85 /*
  86  * Mapped cache, array with unknown size.
  87  * Member csize gets a bogus value, needs to be fixed up.
  88  * Members cids, fids are zero, i.e. cache is empty.
  89  */
  90 #define PTR_CACHE(ptr, flags) \
  91     sizeof(*(ptr)), -1, (flags), (char *)(ptr), \
  92     0, 0, 0, 0, -1
  93 /*
  94  * Array-backed table of fixed size.
  95  */
  96 #define ARRAY_TABLE(array, nent, flags)                 \
  97     sizeof(*(array)), (nent), (flags), (char *)(array), \
  98     ARRAY_SIZE((array)), 0, (nent), (nent), -1
  99
 100 /* Common configuration table flags */
 101 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
 102
 103 struct empfile empfile[] = {
 104     /*
 105      * How this initializer works:
 106      *
 107      * Members uid, name, file, cadef, size, and the EFF_IMMUTABLE
 108      * bits of flags get their final value.
 109      * If flags & EFF_STATIC, the cache is mapped here, and members
 110      * cache, csize get their final value.
 111      * Members baseid, cids, fids and the EFF_MEM|EFF_PRIVATE bits of
 112      * flags are initialized according the initial cache contents.
 113      * Member fd is initialized to -1.
 114      * Members init, postread, prewrite get initialized to NULL, but
 115      * that can be changed by users.
 116      *
 117      * Whatever of the above can't be done here must be done in
 118      * empfile_init() or empfile_fixup().  Except cadef may be set in
 119      * nsc_init() instead.
 120      */
 121
 122     /*
 123      * Keep in mind that player command arguments are matched against
 124      * values of member name: no whitespace there, please.
 125      */
 126
 127     /*
 128      * Dynamic game data
 129      *
 130      * All caches unmapped.  EF_SECTOR gets bogus nent here.  EF_MAP
 131      * and EF_BMAP get a bogus size here.  Fixed up by
 132      * empfile_fixup().
 133      */
 134     {EF_SECTOR, "sect", "sector", "sector", sect_ca, EF_BAD,
 135      UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
 136      sct_oninit, NULL, NULL, NULL},
 137     {EF_SHIP, "ship", NULL, "ship", ship_ca, EF_BAD,
 138      UNMAPPED_CACHE(struct shpstr, -1,
 139                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 140      NULL, NULL, NULL, NULL},
 141     {EF_PLANE, "plane", NULL, "plane", plane_ca, EF_BAD,
 142      UNMAPPED_CACHE(struct plnstr, -1,
 143                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 144      pln_oninit, NULL, NULL, NULL},
 145     {EF_LAND, "land", "land unit", "land", land_ca, EF_BAD,
 146      UNMAPPED_CACHE(struct lndstr, -1,
 147                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 148      lnd_oninit, NULL, NULL, NULL},
 149     {EF_NUKE, "nuke", NULL, "nuke", nuke_ca, EF_BAD,
 150      UNMAPPED_CACHE(struct nukstr, -1,
 151                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 152      nuk_oninit, NULL, NULL, NULL},
 153     {EF_NEWS, "news", NULL, "news", news_ca, EF_BAD,
 154      UNMAPPED_CACHE(struct nwsstr, -1, 0),
 155      NULL, NULL, NULL, NULL},
 156     {EF_TRADE, "trade", "trade lot", "trade", trade_ca, EF_BAD,
 157      UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
 158      NULL, NULL, NULL, NULL},
 159     {EF_POWER, "pow", NULL, "power", NULL, EF_BAD,
 160      UNMAPPED_CACHE(struct powstr, -1, 0),
 161      NULL, NULL, NULL, NULL},
 162     {EF_NATION, "nat", "nation", "nation", nat_ca, EF_BAD,
 163      UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
 164      nat_oninit, NULL, NULL, NULL},
 165     {EF_RELAT, "relat", NULL, "relat", relat_ca, EF_BAD,
 166      UNMAPPED_CACHE(struct relatstr, MAXNOC, EFF_TYPED),
 167      NULL, NULL, NULL, NULL},
 168     {EF_CONTACT, "contact", NULL, "contact", contact_ca, EF_BAD,
 169      UNMAPPED_CACHE(struct contactstr, MAXNOC, EFF_TYPED),
 170      contact_oninit, NULL, NULL, NULL},
 171     {EF_REJECT, "reject", NULL, "reject", reject_ca, EF_BAD,
 172      UNMAPPED_CACHE(struct rejectstr, MAXNOC, EFF_TYPED),
 173      NULL, NULL, NULL, NULL},
 174     {EF_LOAN, "loan", NULL, "loan", loan_ca, EF_BAD,
 175      UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED),
 176      NULL, NULL, NULL, NULL},
 177     {EF_MAP, "map", NULL, "map", NULL, EF_BAD,
 178      0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 179     {EF_BMAP, "bmap", NULL, "bmap", NULL, EF_BAD,
 180      0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 181     {EF_COMM, "commodity", NULL, "commodity", commodity_ca, EF_BAD,
 182      UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER),
 183      NULL, NULL, NULL, NULL},
 184     {EF_LOST, "lost", "lost item", "lostitems", lost_ca, EF_BAD,
 185      UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER),
 186      NULL, NULL, NULL, NULL},
 187     {EF_REALM, "realm", NULL, "realms", realm_ca, EF_BAD,
 188      UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
 189                     EFF_TYPED | EFF_OWNER),
 190      realm_oninit, NULL, NULL, NULL},
 191     {EF_GAME, "game", NULL, "game", game_ca, EF_BAD,
 192      UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED),
 193      game_oninit, NULL, NULL, NULL},
 194
 195     /*
 196      * Static game data (configuration)
 197      */
 198     /*
 199      * Characteristics tables.  Characteristics with a null file
 200      * member are compiled in.  The others are empty; use
 201      * read_builtin_tables() to fill them.
 202      */
 203     {EF_ITEM, "item", NULL, "item.config", ichr_ca, EF_BAD,
 204      ARRAY_CACHE(ichr, EFF_CFG), NULL, NULL, NULL, NULL},
 205     {EF_PRODUCT, "product", NULL, "product.config", pchr_ca, EF_BAD,
 206      ARRAY_CACHE(pchr, EFF_CFG), pchr_oninit, NULL, NULL, NULL},
 207     {EF_SECTOR_CHR, "sect-chr", NULL, "sect.config", dchr_ca, EF_BAD,
 208      ARRAY_CACHE(dchr, EFF_CFG), NULL, NULL, NULL, NULL},
 209     {EF_SHIP_CHR, "ship-chr", NULL, "ship.config", mchr_ca, EF_BAD,
 210      ARRAY_CACHE(mchr, EFF_CFG), mchr_oninit, NULL, NULL, NULL},
 211     {EF_PLANE_CHR, "plane-chr", NULL, "plane.config", plchr_ca, EF_BAD,
 212      ARRAY_CACHE(plchr, EFF_CFG), plchr_oninit, NULL, NULL, NULL},
 213     {EF_LAND_CHR, "land-chr", NULL, "land.config", lchr_ca, EF_BAD,
 214      ARRAY_CACHE(lchr, EFF_CFG), lchr_oninit, NULL, NULL, NULL},
 215     {EF_NUKE_CHR, "nuke-chr", NULL, "nuke.config", nchr_ca, EF_BAD,
 216      ARRAY_CACHE(nchr, EFF_CFG), nchr_oninit, NULL, NULL, NULL},
 217     {EF_NEWS_CHR, "news-chr", NULL, NULL, rpt_ca, EF_BAD,
 218      ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG), NULL, NULL, NULL, NULL},
 219     {EF_INFRASTRUCTURE, "infrastructure", NULL, "infra.config",
 220      intrchr_ca, EF_BAD,
 221      ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
 222     /*
 223      * Update schedule table.  Use read_schedule() to fill.
 224      */
 225     {EF_UPDATES, "updates", NULL, NULL, update_ca, EF_BAD,
 226      ARRAY_CACHE(update_time, EFF_CFG),
 227      NULL, NULL, NULL, NULL},
 228     /*
 229      * Special tables.  EF_META gets bogus size, cids and fids here.
 230      * Fixed up by empfile_init().  EF_VERSION's cadef is set by
 231      * nsc_init().
 232      */
 233     {EF_TABLE, "table", NULL, NULL, empfile_ca, EF_BAD,
 234      ARRAY_TABLE(empfile, EF_MAX, EFF_CFG),
 235      NULL, NULL, NULL, NULL},
 236     {EF_VERSION, "version", NULL, NULL, NULL, EF_BAD,
 237      0, -1, EFF_MEM | EFF_STATIC, &dummy_cache, 1, 0, 1, 1, -1,
 238      NULL, NULL, NULL, NULL},
 239     {EF_META, "meta", NULL, NULL, mdchr_ca, EF_BAD,
 240      PTR_CACHE(mdchr_ca, EFF_CFG),
 241      NULL, NULL, NULL, NULL},
 242
 243     /*
 244      * Symbol tables
 245      *
 246      * These get bogus csize, cids and fids here.  Fixed up by
 247      * empfile_init().
 248      */
 249 #define SYMTAB(type, name, tab)                         \
 250     {(type), (name), NULL, NULL, symbol_ca, EF_BAD,     \
 251      PTR_CACHE((tab), EFF_CFG), NULL, NULL, NULL, NULL}
 252
 253     SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
 254     SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
 255     SYMTAB(EF_LEVEL, "level", level),
 256     SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
 257     SYMTAB(EF_META_TYPE, "meta-type", meta_type),
 258     SYMTAB(EF_MISSIONS, "missions", missions),
 259     SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
 260     SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
 261     SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
 262     SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
 263     SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
 264     SYMTAB(EF_PACKING, "packing", packing),
 265     SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
 266     SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
 267     SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
 268     SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
 269     SYMTAB(EF_RESOURCES, "resources", resources),
 270     SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
 271     SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
 272     SYMTAB(EF_SECTOR_CHR_FLAGS, "sect-chr-flags", sect_chr_flags),
 273     SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
 274
 275     /* Views */
 276     {EF_COUNTRY, "country", NULL, NULL, cou_ca, EF_NATION,
 277      UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
 278      NULL, NULL, NULL, NULL},
 279
 280     /* Sentinel */
 281     {EF_BAD, NULL, NULL, NULL, NULL, EF_BAD,
 282      0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 283 };
 284
 285 static void
 286 sct_oninit(void *ptr)
 287 {
 288     struct sctstr *sp = (struct sctstr *)ptr;
 289
 290     sctoff2xy(&sp->sct_x, &sp->sct_y, sp->sct_uid);
 291     sp->sct_dist_x = sp->sct_x;
 292     sp->sct_dist_y = sp->sct_y;
 293     sp->sct_newtype = sp->sct_type = SCT_WATER;
 294     sp->sct_work = 100;
 295     sp->sct_coastal = 1;
 296 }
 297
 298 static void
 299 pln_oninit(void *ptr)
 300 {
 301     struct plnstr *pp = ptr;
 302
 303     pp->pln_ship = pp->pln_land = -1;
 304 }
 305
 306 static void
 307 lnd_oninit(void *ptr)
 308 {
 309     struct lndstr *lp = ptr;
 310
 311     lp->lnd_ship = lp->lnd_land = -1;
 312 }
 313
 314 static void
 315 nuk_oninit(void *ptr)
 316 {
 317     struct nukstr *np = ptr;
 318
 319     np->nuk_plane = -1;
 320 }
 321
 322 static void
 323 nat_oninit(void *ptr)
 324 {
 325     struct natstr *np = ptr;
 326
 327     np->nat_cnum = np->nat_uid;
 328 }
 329
 330 static void
 331 contact_oninit(void *ptr)
 332 {
 333     struct contactstr *cp = ptr;
 334
 335     if (opt_HIDDEN)
 336         cp->con_contact[cp->con_uid] = 1;
 337     else
 338         memset(cp->con_contact, 1, sizeof(cp->con_contact));
 339 }
 340
 341 static void
 342 realm_oninit(void *ptr)
 343 {
 344     struct realmstr *realm = ptr;
 345
 346     realm->r_cnum = realm->r_uid / MAXNOR;
 347     realm->r_realm = realm->r_uid % MAXNOR;
 348 }
 349
 350 static void
 351 game_oninit(void *ptr)
 352 {
 353     ((struct gamestr *)ptr)->game_turn = 1;
 354 }
 355
 356 static void
 357 pchr_oninit(void *ptr)
 358 {
 359     ((struct pchrstr *)ptr)->p_sname = "";
 360 }
 361
 362 static void
 363 mchr_oninit(void *ptr)
 364 {
 365     ((struct mchrstr *)ptr)->m_name = "";
 366 }
 367
 368 static void
 369 plchr_oninit(void *ptr)
 370 {
 371     ((struct plchrstr *)ptr)->pl_name = "";
 372 }
 373
 374 static void
 375 lchr_oninit(void *ptr)
 376 {
 377     ((struct lchrstr *)ptr)->l_name = "";
 378 }
 379
 380 static void
 381 nchr_oninit(void *ptr)
 382 {
 383     ((struct nchrstr *)ptr)->n_name = "";
 384 }
 385
 386 static void
 387 ef_fix_size(struct empfile *ep, int n)
 388 {
 389     ep->nent = ep->cids = ep->fids = n;
 390     ep->csize = n + 1;
 391 }
 392
 393 void
 394 empfile_init(void)
 395 {
 396     struct castr *ca;
 397     struct empfile *ep;
 398     struct symbol *lup;
 399     int i;
 400
 401     ca = (struct castr *)empfile[EF_META].cache;
 402     for (i = 0; ca[i].ca_name; i++) ;
 403     ef_fix_size(&empfile[EF_META], i);
 404
 405     for (ep = empfile; ep->uid >= 0; ep++) {
 406         if (!ep->pretty_name)
 407             ep->pretty_name = ep->name;
 408         if (ep->cadef == symbol_ca) {
 409             lup = (struct symbol *)ep->cache;
 410             for (i = 0; lup[i].name; i++) ;
 411             ef_fix_size(ep, i);
 412         }
 413     }
 414 }
 415
 416 void
 417 empfile_fixup(void)
 418 {
 419     struct empfile *ep;
 420
 421     empfile[EF_SECTOR].nent = WORLD_SZ();
 422     empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();
 423
 424     for (ep = empfile; ep->uid >= 0; ep++)
 425         assert(!ep->cadef || ep->size <= EF_WITH_CADEF_MAX_ENTRY_SIZE);
 426 }