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
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.
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, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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.
28 * xundump.c: Load back xdump output
30 * Known contributors to this file:
31 * Ron Koenderink, 2005
32 * Markus Armbruster, 2005-2007
37 * - Normalize terminology: table/rows/columns or file/records/fields
38 * - Loading tables with NSC_STRING elements more than once leaks memory
40 * - Check each partial table supplies the same rows
41 * - Check EFF_CFG tables are dense
42 * - Symbolic references to non-symbol tables
43 * - Symbolic array indexes
44 * TODO, but hardly worth the effort:
45 * - Permit reordering of array elements
46 * - Permit repetition of array elements in split tables
59 #include "prototypes.h"
64 static int ellipsis, is_partial;
65 static int cur_type, cur_id;
67 static int cur_obj_is_blank;
69 static struct castr **fldca;
72 static unsigned char *caseen;
74 static int gripe(char *, ...) ATTRIBUTE((format (printf, 1, 2)));
75 static int deffld(int, char *, int);
76 static int defellipsis(int fldno);
77 static int chkflds(void);
78 static int setnum(int, double);
79 static int setstr(int, char *);
80 static int xunsymbol(char *, struct castr *, int);
81 static int setsym(int, char *);
82 static int mtsymset(int, long *);
83 static int add2symset(int, long *, char *);
84 static int xubody(FILE *);
85 static int xutail(FILE *, int, struct castr *);
92 fprintf(stderr, "%s:%d: ", fname, lineno);
94 vfprintf(stderr, fmt, ap);
108 } while (ch == ' ' || ch == '\t');
113 } while (ch != EOF && ch != '\n');
120 getid(FILE *fp, char *buf)
123 if (fscanf(fp, "%1023[^#()<>=#\" \t\n]%n", buf, &n) != 1
139 if (sscanf(++src, "%3o%n", &octal_chr, &n) != 1 || n != 3)
141 *dst++ = (char)octal_chr;
151 xufldname(FILE *fp, int i)
159 return gripe("Unexpected EOF");
166 if (getc(fp) != '.' || getc(fp) != '.')
167 return gripe("Junk in header field %d", i + 1);
169 return gripe("... not allowed in field 1");
170 if (defellipsis(i) < 0)
173 if (ch != EOF && ch != '\n')
174 return gripe("Junk after ...");
179 if (getid(fp, buf) < 0)
180 return gripe("Junk in header field %d", i + 1);
184 return deffld(i, buf, -1);
188 if (isdigit(ch) || ch == '-' || ch == '+') {
189 if (fscanf(fp, "%d", &idx) != 1)
190 return gripe("Malformed number in index of header field %d",
193 return gripe("Index must not be negative in header field %d",
196 if (getid(fp, buf) < 0)
197 return gripe("Malformed index in header field %d", i + 1);
198 return gripe("Symbolic index in header field %d not yet implemented",
203 return gripe("Malformed index in header field %d", i + 1);
204 return deffld(i, buf, idx);
209 xufld(FILE *fp, int i)
219 return gripe("Unexpected EOF");
222 if (fldca[i]->ca_type != NSC_STRINGY && fldca[i]->ca_len)
223 return gripe("Field %s(%d) missing",
224 fldca[i]->ca_name, fldidx[i]);
225 return gripe("Field %s missing", fldca[i]->ca_name);
229 case '+': case '-': case '.':
230 case '0': case '1': case '2': case '3': case '4':
231 case '5': case '6': case '7': case '8': case '9':
233 if (fscanf(fp, "%lg", &dbl) != 1)
234 return gripe("Malformed number in field %d", i + 1);
235 return setnum(i, dbl);
242 if (fscanf(fp, "%1023[^\"\n]", buf) != 1 || getc(fp) != '"')
243 return gripe("Malformed string in field %d", i + 1);
245 return gripe("Invalid escape sequence in field %d",
248 return setstr(i, buf);
250 if (mtsymset(i, &set) < 0)
254 if (ch == EOF || ch == '\n')
255 return gripe("Unmatched '(' in field %d", i + 1);
259 if (getid(fp, buf) < 0)
260 return gripe("Junk in field %d", i + 1);
261 if (add2symset(i, &set, buf) < 0)
264 return setnum(i, set);
267 if (getid(fp, buf) < 0)
268 return gripe("Junk in field %d", i + 1);
269 if (!strcmp(buf, "nil"))
270 return setstr(i, NULL);
272 return setsym(i, buf);
277 xuflds(FILE *fp, int (*parse)(FILE *, int))
290 else if (ch != ' ' && ch != '\t')
291 return gripe("Bad field separator after field %d", i + 1);
296 deffld(int fldno, char *name, int idx)
298 struct castr *ca = ef_cadef(cur_type);
301 res = stmtch(name, ca, offsetof(struct castr, ca_name),
302 sizeof(struct castr));
304 return gripe("Header %s of field %d is %s", name, fldno + 1,
305 res == M_NOTUNIQUE ? "ambiguous" : "unknown");
306 if (ca[res].ca_type != NSC_STRINGY && ca[res].ca_len != 0) {
308 return gripe("Header %s requires an index in field %d",
309 ca[res].ca_name, fldno + 1);
310 if (idx >= ca[res].ca_len)
311 return gripe("Header %s(%d) index out of bounds in field %d",
312 ca[res].ca_name, idx, fldno + 1);
313 if (idx < caflds[res])
314 return gripe("Duplicate header %s(%d) in field %d",
315 ca[res].ca_name, idx, fldno + 1);
316 if (idx > caflds[res])
317 return gripe("Expected header %s(%d) in field %d",
318 ca[res].ca_name, caflds[res], fldno + 1);
321 return gripe("Header %s doesn't take an index in field %d",
322 ca[res].ca_name, fldno + 1);
324 if (caflds[res] && !caseen[res])
325 /* FIXME doesn't catch dupes within table part when caseen[res] */
326 return gripe("Duplicate header %s in field %d",
327 ca[res].ca_name, fldno + 1);
329 fldca[fldno] = &ca[res];
337 defellipsis(int fldno)
339 struct castr *ca = ef_cadef(cur_type);
341 if (ca[0].ca_table != cur_type)
342 return gripe("Table %s doesn't support ...", ef_nameof(cur_type));
351 struct castr *ca = ef_cadef(cur_type);
355 /* Require index field */
357 return gripe("Header field %s required with ...", ca[0].ca_name);
358 /* Want the index field again in continued table: */
363 for (i = 0; ca[i].ca_name; i++) {
364 if (ca[i].ca_flags & NSC_EXTRA)
366 len = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
367 if (!len && !caflds[i])
368 res = gripe("Header field %s missing", ca[i].ca_name);
369 else if (len && caflds[i] == len - 1)
370 res = gripe("Header field %s(%d) missing",
371 ca[i].ca_name, len - 1);
372 else if (len && caflds[i] < len - 1)
373 res = gripe("Header fields %s(%d) ... %s(%d) missing",
374 ca[i].ca_name, caflds[i], ca[i].ca_name, len - 1);
380 static struct castr *
381 getfld(int fldno, int *idx)
383 if (fldno >= nflds) {
384 gripe("Too many fields, expected only %d", nflds);
387 if (CANT_HAPPEN(fldno < 0))
390 *idx = fldidx[fldno];
395 fldval_must_match(int fldno)
397 struct castr *ca = ef_cadef(cur_type);
398 int i = fldca[fldno] - ca;
400 return (!cur_obj_is_blank && (fldca[fldno]->ca_flags & NSC_CONST))
407 struct empfile *ep = &empfile[cur_type];
408 int need_sentinel = !EF_IS_GAME_STATE(cur_type);
411 cur_obj_is_blank = cur_id >= ep->fids;
412 if (cur_obj_is_blank) {
413 /* TODO grow cache (and posssibly file) unless EFF_STATIC */
414 if (cur_id < ep->csize - !!need_sentinel)
415 ep->cids = ep->fids = cur_id + 1;
416 /* else: ef_ptr() will fail */
418 cur_obj = ef_ptr(cur_type, cur_id);
420 gripe("Can't put ID %d into table %s, it holds only 0..%d.",
421 cur_id, ep->name, ep->fids - 1);
428 setnum(int fldno, double dbl)
435 ca = getfld(fldno, &idx);
440 * If this is the record index, put it into cur_id.
442 if (fldno == 0 && ca->ca_table == cur_type)
448 memb_ptr += ca->ca_off;
450 /* FIXME check assignment preserves value */
451 switch (ca->ca_type) {
453 old = ((signed char *)memb_ptr)[idx];
454 ((signed char *)memb_ptr)[idx] = (signed char)dbl;
458 old = ((unsigned char *)memb_ptr)[idx];
459 ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
462 old = ((short *)memb_ptr)[idx];
463 ((short *)memb_ptr)[idx] = (short)dbl;
466 old = ((unsigned short *)memb_ptr)[idx];
467 ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
470 old = ((int *)memb_ptr)[idx];
471 ((int *)memb_ptr)[idx] = (int)dbl;
474 old = ((long *)memb_ptr)[idx];
475 ((long *)memb_ptr)[idx] = (long)dbl;
478 old = ((coord *)memb_ptr)[idx];
479 /* FIXME use variant of xrel() that takes orig instead of nation */
480 if (old >= WORLD_X / 2)
482 ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
485 old = ((coord *)memb_ptr)[idx];
486 /* FIXME use variant of yrel() that takes orig instead of nation */
487 if (old >= WORLD_Y / 2)
489 ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
492 old = ((float *)memb_ptr)[idx];
493 ((float *)memb_ptr)[idx] = (float)dbl;
496 old = ((double *)memb_ptr)[idx];
497 ((double *)memb_ptr)[idx] = dbl;
500 old = ((time_t *)memb_ptr)[idx];
501 ((time_t *)memb_ptr)[idx] = (time_t)dbl;
504 return gripe("Field %d doesn't take numbers", fldno + 1);
507 if (fldval_must_match(fldno) && old != dbl)
508 return gripe("Value for field %d must be %g", fldno + 1, old);
514 setstr(int fldno, char *str)
519 char *memb_ptr, *old;
521 ca = getfld(fldno, &idx);
528 memb_ptr += ca->ca_off;
529 must_match = fldval_must_match(fldno);
531 switch (ca->ca_type) {
533 old = ((char **)memb_ptr)[idx];
535 ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
536 len = 65535; /* really SIZE_MAX, but that's C99 */
539 if (CANT_HAPPEN(idx))
542 return gripe("Field %d doesn't take nil", fldno + 1);
544 if (strlen(str) > len)
545 return gripe("Field %d takes at most %d characters",
546 fldno + 1, (int)len);
549 strncpy(memb_ptr, str, len);
552 return gripe("Field %d doesn't take strings", fldno + 1);
556 if (old && (!str || strncmp(old, str, len)))
557 return gripe("Value for field %d must be \"%.*s\"",
558 fldno + 1, (int)len, old);
560 return gripe("Value for field %d must be nil", fldno + 1);
567 xunsymbol(char *id, struct castr *ca, int n)
569 int i = ef_elt_byname(ca->ca_table, id);
571 return gripe("%s %s symbol `%s' in field %d",
572 i == M_NOTUNIQUE ? "Ambiguous" : "Unknown",
573 ca->ca_name, id, n + 1);
578 symval(struct castr *ca, int i)
580 int type = ca->ca_table;
582 if (ef_check(type) < 0)
584 if (ef_cadef(type) == symbol_ca)
585 /* symbol table, value is in the table */
586 return ((struct symbol *)ef_ptr(type, i))->value;
587 /* value is the table index */
592 setsym(int fldno, char *sym)
597 ca = getfld(fldno, NULL);
601 if (ca->ca_table == EF_BAD || (ca->ca_flags & NSC_BITS))
602 return gripe("Field %d doesn't take symbols", fldno + 1);
604 i = xunsymbol(sym, ca, fldno);
607 return setnum(fldno, symval(ca, i));
611 mtsymset(int fldno, long *set)
615 ca = getfld(fldno, NULL);
619 if (ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca
620 || !(ca->ca_flags & NSC_BITS))
621 return gripe("Field %d doesn't take symbol sets", fldno + 1);
627 add2symset(int fldno, long *set, char *sym)
632 ca = getfld(fldno, NULL);
636 i = xunsymbol(sym, ca, fldno);
639 *set |= symval(ca, i);
644 xuheader(FILE *fp, int expected_table)
650 while ((ch = skipfs(fp)) == '\n')
652 if (ch == EOF && expected_table == EF_BAD)
659 ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
660 : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
661 name, &res) != 1) || res < 0)
662 return gripe("Expected xdump header");
664 type = ef_byname(name);
666 return gripe("Unknown table `%s'", name);
667 if (expected_table != EF_BAD && expected_table != type)
668 return gripe("Expected table `%s', not `%s'",
669 ef_nameof(expected_table), name);
671 if (!ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
672 CANT_HAPPEN(expected_table != EF_BAD);
673 return gripe("Table `%s' is not permitted here", name);
676 if (skipfs(fp) != '\n')
677 return gripe("Junk after xdump header");
684 xufldhdr(FILE *fp, struct castr ca[])
691 while ((ch = skipfs(fp)) == '\n')
695 nflds = xuflds(fp, xufldname);
698 nflds -= ellipsis != 0;
703 for (i = 0; ca[i].ca_name; i++) {
704 if ((ca[i].ca_flags & NSC_EXTRA))
706 n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
714 nflds = fidx - fldidx;
721 xufooter(FILE *fp, int row)
727 if (fscanf(fp, "config%n", &res) != 0 || res < 0)
728 return gripe("Malformed table footer");
730 if (fscanf(fp, "%d", &rows) != 1)
731 return gripe("Malformed table footer");
733 return gripe("Read %d rows, which doesn't match footer "
734 "%d rows", row, rows);
736 if (skipfs(fp) != '\n')
737 return gripe("Junk after table footer");
744 xundump(FILE *fp, char *file, int *plno, int expected_table)
747 int type, nca, nf, i, ch;
752 if ((type = xuheader(fp, expected_table)) < 0)
756 if (CANT_HAPPEN(!ca))
760 for (i = 0; ca[i].ca_name; i++) {
762 if (!(ca[i].ca_flags & NSC_EXTRA))
763 nf += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
765 fldca = calloc(nf, sizeof(*fldca));
766 fldidx = calloc(nf, sizeof(*fldidx));
767 caflds = calloc(nca, sizeof(*caflds));
768 caseen = calloc(nca, sizeof(*caseen));
771 if (xutail(fp, type, ca) < 0)
779 /* Skip empty lines so that callers can easily check for EOF */
780 while ((ch = skipfs(fp)) == '\n')
789 xutail(FILE *fp, int type, struct castr *ca)
795 if (xufldhdr(fp, ca) < 0)
797 if ((recs = xubody(fp)) < 0)
799 if (xufooter(fp, recs) < 0)
803 for (i = 0; ca[i].ca_name; i++)
804 caseen[i] = caflds[i] != 0;
805 if (xuheader(fp, type) < 0)
813 struct empfile *ep = &empfile[cur_type];
814 int need_sentinel = !EF_IS_GAME_STATE(cur_type);
818 for (row = 0;; ++row) {
819 while ((ch = skipfs(fp)) == '\n')
826 if (xuflds(fp, xufld) < 0)
828 n = MAX(n, cur_id + 1);
831 if (CANT_HAPPEN(n > ep->fids))
834 if (EF_IS_GAME_STATE(cur_type) && n != ep->csize)
835 /* TODO truncate file */
836 gripe("Warning: should resize table %s from %d to %d, not implemented",
837 ef_nameof(cur_type), ep->csize, n);
838 else if (cur_type >= EF_SHIP_CHR && cur_type <= EF_NUKE_CHR)
839 ep->cids = ep->fids = n;
841 return gripe("Table %s requires %d rows, got %d",
842 ef_nameof(cur_type), ep->fids, n);
846 if (CANT_HAPPEN(n >= ep->csize))
847 return gripe("No space for sentinel");
848 memset(ep->cache + ep->size * n, 0, ep->size);