]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/xdump.c
License upgrade to GPL version 3 or later
[empserver] / src / lib / common / xdump.c
index b2117249cb0a794d72b20c78583cf2640d99fddc..5c214043d9e606c06565a4d1496acefec64b618f 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/>.
  *
  *  ---
  *
@@ -26,9 +25,9 @@
  *  ---
  *
  *  xdump.c: Extended dumps
- * 
+ *
  *  Known contributors to this file:
- *     Markus Armbruster, 2008
+ *     Markus Armbruster, 2004-2008
  */
 
 /*
 #include <config.h>
 
 #include <ctype.h>
+#include <limits.h>
 #include "file.h"
 #include "nat.h"
 #include "xdump.h"
 
 /*
- * Initialize XD to dump for country CNUM.
+ * Initialize XD.
+ * Translate dump for country CNUM, except when CNUM is NATID_BAD.
+ * If HUMAN, dump in human-readable format.
  * Dump is to be delivered through callback PR.
  * Return XD.
  */
 struct xdstr *
-xdinit(struct xdstr *xd, natid cnum, void (*pr)(char *fmt, ...))
+xdinit(struct xdstr *xd, natid cnum, int human, void (*pr)(char *fmt, ...))
 {
     xd->cnum = cnum;
-    xd->divine = getnatp(cnum)->nat_stat == STAT_GOD;
+    xd->divine = cnum == NATID_BAD || getnatp(cnum)->nat_stat == STAT_GOD;
+    xd->human = human;
     xd->pr = pr;
     return xd;
 }
@@ -101,7 +104,7 @@ xdinit(struct xdstr *xd, natid cnum, void (*pr)(char *fmt, ...))
  * PTR points to the context object.
  * IDX is the index within the attribute.
  */
