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-2011, 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-2008
  31  */
  32
  33 #include <config.h>
  34
  35 #include <stddef.h>
  36 #include "commodity.h"
  37 #include "file.h"
  38 #include "game.h"
  39 #include "land.h"
  40 #include "loan.h"
  41 #include "lost.h"
  42 #include "nat.h"
  43 #include "news.h"
  44 #include "nsc.h"
  45 #include "nuke.h"
  46 #include "optlist.h"
  47 #include "plane.h"
  48 #include "power.h"
  49 #include "product.h"
  50 #include "sect.h"
  51 #include "ship.h"
  52 #include "server.h"
  53 #include "trade.h"
  54 #include "treaty.h"
  55 #include "version.h"
  56 #include "xy.h"
  57
  58 /* Number of elements in ARRAY.  */
  59 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
  60
  61 /* Initializers for members flags... */
  62 /* Unmapped cache */
  63 #define UNMAPPED_CACHE(type, nent, flags)       \
  64     sizeof(type), (nent), (flags), NULL,        \
  65     0, 0, 0, 0, -1
  66 /*
  67  * Mapped cache, array with known size.
  68  * Members cids, fids are zero, i.e. cache is empty.
  69  */
  70 #define ARRAY_CACHE(array, flags) \
  71     sizeof(*(array)), -1, (flags), (char *)(array),     \
  72     SZ((array)), 0, 0, 0, -1
  73 /*
  74  * Mapped cache, array with unknown size.
  75  * Member csize gets a bogus value, needs to be fixed up.
  76  * Members cids, fids are zero, i.e. cache is empty.
  77  */
  78 #define PTR_CACHE(ptr, flags) \
  79     sizeof(*(ptr)), -1, (flags), (char *)(ptr), \
  80     0, 0, 0, 0, -1
  81 /*
  82  * Array-backed table of fixed size.
  83  */
  84 #define ARRAY_TABLE(array, nent, flags)                 \
  85     sizeof(*(array)), (nent), (flags), (char *)(array), \
  86     SZ((array)), 0, (nent), (nent), -1
  87
  88 /* Common configuration table flags */
  89 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
  90
  91 struct empfile empfile[] = {
  92     /*
  93      * How this initializer works:
  94      *
  95      * Members uid, name, file, cadef, size, and the EFF_IMMUTABLE
  96      * bits of flags get their final value.
  97      * If flags & EFF_STATIC, the cache is mapped here, and members
  98      * cache, csize get their final value.
  99      * Members baseid, cids, fids and the EFF_MEM|EFF_PRIVATE bits of
 100      * flags are initialized according the initial cache contents.
 101      * Member fd is initialized to -1.
 102      * Members init, postread, prewrite get initialized to NULL, but
 103      * that can be changed by users.
 104      *
 105      * Whatever of the above can't be done here must be done in
 106      * empfile_init() or empfile_fixup().  Except cadef may be set in
 107      * nsc_init() instead.
 108      */
 109
 110     /*
 111      * Keep in mind that player command arguments are matched against
 112      * values of member name: no whitespace there, please.
 113      */
 114
 115     /*
 116      * Dynamic game data
 117      *
 118      * All caches unmapped.  EF_SECTOR gets bogus nent here.  EF_MAP
 119      * and EF_BMAP get a bogus size here.  Fixed up by
 120      * empfile_fixup().
 121      */
 122     {EF_SECTOR, "sect", "sector", sect_ca, EF_BAD,
 123      UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
 124      NULL, NULL, NULL, NULL},
 125     {EF_SHIP, "ship", "ship", ship_ca, EF_BAD,
 126      UNMAPPED_CACHE(struct shpstr, -1,
 127                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 128      NULL, NULL, NULL, NULL},
 129     {EF_PLANE, "plane", "plane", plane_ca, EF_BAD,
 130      UNMAPPED_CACHE(struct plnstr, -1,
 131                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 132      NULL, NULL, NULL, NULL},
 133     {EF_LAND, "land", "land", land_ca, EF_BAD,
 134      UNMAPPED_CACHE(struct lndstr, -1,
 135                     EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
 136      NULL, NULL, NULL, NULL},
 137     {EF_NUKE, "nuke", "nuke", nuke_ca, EF_BAD,
 138      UNMAPPED_CACHE(struct nukstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
 139      NULL, NULL, NULL, NULL},
 140     {EF_NEWS, "news", "news", news_ca, EF_BAD,
 141      UNMAPPED_CACHE(struct nwsstr, -1, 0),
 142      NULL, NULL, NULL, NULL},
 143     {EF_TREATY, "treaty", "treaty", treaty_ca, EF_BAD,
 144      UNMAPPED_CACHE(struct trtstr, -1, EFF_TYPED),
 145      NULL, NULL, NULL, NULL},
 146     {EF_TRADE, "trade", "trade", trade_ca, EF_BAD,
 147      UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
 148      NULL, NULL, NULL, NULL},
 149     {EF_POWER, "pow", "power", NULL, EF_BAD,
 150      UNMAPPED_CACHE(struct powstr, -1, 0),
 151      NULL, NULL, NULL, NULL},
 152     {EF_NATION, "nat", "nation", nat_ca, EF_BAD,
 153      UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
 154      NULL, NULL, NULL, NULL},
 155     {EF_LOAN, "loan", "loan", loan_ca, EF_BAD,
 156      UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED),
 157      NULL, NULL, NULL, NULL},
 158     {EF_MAP, "map", "map", NULL, EF_BAD,
 159      0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 160     {EF_BMAP, "bmap", "bmap", NULL, EF_BAD,
 161      0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 162     {EF_COMM, "commodity", "commodity", commodity_ca, EF_BAD,
 163      UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER),
 164      NULL, NULL, NULL, NULL},
 165     {EF_LOST, "lost", "lostitems", lost_ca, EF_BAD,
 166      UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER),
 167      NULL, NULL, NULL, NULL},
 168     {EF_REALM, "realm", "realms", realm_ca, EF_BAD,
 169      UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
 170                     EFF_TYPED | EFF_OWNER),
 171      NULL, NULL, NULL, NULL},
 172     {EF_GAME, "game", "game", game_ca, EF_BAD,
 173      UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED),
 174      NULL, NULL, NULL, NULL},
 175
 176     /*
 177      * Static game data (configuration)
 178      */
 179     /*
 180      * Characteristics tables.  Characteristics with a null file
 181      * member are compiled in.  The others are empty; use
 182      * read_builtin_tables() to fill them.
 183      */
 184     {EF_ITEM, "item", "item.config", ichr_ca, EF_BAD,
 185      ARRAY_CACHE(ichr, EFF_CFG), NULL, NULL, NULL, NULL},
 186     {EF_PRODUCT, "product", "product.config", pchr_ca, EF_BAD,
 187      ARRAY_CACHE(pchr, EFF_CFG), NULL, NULL, NULL, NULL},
 188     {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca, EF_BAD,
 189      ARRAY_CACHE(dchr, EFF_CFG), NULL, NULL, NULL, NULL},
 190     {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca, EF_BAD,
 191      ARRAY_CACHE(mchr, EFF_CFG), NULL, NULL, NULL, NULL},
 192     {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca, EF_BAD,
 193      ARRAY_CACHE(plchr, EFF_CFG), NULL, NULL, NULL, NULL},
 194     {EF_LAND_CHR, "land-chr", "land.config", lchr_ca, EF_BAD,
 195      ARRAY_CACHE(lchr, EFF_CFG), NULL, NULL, NULL, NULL},
 196     {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca, EF_BAD,
 197      ARRAY_CACHE(nchr, EFF_CFG), NULL, NULL, NULL, NULL},
 198     {EF_NEWS_CHR, "news-chr", NULL, rpt_ca, EF_BAD,
 199      ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG), NULL, NULL, NULL, NULL},
 200     {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca, EF_BAD,
 201      ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
 202     /*
 203      * Update schedule table.  Use read_schedule() to fill.
 204      */
 205     {EF_UPDATES, "updates", NULL, update_ca, EF_BAD,
 206      ARRAY_CACHE(update_time, EFF_CFG),
 207      NULL, NULL, NULL, NULL},
 208     /*
 209      * Special tables.  EF_META gets bogus size, cids and fids here.
 210      * Fixed up by empfile_init().  EF_VERSION's cadef is set by
 211      * nsc_init().
 212      */
 213     {EF_TABLE, "table", NULL, empfile_ca, EF_BAD,
 214      ARRAY_TABLE(empfile, EF_MAX, EFF_CFG),
 215      NULL, NULL, NULL, NULL},
 216     {EF_VERSION, "version", NULL, NULL, EF_BAD,
 217      sizeof(PACKAGE_STRING), -1, EFF_STATIC, version, 1, 0, 1, 1, -1,
 218      NULL, NULL, NULL, NULL},
 219     {EF_META, "meta", NULL, mdchr_ca, EF_BAD,
 220      PTR_CACHE(mdchr_ca, EFF_CFG),
 221      NULL, NULL, NULL, NULL},
 222
 223     /*
 224      * Symbol tables
 225      *
 226      * These get bogus csize, cids and fids here.  Fixed up by
 227      * empfile_init().
 228      */
 229 #define SYMTAB(type, name, tab) {(type), (name), NULL, symbol_ca, EF_BAD, \
 230                                  PTR_CACHE((tab), EFF_CFG),             \
 231                                  NULL, NULL, NULL, NULL}
 232     SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
 233     SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
 234     SYMTAB(EF_LEVEL, "level", level),
 235     SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
 236     SYMTAB(EF_META_TYPE, "meta-type", meta_type),
 237     SYMTAB(EF_MISSIONS, "missions", missions),
 238     SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
 239     SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
 240     SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
 241     SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
 242     SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
 243     SYMTAB(EF_PACKING, "packing", packing),
 244     SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
 245     SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
 246     SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
 247     SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
 248     SYMTAB(EF_RESOURCES, "resources", resources),
 249     SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
 250     SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
 251     SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
 252     SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
 253
 254     /* Views */
 255     {EF_COUNTRY, "country", NULL, cou_ca, EF_NATION,
 256      UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
 257      NULL, NULL, NULL, NULL},
 258
 259     /* Sentinel */
 260     {EF_BAD, NULL, NULL, NULL, EF_BAD,
 261      0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
 262 };
 263
 264 static void
 265 ef_fix_size(struct empfile *ep, int n)
 266 {
 267     ep->nent = ep->cids = ep->fids = n;
 268     ep->csize = n + 1;
 269 }
 270
 271 void
 272 empfile_init(void)
 273 {
 274     struct castr *ca;
 275     struct empfile *ep;
 276     struct symbol *lup;
 277     int i;
 278
 279     ca = (struct castr *)empfile[EF_META].cache;
 280     for (i = 0; ca[i].ca_name; i++) ;
 281     ef_fix_size(&empfile[EF_META], i);
 282
 283     for (ep = empfile; ep->uid >= 0; ep++) {
 284         if (ep->cadef == symbol_ca) {
 285             lup = (struct symbol *)ep->cache;
 286             for (i = 0; lup[i].name; i++) ;
 287             ef_fix_size(ep, i);
 288         }
 289     }
 290 }
 291
 292 void
 293 empfile_fixup(void)
 294 {
 295     empfile[EF_SECTOR].nent = WORLD_SZ();
 296     empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();
 297 }