]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/xundump.c
Update copyright notice.
[empserver] / src / lib / common / xundump.c
index 948c8a767df37c42154ce3a039be70cdd77607be..44590591bf803942538710866b996417c9dbbaf1 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2007, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                           Ken Stevens, Steve McClure
  *
  *  This program is free software; you can redistribute it and/or modify
  * 
  *  Known contributors to this file:
  *     Ron Koenderink, 2005
- *     Markus Armbruster, 2005
+ *     Markus Armbruster, 2005-2006
  */
 
-/* FIXME normalize terminology: table/rows/columns or file/records/fields */
+/*
+ * FIXME:
+ * - Normalize terminology: table/rows/columns or file/records/fields
+ * - Loading tables with NSC_STRING elements more than once leaks memory
+ * TODO:
+ * - Check each partial table supplies the same rows
+ * - Check EFF_CFG tables are dense
+ * - Symbolic references to non-symbol tables
+ * - Symbolic array indexes
+ * TODO, but hardly worth the effort:
+ * - Permit reordering of array elements
+ * - Permit repetition of array elements in split tables
+ */
 
 #include <config.h>
 
-#include <stdio.h>
-#include <stdlib.h>
-
 #include <ctype.h>
-#include <string.h>
 #include <stdarg.h>
+#include <stdio.h>
 #include <time.h>
-
 #include "file.h"
 #include "match.h"
 #include "nsc.h"
 static char *fname;
 static int lineno;
 static int human;
-static int cur_type;
+static int ellipsis, is_partial;
+static int cur_type, cur_id;
 static void *cur_obj;
+static int cur_obj_is_blank;
 static int nflds;
 static struct castr **fldca;
 static int *fldidx;
 static int *caflds;
+static unsigned char *caseen;
 
 static int gripe(char *, ...) ATTRIBUTE((format (printf, 1, 2)));
 static int deffld(int, char *, int);
+static int defellipsis(int fldno);
+static int chkflds(void);
 static int setnum(int, double);
 static int setstr(int, char *);
-static int xunsymbol1(char *, struct symbol *, struct castr *, int);
+static int xunsymbol(char *, struct castr *, int);
 static int setsym(int, char *);
 static int mtsymset(int, long *);
 static int add2symset(int, long *, char *);
-static struct symbol *get_symtab(struct castr *);
 static int xundump1(FILE *, int, struct castr *);
+static int xundump2(FILE *, int, struct castr *);
 
 static int
 gripe(char *fmt, ...)
@@ -107,7 +120,8 @@ static int
 getid(FILE *fp, char *buf)
 {
     int n;
-    if (fscanf(fp, "%1023[^#() \t\n]%n", buf, &n) != 1 || !isalpha(buf[0]))
+    if (fscanf(fp, "%1023[^#()<>=#\" \t\n]%n", buf, &n) != 1
+       || !isalpha(buf[0]))
        return -1;
     return n;
 }
@@ -144,10 +158,22 @@ xufldname(FILE *fp, int i)
     case EOF:
        return gripe("Unexpected EOF");
     case '\n':
-       if (i != nflds)
-           return gripe("Header fields missing"); /* TODO which? */
+       if (chkflds() < 0)
+           return -1;
        lineno++;
        return 0;
+    case '.':
+       if (getc(fp) != '.' || getc(fp) != '.')
+           return gripe("Junk in header field %d", i + 1);
+       if (i == 0)
+           return gripe("... not allowed in field 1");
+       if (defellipsis(i) < 0)
+           return -1;
+       ch = skipfs(fp);
+       if (ch != EOF && ch != '\n')
+           return gripe("Junk after ...");
+       ungetc(ch, fp);
+       return 1;
     default:
        ungetc(ch, fp);
        if (getid(fp, buf) < 0)
@@ -192,8 +218,12 @@ xufld(FILE *fp, int i)
     case EOF:
        return gripe("Unexpected EOF");
     case '\n':
-       if (i != nflds)
+       if (i != nflds) {
+           if (fldca[i]->ca_type != NSC_STRINGY && fldca[i]->ca_len)
+               return gripe("Field %s(%d) missing",
+                            fldca[i]->ca_name, fldidx[i]);
            return gripe("Field %s missing", fldca[i]->ca_name);
+       }
        lineno++;
        return 0;
     case '+': case '-': case '.':
@@ -291,16 +321,62 @@ deffld(int fldno, char *name, int idx)
            return gripe("Header %s doesn't take an index in field %d",
                         ca[res].ca_name, fldno + 1);
        idx = 0;
