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 /* Number of elements in ARRAY. */
59 #define SZ(array) (sizeof(array) / sizeof((array)[0]))
61 /* Initializers for members flags... */
63 #define UNMAPPED_CACHE(type, nent, flags) \
64 sizeof(type), (nent), (flags), NULL, \
65 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL
67 * Mapped cache, array with known size.
68 * Members cids, fids are not set.
70 #define ARRAY_CACHE(array, flags) \
71 sizeof(*(array)), -1, (flags), (char *)(array), \
72 SZ((array)), 0, 0, 0, -1, NULL, NULL, NULL, NULL
74 * Mapped cache, array with unknown size.
75 * Members csize, cids, fids are not set.
77 #define PTR_CACHE(ptr, flags) \
78 sizeof(*(ptr)), -1, (flags), (char *)(ptr), \
79 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL
81 * Array-backed table of fixed size.
83 #define ARRAY_TABLE(array, nent, flags) \
84 sizeof(*(array)), (nent), (flags), (char *)(array), \
85 SZ((array)), 0, (nent), (nent), -1, NULL, NULL, NULL, NULL
87 /* Common configuration table flags */
88 #define EFF_CFG (EFF_PRIVATE | EFF_MEM | EFF_STATIC | EFF_SENTINEL)
90 struct empfile empfile[] = {
92 * How this initializer works:
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_PRIVATE 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.
104 * Whatever of the above can't be done here must be done in
105 * empfile_init() or empfile_fixup(). Except cadef may be set in
106 * nsc_init() instead.
110 * Keep in mind that player command arguments are matched against
111 * values of member name: no whitespace there, please.
117 * All caches unmapped. EF_SECTOR gets bogus nent here. EF_MAP
118 * and EF_BMAP get a bogus size here. Fixed up by
121 {EF_SECTOR, "sect", "sector", sect_ca, EF_BAD,
122 UNMAPPED_CACHE(struct sctstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER)},
123 {EF_SHIP, "ship", "ship", ship_ca, EF_BAD,
124 UNMAPPED_CACHE(struct shpstr, -1,
125 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
126 {EF_PLANE, "plane", "plane", plane_ca, EF_BAD,
127 UNMAPPED_CACHE(struct plnstr, -1,
128 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
129 {EF_LAND, "land", "land", land_ca, EF_BAD,
130 UNMAPPED_CACHE(struct lndstr, -1,
131 EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP)},
132 {EF_NUKE, "nuke", "nuke", nuke_ca, EF_BAD,
133 UNMAPPED_CACHE(struct nukstr, -1, EFF_TYPED | EFF_XY | EFF_OWNER)},
134 {EF_NEWS, "news", "news", news_ca, EF_BAD,
135 UNMAPPED_CACHE(struct nwsstr, -1, 0)},
136 {EF_TREATY, "treaty", "treaty", treaty_ca, EF_BAD,
137 UNMAPPED_CACHE(struct trtstr, -1, EFF_TYPED)},
138 {EF_TRADE, "trade", "trade", trade_ca, EF_BAD,
139 UNMAPPED_CACHE(struct trdstr, -1, EFF_TYPED | EFF_OWNER)},
140 {EF_POWER, "pow", "power", NULL, EF_BAD,
141 UNMAPPED_CACHE(struct powstr, -1, 0)},
142 {EF_NATION, "nat", "nation", nat_ca, EF_BAD,
143 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER)},
144 {EF_LOAN, "loan", "loan", loan_ca, EF_BAD,
145 UNMAPPED_CACHE(struct lonstr, -1, EFF_TYPED)},
146 {EF_MAP, "map", "map", NULL, EF_BAD,
147 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
148 {EF_BMAP, "bmap", "bmap", NULL, EF_BAD,
149 0, MAXNOC, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
150 {EF_COMM, "commodity", "commodity", commodity_ca, EF_BAD,
151 UNMAPPED_CACHE(struct comstr, -1, EFF_TYPED | EFF_OWNER)},
152 {EF_LOST, "lost", "lostitems", lost_ca, EF_BAD,
153 UNMAPPED_CACHE(struct loststr, -1, EFF_TYPED | EFF_OWNER)},
154 {EF_REALM, "realm", "realms", realm_ca, EF_BAD,
155 UNMAPPED_CACHE(struct realmstr, MAXNOC * MAXNOR,
156 EFF_TYPED | EFF_OWNER)},
157 {EF_GAME, "game", "game", game_ca, EF_BAD,
158 UNMAPPED_CACHE(struct gamestr, 1, EFF_TYPED)},
161 * Static game data (configuration)
164 * Characteristics tables. Characteristics with a null file
165 * member are compiled in. The others are empty; use
166 * read_builtin_tables() to fill them.
168 {EF_ITEM, "item", "item.config", ichr_ca, EF_BAD,
169 ARRAY_CACHE(ichr, EFF_CFG)},
170 {EF_PRODUCT, "product", "product.config", pchr_ca, EF_BAD,
171 ARRAY_CACHE(pchr, EFF_CFG)},
172 {EF_SECTOR_CHR, "sect-chr", "sect.config", dchr_ca, EF_BAD,
173 ARRAY_CACHE(dchr, EFF_CFG)},
174 {EF_SHIP_CHR, "ship-chr", "ship.config", mchr_ca, EF_BAD,
175 ARRAY_CACHE(mchr, EFF_CFG)},
176 {EF_PLANE_CHR, "plane-chr", "plane.config", plchr_ca, EF_BAD,
177 ARRAY_CACHE(plchr, EFF_CFG)},
178 {EF_LAND_CHR, "land-chr", "land.config", lchr_ca, EF_BAD,
179 ARRAY_CACHE(lchr, EFF_CFG)},
180 {EF_NUKE_CHR, "nuke-chr", "nuke.config", nchr_ca, EF_BAD,
181 ARRAY_CACHE(nchr, EFF_CFG)},
182 {EF_NEWS_CHR, "news-chr", NULL, rpt_ca, EF_BAD,
183 ARRAY_TABLE(rpt, N_MAX_VERB + 1, EFF_CFG)},
184 {EF_INFRASTRUCTURE, "infrastructure", "infra.config", intrchr_ca, EF_BAD,
185 ARRAY_CACHE(intrchr, EFF_CFG)},
187 * Update schedule table. Use read_schedule() to fill.
189 {EF_UPDATES, "updates", NULL, update_ca, EF_BAD,
190 ARRAY_CACHE(update_time, EFF_CFG)},
192 * Special tables. EF_META gets bogus size, cids and fids here.
193 * Fixed up by empfile_init(). EF_VERSION's cadef is set by
196 {EF_TABLE, "table", NULL, empfile_ca, EF_BAD,
197 ARRAY_TABLE(empfile, EF_MAX, EFF_CFG)},
198 {EF_VERSION, "version", NULL, NULL, EF_BAD,
199 sizeof(PACKAGE_STRING), -1, EFF_STATIC, version, 1, 0, 1, 1, -1,
200 NULL, NULL, NULL, NULL},
201 {EF_META, "meta", NULL, mdchr_ca, EF_BAD,
202 PTR_CACHE(mdchr_ca, EFF_CFG)},
207 * These get bogus csize, cids and fids here. Fixed up by
210 #define SYMTAB(type, name, tab) {(type), (name), NULL, symbol_ca, EF_BAD, \
211 PTR_CACHE((tab), EFF_CFG)}
212 SYMTAB(EF_AGREEMENT_STATUS, "agreement-status", agreement_statuses),
213 SYMTAB(EF_LAND_CHR_FLAGS, "land-chr-flags", land_chr_flags),
214 SYMTAB(EF_LEVEL, "level", level),
215 SYMTAB(EF_META_FLAGS, "meta-flags", meta_flags),
216 SYMTAB(EF_META_TYPE, "meta-type", meta_type),
217 SYMTAB(EF_MISSIONS, "missions", missions),
218 SYMTAB(EF_NATION_FLAGS, "nation-flags", nation_flags),
219 SYMTAB(EF_NATION_REJECTS, "nation-rejects", nation_rejects),
220 SYMTAB(EF_NATION_RELATIONS, "nation-relationships", nation_relations),
221 SYMTAB(EF_NATION_STATUS, "nation-status", nation_status),
222 SYMTAB(EF_NUKE_CHR_FLAGS, "nuke-chr-flags", nuke_chr_flags),
223 SYMTAB(EF_PACKING, "packing", packing),
224 SYMTAB(EF_PAGE_HEADINGS, "page-headings", page_headings),
225 SYMTAB(EF_PLAGUE_STAGES, "plague-stages", plague_stages),
226 SYMTAB(EF_PLANE_CHR_FLAGS, "plane-chr-flags", plane_chr_flags),
227 SYMTAB(EF_PLANE_FLAGS, "plane-flags", plane_flags),
228 SYMTAB(EF_RESOURCES, "resources", resources),
229 SYMTAB(EF_RETREAT_FLAGS, "retreat-flags", retreat_flags),
230 SYMTAB(EF_SECTOR_NAVIGATION, "sector-navigation", sector_navigation),
231 SYMTAB(EF_SHIP_CHR_FLAGS, "ship-chr-flags", ship_chr_flags),
232 SYMTAB(EF_TREATY_FLAGS, "treaty-flags", treaty_flags),
235 {EF_COUNTRY, "country", NULL, cou_ca, EF_NATION,
236 UNMAPPED_CACHE(struct natstr, MAXNOC, EFF_TYPED | EFF_OWNER)},
239 {EF_BAD, NULL, NULL, NULL, EF_BAD,
240 0, -1, 0, NULL, 0, 0, 0, 0, -1, NULL, NULL, NULL, NULL},
244 ef_fix_size(struct empfile *ep, int n)
246 ep->nent = ep->cids = ep->fids = n;
258 ca = (struct castr *)empfile[EF_META].cache;
259 for (i = 0; ca[i].ca_name; i++) ;
260 ef_fix_size(&empfile[EF_META], i);
262 for (ep = empfile; ep->uid >= 0; ep++) {
263 if (ep->cadef == symbol_ca) {
264 lup = (struct symbol *)ep->cache;
265 for (i = 0; lup[i].name; i++) ;
274 empfile[EF_SECTOR].nent = WORLD_SZ();
275 empfile[EF_MAP].size = empfile[EF_BMAP].size = WORLD_SZ();