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-2007, 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
  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 "plane.h"
  48 #include "power.h"
  49 #include "product.h"
  50 #include "sect.h"
  51 #include "ship.h"
  52 #include "trade.h"
  53 #include "treaty.h"
  54
  55 /* Number of elements in ARRAY.  */
  56 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
  57
  58 /* Initializers for members flags... */
  59 /* Unmapped cache */
  60 #define UNMAPPED_CACHE(type, flags) \
  61     sizeof(type), (flags), NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL
  62 /*
  63  * Mapped cache, array with known size.
  64  * Members cids, fids are not set.
  65  */
  66 #define ARRAY_CACHE(array, flags) \
  67     sizeof(*(array)), (flags), (char *)(array), \
  68     SZ((array)), 0, 0, 0, -1, NULL, NULL, NULL
  69 /*
  70  * Mapped cache, array with unknown size.
  71  * Members csize, cids, fids are not set.
  72  */
  73 #define PTR_CACHE(ptr, flags) \
  74     sizeof(*(ptr)), (flags), (char *)(ptr), \
  75     0, 0, 0, 0, -1, NULL, NULL, NULL
  76 /*
  77  * Array-backed table.
  78  * The array's last element is the sentinel.
  79  */
  80 #define ARRAY_TABLE(array, flags) \
  81     sizeof(*(array)), (flags), (char *)(array), \
  82     SZ((array)), 0, SZ((array)) - 1, SZ((array)) - 1, -1, NULL, NULL, NULL
  83
  84 /* Common configuration table flags */
  85 #define EFF_CFG (EFF_RDONLY | EFF_MEM | EFF_STATIC)
  86
  87 struct empfile empfile[] = {
  88     /*
  89      * How this initializer works:
  90      *
  91      * Members uid, name, file, size, cadef, and the EFF_IMMUTABLE
  92      * bits of flags get their final value.
  93      * If flags & EFF_STATIC, the cache is mapped here, and members
  94      * cache, csize get their final value.
  95      * Members baseid, cids, fids and the EFF_MEM|EFF_RDONLY bits of
  96      * flags are initialized according the initial cache contents.
  97      * Member fd is initialized to -1.
  98      * Members init, postread, prewrite get initialized to NULL, but
  99      * that can be changed by users.
 100      *
 101      * Whatever of the above can't be done here must be done in
 102      * ef_init().
 103      */
 104
 105     /*
 106      * Keep in mind that player command arguments are matched against
 107      * values of member name: no whitespace there, please.
 108      */
 109
 110     /* Dynamic game data */
 111     {EF_SECTOR, "sect", "sector", sect_ca,
 112      UNMAPPED_CACHE(struct sctstr, EFF_XY | EFF_OWNER)},
 113     {EF_SHIP, "ship", "ship", ship_ca,
 114      UNMAPPED_CACHE(struct shpstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 115     {EF_PLANE, "plane", "plane", plane_ca,
 116      UNMAPPED_CACHE(struct plnstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 117     {EF_LAND, "land", "land", land_ca,
 118      UNMAPPED_CACHE(struct lndstr, EFF_XY | EFF_OWNER | EFF_GROUP)},
 119     {EF_NUKE, "nuke", "nuke", nuke_ca,
 120      UNMAPPED_CACHE(struct nukstr, EFF_XY | EFF_OWNER)},
 121     {EF_NEWS, "news", "news", news_ca,
 122      UNMAPPED_CACHE(struct nwsstr, 0)},
 123     {EF_TREATY, "treaty", "treaty", treaty_ca,
 124      UNMAPPED_CACHE(struct trtstr, 0)},
 125     {EF_TRADE, "trade", "trade", trade_ca,
 126      UNMAPPED_CACHE(struct trdstr, 0)},
 127     {EF_POWER, "pow", "power", NULL,
 128      UNMAPPED_CACHE(struct powstr, 0)},
 129     {EF_NATION, "nat", "nation", nat_ca,
 130      UNMAPPED_CACHE(struct natstr, EFF_OWNER)},
 131     {EF_LOAN, "loan", "loan", loan_ca,
 132      UNMAPPED_CACHE(struct lonstr, 0)},
 133     {EF_MAP, "map", "map", NULL,
 134      0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 135     {EF_BMAP, "bmap", "bmap", NULL,
 136      0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 137     {EF_COMM, "commodity", "commodity", commodity_ca,
 138      UNMAPPED_CACHE(struct comstr, 0)},
 139     {EF_LOST, "lost", "lostitems", lost_ca,
 140      UNMAPPED_CACHE(struct loststr, EFF_OWNER)},
 141     {EF_REALM, "realm", "realms", realm_ca,
 142      UNMAPPED_CACHE(struct realmstr, EFF_OWNER)},
 143     {EF_GAME, "game", "game", game_ca,
 144      UNMAPPED_CACHE(struct gamestr, 0)},
 145
 146     /* Static game data (configuration) */
 147     {EF_ITEM, "item", "item.config", ichr_ca,
 148      ARRAY_CACHE(ichr, EFF_CFG)},
 149     {EF_PRODUCT, "product", "product.config", pchr_ca,
 150      ARRAY_CACHE(pchr, EFF_CFG)},
 151     {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca,
 152      ARRAY_CACHE(dchr, EFF_CFG)},
 153     {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca,
 154      ARRAY_CACHE(mchr, EFF_CFG)},
 155     {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca,
 156      ARRAY_CACHE(plchr, EFF_CFG)},
 157     {EF_LAND_CHR, "land-chr", "land.config", lchr_ca,
 158      ARRAY_CACHE(lchr, EFF_CFG)},
 159     {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca,
 160      ARRAY_CACHE(nchr, EFF_CFG)},
 161     {EF_NEWS_CHR, "news-chr", NULL, rpt_ca,
 162      ARRAY_TABLE(rpt, EFF_CFG)},
 163     {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca,
 164      ARRAY_CACHE(intrchr, EFF_CFG)},
 165     {EF_TABLE, "table", NULL, empfile_ca,
 166      ARRAY_TABLE(empfile, EFF_CFG)},
 167     {EF_META, "meta", NULL, mdchr_ca,
 168      PTR_CACHE(mdchr_ca, EFF_CFG)},
 169
 170     /* Symbol tables */
 171 #define SYMTAB(type, name, tab) \
 172         {(type), (name), NULL, symbol_ca, PTR_CACHE((tab), EFF_CFG)}
 173     SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
 174     SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
 175     SYMTAB(EF_LEVEL, "level", level),
 176     SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
 177     SYMTAB(EF_META_TYPE, "meta-type", meta_type),
 178     SYMTAB(EF_MISSIONS, "missions", missions),
 179     SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
 180     SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
 181     SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
 182     SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
 183     SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
 184     SYMTAB(EF_PACKING, "packing", packing),
 185     SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
 186     SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
 187     SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
 188     SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
 189     SYMTAB(EF_RESOURCES, "resources", resources),
 190     SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
 191     SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
 192     SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
 193     SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
 194
 195     /* Views */
 196     {EF_COUNTRY, "country", NULL, cou_ca, UNMAPPED_CACHE(struct natstr, 0)},
 197
 198     /* Sentinel */
 199     {EF_BAD, NULL, NULL, NULL, 0, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL},
 200 };