]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/xundump.c
Clean up xundump's test whether table may be truncated
[empserver] / src / lib / common / xundump.c
index abef9c27e664d1a6b73198938a3d44de72e2c9e8..515f2863e37d14051509eb4128f1ce33e881a8e5 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                Ken Stevens, Steve McClure, Markus Armbruster
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  Empire is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -14,8 +14,7 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *  ---
  *
  *  ---
  *
  *  xundump.c: Load back xdump output
- * 
+ *
  *  Known contributors to this file:
  *     Ron Koenderink, 2005
- *     Markus Armbruster, 2005-2008
+ *     Markus Armbruster, 2005-2011
  */
 
 /*
 
 static char *fname;            /* Name of file being read */
 static int lineno;             /* Current line number */
-static int human;              /* Reading human-readable syntax? */
-static int ellipsis;           /* Header ended with ...? */
-static int is_partial;         /* Is input split into parts? */
+
 static int cur_type;           /* Current table's file type */
 static void *cur_obj;          /* The object being read into */
 static int cur_id;             /* and its index in the table */
 static int cur_obj_is_blank;
+
+static int human;              /* Reading human-readable syntax? */
+static int ellipsis;           /* Header ended with ...? */
+static int is_partial;         /* Is input split into parts? */
 static int nflds;              /* #fields in input records */
 static struct castr **fldca;   /* Map field number to selector */
 static int *fldidx;            /* Map field number to index */
 static int *caflds;            /* Map selector number to #fields seen */
 static int *cafldspp;          /* ditto, in previous parts */
+static int may_trunc;          /* Okay to truncate? */
 
 static int gripe(char *, ...) ATTRIBUTE((format (printf, 1, 2)));
 static int deffld(int, char *, int);
@@ -111,6 +113,95 @@ gripe(char *fmt, ...)
     return -1;
 }
 
+/* Make TYPE the current table.  */
+static void
+tbl_start(int type)
+{
+    cur_type = type;
+    cur_id = -1;
+    cur_obj = NULL;
+}
+
+/* End the current table.  */
+static void
+tbl_end(void)
+{
+    tbl_start(EF_BAD);
+}
+
+/*
+ * Seek to current table's ID-th record.
+ * ID must be acceptable.
+ * Store it in cur_obj, and set cur_id and cur_obj_is_blank accordingly.
+ * Return 0 on success, -1 on failure.
+ */
+static int
+tbl_seek(int id)
+{
+    struct empfile *ep = &empfile[cur_type];
+
+    cur_obj_is_blank = id >= ep->fids;
+
+    if (id >= ef_nelem(cur_type)) {
+       if (!ef_ensure_space(cur_type, id, 1))
+           return gripe("Can't put ID %d into table %s", id, ep->name);
+    }
+
+    cur_obj = ef_ptr(cur_type, id);
+    if (CANT_HAPPEN(!cur_obj))
+       return -1;
+    cur_id = id;
+    return 0;
+}
+
+/*
+ * Get the next object.
+ * Must not have a record index.
+ * Store it in cur_obj, and set cur_id and cur_obj_is_blank accordingly.
+ * Return 0 on success, -1 on failure.
+ */
+static int
+tbl_next_obj(void)
+{
+    int max_id = ef_id_limit(cur_type);
+
+    if (cur_id >= max_id)
+       return gripe("Too many rows");
+    return tbl_seek(cur_id + 1);
+}
+
+/*
+ * Get the next object, it has record index ID.
+ * Store it in cur_obj, and set cur_id and cur_obj_is_blank accordingly.
+ * Return 0 on success, -1 on failure.
+ */
+static int
+tbl_skip_to_obj(int id)
+{
+    int max_id;
+
+    if (id < 0)
+       return gripe("Field %d must be >= 0", 1);
+    max_id = ef_id_limit(cur_type);
+    if (id > max_id)
+       return gripe("Field %d must be <= %d", 1, max_id);
+
+    if (tbl_seek(id) < 0)
+       return -1;
+    return 0;
+}
+
+/*
+ * Finish table part.
+ * If the table has variable length, truncate it.
+ */
+static void
+tbl_part_done(void)
+{
+    cur_id = -1;
+    cur_obj = NULL;
+}
+
 /*
  * Read and ignore field separators from FP.
  * Return first character that is not a field separator.
@@ -349,11 +440,11 @@ deffld(int fldno, char *name, int idx)
     int res;
 
     res = stmtch(name, ca, offsetof(struct castr, ca_name),
-                    sizeof(struct castr));
+                sizeof(struct castr));
     if (res < 0)
        return gripe("Header %s of field %d is %s", name, fldno + 1,
                     res == M_NOTUNIQUE ? "ambiguous" : "unknown");
-    if (ca[res].ca_flags == NSC_EXTRA || CANT_HAPPEN(ca[res].ca_get))
+    if ((ca[res].ca_flags & NSC_EXTRA) || CANT_HAPPEN(ca[res].ca_get))
        return gripe("Extraneous header %s in field %d", name, fldno + 1);
     if (ca[res].ca_type != NSC_STRINGY && ca[res].ca_len != 0) {
        if (idx < 0)
@@ -393,7 +484,7 @@ defellipsis(void)
 {
     struct castr *ca = ef_cadef(cur_type);
 
-    if (ca[0].ca_table != cur_type)
+    if (ca[0].ca_table != cur_type || (ca[0].ca_flags & NSC_EXTRA))
        return gripe("Table %s doesn't support ...", ef_nameof(cur_type));
     ellipsis = is_partial = 1;
     return 0;
@@ -409,15 +500,21 @@ chkflds(void)
     struct castr *ca = ef_cadef(cur_type);
     int i, len, cafldsmax, res = 0;
 
+    /* Record index must come first, to make cur_id work, see setnum() */
+    if (ca[0].ca_table == cur_type && caflds[0] && fldca[0] != &ca[0])
+       res = gripe("Header field %s must come first", ca[0].ca_name);
+
     if (is_partial) {
        /* Need a join field, use 0-th selector */
        if (!caflds[0])
-           return gripe("Header field %s required with ...", ca[0].ca_name);
+           res = gripe("Header field %s required in each table part",
+                       ca[0].ca_name);
     }
 
     if (ellipsis)