-       if (caflds[res])
+       if (caflds[res] && !caseen[res])
+           /* FIXME doesn't catch dupes within table part when caseen[res] */
            return gripe("Duplicate header %s in field %d",
                         ca[res].ca_name, fldno + 1);
     }
     fldca[fldno] = &ca[res];
     fldidx[fldno] = idx;
-    caflds[res]++;
+    if (!caseen[res])
+       caflds[res]++;
     return 1;
 }
 
+static int
+defellipsis(int fldno)
+{
+    struct castr *ca = ef_cadef(cur_type);
+
+    if (ca[0].ca_table != cur_type)
+       return gripe("Table %s doesn't support ...", ef_nameof(cur_type));
+    ellipsis = fldno;
+    is_partial = 1;
+    return 0;
+}
+
+static int
+chkflds(void)
+{
+    struct castr *ca = ef_cadef(cur_type);
+    int i, len, res = 0;
+
+    if (is_partial) {
+       /* Require index field */
+       if (!caflds[0])
+           return gripe("Header field %s required with ...", ca[0].ca_name);
+       /* Want the index field again in continued table: */
+       caflds[0] = 0;
+       return 0;
+    }
+
+    for (i = 0; ca[i].ca_name; i++) {
+       if (ca[i].ca_flags & NSC_EXTRA)
+           continue;
+       len = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
+       if (!len && !caflds[i])
+           res = gripe("Header field %s missing", ca[i].ca_name);
+       else if (len && caflds[i] == len - 1)
+           res = gripe("Header field %s(%d) missing",
+                       ca[i].ca_name, len - 1);
+       else if (len && caflds[i] < len - 1)
+           res = gripe("Header fields %s(%d) ... %s(%d) missing",
+                       ca[i].ca_name, caflds[i], ca[i].ca_name, len - 1);
+    }
+
+    return res;
+}
+
 static struct castr *
 getfld(int fldno, int *idx)
 {
@@ -315,6 +391,41 @@ getfld(int fldno, int *idx)
     return fldca[fldno];
 }
 
