2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2013, 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-2013
36 #include "commodity.h"
58 static void sct_oninit(void *);
59 static void pln_oninit(void *);
60 static void lnd_oninit(void *);
61 static void nuk_oninit(void *);
62 static void nat_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 /* Number of elements in ARRAY. */
72 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
74 /* Initializers for members flags... */
76 #define UNMAPPED_CACHE(type, nent, flags) \
77 sizeof(type), (nent), (flags), NULL, \
80 * Mapped cache, array with known size.
81 * Members cids, fids are zero, i.e. cache is empty.
83 #define ARRAY_CACHE(array, flags) \
84 sizeof(*(array)), -1, (flags), (char *)(array), \
85 SZ((array)), 0, 0, 0, -1
87 * Mapped cache, array with unknown size.
88 * Member csize gets a bogus value, needs to be fixed up.
89 * Members cids, fids are zero, i.e. cache is empty.
91 #define PTR_CACHE(ptr, flags) \
92 sizeof(*(ptr)), -1, (flags), (char *)(ptr), \
95 * Array-backed table of fixed size.
97 #define ARRAY_TABLE(array, nent, flags) \
98 sizeof(*(array)), (nent), (flags), (char *)(array), \
99 SZ((array)), 0, (nent), (nent), -1
101 /* Common configuration table flags */
102 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
104 struct empfile empfile[] = {
106 * How this initializer works:
108 * Members uid, name, file, cadef, size, and the EFF_IMMUTABLE
109 * bits of flags get their final value.
110 * If flags & EFF_STATIC, the cache is mapped here, and members
111 * cache, csize get their final value.
112 * Members baseid, cids, fids and the EFF_MEM|EFF_PRIVATE bits of
113 * flags are initialized according the initial cache contents.
114 * Member fd is initialized to -1.
115 * Members init, postread, prewrite get initialized to NULL, but
116 * that can be changed by users.
118 * Whatever of the above can't be done here must be done in
119 * empfile_init() or empfile_fixup(). Except cadef may be set in
120 * nsc_init() instead.
124 * Keep in mind that player command arguments are matched against
125 * values of member name: no whitespace there, please.
131 * All caches unmapped. EF_SECTOR gets bogus nent here. EF_MAP
132 * and EF_BMAP get a bogus size here. Fixed up by
135 {EF_SECTOR, "sect", "sector", "sector", sect_ca, EF_BAD,
136 UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
137 sct_oninit, NULL, NULL, NULL},
138 {EF_SHIP, "ship", NULL, "ship", ship_ca, EF_BAD,
139 UNMAPPED_CACHE(struct shpstr, -1,
140 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
141 NULL, NULL, NULL, NULL},
142 {EF_PLANE, "plane", NULL, "plane", plane_ca, EF_BAD,
143 UNMAPPED_CACHE(struct plnstr, -1,
144 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
145 pln_oninit, NULL, NULL, NULL},
146 {EF_LAND, "land", "land unit", "land", land_ca, EF_BAD,
147 UNMAPPED_CACHE(struct lndstr, -1,
148 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
149 lnd_oninit, NULL, NULL, NULL},
150 {EF_NUKE, "nuke", NULL, "nuke", nuke_ca, EF_BAD,
151 UNMAPPED_CACHE(struct nukstr, -1,
152 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP),
153 nuk_oninit, NULL, NULL, NULL},
154 {EF_NEWS, "news", NULL, "news", news_ca, EF_BAD,
155 UNMAPPED_CACHE(struct nwsstr, -1, 0),
156 NULL, NULL, NULL, NULL},
157 {EF_TREATY, "treaty", NULL, "treaty", treaty_ca, EF_BAD,
158 UNMAPPED_CACHE(struct trtstr, -1, EFF_TYPED),
159 NULL, NULL, NULL, NULL},
160 {EF_TRADE, "trade", "trade lot", "trade", trade_ca, EF_BAD,
161 UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
162 NULL, NULL, NULL, NULL},
163 {EF_POWER, "pow", NULL, "power", NULL, EF_BAD,
164 UNMAPPED_CACHE(struct powstr, -1, 0),
165 NULL, NULL, NULL, NULL},
166 {EF_NATION, "nat", "nation", "nation", nat_ca, EF_BAD,
167 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
168 nat_oninit, NULL, NULL, NULL},
169 {EF_LOAN, "loan", NULL, "loan", loan_ca, EF_BAD,
170 UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED),
171 NULL, NULL, NULL, NULL},
172 {EF_MAP, "map", NULL, "map", NULL, EF_BAD,
173 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
174 {EF_BMAP, "bmap", NULL, "bmap", NULL, EF_BAD,
175 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
176 {EF_COMM, "commodity", NULL, "commodity", commodity_ca, EF_BAD,
177 UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER),
178 NULL, NULL, NULL, NULL},
179 {EF_LOST, "lost", "lost item", "lostitems", lost_ca, EF_BAD,
180 UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER),
181 NULL, NULL, NULL, NULL},
182 {EF_REALM, "realm", NULL, "realms", realm_ca, EF_BAD,
183 UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
184 EFF_TYPED | EFF_OWNER),
185 realm_oninit, NULL, NULL, NULL},
186 {EF_GAME, "game", NULL, "game", game_ca, EF_BAD,
187 UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED),
188 game_oninit, NULL, NULL, NULL},
191 * Static game data (configuration)
194 * Characteristics tables. Characteristics with a null file
195 * member are compiled in. The others are empty; use
196 * read_builtin_tables() to fill them.
198 {EF_ITEM, "item", NULL, "item.config", ichr_ca, EF_BAD,
199 ARRAY_CACHE(ichr, EFF_CFG), NULL, NULL, NULL, NULL},
200 {EF_PRODUCT, "product", NULL, "product.config", pchr_ca, EF_BAD,
201 ARRAY_CACHE(pchr, EFF_CFG), pchr_oninit, NULL, NULL, NULL},
202 {EF_SECTOR_CHR, "sect-chr", NULL, "sect.config", dchr_ca, EF_BAD,
203 ARRAY_CACHE(dchr, EFF_CFG), NULL, NULL, NULL, NULL},
204 {EF_SHIP_CHR, "ship-chr", NULL, "ship.config", mchr_ca, EF_BAD,
205 ARRAY_CACHE(mchr, EFF_CFG), mchr_oninit, NULL, NULL, NULL},
206 {EF_PLANE_CHR, "plane-chr", NULL, "plane.config", plchr_ca, EF_BAD,
207 ARRAY_CACHE(plchr, EFF_CFG), plchr_oninit, NULL, NULL, NULL},
208 {EF_LAND_CHR, "land-chr", NULL, "land.config", lchr_ca, EF_BAD,
209 ARRAY_CACHE(lchr, EFF_CFG), lchr_oninit, NULL, NULL, NULL},
210 {EF_NUKE_CHR, "nuke-chr", NULL, "nuke.config", nchr_ca, EF_BAD,
211 ARRAY_CACHE(nchr, EFF_CFG), nchr_oninit, NULL, NULL, NULL},
212 {EF_NEWS_CHR, "news-chr", NULL, NULL, rpt_ca, EF_BAD,
213 ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG), NULL, NULL, NULL, NULL},
214 {EF_INFRASTRUCTURE, "infrastructure", NULL, "infra.config",
216 ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
218 * Update schedule table. Use read_schedule() to fill.
220 {EF_UPDATES, "updates", NULL, NULL, update_ca, EF_BAD,
221 ARRAY_CACHE(update_time, EFF_CFG),
222 NULL, NULL, NULL, NULL},
224 * Special tables. EF_META gets bogus size, cids and fids here.
225 * Fixed up by empfile_init(). EF_VERSION's cadef is set by
228 {EF_TABLE, "table", NULL, NULL, empfile_ca, EF_BAD,
229 ARRAY_TABLE(empfile, EF_MAX, EFF_CFG),
230 NULL, NULL, NULL, NULL},
231 {EF_VERSION, "version", NULL, NULL, NULL, EF_BAD,
232 sizeof(PACKAGE_STRING), -1, EFF_STATIC, version, 1, 0, 1, 1, -1,
233 NULL, NULL, NULL, NULL},
234 {EF_META, "meta", NULL, NULL, mdchr_ca, EF_BAD,
235 PTR_CACHE(mdchr_ca, EFF_CFG),
236 NULL, NULL, NULL, NULL},
241 * These get bogus csize, cids and fids here. Fixed up by
244 #define SYMTAB(type, name, tab) \
245 {(type), (name), NULL, NULL, symbol_ca, EF_BAD, \
246 PTR_CACHE((tab), EFF_CFG), NULL, NULL, NULL, NULL}
248 SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
249 SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
250 SYMTAB(EF_LEVEL, "level", level),
251 SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
252 SYMTAB(EF_META_TYPE, "meta-type", meta_type),
253 SYMTAB(EF_MISSIONS, "missions", missions),
254 SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
255 SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
256 SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
257 SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
258 SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
259 SYMTAB(EF_PACKING, "packing", packing),
260 SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
261 SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
262 SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
263 SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
264 SYMTAB(EF_RESOURCES, "resources", resources),
265 SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
266 SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
267 SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
268 SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
271 {EF_COUNTRY, "country", NULL, NULL, cou_ca, EF_NATION,
272 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
273 NULL, NULL, NULL, NULL},
276 {EF_BAD, NULL, NULL, NULL, NULL, EF_BAD,
277 0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
281 sct_oninit(void *ptr)
283 struct sctstr *sp = (struct sctstr *)ptr;
285 sctoff2xy(&sp->sct_x, &sp->sct_y, sp->sct_uid);
286 sp->sct_dist_x = sp->sct_x;
287 sp->sct_dist_y = sp->sct_y;
288 sp->sct_newtype = sp->sct_type = SCT_WATER;
293 pln_oninit(void *ptr)
295 struct plnstr *pp = ptr;
297 pp->pln_ship = pp->pln_land = -1;
301 lnd_oninit(void *ptr)
303 struct lndstr *lp = ptr;
305 lp->lnd_ship = lp->lnd_land = -1;
309 nuk_oninit(void *ptr)
311 struct nukstr *np = ptr;
317 nat_oninit(void *ptr)
319 struct natstr *np = ptr;
321 np->nat_cnum = np->nat_uid;
325 realm_oninit(void *ptr)
327 struct realmstr *realm = ptr;
329 realm->r_cnum = realm->r_uid / MAXNOR;
330 realm->r_realm = realm->r_uid % MAXNOR;
334 game_oninit(void *ptr)
336 ((struct gamestr *)ptr)->game_turn = 1;
340 pchr_oninit(void *ptr)
342 ((struct pchrstr *)ptr)->p_sname = "";
346 mchr_oninit(void *ptr)
348 ((struct mchrstr *)ptr)->m_name = "";
352 plchr_oninit(void *ptr)
354 ((struct plchrstr *)ptr)->pl_name = "";
358 lchr_oninit(void *ptr)
360 ((struct lchrstr *)ptr)->l_name = "";
364 nchr_oninit(void *ptr)
366 ((struct nchrstr *)ptr)->n_name = "";
370 ef_fix_size(struct empfile *ep, int n)
372 ep->nent = ep->cids = ep->fids = n;
384 ca = (struct castr *)empfile[EF_META].cache;
385 for (i = 0; ca[i].ca_name; i++) ;
386 ef_fix_size(&empfile[EF_META], i);
388 for (ep = empfile; ep->uid >= 0; ep++) {
389 if (!ep->pretty_name)
390 ep->pretty_name = ep->name;
391 if (ep->cadef == symbol_ca) {
392 lup = (struct symbol *)ep->cache;
393 for (i = 0; lup[i].name; i++) ;
402 empfile[EF_SECTOR].nent = WORLD_SZ();
403 empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();