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
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-2008
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", 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", "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", "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", 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", "nuke", nuke_ca, EF_BAD,
151 UNMAPPED_CACHE(struct nukstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER),
152 nuk_oninit, NULL, NULL, NULL},
153 {EF_NEWS, "news", "news", news_ca, EF_BAD,
154 UNMAPPED_CACHE(struct nwsstr, -1, 0),
155 NULL, NULL, NULL, NULL},
156 {EF_TREATY, "treaty", "treaty", treaty_ca, EF_BAD,
157 UNMAPPED_CACHE(struct trtstr, -1, EFF_TYPED),
158 NULL, NULL, NULL, NULL},
159 {EF_TRADE, "trade", "trade", trade_ca, EF_BAD,
160 UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER),
161 NULL, NULL, NULL, NULL},
162 {EF_POWER, "pow", "power", NULL, EF_BAD,
163 UNMAPPED_CACHE(struct powstr, -1, 0),
164 NULL, NULL, NULL, NULL},
165 {EF_NATION, "nat", "nation", nat_ca, EF_BAD,
166 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
167 nat_oninit, NULL, NULL, NULL},
168 {EF_LOAN, "loan", "loan", loan_ca, EF_BAD,
169 UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED),
170 NULL, NULL, NULL, NULL},
171 {EF_MAP, "map", "map", NULL, EF_BAD,
172 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
173 {EF_BMAP, "bmap", "bmap", NULL, EF_BAD,
174 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
175 {EF_COMM, "commodity", "commodity", commodity_ca, EF_BAD,
176 UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER),
177 NULL, NULL, NULL, NULL},
178 {EF_LOST, "lost", "lostitems", lost_ca, EF_BAD,
179 UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER),
180 NULL, NULL, NULL, NULL},
181 {EF_REALM, "realm", "realms", realm_ca, EF_BAD,
182 UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
183 EFF_TYPED | EFF_OWNER),
184 realm_oninit, NULL, NULL, NULL},
185 {EF_GAME, "game", "game", game_ca, EF_BAD,
186 UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED),
187 game_oninit, NULL, NULL, NULL},
190 * Static game data (configuration)
193 * Characteristics tables. Characteristics with a null file
194 * member are compiled in. The others are empty; use
195 * read_builtin_tables() to fill them.
197 {EF_ITEM, "item", "item.config", ichr_ca, EF_BAD,
198 ARRAY_CACHE(ichr, EFF_CFG), NULL, NULL, NULL, NULL},
199 {EF_PRODUCT, "product", "product.config", pchr_ca, EF_BAD,
200 ARRAY_CACHE(pchr, EFF_CFG), pchr_oninit, NULL, NULL, NULL},
201 {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca, EF_BAD,
202 ARRAY_CACHE(dchr, EFF_CFG), NULL, NULL, NULL, NULL},
203 {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca, EF_BAD,
204 ARRAY_CACHE(mchr, EFF_CFG), mchr_oninit, NULL, NULL, NULL},
205 {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca, EF_BAD,
206 ARRAY_CACHE(plchr, EFF_CFG), plchr_oninit, NULL, NULL, NULL},
207 {EF_LAND_CHR, "land-chr", "land.config", lchr_ca, EF_BAD,
208 ARRAY_CACHE(lchr, EFF_CFG), lchr_oninit, NULL, NULL, NULL},
209 {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca, EF_BAD,
210 ARRAY_CACHE(nchr, EFF_CFG), nchr_oninit, NULL, NULL, NULL},
211 {EF_NEWS_CHR, "news-chr", NULL, rpt_ca, EF_BAD,
212 ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG), NULL, NULL, NULL, NULL},
213 {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca, EF_BAD,
214 ARRAY_CACHE(intrchr, EFF_CFG), NULL, NULL, NULL, NULL},
216 * Update schedule table. Use read_schedule() to fill.
218 {EF_UPDATES, "updates", NULL, update_ca, EF_BAD,
219 ARRAY_CACHE(update_time, EFF_CFG),
220 NULL, NULL, NULL, NULL},
222 * Special tables. EF_META gets bogus size, cids and fids here.
223 * Fixed up by empfile_init(). EF_VERSION's cadef is set by
226 {EF_TABLE, "table", NULL, empfile_ca, EF_BAD,
227 ARRAY_TABLE(empfile, EF_MAX, EFF_CFG),
228 NULL, NULL, NULL, NULL},
229 {EF_VERSION, "version", NULL, NULL, EF_BAD,
230 sizeof(PACKAGE_STRING), -1, EFF_STATIC, version, 1, 0, 1, 1, -1,
231 NULL, NULL, NULL, NULL},
232 {EF_META, "meta", NULL, mdchr_ca, EF_BAD,
233 PTR_CACHE(mdchr_ca, EFF_CFG),
234 NULL, NULL, NULL, NULL},
239 * These get bogus csize, cids and fids here. Fixed up by
242 #define SYMTAB(type, name, tab) {(type), (name), NULL, symbol_ca, EF_BAD, \
243 PTR_CACHE((tab), EFF_CFG), \
244 NULL, NULL, NULL, NULL}
245 SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
246 SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
247 SYMTAB(EF_LEVEL, "level", level),
248 SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
249 SYMTAB(EF_META_TYPE, "meta-type", meta_type),
250 SYMTAB(EF_MISSIONS, "missions", missions),
251 SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
252 SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
253 SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
254 SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
255 SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
256 SYMTAB(EF_PACKING, "packing", packing),
257 SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
258 SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
259 SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
260 SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
261 SYMTAB(EF_RESOURCES, "resources", resources),
262 SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
263 SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
264 SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
265 SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
268 {EF_COUNTRY, "country", NULL, cou_ca, EF_NATION,
269 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER),
270 NULL, NULL, NULL, NULL},
273 {EF_BAD, NULL, NULL, NULL, EF_BAD,
274 0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
278 sct_oninit(void *ptr)
280 struct sctstr *sp = (struct sctstr *)ptr;
282 sp->sct_y = sp->sct_uid * 2 / WORLD_X;
283 sp->sct_x = sp->sct_uid * 2 % WORLD_X + sp->sct_y % 2;
284 sp->sct_dist_x = sp->sct_x;
285 sp->sct_dist_y = sp->sct_y;
286 sp->sct_newtype = sp->sct_type = SCT_WATER;
291 pln_oninit(void *ptr)
293 struct plnstr *pp = ptr;
295 pp->pln_ship = pp->pln_land = -1;
299 lnd_oninit(void *ptr)
301 struct lndstr *lp = ptr;
303 lp->lnd_ship = lp->lnd_land = -1;
307 nuk_oninit(void *ptr)
309 struct nukstr *np = ptr;
315 nat_oninit(void *ptr)
317 struct natstr *np = ptr;
319 np->nat_cnum = np->nat_uid;
323 realm_oninit(void *ptr)
325 struct realmstr *realm = ptr;
327 realm->r_cnum = realm->r_uid / MAXNOR;
328 realm->r_realm = realm->r_uid % MAXNOR;
332 game_oninit(void *ptr)
334 ((struct gamestr *)ptr)->game_turn = 1;
338 pchr_oninit(void *ptr)
340 ((struct pchrstr *)ptr)->p_sname = "";
344 mchr_oninit(void *ptr)
346 ((struct mchrstr *)ptr)->m_name = "";
350 plchr_oninit(void *ptr)
352 ((struct plchrstr *)ptr)->pl_name = "";
356 lchr_oninit(void *ptr)
358 ((struct lchrstr *)ptr)->l_name = "";
362 nchr_oninit(void *ptr)
364 ((struct nchrstr *)ptr)->n_name = "";
368 ef_fix_size(struct empfile *ep, int n)
370 ep->nent = ep->cids = ep->fids = n;
382 ca = (struct castr *)empfile[EF_META].cache;
383 for (i = 0; ca[i].ca_name; i++) ;
384 ef_fix_size(&empfile[EF_META], i);
386 for (ep = empfile; ep->uid >= 0; ep++) {
387 if (ep->cadef == symbol_ca) {
388 lup = (struct symbol *)ep->cache;
389 for (i = 0; lup[i].name; i++) ;
398 empfile[EF_SECTOR].nent = WORLD_SZ();
399 empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();