-       return 0;
+       return res;             /* table is split, another part expected */
 
+    /* Check for missing fields */
     for (i = 0; ca[i].ca_name; i++) {
        cafldsmax = MAX(caflds[i], cafldspp[i]);
        if (ca[i].ca_flags & NSC_EXTRA)
@@ -473,32 +570,6 @@ fldval_must_match(int fldno)
        || fldidx[fldno] < cafldspp[i];
 }
 
-/*
- * Get the current object.
- * Store it in cur_obj, and set cur_obj_is_blank accordingly.
- * Return cur_obj, which is null on error.
- */
-static void *
-getobj(void)
-{
-    struct empfile *ep = &empfile[cur_type];
-
-    if (!cur_obj) {
-       cur_obj_is_blank = cur_id >= ep->fids;
-       if (cur_obj_is_blank) {
-           if (ef_ensure_space(cur_type, cur_id, 1))
-               cur_obj = ef_ptr(cur_type, cur_id);
-           /* FIXME diagnose out of dynamic memory vs. static table full */
-           if (!cur_obj)
-               gripe("Can't put ID %d into table %s, it holds only 0..%d.",
-                     cur_id, ep->name, ep->fids - 1);
-       } else
-           cur_obj = ef_ptr(cur_type, cur_id);
-    }
-
-    return cur_obj;
-}
-
 /*
  * Set value of field FLDNO in current object to DBL.
  * Return 1 on success, -1 on error.
@@ -507,77 +578,87 @@ static int
 setnum(int fldno, double dbl)
 {
     struct castr *ca;
-    int idx;
+    int next_id, idx;
     char *memb_ptr;
-    double old;
+    double old, new;
 
     ca = getfld(fldno, &idx);
     if (!ca)
        return -1;
 
-    /*
-     * If this is the record index, put it into cur_id.
-     */
-    if (fldno == 0 && ca->ca_table == cur_type)
-       cur_id = (int)dbl;
-
-    memb_ptr = getobj();
-    if (!memb_ptr)
-       return -1;
+    if (fldno == 0) {
+       if (ca->ca_table == cur_type) {
+           /* Got record index */
+           next_id = (int)dbl;
+           if (next_id != dbl)
+               return gripe("Field %d can't hold this value", fldno + 1);
+           if (tbl_skip_to_obj(next_id) < 0)
+               return -1;
+       } else {
+           if (tbl_next_obj() < 0)
+               return -1;
+       }
+    }
+    memb_ptr = cur_obj;
     memb_ptr += ca->ca_off;
 