-struct valstr *
+static struct valstr *
 xdeval(struct valstr *val, struct xdstr *xd,
        struct castr *ca, void *ptr, int idx)
 {
@@ -110,14 +113,38 @@ xdeval(struct valstr *val, struct xdstr *xd,
 }
 
 /*
- * Dump VAL prefixed with SEP, return " ".
- * VAL must be evaluated.
+ * Dump string STR to XD with funny characters escaped.
+ * Dump at most N characters.
  */
-char *
-xdprval(struct xdstr *xd, struct valstr *val, char *sep)
+static void
+xdpresc(struct xdstr *xd, char *str, size_t n)
 {
     unsigned char *s, *e, *l;
 
+    s = (unsigned char *)str;
+    l = s + n;
+    for (;;) {
+       for (e = s;
+            e < l && *e != '"' && *e != '\\' && isgraph(*e);
+            ++e)
+           ;
+       xd->pr("%.*s", (int)(e-s), s);
+       if (e < l && *e)
+           xd->pr("\\%03o", *e++);
+       else
+           break;
+       s = e;
+    }
+}
+
+/*
+ * Dump VAL prefixed with SEP to XD, in machine readable format.
+ * VAL must be evaluated.
+ * Return " ".
+ */
+static char *
+xdprval_nosym(struct xdstr *xd, struct valstr *val, char *sep)
+{
     if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
        xd->pr("%snil", sep);
        return " ";
@@ -131,23 +158,9 @@ xdprval(struct xdstr *xd, struct valstr *val, char *sep)
        xd->pr("%s%#g", sep, val->val_as.dbl);
        break;
     case NSC_STRING:
-       s = (unsigned char *)val->val_as.str.base;
-       if (s) {
+       if (val->val_as.str.base) {
            xd->pr("%s\"", sep);
-           l = s + val->val_as.str.maxsz;
-           /* FIXME maxsz == INT_MAX ! */
-           for (;;) {
-               for (e = s;
-                    e < l && *e != '"' && *e != '\\' && isgraph(*e);
-                    ++e)
-                   ;
-               xd->pr("%.*s", (int)(e-s), s);
-               if (e < l && *e)
-                   xd->pr("\\%03o", *e++);
-               else
-                   break;
-               s = e;
-           }
+           xdpresc(xd, val->val_as.str.base, val->val_as.str.maxsz);
            xd->pr("\"");
        } else
            xd->pr("%snil", sep);
@@ -159,6 +172,58 @@ xdprval(struct xdstr *xd, struct valstr *val, char *sep)
     return " ";
 }
 
+/*
+ * Dump symbol with value KEY from symbol table TYPE to XD.
+ * Prefix with SEP, return " ".
+ */
+static char *
+xdprsym(struct xdstr *xd, int key, int type, char *sep)
+{
+    char *sym = symbol_by_value(key, ef_ptr(type, 0));
+
+    if (CANT_HAPPEN(!sym))
+       xd->pr("%s%d", sep, key);
+    else {
+       xd->pr("%s", sep);
+       xdpresc(xd, sym, INT_MAX);
+    }
+    return " ";
+}
+
+/*
+ * Dump VAL prefixed with SEP to XD, return " ".
+ * VAL must be evaluated.
+ * CA describes the field from which the value was fetched.
+ */
+static char *
+xdprval_sym(struct xdstr *xd, struct valstr *val, struct castr *ca,
+           char *sep)
+{
+    unsigned long bit;
+
+    if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
+       xd->pr("%snil", sep);
+       return " ";
+    }
+
+    if (!xd->human || val->val_type != NSC_LONG
+       || ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca)
+       return xdprval_nosym(xd, val, sep);
+
+    if (ca->ca_flags & NSC_BITS) {
+       xd->pr("%s(", sep);
+       sep = "";
+       for (bit = 1; bit; bit <<= 1) {
+           if (bit & val->val_as.lng)
+               sep = xdprsym(xd, bit, ca->ca_table, sep);
+       }
+       xd->pr(")");
+       return " ";
+    }
+
+    return xdprsym(xd, val->val_as.lng, ca->ca_table, sep);
+}
+
 /*
  * Dump field values of a context object to XD.
  * CA[] describes fields.
@@ -180,31 +245,72 @@ xdflds(struct xdstr *xd, struct castr ca[], void *ptr)
        j = 0;
        do {
            xdeval(&val, xd, &ca[i], ptr, j);
-           sep = xdprval(xd, &val, sep);
+           sep = xdprval_sym(xd, &val, &ca[i], sep);
        } while (++j < n);
     }
 }
 
 /*
- * Dump header for dump NAME.
+ * Dump header for dump NAME to XD.
  * If META, it's for the meta-data dump rather than the data dump.
  */
 void
 xdhdr(struct xdstr *xd, char *name, int meta)
 {
-    xd->pr("XDUMP %s%s %ld\n", meta ? "meta " : "", name, (long)time(NULL));
+    if (xd->human) {
+       xd->pr("config %s\n", name);
+    } else
+       xd->pr("XDUMP %s%s %ld\n",
+              meta ? "meta " : "",
+              name, (long)time(NULL));
+}
+
+/*
+ * Dump column header to XD.
+ * CA[] describes fields.
+ * Does nothing unless XD is human-readable.
+ */
+void
+xdcolhdr(struct xdstr *xd, struct castr ca[])
+{
+    int i, j, n;
+    char *sep = "";
+
+    if (!xd->human)
+       return;
+
+    for (i = 0; ca[i].ca_name; ++i) {
+       if (ca[i].ca_flags & NSC_DEITY && !xd->divine)
+           continue;
+       if (ca[i].ca_flags & NSC_EXTRA)
+           continue;
+       n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
+       if (n) {
+           for (j = 0; j < n; j++) {
+               xd->pr("%s%s(%d)", sep, ca[i].ca_name, j);
+               sep = " ";
+           }
+       } else {
+           xd->pr("%s%s", sep, ca[i].ca_name);
+           sep = " ";
+       }
+    }
+    xd->pr("\n");
 }
 
-/* Dump footer for a dump that dumped N objects.  */
+/* Dump footer for a dump that dumped N objects to XD.  */
 void
 xdftr(struct xdstr *xd, int n)
 {
-    xd->pr("/%d\n", n);
+    if (xd->human)
+       xd->pr("/config\n");
+    else
+       xd->pr("/%d\n", n);
 }
 
 /*
  * Dump meta-data for items of type TYPE to XD.
- * Return RET_OK.
+ * Return RET_SYN when TYPE doesn't have meta-data, else RET_OK.
  */
 int
 xdmeta(struct xdstr *xd, int type)
@@ -217,6 +323,7 @@ xdmeta(struct xdstr *xd, int type)
        return RET_SYN;
 
     xdhdr(xd, ef_nameof(type), 1);
+    xdcolhdr(xd, ca);
 
     for (i = 0; ca[i].ca_name; i++) {
        if (ca[i].ca_flags & NSC_DEITY && !xd->divine)