+static int
+fldval_must_match(int fldno)
+{
+    struct castr *ca = ef_cadef(cur_type);
+    int i = fldca[fldno] - ca;
+
+    return (!cur_obj_is_blank && (fldca[fldno]->ca_flags & NSC_CONST))
+       || caseen[i];
+}
+
+static void *
+getobj(struct castr *ca, int altid)
+{
+    struct empfile *ep = &empfile[cur_type];
+    int need_sentinel = !EF_IS_GAME_STATE(cur_type);
+
+    if (!cur_obj) {
+       if (ca->ca_table == cur_type)
+           cur_id = altid;
+       cur_obj_is_blank = cur_id >= ep->fids;
+       if (cur_obj_is_blank) {
+           /* TODO grow cache (and posssibly file) unless EFF_STATIC */
+           if (cur_id < ep->csize - !!need_sentinel)
+               ep->cids = ep->fids = cur_id + 1;
+           /* else: ef_ptr() will fail */
+       }
+       cur_obj = ef_ptr(cur_type, cur_id);
+       if (!cur_obj)
+           gripe("Can't put ID %d into table %s, it holds only 0..%d.",
+                 cur_id, ep->name, ep->fids - 1);
+    }
+
+    return cur_obj;
+}
+
 static int
 setnum(int fldno, double dbl)
 {
@@ -327,15 +438,19 @@ setnum(int fldno, double dbl)
     if (!ca)
        return -1;
 
-    memb_ptr = cur_obj;
+    memb_ptr = getobj(ca, (int)dbl);
+    if (!memb_ptr)
+       return -1;
     memb_ptr += ca->ca_off;
+
+    /* FIXME check assignment preserves value */
     switch (ca->ca_type) {
     case NSC_CHAR:
-    case NSC_TYPEID:
        old = ((signed char *)memb_ptr)[idx];
        ((signed char *)memb_ptr)[idx] = (signed char)dbl;
        break;
     case NSC_UCHAR:
+    case NSC_HIDDEN:
        old = ((unsigned char *)memb_ptr)[idx];
        ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
        break;
@@ -357,10 +472,16 @@ setnum(int fldno, double dbl)
        break;
     case NSC_XCOORD:
        old = ((coord *)memb_ptr)[idx];
+       /* FIXME use variant of xrel() that takes orig instead of nation */
+       if (old >= WORLD_X / 2)
+           old -= WORLD_X;
        ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
        break;
     case NSC_YCOORD:
        old = ((coord *)memb_ptr)[idx];
+       /* FIXME use variant of yrel() that takes orig instead of nation */
+       if (old >= WORLD_Y / 2)
+           old -= WORLD_Y;
        ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
        break;
     case NSC_FLOAT:
@@ -379,7 +500,7 @@ setnum(int fldno, double dbl)
        return gripe("Field %d doesn't take numbers", fldno + 1);
     }
 
-    if ((ca->ca_flags & NSC_CONST) && old != dbl)
+    if (fldval_must_match(fldno) && old != dbl)
        return gripe("Value for field %d must be %g", fldno + 1, old);
 
     return 1;
@@ -389,40 +510,48 @@ static int
 setstr(int fldno, char *str)
 {
     struct castr *ca;
-    int idx;
+    int must_match, idx;
+    size_t len;
     char *memb_ptr, *old;
 
     ca = getfld(fldno, &idx);
     if (!ca)
        return -1;
 
-    memb_ptr = cur_obj;
+    memb_ptr = getobj(ca, cur_id);
+    if (!memb_ptr)
+       return -1;
     memb_ptr += ca->ca_off;
+    must_match = fldval_must_match(fldno);
+
     switch (ca->ca_type) {
     case NSC_STRING:
        old = ((char **)memb_ptr)[idx];
-       if (!(ca->ca_flags & NSC_CONST))
+       if (!must_match)
            ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
+       len = 65535;            /* really SIZE_MAX, but that's C99 */
        break;
     case NSC_STRINGY:
        if (CANT_HAPPEN(idx))
            return -1;
        if (!str)
-           return gripe("Field doesn't take nil");
-       if (strlen(str) > ca->ca_len)
+           return gripe("Field %d doesn't take nil", fldno + 1);
+       len = ca->ca_len;
+       if (strlen(str) > len)
            return gripe("Field %d takes at most %d characters",
-                        fldno + 1, ca->ca_len);
+                        fldno + 1, (int)len);
        old = memb_ptr;
-       if (!(ca->ca_flags & NSC_CONST))
-           strncpy(memb_ptr, str, ca->ca_len);
+       if (!must_match)
+           strncpy(memb_ptr, str, len);
        break;
     default:
        return gripe("Field %d doesn't take strings", fldno + 1);
     }
 
-    if (ca->ca_flags & NSC_CONST) {
-       if (old && (!str || strcmp(old, str)))
-           return gripe("Value for field %d must be \"%s\"", fldno + 1, old);
+    if (must_match) {
+       if (old && (!str || strncmp(old, str, len)))
+           return gripe("Value for field %d must be \"%.*s\"",
+                        fldno + 1, (int)len, old);
        if (!old && str)
            return gripe("Value for field %d must be nil", fldno + 1);
     }
@@ -431,14 +560,27 @@ setstr(int fldno, char *str)
 }
 
 static int
-xunsymbol1(char *id, struct symbol *symtab, struct castr *ca, int n)
+xunsymbol(char *id, struct castr *ca, int n)
 {
-    int i = stmtch(id, symtab, offsetof(struct symbol, name),
-                  sizeof(struct symbol));
+    int i = ef_elt_byname(ca->ca_table, id);
     if (i < 0)
        return gripe("%s %s symbol `%s' in field %d",
                     i == M_NOTUNIQUE ? "Ambiguous" : "Unknown",
-                    ca->ca_name, id, n);
+                    ca->ca_name, id, n + 1);
+    return i;
+}
+
+static int
+symval(struct castr *ca, int i)
+{
+    int type = ca->ca_table;
+
+    if (ef_check(type) < 0)
+       return -1;
+    if (ef_cadef(type) == symbol_ca)
+       /* symbol table, value is in the table */
+       return ((struct symbol *)ef_ptr(type, i))->value;
+    /* value is the table index */
     return i;
 }
 