-    /* FIXME check assignment preserves value */
     switch (ca->ca_type) {
     case NSC_CHAR:
        old = ((signed char *)memb_ptr)[idx];
-       ((signed char *)memb_ptr)[idx] = (signed char)dbl;
+       new = ((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;
+       new = ((unsigned char *)memb_ptr)[idx] = (unsigned char)dbl;
        break;
     case NSC_SHORT:
        old = ((short *)memb_ptr)[idx];
-       ((short *)memb_ptr)[idx] = (short)dbl;
+       new = ((short *)memb_ptr)[idx] = (short)dbl;
        break;
     case NSC_USHORT:
        old = ((unsigned short *)memb_ptr)[idx];
-       ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
+       new = ((unsigned short *)memb_ptr)[idx] = (unsigned short)dbl;
        break;
     case NSC_INT:
        old = ((int *)memb_ptr)[idx];
-       ((int *)memb_ptr)[idx] = (int)dbl;
+       new = ((int *)memb_ptr)[idx] = (int)dbl;
        break;
     case NSC_LONG:
        old = ((long *)memb_ptr)[idx];
-       ((long *)memb_ptr)[idx] = (long)dbl;
+       new = ((long *)memb_ptr)[idx] = (long)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);
+       new = ((coord *)memb_ptr)[idx] = XNORM((coord)dbl);
+       if (new >= WORLD_X / 2)
+           new -= WORLD_X;
        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);
+       new = ((coord *)memb_ptr)[idx] = YNORM((coord)dbl);
+       if (new >= WORLD_Y / 2)
+           new -= WORLD_Y;
        break;
     case NSC_FLOAT:
        old = ((float *)memb_ptr)[idx];
        ((float *)memb_ptr)[idx] = (float)dbl;
+       new = dbl;              /* suppress new != dbl check */
        break;
     case NSC_DOUBLE:
        old = ((double *)memb_ptr)[idx];
        ((double *)memb_ptr)[idx] = dbl;
+       new = dbl;              /* suppress new != dbl check */
        break;
     case NSC_TIME:
        old = ((time_t *)memb_ptr)[idx];
-       ((time_t *)memb_ptr)[idx] = (time_t)dbl;
+       new = ((time_t *)memb_ptr)[idx] = (time_t)dbl;
        break;
     default:
        return gripe("Field %d doesn't take numbers", fldno + 1);
@@ -585,6 +666,8 @@ setnum(int fldno, double dbl)
 
     if (fldval_must_match(fldno) && old != dbl)
        return gripe("Value for field %d must be %g", fldno + 1, old);
+    if (new != dbl)
+       return gripe("Field %d can't hold this value", fldno + 1);
 
     return 1;
 }
@@ -605,9 +688,11 @@ setstr(int fldno, char *str)
     if (!ca)
        return -1;
 
-    memb_ptr = getobj();
-    if (!memb_ptr)
-       return -1;
+    if (fldno == 0) {
+       if (tbl_next_obj() < 0)
+           return -1;
+    }
+    memb_ptr = cur_obj;
     memb_ptr += ca->ca_off;
     must_match = fldval_must_match(fldno);
 
@@ -615,6 +700,7 @@ setstr(int fldno, char *str)
     case NSC_STRING:
        old = ((char **)memb_ptr)[idx];
        if (!must_match)
+           /* FIXME may leak old value */
            ((char **)memb_ptr)[idx] = str ? strdup(str) : NULL;
        len = 65535;            /* really SIZE_MAX, but that's C99 */
        break;
