2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2016, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure, Markus Armbruster
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.
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.
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/>.
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.
27 * filetable.c: Empire game data file descriptions.
29 * Known contributors to this file:
30 * Markus Armbruster, 2005-2016
38 #include "commodity.h"
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 *);
71 static char dummy_cache;
73 /* Number of elements in ARRAY. */
74 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
76 /* Initializers for members flags... */
78 #define UNMAPPED_CACHE(type, nent, flags) \
79 sizeof(type), (nent), (flags), NULL, \
82 * Mapped cache, array with known size.
83 * Members cids, fids are zero, i.e. cache is empty.
85 #define ARRAY_CACHE(array, flags) \
86 sizeof(*(array)), -1, (flags), (char *)(array), \
87 SZ((array)), 0, 0, 0, -1
89 * Mapped cache, array with unknown size.
90 * Member csize gets a bogus value, needs to be fixed up.
91 * Members cids, fids are zero, i.e. cache is empty.
93 #define PTR_CACHE(ptr, flags) \
94 sizeof(*(ptr)), -1, (flags), (char *)(ptr), \
97 * Array-backed table of fixed size.
99 #define ARRAY_TABLE(array, nent, flags) \
100 sizeof(*(array)), (nent), (flags), (char *)(array), \
101 SZ((array)), 0, (nent), (nent), -1
103 /* Common configuration table flags */
104 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
106 struct empfile empfile[] = {
108 * How this initializer works:
110 * Members uid, name, file, cadef, size, and the EFF_IMMUTABLE
111 * bits of flags get their final value.
112 * If flags & EFF_STATIC, the cache is mapped here, and members
113 * cache, csize get their final value.
114 * Members baseid, cids, fids and the EFF_MEM|EFF_PRIVATE bits of
115 * flags are initialized according the initial cache contents.
116 * Member fd is initialized to -1.
117 * Members init, postread, prewrite get initialized to NULL, but
118 * that can be changed by users.
120 * Whatever of the above can't be done here must be done in
121 * empfile_init() or empfile_fixup(). Except cadef may be set in
122 * nsc_init() instead.
126 * Keep in mind that player command arguments are matched against
127 * values of member name: no whitespace there, please.
133 * All caches unmapped. EF_SECTOR gets bogus nent here. EF_MAP
134 * and EF_BMAP get a bogus size here. Fixed up by
137 {EF_SECTOR, "sect", "sector", "sector", sect_ca, EF_BAD,
138 UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
139 sct_oninit, NULL, NULL, NULL},
140 {EF_SHIP, "ship", NULL, "ship", ship_ca, EF_BAD,
141 UNMAPPED_CACHE(struct shpstr, -1,
142 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
143 NULL, NULL, NULL, NULL},
144 {EF_PLANE, "plane", NULL, "plane", plane_ca, EF_BAD,
145 UNMAPPED_CACHE(struct plnstr, -1,
146 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
147 pln_oninit, NULL, NULL, NULL},
148 {EF_LAND, "land", "land unit", "land", land_ca, EF_BAD,
149 UNMAPPED_CACHE(struct lndstr, -1,
150 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
151 lnd_oninit, NULL, NULL, NULL},
152 {EF_NUKE, "nuke", NULL, "nuke", nuke_ca, EF_BAD,
153 UNMAPPED_CACHE(struct nukstr, -1,
154 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
155 nuk_oninit, NULL, NULL, NULL},
156 {EF_NEWS, "news", NULL, "news", news_ca, EF_BAD,
157 UNMAPPED_CACHE(struct nwsstr, -1, 0),
158 NULL, NULL, NULL, NULL},
159 {EF_TRADE, "trade", "trade lot", "trade", trade_ca, EF_BAD,
160 UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
161 NULL, NULL, NULL, NULL},
162 {EF_POWER, "pow", NULL, "power", NULL, EF_BAD,
163 UNMAPPED_CACHE(struct powstr, -1, 0),
164 NULL, NULL, NULL, NULL},
165 {EF_NATION, "nat", "nation", "nation", nat_ca, EF_BAD,
166 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
167 nat_oninit, 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},
196 * Static game data (configuration)
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.
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",
221 ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
223 * Update schedule table. Use read_schedule() to fill.
225 {EF_UPDATES, "updates", NULL, NULL, update_ca, EF_BAD,
226 ARRAY_CACHE(update_time, EFF_CFG),
227 NULL, NULL, NULL, NULL},
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
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},
246 * These get bogus csize, cids and fids here. Fixed up by
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}
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),
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},
281 {EF_BAD, NULL, NULL, NULL, NULL, EF_BAD,
282 0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
286 sct_oninit(void *ptr)
288 struct sctstr *sp = (struct sctstr *)ptr;
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;
299 pln_oninit(void *ptr)
301 struct plnstr *pp = ptr;
303 pp->pln_ship = pp->pln_land = -1;
307 lnd_oninit(void *ptr)
309 struct lndstr *lp = ptr;
311 lp->lnd_ship = lp->lnd_land = -1;
315 nuk_oninit(void *ptr)
317 struct nukstr *np = ptr;
323 nat_oninit(void *ptr)
325 struct natstr *np = ptr;
327 np->nat_cnum = np->nat_uid;
331 contact_oninit(void *ptr)
333 struct contactstr *cp = ptr;
336 cp->con_contact[cp->con_uid] = 1;
338 memset(cp->con_contact, 1, sizeof(cp->con_contact));
342 realm_oninit(void *ptr)
344 struct realmstr *realm = ptr;
346 realm->r_cnum = realm->r_uid / MAXNOR;
347 realm->r_realm = realm->r_uid % MAXNOR;
351 game_oninit(void *ptr)
353 ((struct gamestr *)ptr)->game_turn = 1;
357 pchr_oninit(void *ptr)
359 ((struct pchrstr *)ptr)->p_sname = "";
363 mchr_oninit(void *ptr)
365 ((struct mchrstr *)ptr)->m_name = "";
369 plchr_oninit(void *ptr)
371 ((struct plchrstr *)ptr)->pl_name = "";
375 lchr_oninit(void *ptr)
377 ((struct lchrstr *)ptr)->l_name = "";
381 nchr_oninit(void *ptr)
383 ((struct nchrstr *)ptr)->n_name = "";
387 ef_fix_size(struct empfile *ep, int n)
389 ep->nent = ep->cids = ep->fids = n;
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);
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++) ;
421 empfile[EF_SECTOR].nent = WORLD_SZ();
422 empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();
424 for (ep = empfile; ep->uid >= 0; ep++)
425 assert(!ep->cadef || ep->size <= EF_WITH_CADEF_MAX_ENTRY_SIZE);