@@ -446,49 +588,33 @@ static int
 setsym(int fldno, char *sym)
 {
     struct castr *ca;
-    struct symbol *symtab;
     int i;
 
     ca = getfld(fldno, NULL);
     if (!ca)
        return -1;
 
-    symtab = get_symtab(ca);
-    if (!symtab || (ca->ca_flags & NSC_BITS))
+    if (ca->ca_table == EF_BAD || (ca->ca_flags & NSC_BITS))
        return gripe("Field %d doesn't take symbols", fldno + 1);
 
-    i = xunsymbol1(sym, symtab, ca, fldno);
+    i = xunsymbol(sym, ca, fldno);
     if (i < 0)
        return -1;
-    return setnum(fldno, symtab[i].value);
-}
-
-static int
-has_const(struct castr ca[])
-{
-    int i;
-
-    for (i = 0; ca[i].ca_name; i++) {
-       if (ca[i].ca_flags & NSC_CONST)
-           return 1;
-    }
-    return 0;
+    return setnum(fldno, symval(ca, i));
 }
 
 static int
 mtsymset(int fldno, long *set)
 {
     struct castr *ca;
-    struct symbol *symtab;
 
     ca = getfld(fldno, NULL);
     if (!ca)
        return -1;
 
-    symtab = get_symtab(ca);
-    if (!symtab || !(ca->ca_flags & NSC_BITS)) {
+    if (ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca
+       || !(ca->ca_flags & NSC_BITS))
        return gripe("Field %d doesn't take symbol sets", fldno + 1);
-    }
     *set = 0;
     return 0;
 }
@@ -497,35 +623,19 @@ static int
 add2symset(int fldno, long *set, char *sym)
 {
     struct castr *ca;
-    struct symbol *symtab;
     int i;
 
     ca = getfld(fldno, NULL);
     if (!ca)
        return -1;
 
-    symtab = get_symtab(ca);
-    i = xunsymbol1(sym, symtab, ca, fldno);
+    i = xunsymbol(sym, ca, fldno);
     if (i < 0)
        return -1;
-    *set |= symtab[i].value;
+    *set |= symval(ca, i);
     return 0;
 }
 
-static struct symbol *
-get_symtab(struct castr *ca)
-{
-    int symtype = ca->ca_table;
-    struct symbol *symtab;
-
-    if (symtype == EF_BAD || ef_cadef(symtype) != symbol_ca)
-       return NULL;
-
-    symtab = ef_ptr(symtype, 0);
-    CANT_HAPPEN(!symtab);
-    return symtab;
-}
-
 static int
 xuheader(FILE *fp, int expected_table)
 {
@@ -536,7 +646,7 @@ xuheader(FILE *fp, int expected_table)
     while ((ch = skipfs(fp)) == '\n')
        lineno++;
     if (ch == EOF && expected_table == EF_BAD)
-       return -1;
+       return -2;
     ungetc(ch, fp);
 
     human = ch == 'c';
@@ -556,7 +666,7 @@ xuheader(FILE *fp, int expected_table)
 
     if (!ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
        CANT_HAPPEN(expected_table != EF_BAD);
-       return gripe("Undumping of table `%s' not implemented", name);
+       return gripe("Table `%s' is not permitted here", name);
     }
 
     if (skipfs(fp) != '\n')
@@ -566,6 +676,43 @@ xuheader(FILE *fp, int expected_table)
     return type;
 }
 
