2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2020, 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-2016
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 * - Symbolic array indexes
47 * - Option to treat missing and unknown fields as warning, not error
48 * TODO, but hardly worth the effort:
49 * - Permit reordering of array elements
67 static char *fname; /* Name of file being read */
68 static int lineno; /* Current line number */
70 static int cur_type; /* Current table's file type */
71 static int partno; /* Counts from 0..#parts-1 */
72 static int cur_id; /* and its index in the table */
74 static unsigned char *idgap; /* idgap && idgap[ID] iff part#0 lacks ID */
75 static int idgap_len; /* #elements in idgap[] */
77 static int human; /* Reading human-readable syntax? */
78 static int ellipsis; /* Header ended with ...? */
79 static int nflds; /* #fields in input records */
80 static struct castr **fldca; /* Map field number to selector */
81 static int *fldidx; /* Map field number to index */
82 static struct valstr *fldval; /* Map field number to value */
83 static int *caflds; /* Map selector number to #fields seen */
84 static int *cafldspp; /* ditto, in previous parts */
86 static int gripe(char *, ...) ATTRIBUTE((format (printf, 1, 2)));
87 static int deffld(int, char *, int);
88 static int chkflds(void);
89 static int setnum(int, double);
90 static int setstr(int, char *);
91 static int setsym(int, char *);
92 static int mtsymset(int, long *);
93 static int add2symset(int, long *, char *);
94 static int xubody(FILE *);
95 static int xutail(FILE *, struct castr *);
98 * Does the code hardcode indexes for table @type?
101 have_hardcoded_indexes(int type)
103 return type == EF_ITEM || type == EF_SECTOR_CHR
104 || type == EF_INFRASTRUCTURE;
108 * Okay to truncate table @type?
111 may_truncate(int type)
113 return empfile[type].nent < 0 && !have_hardcoded_indexes(type);
117 * Is @type's 0-th selector a usable ID?
122 struct castr *ca = ef_cadef(type);
124 return ca[0].ca_table == type && ca[0].ca_dump <= CA_DUMP_CONST;
128 * Can we fill in gaps in table @type?
131 can_fill_gaps(int type)
133 return (ca0_is_id(type) || type == EF_SECTOR || type == EF_REALM)
134 && !have_hardcoded_indexes(type);
138 * Is table @type's @id-th record @obj redundant for xundump()?
141 xundump_redundant(int type, int id, void *obj)
143 char buf[EF_WITH_CADEF_MAX_ENTRY_SIZE];
145 if (!can_fill_gaps(type))
148 if (may_truncate(type) && id == ef_nelem(type) - 1)
151 ef_blank(type, id, buf);
152 if (ef_flags(type) & EFF_TYPED)
153 return ef_typedstr_eq((struct ef_typedstr *)buf,
154 (struct ef_typedstr *)obj);
155 return !memcmp(obj, buf, empfile[type].size);
159 * Gripe about the current line to stderr, return -1.
162 gripe(char *fmt, ...)
166 fprintf(stderr, "%s:%d: ", fname, lineno);
168 vfprintf(stderr, fmt, ap);
175 /* Make TYPE the current table. */
182 old_nelem = type == EF_BAD ? 0 : ef_nelem(type);
187 /* End the current table. */
196 * Seek to current table's @id-th object.
197 * Extend the table if necessary.
198 * Save @id in @cur_id.
199 * Return the object on success, NULL on failure.
206 if (id >= ef_nelem(cur_type)) {
207 if (!ef_ensure_space(cur_type, id, 1)) {
208 gripe("can't grow table to hold this row");
213 obj = ef_ptr(cur_type, id);
214 if (CANT_HAPPEN(!obj))
222 * Reset the omitted objects to default state.
225 omit_ids(int id1, int id2)
232 idgap = realloc(idgap, id2 * sizeof(*idgap));
233 for (i = idgap_len; i < id1; i++)
235 for (i = id1; i < id2; i++) {
236 ef_blank(cur_type, i, ef_ptr(cur_type, i));
243 * Return the smallest non-omitted ID in @id1..@id2-1 if any, else -1.
246 expected_id(int id1, int id2)
250 for (i = id1; i < id2; i++) {
251 if (i >= idgap_len || !idgap[i])
259 * If the table has variable length, truncate it.
260 * Else ensure we're omitting the same objects as the previous parts.
261 * Reset any omitted objects to default state.
262 * Return 0 on success, -1 on failure.
267 struct empfile *ep = &empfile[cur_type];
269 if (cur_id + 1 < ep->fids) {
271 if (may_truncate(cur_type)) {
272 if (!ef_truncate(cur_type, cur_id + 1))
275 if (!can_fill_gaps(cur_type))
276 return gripe("expected %d more rows",
277 ep->fids - (cur_id + 1));
278 omit_ids(cur_id + 1, ep->fids);
281 if (expected_id(cur_id + 1, ep->fids) >= 0)
282 return gripe("table's first part has more rows");
292 * Get selector for field @fldno.
293 * Assign the field's selector index to *@idx, unless it is null.
294 * Return the selector on success, null pointer on error.
296 static struct castr *
297 getfld(int fldno, int *idx)
299 if (fldno >= nflds) {
300 gripe("too many fields, expected only %d", nflds);
303 if (CANT_HAPPEN(fldno < 0))
306 *idx = fldidx[fldno];
311 * Find the field for selector @ca with index @idx.
312 * Return the field number if it exists, else -1.
315 fld_find(struct castr *ca, int idx)
319 for (i = 0; i < nflds; i++) {
320 if (fldca[i] == ca && fldidx[i] == idx)
327 * Get the current row's ID.
328 * Current table's 0-th selector must be a usable ID.
329 * Return ID on success, -1 on failure.
334 struct castr *ca = ef_cadef(cur_type);
335 int fldno, id, max_id;
337 if (CANT_HAPPEN(partno != 0 || !ca0_is_id(cur_type)))
340 fldno = fld_find(ca, 0);
342 return cur_id + 1; /* ID not specified */
344 * Field values not representable as int will be rejected by
345 * putnum() or putstr(). Leave the error reporting to them, and
346 * simply pick the next ID here.
348 if (fldval[fldno].val_type != NSC_DOUBLE)
350 id = fldval[fldno].val_as.dbl;
351 if (id != fldval[fldno].val_as.dbl)
354 if (id != cur_id + 1 && !can_fill_gaps(cur_type))
355 return gripe("expected %d in field %d",
356 cur_id + 1, fldno + 1);
358 return gripe("field %d must be > %d", fldno + 1, cur_id);
359 max_id = ef_id_limit(cur_type);
361 return gripe("field %d must be <= %d", fldno + 1, max_id);
367 * Find the field @name with index @idx and value representable as long.
368 * Return the field number if it exists, else -1.
371 fld_find_long_by_name(char *name, int idx)
375 for (i = 0; i < nflds; i++) {
376 if (!strcmp(fldca[i]->ca_name, name) && fldidx[i] == idx)
380 if (i == nflds || fldval[i].val_type != NSC_DOUBLE
381 || (long)fldval[i].val_as.dbl != fldval[i].val_as.dbl)
387 * Get the current row's ID.
388 * Current table's type must be EF_SECTOR.
389 * Return ID on success, -1 on failure.
394 int fldno_x, fldno_y, id;
397 if (CANT_HAPPEN(partno != 0 || cur_type != EF_SECTOR))
400 fldno_x = fld_find_long_by_name("xloc", 0);
401 fldno_y = fld_find_long_by_name("yloc", 0);
402 if (fldno_x < 0 || fldno_y < 0)
405 id = sctoff((long)fldval[fldno_x].val_as.dbl,
406 (long)fldval[fldno_y].val_as.dbl);
407 /* Note: reporting values out of range left to putnum() */
409 sctoff2xy(&x, &y, cur_id);
410 return gripe("coordinates in fields %d,%d must be > %d,%d",
411 fldno_x + 1, fldno_y + 1, x, y);
417 * Get the current row's ID.
418 * Current table's type must be EF_REALM.
419 * Return ID on success, -1 on failure.
424 int fldno_cnum, fldno_realm, id;
427 if (CANT_HAPPEN(partno != 0 || cur_type != EF_REALM))
430 fldno_cnum = fld_find_long_by_name("cnum", 0);
431 fldno_realm = fld_find_long_by_name("realm", 0);
432 if (fldno_cnum < 0 || fldno_realm < 0)
435 realm = (long)fldval[fldno_realm].val_as.dbl;
436 cnum = (long)fldval[fldno_cnum].val_as.dbl;
437 if (cnum < 0 || cnum >= MAXNOC)
438 return gripe("field %d must be between 0 and %d",
440 if (realm < 0 || realm >= MAXNOR)
441 return gripe("field %d must be between 0 and %d",
442 fldno_realm, MAXNOR);
443 id = realm + cnum * MAXNOR;
445 return gripe("fields %d,%d must be > (%d,%d)",
446 fldno_cnum + 1, fldno_realm + 1,
447 cur_id / MAXNOR, cur_id % MAXNOR);
451 * Get the current row's object.
452 * Extend the table if necessary.
453 * Save ID in @cur_id.
454 * Return the object on success, NULL on failure.
459 int last_id = cur_id;
464 id = expected_id(cur_id + 1, empfile[cur_type].fids);
466 gripe("table's first part doesn't have this row");
469 } else if (ca0_is_id(cur_type)) {
473 } else if (cur_type == EF_SECTOR) {
477 } else if (cur_type == EF_REALM) {
483 if (id > ef_id_limit(cur_type)) {
484 gripe("too many rows");
490 omit_ids(last_id + 1, id);
495 * Is a new value for field @fldno required to match the old one?
498 fldval_must_match(int fldno)
500 struct castr *ca = ef_cadef(cur_type);
501 int i = fldca[fldno] - ca;
504 * Value must match if:
505 * it's for a const selector, unless the object is still blank, or
506 * it was already given in a previous part of a split table.
508 return (cur_id < old_nelem && (fldca[fldno]->ca_dump == CA_DUMP_CONST))
509 || fldidx[fldno] < cafldspp[i];
513 * Set @obj's field @fldno to @dbl.
514 * Return 0 on success, -1 on error.
517 putnum(void *obj, int fldno, double dbl)
519 struct castr *ca = fldca[fldno];
520 int idx = fldidx[fldno];
524 memb_ptr = (char *)obj + ca->ca_off;
526 switch (ca->ca_type) {
528 old = ((signed char *)memb_ptr)[idx];
529 new = ((signed char *)memb_ptr)[idx] = (signed char)dbl;
532 old = ((unsigned char *)memb_ptr)[idx];
533 new = ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
536 old = ((short *)memb_ptr)[idx];
537 new = ((short *)memb_ptr)[idx] = (short)dbl;
540 old = ((unsigned short *)memb_ptr)[idx];
541 new = ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
544 old = ((int *)memb_ptr)[idx];
545 new = ((int *)memb_ptr)[idx] = (int)dbl;
548 old = ((long *)memb_ptr)[idx];
549 new = ((long *)memb_ptr)[idx] = (long)dbl;
552 old = ((coord *)memb_ptr)[idx];
553 /* FIXME use variant of xrel() that takes orig instead of nation */
554 if (old >= WORLD_X / 2)
556 new = ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
557 if (new >= WORLD_X / 2)
561 old = ((coord *)memb_ptr)[idx];
562 /* FIXME use variant of yrel() that takes orig instead of nation */
563 if (old >= WORLD_Y / 2)
565 new = ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
566 if (new >= WORLD_Y / 2)
570 old = ((float *)memb_ptr)[idx];
571 ((float *)memb_ptr)[idx] = (float)dbl;
572 new = dbl; /* suppress new != dbl check */
575 old = ((double *)memb_ptr)[idx];
576 ((double *)memb_ptr)[idx] = dbl;
577 new = dbl; /* suppress new != dbl check */
580 old = ((time_t *)memb_ptr)[idx];
581 new = ((time_t *)memb_ptr)[idx] = (time_t)dbl;
584 return gripe("field %d doesn't take numbers", fldno + 1);
587 if (fldval_must_match(fldno) && old != dbl)
588 return gripe("value for field %d must be %g", fldno + 1, old);
590 return gripe("field %d can't hold this value", fldno + 1);
596 * Set obj's field @fldno to @str.
597 * Return 0 on success, -1 on error.
600 putstr(void *obj, int fldno, char *str)
602 struct castr *ca = fldca[fldno];
603 int idx = fldidx[fldno];
604 int must_match, mismatch;
606 char *memb_ptr, *old;
608 memb_ptr = (char *)obj + ca->ca_off;
609 must_match = fldval_must_match(fldno);
612 switch (ca->ca_type) {
614 old = ((char **)memb_ptr)[idx];
616 mismatch = old ? !str || strcmp(old, str) : !!str;
618 /* FIXME may leak old value */
619 ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
620 len = -1; /* unlimited */
623 if (CANT_HAPPEN(idx))
626 return gripe("field %d doesn't take nil", fldno + 1);
627 /* Wart: if ca_len <= 1, the terminating null may be omitted */
629 len = sz > 1 ? sz - 1 : sz;
630 if (strlen(str) > len)
631 return gripe("field %d takes at most %d characters",
632 fldno + 1, (int)len);
635 mismatch = !str || strncmp(old, str, len);
637 strncpy(memb_ptr, str, sz);
640 return gripe("field %d doesn't take strings", fldno + 1);
645 return gripe("value for field %d must be \"%.*s\"",
646 fldno + 1, (int)len, old);
648 return gripe("value for field %d must be nil", fldno + 1);
655 * Save the current row's fields in its object.
656 * Return 0 on success, -1 on failure.
668 for (i = 0; i < nflds; i++) {
669 switch (fldval[i].val_type) {
671 ret |= putnum(obj, i, fldval[i].val_as.dbl);
674 ret |= putstr(obj, i, fldval[i].val_as.str.base);
675 free(fldval[i].val_as.str.base);
687 * Read and ignore field separators from @fp.
688 * Return first character that is not a field separator.
697 } while (ch == ' ' || ch == '\t');
702 } while (ch != EOF && ch != '\n');
709 * Decode escape sequences in @buf.
710 * Return @buf on success, null pointer on failure.
723 if (sscanf(++src, "%3o%n", &octal_chr, &n) != 1 || n != 3)
725 *dst++ = (char)octal_chr;
735 * Read an identifier from @fp into @buf.
736 * @buf must have space for 1024 characters.
737 * Return number of characters read on success, -1 on failure.
740 getid(FILE *fp, char *buf)
743 if (fscanf(fp, "%1023[^\"#()<>= \t\n]%n", buf, &n) != 1
751 * Try to read a field name from @fp.
752 * @i is the field number, counting from zero.
753 * If a name is read, set fldca[@i] and fldidx[@i] for it, and update
755 * Return 1 if a name or ... was read, 0 on end of line, -1 on error.
758 xufldname(FILE *fp, int i)
766 return gripe("unexpected EOF");
768 nflds = i - (ellipsis != 0);
774 if (getc(fp) != '.' || getc(fp) != '.')
775 return gripe("junk in header field %d", i + 1);
777 return gripe("header fields expected");
780 if (ch != EOF && ch != '\n')
781 return gripe("junk after ...");
786 if (getid(fp, buf) < 0)
787 return gripe("junk in header field %d", i + 1);
791 return deffld(i, buf, -1);
795 if (isdigit(ch) || ch == '-' || ch == '+') {
796 if (fscanf(fp, "%d", &idx) != 1)
797 return gripe("malformed number in index of header field %d",
800 return gripe("index must not be negative in header field %d",
803 if (getid(fp, buf) < 0)
804 return gripe("malformed index in header field %d", i + 1);
805 return gripe("symbolic index in header field %d not yet implemented",
810 return gripe("malformed index in header field %d", i + 1);
811 return deffld(i, buf, idx);
816 * Try to read a field value from @fp.
817 * @i is the field number, counting from zero.
818 * Return 1 if a value was read, 0 on end of line, -1 on error.
821 xufld(FILE *fp, int i)
831 return gripe("unexpected EOF");
833 CANT_HAPPEN(i > nflds);
834 for (j = i; j < nflds; j++) {
835 if (CA_IS_ARRAY(fldca[j]))
836 gripe("field '%s(%d)' missing",
837 fldca[j]->ca_name, fldidx[j]);
839 gripe("field '%s' missing", fldca[j]->ca_name);
841 if (i != nflds || putrow() < 0)
844 return i < nflds ? -1 : 0;
845 case '+': case '-': case '.':
846 case '0': case '1': case '2': case '3': case '4':
847 case '5': case '6': case '7': case '8': case '9':
849 if (fscanf(fp, "%lg", &dbl) != 1)
850 return gripe("malformed number in field %d", i + 1);
851 return setnum(i, dbl);
858 if (fscanf(fp, "%1023[^\"\n]", buf) != 1 || getc(fp) != '"')
859 return gripe("malformed string in field %d", i + 1);
861 return gripe("invalid escape sequence in field %d",
864 return setstr(i, buf);
866 if (mtsymset(i, &set) < 0)
870 if (ch == EOF || ch == '\n')
871 return gripe("unmatched '(' in field %d", i + 1);
875 if (getid(fp, buf) < 0)
876 return gripe("junk in field %d", i + 1);
877 if (add2symset(i, &set, buf) < 0)
880 return setnum(i, set);
883 if (getid(fp, buf) < 0)
884 return gripe("junk in field %d", i + 1);
885 if (!strcmp(buf, "nil"))
886 return setstr(i, NULL);
888 return setsym(i, buf);
893 * Read fields from @fp.
894 * Use @parse() to read each field.
895 * Return number of fields read on success, -1 on error.
898 xuflds(FILE *fp, int (*parse)(FILE *, int))
911 else if (ch != ' ' && ch != '\t')
912 return gripe("bad field separator after field %d", i + 1);
917 * Define the @fldno-th field.
918 * If @idx is negative, define as selector @name, else as @name(@idx).
919 * Set fldca[@fldno] and fldidx[@fldno] accordingly.
921 * Return 1 on success, -1 on error.
924 deffld(int fldno, char *name, int idx)
926 struct castr *ca = ef_cadef(cur_type);
929 res = stmtch(name, ca, offsetof(struct castr, ca_name),
930 sizeof(struct castr));
932 return gripe("%s header '%s' in field %d",
933 res == M_NOTUNIQUE ? "ambiguous" : "unknown",
935 if (ca[res].ca_dump > CA_DUMP_CONST || CANT_HAPPEN(ca[res].ca_get))
936 return gripe("extraneous header '%s' in field %d", name, fldno + 1);
937 if (CA_IS_ARRAY(&ca[res])) {
939 return gripe("header '%s' requires an index in field %d",
940 ca[res].ca_name, fldno + 1);
941 if (idx != caflds[res] && idx < ca[res].ca_len)
942 return gripe("expected header '%s(%d)' in field %d",
943 ca[res].ca_name, caflds[res], fldno + 1);
944 if (idx >= ca[res].ca_len)
945 return gripe("unexpected header '%s(%d)' in field %d",
946 ca[res].ca_name, idx, fldno + 1);
949 return gripe("header '%s' doesn't take an index in field %d",
950 ca[res].ca_name, fldno + 1);
953 return gripe("duplicate header '%s' in field %d",
954 ca[res].ca_name, fldno + 1);
956 fldca[fldno] = &ca[res];
963 * Check fields in xdump are sane.
964 * Return 0 on success, -1 on error.
969 struct castr *ca = ef_cadef(cur_type);
970 int i, len, cafldsmax, res = 0;
973 return res; /* table is split, another part expected */
975 /* Check for missing fields */
976 for (i = 0; ca[i].ca_name; i++) {
977 cafldsmax = MAX(caflds[i], cafldspp[i]);
978 if (ca[i].ca_dump > CA_DUMP_CONST)
980 len = CA_ARRAY_LEN(&ca[i]);
981 if (!len && !cafldsmax)
982 res = gripe("header '%s' missing", ca[i].ca_name);
983 else if (len && cafldsmax == len - 1)
984 res = gripe("header '%s(%d)' missing",
985 ca[i].ca_name, len - 1);
986 else if (len && cafldsmax < len - 1)
987 res = gripe("header '%s(%d)' ... '%s(%d)' missing",
988 ca[i].ca_name, cafldsmax, ca[i].ca_name, len - 1);
995 * Set value of field @fldno in current row to @dbl.
996 * Return 1 on success, -1 on error.
999 setnum(int fldno, double dbl)
1001 if (!getfld(fldno, NULL))
1003 fldval[fldno].val_cat = NSC_VAL;
1004 fldval[fldno].val_type = NSC_DOUBLE;
1005 fldval[fldno].val_as.dbl = dbl;
1010 * Set value of field @fldno in current row to @str.
1011 * Return 1 on success, -1 on error.
1014 setstr(int fldno, char *str)
1016 if (!getfld(fldno, NULL))
1018 fldval[fldno].val_cat = NSC_VAL;
1019 fldval[fldno].val_type = NSC_STRING;
1020 fldval[fldno].val_as.str.base = str ? strdup(str) : NULL;
1021 fldval[fldno].val_as.str.maxsz = INT_MAX;
1022 /* really SIZE_MAX, but that's C99 */
1027 * Resolve symbol name @id in table referred to by @ca.
1028 * Use field number @n for error messages.
1029 * Return index in referred table on success, -1 on failure.
1032 xunsymbol(char *id, struct castr *ca, int n)
1034 int i = ef_elt_byname(ca->ca_table, id);
1036 return gripe("%s %s symbol '%s' in field %d",
1037 i == M_NOTUNIQUE ? "ambiguous" : "unknown",
1038 ca->ca_name, id, n + 1);
1043 * Map symbol index to symbol value.
1044 * @ca is the table, and @i is the index in it.
1047 symval(struct castr *ca, int i)
1049 int type = ca->ca_table;
1051 if (type != EF_BAD && ef_cadef(type) == symbol_ca)
1052 /* symbol table, value is in the table */
1053 return ((struct symbol *)ef_ptr(type, i))->value;
1054 /* value is the table index */
1059 * Set value of field @fldno in current object to value of symbol @sym.
1060 * Return 1 on success, -1 on error.
1063 setsym(int fldno, char *sym)
1068 ca = getfld(fldno, NULL);
1072 if (ca->ca_table == EF_BAD || (ca->ca_flags & NSC_BITS))
1073 return gripe("field %d doesn't take symbols", fldno + 1);
1075 i = xunsymbol(sym, ca, fldno);
1078 return setnum(fldno, symval(ca, i));
1082 * Create an empty symbol set for field @fldno in *@set.
1083 * Return 1 on success, -1 on error.
1086 mtsymset(int fldno, long *set)
1090 ca = getfld(fldno, NULL);
1094 if (ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca
1095 || !(ca->ca_flags & NSC_BITS))
1096 return gripe("field %d doesn't take symbol sets", fldno + 1);
1102 * Add a symbol to a symbol set for field @fldno in *@set.
1103 * @sym is the name of the symbol to add.
1104 * Return 1 on success, -1 on error.
1107 add2symset(int fldno, long *set, char *sym)
1112 ca = getfld(fldno, NULL);
1116 i = xunsymbol(sym, ca, fldno);
1119 *set |= symval(ca, i);
1124 * Read an xdump table header line from @fp.
1125 * Expect header for @expected_table, unless it is EF_BAD.
1126 * Recognize header for machine- and human-readable syntax, and set
1127 * human accordingly.
1128 * Return table type on success, -2 on EOF before header, -1 on failure.
1131 xuheader(FILE *fp, int expected_table)
1137 while ((ch = skipfs(fp)) == '\n')
1139 if (ch == EOF && expected_table == EF_BAD)
1146 ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
1147 : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
1148 name, &res) != 1) || res < 0)
1149 return gripe("expected xdump header");
1151 type = ef_byname(name);
1153 return gripe("unknown table '%s'", name);
1154 if (expected_table != EF_BAD && expected_table != type)
1155 return gripe("expected table '%s', not '%s'",
1156 ef_nameof(expected_table), name);
1158 if (!xundumpable(type)) {
1159 CANT_HAPPEN(expected_table != EF_BAD);
1160 return gripe("table '%s' is not permitted here", name);
1163 if (skipfs(fp) != '\n')
1164 return gripe("junk after xdump header");
1171 * Can table @type be xundumped?
1174 xundumpable(int type)
1176 return empfile[type].file && ef_cadef(type)
1177 && (ef_flags(type) & EFF_MEM);
1181 * Find fields in this xdump.
1182 * If reading human-readable syntax, read a field header line from @fp.
1183 * Else take fields from the table's selectors in @ca[].
1184 * Set ellipsis, nflds, fldca[], fldidx[] and caflds[] accordingly.
1185 * Return 0 on success, -1 on failure.
1188 xufldhdr(FILE *fp, struct castr ca[])
1194 for (i = 0; ca[i].ca_name; i++)
1199 while ((ch = skipfs(fp)) == '\n')
1202 if (xuflds(fp, xufldname) < 0)
1208 for (i = 0; ca[i].ca_name; i++) {
1209 if (ca[i].ca_dump > CA_DUMP_CONST)
1211 n = CA_ARRAY_LEN(&ca[i]);
1219 nflds = fidx - fldidx;
1226 * Read xdump footer from @fp.
1227 * @ca[] contains the table's selectors.
1228 * The body had @recs records.
1229 * Update cafldspp[] from caflds[].
1230 * Return 0 on success, -1 on failure.
1233 xufooter(FILE *fp, struct castr ca[], int recs)
1239 if (fscanf(fp, "config%n", &res) != 0 || res < 0)
1240 return gripe("malformed table footer");
1242 if (fscanf(fp, "%d", &n) != 1)
1243 return gripe("malformed table footer");
1245 return gripe("expected footer /%d", recs);
1247 if (skipfs(fp) != '\n')
1248 return gripe("junk after table footer");
1249 if (tbl_part_done() < 0)
1253 for (i = 0; ca[i].ca_name; i++) {
1254 if (cafldspp[i] < caflds[i])
1255 cafldspp[i] = caflds[i];
1262 * Read an xdump table from @fp.
1263 * Both machine- and human-readable xdump syntax are recognized.
1264 * Expect table @expected_table, unless it is EF_BAD.
1265 * Report errors to stderr.
1266 * Messages assume @fp starts in the file @file at line *@plno.
1267 * Update *@plno to reflect lines read from @fp.
1268 * Return table type on success, -2 on EOF before header, -1 on failure.
1271 xundump(FILE *fp, char *file, int *plno, int expected_table)
1274 int type, nca, nf, i, ch;
1279 if ((type = xuheader(fp, expected_table)) < 0)
1282 ca = ef_cadef(type);
1283 if (CANT_HAPPEN(!ca))
1287 for (i = 0; ca[i].ca_name; i++) {
1289 if (ca[i].ca_dump <= CA_DUMP_CONST)
1290 nf += MAX(1, CA_ARRAY_LEN(&ca[i]));
1292 fldca = malloc(nf * sizeof(*fldca));
1293 fldidx = malloc(nf * sizeof(*fldidx));
1294 fldval = malloc(nf * sizeof(*fldval));
1295 caflds = malloc(nca * sizeof(*caflds));
1296 cafldspp = calloc(nca, sizeof(*cafldspp));
1299 if (xutail(fp, ca) < 0)
1309 /* Skip empty lines so that callers can easily check for EOF */
1310 while ((ch = skipfs(fp)) == '\n')
1319 * Read the remainder of an xdump after the table header line from @fp.
1320 * @ca[] contains the table's selectors.
1321 * Return 0 on success, -1 on failure.
1324 xutail(FILE *fp, struct castr *ca)
1329 if (xufldhdr(fp, ca) < 0)
1331 if ((recs = xubody(fp)) < 0)
1333 if (xufooter(fp, ca, recs) < 0)
1337 if (xuheader(fp, cur_type) < 0)
1343 * Read the body of an xdump table from @fp.
1344 * Return number of rows read on success, -1 on failure.
1352 while ((ch = skipfs(fp)) == '\n')
1357 if (xuflds(fp, xufld) < 0)