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 * xundump.c: Load back xdump output
29 * Known contributors to this file:
30 * Ron Koenderink, 2005
31 * Markus Armbruster, 2005-2011
35 * See doc/xdump! And keep it up-to-date.
37 * Parsing of machine-readable xdump is not precise: it recognizes
38 * comments, accepts whitespace in place of single space, and accepts
39 * the full human-readable field syntax instead of its machine-
43 * - Normalize terminology: table/rows/columns or file/records/fields
44 * - Loading tables with NSC_STRING elements more than once leaks memory
46 * - Check each partial table supplies the same rows
47 * - Check EFF_CFG tables are dense
48 * - Symbolic array indexes
49 * - Option to treat missing and unknown fields as warning, not error
50 * TODO, but hardly worth the effort:
51 * - Permit reordering of array elements
68 static char *fname; /* Name of file being read */
69 static int lineno; /* Current line number */
70 static int human; /* Reading human-readable syntax? */
71 static int ellipsis; /* Header ended with ...? */
72 static int is_partial; /* Is input split into parts? */
73 static int cur_type; /* Current table's file type */
74 static void *cur_obj; /* The object being read into */
75 static int cur_id; /* and its index in the table */
76 static int cur_obj_is_blank;
77 static int nflds; /* #fields in input records */
78 static struct castr **fldca; /* Map field number to selector */
79 static int *fldidx; /* Map field number to index */
80 static int *caflds; /* Map selector number to #fields seen */
81 static int *cafldspp; /* ditto, in previous parts */
83 static int gripe(char *, ...) ATTRIBUTE((format (printf, 1, 2)));
84 static int deffld(int, char *, int);
85 static int defellipsis(void);
86 static int chkflds(void);
87 static int setnum(int, double);
88 static int setstr(int, char *);
89 static int xunsymbol(char *, struct castr *, int);
90 static int setsym(int, char *);
91 static int mtsymset(int, long *);
92 static int add2symset(int, long *, char *);
93 static int xubody(FILE *);
94 static int xutail(FILE *, struct castr *);
97 * Gripe about the current line to stderr, return -1.
100 gripe(char *fmt, ...)
104 fprintf(stderr, "%s:%d: ", fname, lineno);
106 vfprintf(stderr, fmt, ap);
114 * Read and ignore field separators from FP.
115 * Return first character that is not a field separator.
124 } while (ch == ' ' || ch == '\t');
129 } while (ch != EOF && ch != '\n');
136 * Decode escape sequences in BUF.
137 * Return BUF on success, null pointer on failure.
149 if (sscanf(++src, "%3o%n", &octal_chr, &n) != 1 || n != 3)
151 *dst++ = (char)octal_chr;
161 * Read an identifier from FP into BUF.
162 * BUF must have space for 1024 characters.
163 * Return number of characters read on success, -1 on failure.
166 getid(FILE *fp, char *buf)
169 if (fscanf(fp, "%1023[^\"#()<>= \t\n]%n", buf, &n) != 1
177 * Try to read a field name from FP.
178 * I is the field number, counting from zero.
179 * If a name is read, set fldca[I] and fldidx[I] for it, and update
181 * Return 1 if a name or ... was read, 0 on end of line, -1 on error.
184 xufldname(FILE *fp, int i)
192 return gripe("Unexpected EOF");
199 if (getc(fp) != '.' || getc(fp) != '.')
200 return gripe("Junk in header field %d", i + 1);
201 if (defellipsis() < 0)
204 if (ch != EOF && ch != '\n')
205 return gripe("Junk after ...");
210 if (getid(fp, buf) < 0)
211 return gripe("Junk in header field %d", i + 1);
215 return deffld(i, buf, -1);
219 if (isdigit(ch) || ch == '-' || ch == '+') {
220 if (fscanf(fp, "%d", &idx) != 1)
221 return gripe("Malformed number in index of header field %d",
224 return gripe("Index must not be negative in header field %d",
227 if (getid(fp, buf) < 0)
228 return gripe("Malformed index in header field %d", i + 1);
229 return gripe("Symbolic index in header field %d not yet implemented",
234 return gripe("Malformed index in header field %d", i + 1);
235 return deffld(i, buf, idx);
240 * Try to read a field value from FP.
241 * I is the field number, counting from zero.
242 * Return 1 if a value was read, 0 on end of line, -1 on error.
245 xufld(FILE *fp, int i)
255 return gripe("Unexpected EOF");
257 CANT_HAPPEN(i > nflds);
259 if (fldca[i]->ca_type != NSC_STRINGY && fldca[i]->ca_len)
260 return gripe("Field %s(%d) missing",
261 fldca[i]->ca_name, fldidx[i]);
262 return gripe("Field %s missing", fldca[i]->ca_name);
266 case '+': case '-': case '.':
267 case '0': case '1': case '2': case '3': case '4':
268 case '5': case '6': case '7': case '8': case '9':
270 if (fscanf(fp, "%lg", &dbl) != 1)
271 return gripe("Malformed number in field %d", i + 1);
272 return setnum(i, dbl);
279 if (fscanf(fp, "%1023[^\"\n]", buf) != 1 || getc(fp) != '"')
280 return gripe("Malformed string in field %d", i + 1);
282 return gripe("Invalid escape sequence in field %d",
285 return setstr(i, buf);
287 if (mtsymset(i, &set) < 0)
291 if (ch == EOF || ch == '\n')
292 return gripe("Unmatched '(' in field %d", i + 1);
296 if (getid(fp, buf) < 0)
297 return gripe("Junk in field %d", i + 1);
298 if (add2symset(i, &set, buf) < 0)
301 return setnum(i, set);
304 if (getid(fp, buf) < 0)
305 return gripe("Junk in field %d", i + 1);
306 if (!strcmp(buf, "nil"))
307 return setstr(i, NULL);
309 return setsym(i, buf);
314 * Read fields from FP.
315 * Use PARSE() to read each field.
316 * Return number of fields read on success, -1 on error.
319 xuflds(FILE *fp, int (*parse)(FILE *, int))
332 else if (ch != ' ' && ch != '\t')
333 return gripe("Bad field separator after field %d", i + 1);
338 * Define the FLDNO-th field.
339 * If IDX is negative, define as selector NAME, else as NAME(IDX).
340 * Set fldca[FLDNO] and fldidx[FLDNO] accordingly.
342 * Return 1 on success, -1 on error.
345 deffld(int fldno, char *name, int idx)
347 struct castr *ca = ef_cadef(cur_type);
350 res = stmtch(name, ca, offsetof(struct castr, ca_name),
351 sizeof(struct castr));
353 return gripe("Header %s of field %d is %s", name, fldno + 1,
354 res == M_NOTUNIQUE ? "ambiguous" : "unknown");
355 if (ca[res].ca_flags == NSC_EXTRA || CANT_HAPPEN(ca[res].ca_get))
356 return gripe("Extraneous header %s in field %d", name, fldno + 1);
357 if (ca[res].ca_type != NSC_STRINGY && ca[res].ca_len != 0) {
359 return gripe("Header %s requires an index in field %d",
360 ca[res].ca_name, fldno + 1);
361 if (idx >= ca[res].ca_len)
362 return gripe("Header %s(%d) index out of bounds in field %d",
363 ca[res].ca_name, idx, fldno + 1);
364 if (idx < caflds[res])
365 return gripe("Duplicate header %s(%d) in field %d",
366 ca[res].ca_name, idx, fldno + 1);
367 if (idx > caflds[res])
368 return gripe("Expected header %s(%d) in field %d",
369 ca[res].ca_name, caflds[res], fldno + 1);
372 return gripe("Header %s doesn't take an index in field %d",
373 ca[res].ca_name, fldno + 1);
376 return gripe("Duplicate header %s in field %d",
377 ca[res].ca_name, fldno + 1);
379 fldca[fldno] = &ca[res];
386 * Record that header ends with ...
387 * Set ellipsis and is_partial.
388 * Return 0 on success, -1 on error.
393 struct castr *ca = ef_cadef(cur_type);
395 if (ca[0].ca_table != cur_type)
396 return gripe("Table %s doesn't support ...", ef_nameof(cur_type));
397 ellipsis = is_partial = 1;
402 * Check fields in xdump are sane.
403 * Return 0 on success, -1 on error.
408 struct castr *ca = ef_cadef(cur_type);
409 int i, len, cafldsmax, res = 0;
411 /* Record index must come first, to make cur_id work, see setnum() */
412 if (ca[0].ca_table == cur_type && caflds[0] && fldca[0] != &ca[0])
413 res = gripe("Header field %s must come first", ca[0].ca_name);
416 /* Need a join field, use 0-th selector */
418 res = gripe("Header field %s required in each table part",
423 return res; /* table is split, another part expected */
425 /* Check for missing fields */
426 for (i = 0; ca[i].ca_name; i++) {
427 cafldsmax = MAX(caflds[i], cafldspp[i]);
428 if (ca[i].ca_flags & NSC_EXTRA)
430 len = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
431 if (!len && !cafldsmax)
432 res = gripe("Header field %s missing", ca[i].ca_name);
433 else if (len && cafldsmax == len - 1)
434 res = gripe("Header field %s(%d) missing",
435 ca[i].ca_name, len - 1);
436 else if (len && cafldsmax < len - 1)
437 res = gripe("Header fields %s(%d) ... %s(%d) missing",
438 ca[i].ca_name, cafldsmax, ca[i].ca_name, len - 1);
445 * Get selector for field FLDNO.
446 * Assign the field's selector index to *IDX, unless it is null.
447 * Return the selector on success, null pointer on error.
449 static struct castr *
450 getfld(int fldno, int *idx)
452 if (fldno >= nflds) {
453 gripe("Too many fields, expected only %d", nflds);
456 if (CANT_HAPPEN(fldno < 0))
459 *idx = fldidx[fldno];
464 * Is a new value for field FLDNO required to match the old one?
467 fldval_must_match(int fldno)
469 struct castr *ca = ef_cadef(cur_type);
470 int i = fldca[fldno] - ca;
473 * Value must match if:
474 * it's for a const selector, unless the object is still blank, or
475 * it was already given in a previous part of a split table.
477 return (!cur_obj_is_blank && (fldca[fldno]->ca_flags & NSC_CONST))
478 || fldidx[fldno] < cafldspp[i];
482 * Get the current object.
483 * Store it in cur_obj, and set cur_obj_is_blank accordingly.
484 * Return cur_obj, which is null on error.
489 struct empfile *ep = &empfile[cur_type];
492 cur_obj_is_blank = cur_id >= ep->fids;
493 if (cur_obj_is_blank) {
494 if (ef_ensure_space(cur_type, cur_id, 1))
495 cur_obj = ef_ptr(cur_type, cur_id);
496 /* FIXME diagnose out of dynamic memory vs. static table full */
498 gripe("Can't put ID %d into table %s, it holds only 0..%d.",
499 cur_id, ep->name, ep->fids - 1);
501 cur_obj = ef_ptr(cur_type, cur_id);
508 * Set value of field FLDNO in current object to DBL.
509 * Return 1 on success, -1 on error.
512 setnum(int fldno, double dbl)
519 ca = getfld(fldno, &idx);
524 * If this is the record index, put it into cur_id.
526 if (fldno == 0 && ca->ca_table == cur_type) {
527 if (dbl < 0 || (int)dbl != dbl)
528 return gripe("Field %d can't hold this value", fldno + 1);
535 memb_ptr += ca->ca_off;
537 switch (ca->ca_type) {
539 old = ((signed char *)memb_ptr)[idx];
540 new = ((signed char *)memb_ptr)[idx] = (signed char)dbl;
544 old = ((unsigned char *)memb_ptr)[idx];
545 new = ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
548 old = ((short *)memb_ptr)[idx];
549 new = ((short *)memb_ptr)[idx] = (short)dbl;
552 old = ((unsigned short *)memb_ptr)[idx];
553 new = ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
556 old = ((int *)memb_ptr)[idx];
557 new = ((int *)memb_ptr)[idx] = (int)dbl;
560 old = ((long *)memb_ptr)[idx];
561 new = ((long *)memb_ptr)[idx] = (long)dbl;
564 old = ((coord *)memb_ptr)[idx];
565 /* FIXME use variant of xrel() that takes orig instead of nation */
566 if (old >= WORLD_X / 2)
568 new = ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
569 if (new >= WORLD_X / 2)
573 old = ((coord *)memb_ptr)[idx];
574 /* FIXME use variant of yrel() that takes orig instead of nation */
575 if (old >= WORLD_Y / 2)
577 new = ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
578 if (new >= WORLD_Y / 2)
582 old = ((float *)memb_ptr)[idx];
583 ((float *)memb_ptr)[idx] = (float)dbl;
584 new = dbl; /* suppress new != dbl check */
587 old = ((double *)memb_ptr)[idx];
588 ((double *)memb_ptr)[idx] = dbl;
589 new = dbl; /* suppress new != dbl check */
592 old = ((time_t *)memb_ptr)[idx];
593 new = ((time_t *)memb_ptr)[idx] = (time_t)dbl;
596 return gripe("Field %d doesn't take numbers", fldno + 1);
599 if (fldval_must_match(fldno) && old != dbl)
600 return gripe("Value for field %d must be %g", fldno + 1, old);
602 return gripe("Field %d can't hold this value", fldno + 1);
608 * Set value of field FLDNO in current object to STR.
609 * Return 1 on success, -1 on error.
612 setstr(int fldno, char *str)
617 char *memb_ptr, *old;
619 ca = getfld(fldno, &idx);
626 memb_ptr += ca->ca_off;
627 must_match = fldval_must_match(fldno);
629 switch (ca->ca_type) {
631 old = ((char **)memb_ptr)[idx];
633 /* FIXME may leak old value */
634 ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
635 len = 65535; /* really SIZE_MAX, but that's C99 */
638 if (CANT_HAPPEN(idx))
641 return gripe("Field %d doesn't take nil", fldno + 1);
643 if (strlen(str) > len)
644 return gripe("Field %d takes at most %d characters",
645 fldno + 1, (int)len);
648 strncpy(memb_ptr, str, len);
651 return gripe("Field %d doesn't take strings", fldno + 1);
655 if (old && (!str || strncmp(old, str, len)))
656 return gripe("Value for field %d must be \"%.*s\"",
657 fldno + 1, (int)len, old);
659 return gripe("Value for field %d must be nil", fldno + 1);
666 * Resolve symbol name ID in table referred to by CA.
667 * Use field number N for error messages.
668 * Return index in referred table on success, -1 on failure.
671 xunsymbol(char *id, struct castr *ca, int n)
673 int i = ef_elt_byname(ca->ca_table, id);
675 return gripe("%s %s symbol `%s' in field %d",
676 i == M_NOTUNIQUE ? "Ambiguous" : "Unknown",
677 ca->ca_name, id, n + 1);
682 * Map symbol index to symbol value.
683 * CA is the table, and I is the index in it.
686 symval(struct castr *ca, int i)
688 int type = ca->ca_table;
690 if (type != EF_BAD && ef_cadef(type) == symbol_ca)
691 /* symbol table, value is in the table */
692 return ((struct symbol *)ef_ptr(type, i))->value;
693 /* value is the table index */
698 * Set value of field FLDNO in current object to value of symbol SYM.
699 * Return 1 on success, -1 on error.
702 setsym(int fldno, char *sym)
707 ca = getfld(fldno, NULL);
711 if (ca->ca_table == EF_BAD || (ca->ca_flags & NSC_BITS))
712 return gripe("Field %d doesn't take symbols", fldno + 1);
714 i = xunsymbol(sym, ca, fldno);
717 return setnum(fldno, symval(ca, i));
721 * Create an empty symbol set for field FLDNO in *SET.
722 * Return 1 on success, -1 on error.
725 mtsymset(int fldno, long *set)
729 ca = getfld(fldno, NULL);
733 if (ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca
734 || !(ca->ca_flags & NSC_BITS))
735 return gripe("Field %d doesn't take symbol sets", fldno + 1);
741 * Add a symbol to a symbol set for field FLDNO in *SET.
742 * SYM is the name of the symbol to add.
743 * Return 1 on success, -1 on error.
746 add2symset(int fldno, long *set, char *sym)
751 ca = getfld(fldno, NULL);
755 i = xunsymbol(sym, ca, fldno);
758 *set |= symval(ca, i);
763 * Read an xdump table header line from FP.
764 * Expect header for EXPECTED_TABLE, unless it is EF_BAD.
765 * Recognize header for machine- and human-readable syntax, and set
767 * Return table type on success, -2 on EOF before header, -1 on failure.
770 xuheader(FILE *fp, int expected_table)
776 while ((ch = skipfs(fp)) == '\n')
778 if (ch == EOF && expected_table == EF_BAD)
785 ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
786 : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
787 name, &res) != 1) || res < 0)
788 return gripe("Expected xdump header");
790 type = ef_byname(name);
792 return gripe("Unknown table `%s'", name);
793 if (expected_table != EF_BAD && expected_table != type)
794 return gripe("Expected table `%s', not `%s'",
795 ef_nameof(expected_table), name);
797 if (!empfile[type].file
798 || !ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
799 CANT_HAPPEN(expected_table != EF_BAD);
800 return gripe("Table `%s' is not permitted here", name);
803 if (skipfs(fp) != '\n')
804 return gripe("Junk after xdump header");
811 * Find fields in this xdump.
812 * If reading human-readable syntax, read a field header line from FP.
813 * Else take fields from the table's selectors in CA[].
814 * Set ellipsis, nflds, fldca[], fldidx[] and caflds[] accordingly.
815 * Return 0 on success, -1 on failure.
818 xufldhdr(FILE *fp, struct castr ca[])
824 for (i = 0; ca[i].ca_name; i++)
829 while ((ch = skipfs(fp)) == '\n')
832 nflds = xuflds(fp, xufldname);
835 nflds -= ellipsis != 0;
840 for (i = 0; ca[i].ca_name; i++) {
841 if ((ca[i].ca_flags & NSC_EXTRA))
843 n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
851 nflds = fidx - fldidx;
858 * Read xdump footer from FP.
859 * CA[] contains the table's selectors.
860 * The body had RECS records.
861 * Update cafldspp[] from caflds[].
862 * Return 0 on success, -1 on failure.
865 xufooter(FILE *fp, struct castr ca[], int recs)
871 if (fscanf(fp, "config%n", &res) != 0 || res < 0)
872 return gripe("Malformed table footer");
874 if (fscanf(fp, "%d", &n) != 1)
875 return gripe("Malformed table footer");
877 return gripe("Read %d rows, which doesn't match footer "
880 if (skipfs(fp) != '\n')
881 return gripe("Junk after table footer");
884 for (i = 0; ca[i].ca_name; i++) {
885 if (cafldspp[i] < caflds[i])
886 cafldspp[i] = caflds[i];
893 * Read an xdump table from FP.
894 * Both machine- and human-readable xdump syntax are recognized.
895 * Expect table EXPECTED_TABLE, unless it is EF_BAD.
896 * Report errors to stderr.
897 * Messages assume FP starts in the file FILE at line *PLNO.
898 * Update *PLNO to reflect lines read from FP.
899 * Return table type on success, -2 on EOF before header, -1 on failure.
902 xundump(FILE *fp, char *file, int *plno, int expected_table)
905 int type, nca, nf, i, ch;
910 if ((type = xuheader(fp, expected_table)) < 0)
914 if (CANT_HAPPEN(!ca))
918 for (i = 0; ca[i].ca_name; i++) {
920 if (!(ca[i].ca_flags & NSC_EXTRA))
921 nf += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
923 fldca = malloc(nf * sizeof(*fldca));
924 fldidx = malloc(nf * sizeof(*fldidx));
925 caflds = malloc(nca * sizeof(*caflds));
926 cafldspp = calloc(nca, sizeof(*cafldspp));
929 if (xutail(fp, ca) < 0)
937 /* Skip empty lines so that callers can easily check for EOF */
938 while ((ch = skipfs(fp)) == '\n')
947 * Read the remainder of an xdump after the table header line from FP.
948 * CA[] contains the table's selectors.
949 * Return 0 on success, -1 on failure.
952 xutail(FILE *fp, struct castr *ca)
958 if (xufldhdr(fp, ca) < 0)
960 if ((recs = xubody(fp)) < 0)
962 if (xufooter(fp, ca, recs) < 0)
966 if (xuheader(fp, cur_type) < 0)
972 * Read the body of an xdump table from FP.
973 * Return number of rows read on success, -1 on failure.
978 struct empfile *ep = &empfile[cur_type];
983 while ((ch = skipfs(fp)) == '\n')
990 if (xuflds(fp, xufld) < 0)
992 maxid = MAX(maxid, cur_id + 1);
995 if (CANT_HAPPEN(maxid > ep->fids))
997 if (maxid < ep->fids) {
998 if (EF_IS_GAME_STATE(cur_type)
999 || (cur_type >= EF_SHIP_CHR && cur_type <= EF_NUKE_CHR)) {
1000 if (!ef_truncate(cur_type, maxid))
1003 return gripe("Table %s requires %d rows, got %d",
1004 ef_nameof(cur_type), ep->fids, maxid);