@@ -671,9 +757,7 @@ symval(struct castr *ca, int i)
 {
     int type = ca->ca_table;
 
-    if (ef_check(type) < 0)
-       return -1;
-    if (ef_cadef(type) == symbol_ca)
+    if (type != EF_BAD && 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 */
@@ -768,9 +852,9 @@ xuheader(FILE *fp, int expected_table)
     human = ch == 'c';
     res = -1;
     if ((human
-         ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
-         : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
-                  name, &res) != 1) || res < 0)
+        ? fscanf(fp, "config%*[ \t]%63[^ \t#\n]%n", name, &res) != 1
+        : fscanf(fp, "XDUMP%*[ \t]%63[^ \t#\n]%*[ \t]%*[^ \t#\n]%n",
+                 name, &res) != 1) || res < 0)
        return gripe("Expected xdump header");
 
     type = ef_byname(name);
@@ -780,7 +864,8 @@ xuheader(FILE *fp, int expected_table)
        return gripe("Expected table `%s', not `%s'",
                     ef_nameof(expected_table), name);
 
-    if (!ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
+    if (!empfile[type].file
+       || !ef_cadef(type) || !(ef_flags(type) & EFF_MEM)) {
        CANT_HAPPEN(expected_table != EF_BAD);
        return gripe("Table `%s' is not permitted here", name);
     }
@@ -853,7 +938,7 @@ xufooter(FILE *fp, struct castr ca[], int recs)
 
     res = -1;
     if (human) {
-       if (fscanf(fp, "config%n",  &res) != 0 || res < 0)
+       if (fscanf(fp, "config%n", &res) != 0 || res < 0)
            return gripe("Malformed table footer");
     } else {
        if (fscanf(fp, "%d", &n) != 1)
@@ -864,6 +949,7 @@ xufooter(FILE *fp, struct castr ca[], int recs)
     }
     if (skipfs(fp) != '\n')
        return gripe("Junk after table footer");
+    tbl_part_done();
     lineno++;
 
     for (i = 0; ca[i].ca_name; i++) {
@@ -900,19 +986,24 @@ xundump(FILE *fp, char *file, int *plno, int expected_table)
        return -1;
 
     nca = nf = 0;
+    may_trunc = empfile[type].nent < 0;
     for (i = 0; ca[i].ca_name; i++) {
        nca++;
-       if (!(ca[i].ca_flags & NSC_EXTRA))
+       if (!(ca[i].ca_flags & NSC_EXTRA)) {
            nf += MAX(1, ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0);
+           if (ca[i].ca_flags & NSC_CONST)
+               may_trunc = 0;
+       }
     }
     fldca = malloc(nf * sizeof(*fldca));
     fldidx = malloc(nf * sizeof(*fldidx));
     caflds = malloc(nca * sizeof(*caflds));
     cafldspp = calloc(nca, sizeof(*cafldspp));
-    cur_type = type;
 
+    tbl_start(type);
     if (xutail(fp, ca) < 0)
        type = EF_BAD;
+    tbl_end();
 
     free(cafldspp);
     free(caflds);
@@ -970,8 +1061,6 @@ xubody(FILE *fp)
        if (ch == '/')
            break;
        ungetc(ch, fp);
-       cur_obj = NULL;
-       cur_id = i;
        if (xuflds(fp, xufld) < 0)
            return -1;
        maxid = MAX(maxid, cur_id + 1);
@@ -980,10 +1069,10 @@ xubody(FILE *fp)
     if (CANT_HAPPEN(maxid > ep->fids))
        maxid = ep->fids;
     if (maxid < ep->fids) {
-       if (EF_IS_GAME_STATE(cur_type)
-           || (cur_type >= EF_SHIP_CHR && cur_type <= EF_NUKE_CHR))
-           ef_truncate(cur_type, maxid);
-       else
+       if (may_trunc) {
+           if (!ef_truncate(cur_type, maxid))
+               return -1;
+       else
            return gripe("Table %s requires %d rows, got %d",
                         ef_nameof(cur_type), ep->fids, maxid);
     }