git.pond.sub.org Git - empserver/blob - src/lib/global/file.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2008, 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 files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  file.c: Empire game data file descriptions.
  29  *
  30  *  Known contributors to this file:
  31  *     Markus Armbruster, 2005-2007
  32  */
  33
  34 #include <config.h>
  35
  36 #include <stddef.h>
  37 #include "commodity.h"
  38 #include "file.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 "treaty.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, flags) \
  64     sizeof(type), (flags), NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL
  65 /*
  66  * Mapped cache, array with known size.
  67  * Members cids, fids are not set.
  68  */
  69 #define ARRAY_CACHE(array, flags) \
  70     sizeof(*(array)), (flags), (char *)(array), \
  71     SZ((array)), 0, 0, 0, -1, NULL, NULL, NULL
  72 /*
  73  * Mapped cache, array with unknown size.
  74  * Members csize, cids, fids are not set.
  75  */
  76 #define PTR_CACHE(ptr, flags) \
  77     sizeof(*(ptr)), (flags), (char *)(ptr), \
  78     0, 0, 0, 0, -1, NULL, NULL, NULL
  79 /*
  80  * Array-backed table.
  81  * The array's last element is the sentinel.
  82  */
  83 #define ARRAY_TABLE(array, flags) \
  84     sizeof(*(array)), (flags), (char *)(array), \
  85     SZ((array)), 0, SZ((array)) - 1, SZ((array)) - 1, -1, NULL, NULL, NULL
  86
  87 /* Common configuration table flags */
  88 #define EFF_CFG (EFF_RDONLY | EFF_MEM | EFF_STATIC)
  89
  90 struct empfile empfile[] = {
  91     /*
  92      * How this initializer works:
  93      *
  94      * Members uid, name, file, cadef, size, and the EFF_IMMUTABLE
  95      * bits of flags get their final value.
  96      * If flags & EFF_STATIC, the cache is mapped here, and members
  97      * cache, csize get their final value.
  98      * Members baseid, cids, fids and the EFF_MEM|EFF_RDONLY bits of
  99      * flags are initialized according the initial cache contents.
 100      * Member fd is initialized to -1.
 101      * Members init, postread, prewrite get initialized to NULL, but
 102      * that can be changed by users.
 103      *
 104      * Whatever of the above can't be done here must be done in
 105      * empfile_init() or empfile_fixup().
 106      */
 107
 108     /*
 109      * Keep in mind that player command arguments are matched against
 110      * values of member name: no whitespace there, please.
 111      */
 112
 113     /*
 114      * Dynamic game data
 115      *
 116      * All caches unmapped.  EF_MAP and EF_BMAP get a bogus size here.
 117      * Fixed up by empfile_fixup().
 118      */
 119     {EF_SECTOR, "sect", "sector", sect_ca,
 120      UNMAPPED_CACHE(struct sctstr, EFF_XY | EFF_OWNER)},
 121     {EF_SHIP, "ship", "ship", ship_ca,
 122      UNMAPPED_CACHE(struct shpstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 123     {EF_PLANE, "plane", "plane", plane_ca,
 124      UNMAPPED_CACHE(struct plnstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 125     {EF_LAND, "land", "land", land_ca,
 126      UNMAPPED_CACHE(struct lndstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 127     {EF_NUKE, "nuke", "nuke", nuke_ca,
 128      UNMAPPED_CACHE(struct nukstr, EFF_XY | EFF_OWNER)},
 129     {EF_NEWS, "news", "news", news_ca,
 130      UNMAPPED_CACHE(struct nwsstr, 0)},
 131     {EF_TREATY, "treaty", "treaty", treaty_ca,
 132      UNMAPPED_CACHE(struct trtstr, 0)},
 133     {EF_TRADE, "trade", "trade", trade_ca,
 134      UNMAPPED_CACHE(struct trdstr, 0)},
 135     {EF_POWER, "pow", "power", NULL,
 136      UNMAPPED_CACHE(struct powstr, 0)},
 137     {EF_NATION, "nat", "nation", nat_ca,
 138      UNMAPPED_CACHE(struct natstr, EFF_OWNER)},
 139     {EF_LOAN, "loan", "loan", loan_ca,
 140      UNMAPPED_CACHE(struct lonstr, 0)},
 141     {EF_MAP, "map", "map", NULL,
 142      0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 143     {EF_BMAP, "bmap", "bmap", NULL,
 144      0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 145     {EF_COMM, "commodity", "commodity", commodity_ca,
 146      UNMAPPED_CACHE(struct comstr, 0)},
 147     {EF_LOST, "lost", "lostitems", lost_ca,
 148      UNMAPPED_CACHE(struct loststr, EFF_OWNER)},
 149     {EF_REALM, "realm", "realms", realm_ca,
 150      UNMAPPED_CACHE(struct realmstr, EFF_OWNER)},
 151     {EF_GAME, "game", "game", game_ca,
 152      UNMAPPED_CACHE(struct gamestr, 0)},
 153
 154     /*
 155      * Static game data (configuration)
 156      *
 157      * These are all empty tables, except for EF_NEWS_CHR and EF_META.
 158      * Use read_builtin_tables() to fill them.  EF_META gets bogus
 159      * size, cids and fids here.  Fixed up by empfile_init().
 160      */
 161     {EF_ITEM, "item", "item.config", ichr_ca,
 162      ARRAY_CACHE(ichr, EFF_CFG)},
 163     {EF_PRODUCT, "product", "product.config", pchr_ca,
 164      ARRAY_CACHE(pchr, EFF_CFG)},
 165     {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca,
 166      ARRAY_CACHE(dchr, EFF_CFG)},
 167     {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca,
 168      ARRAY_CACHE(mchr, EFF_CFG)},
 169     {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca,
 170      ARRAY_CACHE(plchr, EFF_CFG)},
 171     {EF_LAND_CHR, "land-chr", "land.config", lchr_ca,
 172      ARRAY_CACHE(lchr, EFF_CFG)},
 173     {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca,
 174      ARRAY_CACHE(nchr, EFF_CFG)},
 175     {EF_NEWS_CHR, "news-chr", NULL, rpt_ca,
 176      ARRAY_TABLE(rpt, EFF_CFG)},
 177     {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca,
 178      ARRAY_CACHE(intrchr, EFF_CFG)},
 179     {EF_UPDATES, "updates", NULL, update_ca,
 180      ARRAY_TABLE(update_time, EFF_CFG)},
 181     {EF_TABLE, "table", NULL, empfile_ca,
 182      ARRAY_TABLE(empfile, EFF_CFG)},
 183     {EF_META, "meta", NULL, mdchr_ca,
 184      PTR_CACHE(mdchr_ca, EFF_CFG)},
 185
 186     /*
 187      * Symbol tables
 188      *
 189      * These get bogus size, cids and fids here.  Fixed up by
 190      * empfile_init().
 191      */
 192 #define SYMTAB(type, name, tab) \
 193         {(type), (name), NULL, symbol_ca, PTR_CACHE((tab), EFF_CFG)}
 194     SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
 195     SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
 196     SYMTAB(EF_LEVEL, "level", level),
 197     SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
 198     SYMTAB(EF_META_TYPE, "meta-type", meta_type),
 199     SYMTAB(EF_MISSIONS, "missions", missions),
 200     SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
 201     SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
 202     SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
 203     SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
 204     SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
 205     SYMTAB(EF_PACKING, "packing", packing),
 206     SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
 207     SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
 208     SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
 209     SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
 210     SYMTAB(EF_RESOURCES, "resources", resources),
 211     SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
 212     SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
 213     SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
 214     SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
 215
 216     /* Views */
 217     {EF_COUNTRY, "country", NULL, cou_ca, UNMAPPED_CACHE(struct natstr, 0)},
 218
 219     /* Sentinel */
 220     {EF_BAD, NULL, NULL, NULL, 0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 221 };
 222
 223 static void
 224 ef_fix_size(struct empfile *ep, int n)
 225 {
 226     ep->cids = ep->fids = n;
 227     ep->csize = n + 1;
 228 }
 229
 230 void
 231 empfile_init(void)
 232 {
 233     struct castr *ca;
 234     struct empfile *ep;
 235     struct symbol *lup;
 236     int i;
 237
 238     ca = (struct castr *)empfile[EF_META].cache;
 239     for (i = 0; ca[i].ca_name; i++) ;
 240     ef_fix_size(&empfile[EF_META], i);
 241
 242     for (ep = empfile; ep->uid >= 0; ep++) {
 243         if (ep->cadef == symbol_ca) {
 244             lup = (struct symbol *)ep->cache;
 245             for (i = 0; lup[i].name; i++) ;
 246             ef_fix_size(ep, i);
 247         }
 248     }
 249 }
 250
 251 void
 252 empfile_fixup(void)
 253 {
 254     empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();
 255 }