git.pond.sub.org Git - empserver/blob - src/lib/common/xundump.c

   1 /*
   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
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  *
  19  *  ---
  20  *
  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.
  24  *
  25  *  ---
  26  *
  27  *  xundump.c: Load back xdump output
  28  *
  29  *  Known contributors to this file:
  30  *     Ron Koenderink, 2005
  31  *     Markus Armbruster, 2005-2008
  32  */
  33
  34 /*
  35  * See doc/xdump!  And keep it up-to-date.
  36  *
  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-
  40  * readable subset.
  41  *
  42  * FIXME:
  43  * - Normalize terminology: table/rows/columns or file/records/fields
  44  * - Loading tables with NSC_STRING elements more than once leaks memory
  45  * TODO:
  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
  52  */
  53
  54 #include <config.h>
  55
  56 #include <ctype.h>
  57 #include <stdarg.h>
  58 #include <stdio.h>
  59 #include <stdlib.h>
  60 #include <string.h>
  61 #include <time.h>
  62 #include "file.h"
  63 #include "match.h"
  64 #include "nsc.h"
  65 #include "optlist.h"
  66 #include "xdump.h"
  67
  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 */
  82
  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 *);
  95
  96 /*
  97  * Gripe about the current line to stderr, return -1.
  98  */
  99 static int
 100 gripe(char *fmt, ...)
 101 {
 102     va_list ap;
 103
 104     fprintf(stderr, "%s:%d: ", fname, lineno);
 105     va_start(ap, fmt);
 106     vfprintf(stderr, fmt, ap);
 107     va_end(ap);
 108     putc('\n', stderr);
 109
 110     return -1;
 111 }
 112
 113 /*
 114  * Read and ignore field separators from FP.
 115  * Return first character that is not a field separator.
 116  */
 117 static int
 118 skipfs(FILE *fp)
 119 {
 120     int ch;
 121
 122     do {
 123         ch = getc(fp);
 124     } while (ch == ' ' || ch == '\t');
 125
 126     if (ch == '#') {
 127         do {
 128             ch = getc(fp);
 129         } while (ch != EOF && ch != '\n');
 130     }
 131
 132     return ch;
 133 }
 134
 135 /*
 136  * Decode escape sequences in BUF.
 137  * Return BUF on success, null pointer on failure.
 138  */
 139 static char *
 140 xuesc(char *buf)
 141 {
 142     char *src, *dst;
 143     int octal_chr, n;
 144
 145     dst = buf;
 146     src = buf;
 147     while (*src) {
 148         if (*src == '\\') {
 149             if (sscanf(++src, "%3o%n", &octal_chr, &n) != 1 || n != 3)
 150                 return NULL;
 151             *dst++ = (char)octal_chr;
 152             src += 3;
 153         } else
 154             *dst++ = *src++;
 155     }
 156     *dst = '\0';
 157     return buf;
 158 }
 159
 160 /*
 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.
 164  */
 165 static int
 166 getid(FILE *fp, char *buf)
 167 {
 168     int n;
 169     if (fscanf(fp, "%1023[^\"#()<>= \t\n]%n", buf, &n) != 1
 170         || !isalpha(buf[0]))
 171         return -1;
 172     xuesc(buf);
 173     return n;
 174 }
 175
 176 /*
 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
 180  * caflds[].
 181  * Return 1 if a name or ... was read, 0 on end of line, -1 on error.
 182  */
 183 static int
 184 xufldname(FILE *fp, int i)
 185 {
 186     int ch, idx;
 187     char buf[1024];
 188
 189     ch = skipfs(fp);
 190     switch (ch) {
 191     case EOF:
 192         return gripe("Unexpected EOF");
 193     case '\n':
 194         if (chkflds() < 0)
 195             return -1;
 196         lineno++;
 197         return 0;
 198     case '.':
 199         if (getc(fp) != '.' || getc(fp) != '.')
 200             return gripe("Junk in header field %d", i + 1);
 201         if (defellipsis() < 0)
 202             return -1;
 203         ch = skipfs(fp);
 204         if (ch != EOF && ch != '\n')
 205             return gripe("Junk after ...");
 206         ungetc(ch, fp);
 207         return 1;
 208     default:
 209         ungetc(ch, fp);
 210         if (getid(fp, buf) < 0)
 211             return gripe("Junk in header field %d", i + 1);
 212         ch = getc(fp);
 213         if (ch != '(') {
 214             ungetc(ch, fp);
 215             return deffld(i, buf, -1);
 216         }
 217         ch = getc(fp);
 218         ungetc(ch, fp);
 219         if (isdigit(ch) || ch == '-' || ch == '+') {
 220             if (fscanf(fp, "%d", &idx) != 1)
 221                 return gripe("Malformed number in index of header field %d",
 222                              i + 1);
 223             if (idx < 0)
 224                 return gripe("Index must not be negative in header field %d",
 225                              i + 1);
 226         } else {
 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",
 230                          i + 1);
 231         }
 232         ch = getc(fp);
 233         if (ch != ')')
 234             return gripe("Malformed index in header field %d", i + 1);
 235         return deffld(i, buf, idx);
 236     }
 237 }
 238
 239 /*
 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.
 243  */
 244 static int
 245 xufld(FILE *fp, int i)
 246 {
 247     int ch;
 248     char buf[1024];
 249     double dbl;
 250     long set;
 251
 252     ch = skipfs(fp);
 253     switch (ch) {
 254     case EOF:
 255         return gripe("Unexpected EOF");
 256     case '\n':
 257         CANT_HAPPEN(i > nflds);
 258         if (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);
 263         }
 264         lineno++;
 265         return 0;
 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':
 269         ungetc(ch, fp);
 270         if (fscanf(fp, "%lg", &dbl) != 1)
 271             return gripe("Malformed number in field %d", i + 1);
 272         return setnum(i, dbl);
 273     case '"':
 274         ch = getc(fp);
 275         if (ch == '"')
 276             buf[0] = 0;
 277         else {
 278             ungetc(ch, fp);
 279             if (fscanf(fp, "%1023[^\"\n]", buf) != 1 || getc(fp) != '"')
 280                 return gripe("Malformed string in field %d", i + 1);
 281             if (!xuesc(buf))
 282                 return gripe("Invalid escape sequence in field %d",
 283                              i + 1);
 284         }
 285         return setstr(i, buf);
 286     case '(':
 287         if (mtsymset(i, &set) < 0)
 288             return -1;
 289         for (;;) {
 290             ch = skipfs(fp);
 291             if (ch == EOF || ch == '\n')
 292                 return gripe("Unmatched '(' in field %d", i + 1);
 293             if (ch == ')')
 294                 break;
 295             ungetc(ch, fp);
 296             if (getid(fp, buf) < 0)
 297                 return gripe("Junk in field %d", i + 1);
 298             if (add2symset(i, &set, buf) < 0)
 299                 return -1;
 300         }
 301         return setnum(i, set);
 302     default:
 303         ungetc(ch, fp);
 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);
 308         else
 309             return setsym(i, buf);
 310     }
 311 }
 312
 313 /*
 314  * Read fields from FP.
 315  * Use PARSE() to read each field.
 316  * Return number of fields read on success, -1 on error.
 317  */
 318 static int
 319 xuflds(FILE *fp, int (*parse)(FILE *, int))
 320 {
 321     int i, ch, res;
 322
 323     for (i = 0; ; i++) {
 324         res = parse(fp, i);
 325         if (res < 0)
 326             return -1;
 327         if (res == 0)
 328             return i;
 329         ch = getc(fp);
 330         if (ch == '\n')
 331             ungetc(ch, fp);
 332         else if (ch != ' ' && ch != '\t')
 333             return gripe("Bad field separator after field %d", i + 1);
 334     }
 335 }
 336
 337 /*
 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.
 341  * Update caflds[].
 342  * Return 1 on success, -1 on error.
 343  */
 344 static int
 345 deffld(int fldno, char *name, int idx)
 346 {
 347     struct castr *ca = ef_cadef(cur_type);
 348     int res;
 349
 350     res = stmtch(name, ca, offsetof(struct castr, ca_name),
 351                  sizeof(struct castr));
 352     if (res < 0)
 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) {
 358         if (idx < 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);
 370     } else {
 371         if (idx >= 0)
 372             return gripe("Header %s doesn't take an index in field %d",
 373                          ca[res].ca_name, fldno + 1);
 374         idx = 0;
 375         if (caflds[res])
 376             return gripe("Duplicate header %s in field %d",
 377                          ca[res].ca_name, fldno + 1);
 378     }
 379     fldca[fldno] = &ca[res];
 380     fldidx[fldno] = idx;
 381     caflds[res]++;
 382     return 1;
 383 }
 384
 385 /*
 386  * Record that header ends with ...
 387  * Set ellipsis and is_partial.
 388  * Return 0 on success, -1 on error.
 389  */
 390 static int
 391 defellipsis(void)
 392 {
 393     struct castr *ca = ef_cadef(cur_type);
 394
 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;
 398     return 0;
 399 }
 400
 401 /*
 402  * Check fields in xdump are sane.
 403  * Return 0 on success, -1 on error.
 404  */
 405 static int
 406 chkflds(void)
 407 {
 408     struct castr *ca = ef_cadef(cur_type);
 409     int i, len, cafldsmax, res = 0;
 410
 411     if (is_partial) {
 412         /* Need a join field, use 0-th selector */
 413         if (!caflds[0])
 414             return gripe("Header field %s required with ...", ca[0].ca_name);
 415     }
 416
 417     if (ellipsis)
 418         return 0;
 419
 420     for (i = 0; ca[i].ca_name; i++) {
 421         cafldsmax = MAX(caflds[i], cafldspp[i]);
 422         if (ca[i].ca_flags & NSC_EXTRA)
 423             continue;
 424         len = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
 425         if (!len && !cafldsmax)
 426             res = gripe("Header field %s missing", ca[i].ca_name);
 427         else if (len && cafldsmax == len - 1)
 428             res = gripe("Header field %s(%d) missing",
 429                         ca[i].ca_name, len - 1);
 430         else if (len && cafldsmax < len - 1)
 431             res = gripe("Header fields %s(%d) ... %s(%d) missing",
 432                         ca[i].ca_name, cafldsmax, ca[i].ca_name, len - 1);
 433     }
 434
 435     return res;
 436 }
 437
 438 /*
 439  * Get selector for field FLDNO.
 440  * Assign the field's selector index to *IDX, unless it is null.
 441  * Return the selector on success, null pointer on error.
 442  */
 443 static struct castr *
 444 getfld(int fldno, int *idx)
 445 {
 446     if (fldno >= nflds) {
 447         gripe("Too many fields, expected only %d", nflds);
 448         return NULL;
 449     }
 450     if (CANT_HAPPEN(fldno < 0))
 451         return NULL;
 452     if (idx)
 453         *idx = fldidx[fldno];
 454     return fldca[fldno];
 455 }
 456
 457 /*
 458  * Is a new value for field FLDNO required to match the old one?
 459  */
 460 static int
 461 fldval_must_match(int fldno)
 462 {
 463     struct castr *ca = ef_cadef(cur_type);
 464     int i = fldca[fldno] - ca;
 465
 466     /*
 467      * Value must match if:
 468      * it's for a const selector, unless the object is still blank, or
 469      * it was already given in a previous part of a split table.
 470      */
 471     return (!cur_obj_is_blank && (fldca[fldno]->ca_flags & NSC_CONST))
 472         || fldidx[fldno] < cafldspp[i];
 473 }
 474
 475 /*
 476  * Get the current object.
 477  * Store it in cur_obj, and set cur_obj_is_blank accordingly.
 478  * Return cur_obj, which is null on error.
 479  */
 480 static void *
 481 getobj(void)
 482 {
 483     struct empfile *ep = &empfile[cur_type];
 484
 485     if (!cur_obj) {
 486         cur_obj_is_blank = cur_id >= ep->fids;
 487         if (cur_obj_is_blank) {
 488             if (ef_ensure_space(cur_type, cur_id, 1))
 489                 cur_obj = ef_ptr(cur_type, cur_id);
 490             /* FIXME diagnose out of dynamic memory vs. static table full */
 491             if (!cur_obj)
 492                 gripe("Can't put ID %d into table %s, it holds only 0..%d.",
 493                       cur_id, ep->name, ep->fids - 1);
 494         } else
 495             cur_obj = ef_ptr(cur_type, cur_id);
 496     }
 497
 498     return cur_obj;
 499 }
 500
 501 /*
 502  * Set value of field FLDNO in current object to DBL.
 503  * Return 1 on success, -1 on error.
 504  */
 505 static int
 506 setnum(int fldno, double dbl)
 507 {
 508     struct castr *ca;
 509     int idx;
 510     char *memb_ptr;
 511     double old;
 512
 513     ca = getfld(fldno, &idx);
 514     if (!ca)
 515         return -1;
 516
 517     /*
 518      * If this is the record index, put it into cur_id.
 519      */
 520     if (fldno == 0 && ca->ca_table == cur_type)
 521         cur_id = (int)dbl;
 522
 523     memb_ptr = getobj();
 524     if (!memb_ptr)
 525         return -1;
 526     memb_ptr += ca->ca_off;
 527
 528     /* FIXME check assignment preserves value */
 529     switch (ca->ca_type) {
 530     case NSC_CHAR:
 531         old = ((signed char *)memb_ptr)[idx];
 532         ((signed char *)memb_ptr)[idx] = (signed char)dbl;
 533         break;
 534     case NSC_UCHAR:
 535     case NSC_HIDDEN:
 536         old = ((unsigned char *)memb_ptr)[idx];
 537         ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
 538         break;
 539     case NSC_SHORT:
 540         old = ((short *)memb_ptr)[idx];
 541         ((short *)memb_ptr)[idx] = (short)dbl;
 542         break;
 543     case NSC_USHORT:
 544         old = ((unsigned short *)memb_ptr)[idx];
 545         ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
 546         break;
 547     case NSC_INT:
 548         old = ((int *)memb_ptr)[idx];
 549         ((int *)memb_ptr)[idx] = (int)dbl;
 550         break;
 551     case NSC_LONG:
 552         old = ((long *)memb_ptr)[idx];
 553         ((long *)memb_ptr)[idx] = (long)dbl;
 554         break;
 555     case NSC_XCOORD:
 556         old = ((coord *)memb_ptr)[idx];
 557         /* FIXME use variant of xrel() that takes orig instead of nation */
 558         if (old >= WORLD_X / 2)
 559             old -= WORLD_X;
 560         ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
 561         break;
 562     case NSC_YCOORD:
 563         old = ((coord *)memb_ptr)[idx];
 564         /* FIXME use variant of yrel() that takes orig instead of nation */
 565         if (old >= WORLD_Y / 2)
 566             old -= WORLD_Y;
 567         ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
 568         break;
 569     case NSC_FLOAT:
 570         old = ((float *)memb_ptr)[idx];
 571         ((float *)memb_ptr)[idx] = (float)dbl;
 572         break;
 573     case NSC_DOUBLE:
 574         old = ((double *)memb_ptr)[idx];
 575         ((double *)memb_ptr)[idx] = dbl;
 576         break;
 577     case NSC_TIME:
 578         old = ((time_t *)memb_ptr)[idx];
 579         ((time_t *)memb_ptr)[idx] = (time_t)dbl;
 580         break;
 581     default:
 582         return gripe("Field %d doesn't take numbers", fldno + 1);
 583     }
 584
 585     if (fldval_must_match(fldno) && old != dbl)
 586         return gripe("Value for field %d must be %g", fldno + 1, old);
 587
 588     return 1;
 589 }
 590
 591 /*
 592  * Set value of field FLDNO in current object to STR.
 593  * Return 1 on success, -1 on error.
 594  */
 595 static int
 596 setstr(int fldno, char *str)
 597 {
 598     struct castr *ca;
 599     int must_match, idx;
 600     size_t len;
 601     char *memb_ptr, *old;
 602
 603     ca = getfld(fldno, &idx);
 604     if (!ca)
 605         return -1;
 606
 607     memb_ptr = getobj();
 608     if (!memb_ptr)
 609         return -1;
 610     memb_ptr += ca->ca_off;
 611     must_match = fldval_must_match(fldno);
 612
 613     switch (ca->ca_type) {
 614     case NSC_STRING:
 615         old = ((char **)memb_ptr)[idx];
 616         if (!must_match)
 617             /* FIXME may leak old value */
 618             ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
 619         len = 65535;            /* really SIZE_MAX, but that's C99 */
 620         break;
 621     case NSC_STRINGY:
 622         if (CANT_HAPPEN(idx))
 623             return -1;
 624         if (!str)
 625             return gripe("Field %d doesn't take nil", fldno + 1);
 626         len = ca->ca_len;
 627         if (strlen(str) > len)
 628             return gripe("Field %d takes at most %d characters",
 629                          fldno + 1, (int)len);
 630         old = memb_ptr;
 631         if (!must_match)
 632             strncpy(memb_ptr, str, len);
 633         break;
 634     default:
 635         return gripe("Field %d doesn't take strings", fldno + 1);
 636     }
 637
 638     if (must_match) {
 639         if (old && (!str || strncmp(old, str, len)))
 640             return gripe("Value for field %d must be \"%.*s\"",
 641                          fldno + 1, (int)len, old);
 642         if (!old && str)
 643             return gripe("Value for field %d must be nil", fldno + 1);
 644     }
 645
 646     return 1;
 647 }
 648
 649 /*
 650  * Resolve symbol name ID in table referred to by CA.
 651  * Use field number N for error messages.
 652  * Return index in referred table on success, -1 on failure.
 653  */
 654 static int
 655 xunsymbol(char *id, struct castr *ca, int n)
 656 {
 657     int i = ef_elt_byname(ca->ca_table, id);
 658     if (i < 0)
 659         return gripe("%s %s symbol `%s' in field %d",
 660                      i == M_NOTUNIQUE ? "Ambiguous" : "Unknown",
 661                      ca->ca_name, id, n + 1);
 662     return i;
 663 }
 664
 665 /*
 666  * Map symbol index to symbol value.
 667  * CA is the table, and I is the index in it.
 668  */
 669 static int
 670 symval(struct castr *ca, int i)
 671 {
 672     int type = ca->ca_table;
 673
 674     if (type != EF_BAD && ef_cadef(type) == symbol_ca)
 675         /* symbol table, value is in the table */
 676         return ((struct symbol *)ef_ptr(type, i))->value;
 677     /* value is the table index */
 678     return i;
 679 }
 680
 681 /*
 682  * Set value of field FLDNO in current object to value of symbol SYM.
 683  * Return 1 on success, -1 on error.
 684  */
 685 static int
 686 setsym(int fldno, char *sym)
 687 {
 688     struct castr *ca;
 689     int i;
 690
 691     ca = getfld(fldno, NULL);
 692     if (!ca)
 693         return -1;
 694
 695     if (ca->ca_table == EF_BAD || (ca->ca_flags & NSC_BITS))
 696         return gripe("Field %d doesn't take symbols", fldno + 1);
 697
 698     i = xunsymbol(sym, ca, fldno);
 699     if (i < 0)
 700         return -1;
 701     return setnum(fldno, symval(ca, i));
 702 }
 703
 704 /*
 705  * Create an empty symbol set for field FLDNO in *SET.
 706  * Return 1 on success, -1 on error.
 707  */
 708 static int
 709 mtsymset(int fldno, long *set)
 710 {
 711     struct castr *ca;
 712
 713     ca = getfld(fldno, NULL);
 714     if (!ca)
 715         return -1;
 716
 717     if (ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca
 718         || !(ca->ca_flags & NSC_BITS))
 719         return gripe("Field %d doesn't take symbol sets", fldno + 1);
 720     *set = 0;
 721     return 0;
 722 }
 723
 724 /*
 725  * Add a symbol to a symbol set for field FLDNO in *SET.
 726  * SYM is the name of the symbol to add.
 727  * Return 1 on success, -1 on error.
 728  */
 729 static int
 730 add2symset(int fldno, long *set, char *sym)
 731 {
 732     struct castr *ca;
 733     int i;
 734
 735     ca = getfld(fldno, NULL);
 736     if (!ca)
 737         return -1;
 738
 739     i = xunsymbol(sym, ca, fldno);
 740     if (i < 0)
 741         return -1;
 742     *set |= symval(ca, i);
 743     return 0;
 744 }
 745
 746 /*
 747  * Read an xdump table header line from FP.
 748  * Expect header for EXPECTED_TABLE, unless it is EF_BAD.
 749  * Recognize header for machine- and human-readable syntax, and set
 750  * human accordingly.
 751  * Return table type on success, -2 on EOF before header, -1 on failure.
 752  */
 753 static int
 754 xuheader(FILE *fp, int expected_table)
 755 {
 756     char name[64];
 757     int res, ch;
 758     int type;
 759
 760     while ((ch = skipfs(fp)) == '\n')
 761         lineno++;
 762     if (ch == EOF && expected_table == EF_BAD)
 763         return -2;
 764     ungetc(ch, fp);
 765
 766     human = ch == 'c';
 767     res = -1;
 768     if ((human
 769          ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
 770          : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
 771                   name, &res) != 1) || res < 0)
 772         return gripe("Expected xdump header");
 773
 774     type = ef_byname(name);
 775     if (type < 0)
 776         return gripe("Unknown table `%s'", name);
 777     if (expected_table != EF_BAD && expected_table != type)
 778         return gripe("Expected table `%s', not `%s'",
 779                      ef_nameof(expected_table), name);
 780
 781     if (!ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
 782         CANT_HAPPEN(expected_table != EF_BAD);
 783         return gripe("Table `%s' is not permitted here", name);
 784     }
 785
 786     if (skipfs(fp) != '\n')
 787         return gripe("Junk after xdump header");
 788     lineno++;
 789
 790     return type;
 791 }
 792
 793 /*
 794  * Find fields in this xdump.
 795  * If reading human-readable syntax, read a field header line from FP.
 796  * Else take fields from the table's selectors in CA[].
 797  * Set ellipsis, nflds, fldca[], fldidx[] and caflds[] accordingly.
 798  * Return 0 on success, -1 on failure.
 799  */
 800 static int
 801 xufldhdr(FILE *fp, struct castr ca[])
 802 {
 803     struct castr **fca;
 804     int *fidx;
 805     int ch, i, j, n;
 806
 807     for (i = 0; ca[i].ca_name; i++)
 808         caflds[i] = 0;
 809     ellipsis = 0;
 810
 811     if (human) {
 812         while ((ch = skipfs(fp)) == '\n')
 813             lineno++;
 814         ungetc(ch, fp);
 815         nflds = xuflds(fp, xufldname);
 816         if (nflds < 0)
 817             return -1;
 818         nflds -= ellipsis != 0;
 819     } else {
 820         fca = fldca;
 821         fidx = fldidx;
 822
 823         for (i = 0; ca[i].ca_name; i++) {
 824             if ((ca[i].ca_flags & NSC_EXTRA))
 825                 continue;
 826             n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
 827             j = 0;
 828             do {
 829                 *fca++ = &ca[i];
 830                 *fidx++ = j;
 831             } while (++j < n);
 832         }
 833
 834         nflds = fidx - fldidx;
 835     }
 836
 837     return 0;
 838 }
 839
 840 /*
 841  * Read xdump footer from FP.
 842  * CA[] contains the table's selectors.
 843  * The body had RECS records.
 844  * Update cafldspp[] from caflds[].
 845  * Return 0 on success, -1 on failure.
 846  */
 847 static int
 848 xufooter(FILE *fp, struct castr ca[], int recs)
 849 {
 850     int res, n, i;
 851
 852     res = -1;
 853     if (human) {
 854         if (fscanf(fp, "config%n", &res) != 0 || res < 0)
 855             return gripe("Malformed table footer");
 856     } else {
 857         if (fscanf(fp, "%d", &n) != 1)
 858             return gripe("Malformed table footer");
 859         if (recs != n)
 860             return gripe("Read %d rows, which doesn't match footer "
 861                          "%d rows", recs, n);
 862     }
 863     if (skipfs(fp) != '\n')
 864         return gripe("Junk after table footer");
 865     lineno++;
 866
 867     for (i = 0; ca[i].ca_name; i++) {
 868         if (cafldspp[i] < caflds[i])
 869             cafldspp[i] = caflds[i];
 870     }
 871
 872     return 0;
 873 }
 874
 875 /*
 876  * Read an xdump table from FP.
 877  * Both machine- and human-readable xdump syntax are recognized.
 878  * Expect table EXPECTED_TABLE, unless it is EF_BAD.
 879  * Report errors to stderr.
 880  * Messages assume FP starts in the file FILE at line *PLNO.
 881  * Update *PLNO to reflect lines read from FP.
 882  * Return table type on success, -2 on EOF before header, -1 on failure.
 883  */
 884 int
 885 xundump(FILE *fp, char *file, int *plno, int expected_table)
 886 {
 887     struct castr *ca;
 888     int type, nca, nf, i, ch;
 889
 890     fname = file;
 891     lineno = *plno;
 892
 893     if ((type = xuheader(fp, expected_table)) < 0)
 894         return type;
 895
 896     ca = ef_cadef(type);
 897     if (CANT_HAPPEN(!ca))
 898         return -1;
 899
 900     nca = nf = 0;
 901     for (i = 0; ca[i].ca_name; i++) {
 902         nca++;
 903         if (!(ca[i].ca_flags & NSC_EXTRA))
 904             nf += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
 905     }
 906     fldca = malloc(nf * sizeof(*fldca));
 907     fldidx = malloc(nf * sizeof(*fldidx));
 908     caflds = malloc(nca * sizeof(*caflds));
 909     cafldspp = calloc(nca, sizeof(*cafldspp));
 910     cur_type = type;
 911
 912     if (xutail(fp, ca) < 0)
 913         type = EF_BAD;
 914
 915     free(cafldspp);
 916     free(caflds);
 917     free(fldidx);
 918     free(fldca);
 919
 920     /* Skip empty lines so that callers can easily check for EOF */
 921     while ((ch = skipfs(fp)) == '\n')
 922         lineno++;
 923     ungetc(ch, fp);
 924
 925     *plno = lineno;
 926     return type;
 927 }
 928
 929 /*
 930  * Read the remainder of an xdump after the table header line from FP.
 931  * CA[] contains the table's selectors.
 932  * Return 0 on success, -1 on failure.
 933  */
 934 static int
 935 xutail(FILE *fp, struct castr *ca)
 936 {
 937     int recs;
 938
 939     is_partial = 0;
 940     for (;;) {
 941         if (xufldhdr(fp, ca) < 0)
 942             return -1;
 943         if ((recs = xubody(fp)) < 0)
 944             return -1;
 945         if (xufooter(fp, ca, recs) < 0)
 946             return -1;
 947         if (!ellipsis)
 948             return 0;
 949         if (xuheader(fp, cur_type) < 0)
 950             return -1;
 951     }
 952 }
 953
 954 /*
 955  * Read the body of an xdump table from FP.
 956  * Return number of rows read on success, -1 on failure.
 957  */
 958 static int
 959 xubody(FILE *fp)
 960 {
 961     struct empfile *ep = &empfile[cur_type];
 962     int i, maxid, ch;
 963
 964     maxid = 0;
 965     for (i = 0;; ++i) {
 966         while ((ch = skipfs(fp)) == '\n')
 967             lineno++;
 968         if (ch == '/')
 969             break;
 970         ungetc(ch, fp);
 971         cur_obj = NULL;
 972         cur_id = i;
 973         if (xuflds(fp, xufld) < 0)
 974             return -1;
 975         maxid = MAX(maxid, cur_id + 1);
 976     }
 977
 978     if (CANT_HAPPEN(maxid > ep->fids))
 979         maxid = ep->fids;
 980     if (maxid < ep->fids) {
 981         if (EF_IS_GAME_STATE(cur_type)
 982             || (cur_type >= EF_SHIP_CHR && cur_type <= EF_NUKE_CHR))
 983             ef_truncate(cur_type, maxid);
 984         else
 985             return gripe("Table %s requires %d rows, got %d",
 986                          ef_nameof(cur_type), ep->fids, maxid);
 987     }
 988
 989     return i;
 990 }