+static int
+xuheader1(FILE *fp, int type, struct castr ca[])
+{
+    struct castr **fca;
+    int *fidx;
+    int ch, i, j, n;
+
+    if (human) {
+       while ((ch = skipfs(fp)) == '\n')
+           lineno++;
+       ungetc(ch, fp);
+       ellipsis = 0;
+       nflds = xuflds(fp, xufldname);
+       if (nflds < 0)
+           return -1;
+       nflds -= ellipsis != 0;
+    } else {
+       fca = fldca;
+       fidx = fldidx;
+
+       for (i = 0; ca[i].ca_name; i++) {
+           if ((ca[i].ca_flags & NSC_EXTRA))
+               continue;
+           n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
+           j = 0;
+           do {
+               *fca++ = &ca[i];
+               *fidx++ = j;
+           } while (++j < n);
+       }
+
+       nflds = fidx - fldidx;
+    }
+
+    return 0;
+}
+
 static int
 xutrailer(FILE *fp, int type, int row)
 {
@@ -593,7 +740,7 @@ int
 xundump(FILE *fp, char *file, int expected_table)
 {
     struct castr *ca;
-    int type, nca, i;
+    int type, nca, nf, i, ch;
 
     if (fname != file) {
         fname = file;
@@ -601,97 +748,99 @@ xundump(FILE *fp, char *file, int expected_table)
     }
 
     if ((type = xuheader(fp, expected_table)) < 0)
-       return -1;
+       return type;
 
     ca = ef_cadef(type);
     if (CANT_HAPPEN(!ca))
        return -1;
 
-    nca = nflds = 0;
+    nca = nf = 0;
     for (i = 0; ca[i].ca_name; i++) {
        nca++;
        if (!(ca[i].ca_flags & NSC_EXTRA))
-           nflds += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
+           nf += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
     }
-    fldca = calloc(nflds, sizeof(*fldca));
-    fldidx = calloc(nflds, sizeof(*fldidx));
+    fldca = calloc(nf, sizeof(*fldca));
+    fldidx = calloc(nf, sizeof(*fldidx));
     caflds = calloc(nca, sizeof(*caflds));
-
+    caseen = calloc(nca, sizeof(*caseen));
     cur_type = type;
-    if (human) {
-       if (xuflds(fp, xufldname) < 0)
-           type = EF_BAD;
-    } else {
-       struct castr **fca = fldca;
-       int *fidx = fldidx;
-       int i, j, n;
-       for (i = 0; ca[i].ca_name; i++) {
-           if ((ca[i].ca_flags & NSC_EXTRA))
-               continue;
-           n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
-           j = 0;
-           do {
-               *fca++ = &ca[i];
-               *fidx++ = j;
-           } while (++j < n);
-       }
-    }
 
-    if (type >= 0 && xundump1(fp, type, ca) < 0)
+    if (xundump2(fp, type, ca) < 0)
        type = EF_BAD;
 
+    free(caseen);
     free(caflds);
     free(fldidx);
     free(fldca);
 
+    /* Skip empty lines so that callers can easily check for EOF */
+    while ((ch = skipfs(fp)) == '\n')
+       lineno++;
+    ungetc(ch, fp);
+
     return type;
 }
 
+static int
+xundump2(FILE *fp, int type, struct castr *ca)
+{
+    int i;
+
+    is_partial = 0;
+    for (;;) {
+       if (xuheader1(fp, type, ca) < 0)
+           return -1;
+       if (xundump1(fp, type, ca) < 0)
+           return -1;
+       if (!ellipsis)
+           return 0;
+       for (i = 0; ca[i].ca_name; i++)
+           caseen[i] = caflds[i] != 0;
+       if (xuheader(fp, type) < 0)
+           return -1;
+    }
+}
+
 static int
 xundump1(FILE *fp, int type, struct castr *ca)
 {
     struct empfile *ep = &empfile[type];
-    int fixed_rows = has_const(ca);
     int need_sentinel = !EF_IS_GAME_STATE(type);
-    int row, ch;
+    int row, n, ch;
 
+    n = 0;
     for (row = 0;; ++row) {
-       ch = skipfs(fp);
+       while ((ch = skipfs(fp)) == '\n')
+           lineno++;
        if (ch == '/')
            break;
        ungetc(ch, fp);
-       /* TODO ability to skip records */
-       if (!fixed_rows) {
-           if (row >= ep->csize - !!need_sentinel)
-               /* TODO grow cache unless EFF_STATIC */
-               return gripe("Too many rows for table %s", ef_nameof(type));
-           if (row >= ep->cids)
-               /* TODO grow file */
-               ep->cids = ep->fids = row + 1;
-       }
-       cur_obj = ef_ptr(type, row);
-       if (!cur_obj)
-           return gripe("Too many rows for table %s", ef_nameof(type));
+       cur_obj = NULL;
+       cur_id = row;
        if (xuflds(fp, xufld) < 0)
            return -1;
+       n = MAX(n, cur_id + 1);
     }
-    if (row != ep->fids) {
-       if (fixed_rows)
+
+    if (CANT_HAPPEN(n > ep->fids))
+       n = ep->fids;
+    if (n < ep->fids) {
+       if (EF_IS_GAME_STATE(type) && n != ep->csize)
+           /* TODO truncate file */
+           gripe("Warning: should resize table %s from %d to %d, not implemented",
+                 ef_nameof(type), ep->csize, n);
+       else if (type >= EF_SHIP_CHR && type <= EF_NUKE_CHR)
+           ep->cids = ep->fids = n;
+       else
            return gripe("Table %s requires %d rows, got %d",
-                        ef_nameof(type), ep->fids, row);
-       else {
-           ep->cids = ep->fids = row;
-           if (EF_IS_GAME_STATE(type) && row != ep->csize)
-               /* TODO truncate file */
-               gripe("Warning: should resize table %s from %d to %d, not implemented",
-                     ef_nameof(type), ep->csize, row);
-       }
+                        ef_nameof(type), ep->fids, n);
     }
 
     if (need_sentinel) {
-       if (CANT_HAPPEN(row >= ep->csize))
+       if (CANT_HAPPEN(n >= ep->csize))
            return gripe("No space for sentinel");
-       memset(ep->cache + ep->size * row, 0, ep->size);
+       memset(ep->cache + ep->size * n, 0, ep->size);
     }
 
     if (xutrailer(fp, type, row) < 0)