]> git.pond.sub.org Git - empserver/commitdiff
Make xdump code available for future use outside the server
authorMarkus Armbruster <armbru@pond.sub.org>
Fri, 8 Feb 2008 20:51:24 +0000 (21:51 +0100)
committerMarkus Armbruster <armbru@pond.sub.org>
Fri, 14 Mar 2008 19:25:42 +0000 (20:25 +0100)
Move the bits useful there from src/lib/commands/xdump.c to new
include/xdump.h and src/lib/common/xdump.c.

include/prototypes.h
include/xdump.h [new file with mode: 0644]
src/lib/commands/xdump.c
src/lib/common/conftab.c
src/lib/common/xdump.c [new file with mode: 0644]
src/lib/common/xundump.c

index b0788801a9e36628aa3fe056d5692382961cec55..6f9cdb95c8efb9a4d0c21c359b70d8f0a6f617cb 100644 (file)
@@ -315,8 +315,8 @@ extern int sct_typematch(char *);
 extern int demand_update_want(int *, int *, int);
 extern int demand_check(void);
 extern int demandupdatecheck(void);
-/* xundump.c */
-extern int xundump(FILE *, char *, int *, int);
+/* xdump.c xundump.c */
+/* in xdump.h */
 
 /*
  * src/lib/gen/ *.c 
diff --git a/include/xdump.h b/include/xdump.h
new file mode 100644 (file)
index 0000000..34108b3
--- /dev/null
@@ -0,0 +1,57 @@
+/*
+ *  Empire - A multi-player, client/server Internet based war game.
+ *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                           Ken Stevens, Steve McClure
+ *
+ *  This program 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
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  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
+ *
+ *  ---
+ *
+ *  See files README, COPYING and CREDITS in the root of the source
+ *  tree for related information and legal notices.  It is expected
+ *  that future projects/authors will amend these files as needed.
+ *
+ *  ---
+ *
+ *  xdump.h: Extended dumps
+ * 
+ *  Known contributors to this file:
+ *     Markus Armbruster, 2008
+ */
+
+#ifndef XDUMP_H
+#define XDUMP_H
+
+#include <stdio.h>
+#include "nsc.h"
+#include "types.h"
+
+/* xdump descriptor */
+struct xdstr {
+    natid cnum;                        /* dump for this country */
+    int divine;                        /* is this a deity dump? */
+    void (*pr)(char *fmt, ...);        /* callback for printing dump */
+};
+
+struct xdstr *xdinit(struct xdstr *, natid, void (*)(char *, ...));
+extern void xdhdr(struct xdstr *, char *, int);
+extern void xdflds(struct xdstr *, struct castr[], void *);
+extern struct valstr *xdeval(struct valstr *, struct xdstr *, struct castr *, void *, int);
+extern char *xdprval(struct xdstr *, struct valstr *, char *);
+extern void xdftr(struct xdstr *, int);
+extern int xdmeta(struct xdstr *, int);
+extern int xundump(FILE *, char *, int *, int);
+
+#endif
index bbc02058a6b55c4ae935abf03e5161c1e75495bd..30e0d073334f1bd48e41d34f7929e672b238e325 100644 (file)
  *     Markus Armbruster, 2004-2008
  */
 
-/*
- * Dump everything under the sun
- *
- * Static game data (configuration):
- * - Item characteristics: ichr[]
- * - Land unit characteristics: lchr[]
- * - Nuke characteristics: nchr[]
- * - Plane characteristics: plchr[]
- * - Product characteristics: pchr[]
- * - Sector designation characteristics: dchr[]
- * - Sector infrastructure characteristics: intrchr[]
- * - Ship characteristics: mchr[]
- * - News item characteristics: rpt[]
- * - News page headings: page_headings[]
- * - Commands: player_coms[] (TODO)
- * - Update schedule: update_time[] (not really static)
- * - Configuration: configkeys[]
- *
- * Dynamic game data:
- * - Sectors: EF_SECTOR (superseding dump)
- * - Land units: EF_LAND (superseding ldump)
- * - Lost: EF_LOST (superseding lost)
- * - Nukes: EF_NUKE (superseding ndump)
- * - Planes: EF_PLANE (superseding pdump)
- * - Ships: EF_SHIP (superseding sdump)
- * - News: EF_NEWS
- * - Treaties: EF_TREATY
- * - Power: EF_POWER (TODO)
- * - Nations: EF_NATION
- * - Loans: EF_LOAN
- * - Map: EF_MAP (TODO)
- * - Bmap: EF_BMAP (TODO)
- * - Market: EF_COMM
- */
-
-/*
- * See doc/xdump for motivation, syntax, semantics, and rationale.
- * Make sure to keep it up-to-date!
- */
-
-/* TODO don't dump stuff that's useless due to options */
-
 #include <config.h>
 
 #include <ctype.h>
-#include <stddef.h>
 #include "commands.h"
 #include "empobj.h"
-#include "match.h"
-#include "news.h"
 #include "optlist.h"
-#include "treaty.h"
 #include "version.h"
-
-/* xdump descriptor */
-struct xdstr {
-    natid cnum;                        /* dump for this country */
-    int divine;                        /* is this a deity dump? */
-    void (*pr)(char *fmt, ...);        /* callback for printing dump */
-};
-
-/*
- * Initialize XD to dump for country CNUM.
- * Dump is to be delivered through callback PR.
- * Return XD.
- */
-static struct xdstr *
-xdinit(struct xdstr *xd, natid cnum, void (*pr)(char *fmt, ...))
-{
-    xd->cnum = cnum;
-    xd->divine = getnatp(cnum)->nat_stat == STAT_GOD;
-    xd->pr = pr;
-    return xd;
-}
-
-/*
- * Evaluate a attribute of an object into VAL, return VAL.
- * CA describes the attribute.
- * XD is the xdump descriptor.
- * PTR points to the context object.
- * IDX is the index within the attribute.
- */
-static struct valstr *
-xdeval(struct valstr *val, struct xdstr *xd,
-       struct castr *ca, void *ptr, int idx)
-{
-    nstr_mksymval(val, ca, idx);
-    return nstr_exec_val(val, xd->cnum, ptr, NSC_NOTYPE);
-}
-
-/*
- * Dump VAL prefixed with SEP, return " ".
- * VAL must be evaluated.
- */
-static char *
-xdprval(struct xdstr *xd, struct valstr *val, char *sep)
-{
-    unsigned char *s, *e, *l;
-
-    if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
-       xd->pr("%snil", sep);
-       return " ";
-    }
-
-    switch (val->val_type) {
-    case NSC_LONG:
-       xd->pr("%s%ld", sep, val->val_as.lng);
-       break;
-    case NSC_DOUBLE:
-       xd->pr("%s%#g", sep, val->val_as.dbl);
-       break;
-    case NSC_STRING:
-       s = (unsigned char *)val->val_as.str.base;
-       if (s) {
-           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;
-           }
-           xd->pr("\"");
-       } else
-           xd->pr("%snil", sep);
-       break;
-    default:
-       CANT_REACH();
-       xd->pr("%snil", sep);
-    }
-    return " ";
-}
-
-/*
- * Dump field values of a context object to XD.
- * CA[] describes fields.
- * PTR points to context object.
- */
-static void
-xdflds(struct xdstr *xd, struct castr ca[], void *ptr)
-{
-    int i, j, n;
-    struct valstr val;
-    char *sep = "";
-
-    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;
-       j = 0;
-       do {
-           xdeval(&val, xd, &ca[i], ptr, j);
-           sep = xdprval(xd, &val, sep);
-       } while (++j < n);
-    }
-}
-
-/*
- * Dump header for dump NAME.
- * If META, it's for the meta-data dump rather than the data dump.
- */
-static void
-xdhdr(struct xdstr *xd, char *name, int meta)
-{
-    xd->pr("XDUMP %s%s %ld\n", meta ? "meta " : "", name, (long)time(NULL));
-}
-
-/* Dump footer for a dump that dumped N objects.  */
-static void
-xdftr(struct xdstr *xd, int n)
-{
-    xd->pr("/%d\n", n);
-}
+#include "xdump.h"
 
 /*
  * Is object P of type TYPE visible to the player?
@@ -322,37 +148,6 @@ xditem(struct xdstr *xd, int type, char *arg)
     return RET_OK;
 }
 
-/*
- * Dump meta-data for items of type TYPE to XD.
- * Return RET_OK.
- */
-static int
-xdmeta(struct xdstr *xd, int type)
-{
-    struct castr *ca = ef_cadef(type);
-    int i;
-    int n = 0;
-
-    if (!ca)
-       return RET_SYN;
-
-    xdhdr(xd, ef_nameof(type), 1);
-
-    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;
-       xdflds(xd, mdchr_ca, &ca[i]);
-       xd->pr("\n");
-       n++;
-    }
-
-    xdftr(xd, n);
-
-    return RET_OK;
-}
-
 /* Extended dump command */
 int
 xdump(void)
index 980c710d7491e982eea344e528edcd609218e0ee..2848e23edd3d9e3c76e9676d108716998ad1680e 100644 (file)
@@ -39,6 +39,7 @@
 #include "optlist.h"
 #include "product.h"
 #include "prototypes.h"
+#include "xdump.h"
 
 static int read_custom_table_file(char *);
 
diff --git a/src/lib/common/xdump.c b/src/lib/common/xdump.c
new file mode 100644 (file)
index 0000000..b211724
--- /dev/null
@@ -0,0 +1,234 @@
+/*
+ *  Empire - A multi-player, client/server Internet based war game.
+ *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                           Ken Stevens, Steve McClure
+ *
+ *  This program 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
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  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
+ *
+ *  ---
+ *
+ *  See files README, COPYING and CREDITS in the root of the source
+ *  tree for related information and legal notices.  It is expected
+ *  that future projects/authors will amend these files as needed.
+ *
+ *  ---
+ *
+ *  xdump.c: Extended dumps
+ * 
+ *  Known contributors to this file:
+ *     Markus Armbruster, 2008
+ */
+
+/*
+ * Dump everything under the sun
+ *
+ * Static game data (configuration):
+ * - Item characteristics: ichr[]
+ * - Land unit characteristics: lchr[]
+ * - Nuke characteristics: nchr[]
+ * - Plane characteristics: plchr[]
+ * - Product characteristics: pchr[]
+ * - Sector designation characteristics: dchr[]
+ * - Sector infrastructure characteristics: intrchr[]
+ * - Ship characteristics: mchr[]
+ * - News item characteristics: rpt[]
+ * - News page headings: page_headings[]
+ * - Commands: player_coms[] (TODO)
+ * - Update schedule: update_time[] (not really static)
+ * - Configuration: configkeys[]
+ *
+ * Dynamic game data:
+ * - Sectors: EF_SECTOR (superseding dump)
+ * - Land units: EF_LAND (superseding ldump)
+ * - Lost: EF_LOST (superseding lost)
+ * - Nukes: EF_NUKE (superseding ndump)
+ * - Planes: EF_PLANE (superseding pdump)
+ * - Ships: EF_SHIP (superseding sdump)
+ * - News: EF_NEWS
+ * - Treaties: EF_TREATY
+ * - Power: EF_POWER (TODO)
+ * - Nations: EF_NATION
+ * - Loans: EF_LOAN
+ * - Map: EF_MAP (TODO)
+ * - Bmap: EF_BMAP (TODO)
+ * - Market: EF_COMM
+ */
+
+/*
+ * See doc/xdump for motivation, syntax, semantics, and rationale.
+ * Make sure to keep it up-to-date!
+ */
+
+/* TODO don't dump stuff that's useless due to options */
+
+#include <config.h>
+
+#include <ctype.h>
+#include "file.h"
+#include "nat.h"
+#include "xdump.h"
+
+/*
+ * Initialize XD to dump for country CNUM.
+ * Dump is to be delivered through callback PR.
+ * Return XD.
+ */
+struct xdstr *
+xdinit(struct xdstr *xd, natid cnum, void (*pr)(char *fmt, ...))
+{
+    xd->cnum = cnum;
+    xd->divine = getnatp(cnum)->nat_stat == STAT_GOD;
+    xd->pr = pr;
+    return xd;
+}
+
+/*
+ * Evaluate a attribute of an object into VAL, return VAL.
+ * CA describes the attribute.
+ * XD is the xdump descriptor.
+ * PTR points to the context object.
+ * IDX is the index within the attribute.
+ */
+struct valstr *
+xdeval(struct valstr *val, struct xdstr *xd,
+       struct castr *ca, void *ptr, int idx)
+{
+    nstr_mksymval(val, ca, idx);
+    return nstr_exec_val(val, xd->cnum, ptr, NSC_NOTYPE);
+}
+
+/*
+ * Dump VAL prefixed with SEP, return " ".
+ * VAL must be evaluated.
+ */
+char *
+xdprval(struct xdstr *xd, struct valstr *val, char *sep)
+{
+    unsigned char *s, *e, *l;
+
+    if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
+       xd->pr("%snil", sep);
+       return " ";
+    }
+
+    switch (val->val_type) {
+    case NSC_LONG:
+       xd->pr("%s%ld", sep, val->val_as.lng);
+       break;
+    case NSC_DOUBLE:
+       xd->pr("%s%#g", sep, val->val_as.dbl);
+       break;
+    case NSC_STRING:
+       s = (unsigned char *)val->val_as.str.base;
+       if (s) {
+           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;
+           }
+           xd->pr("\"");
+       } else
+           xd->pr("%snil", sep);
+       break;
+    default:
+       CANT_REACH();
+       xd->pr("%snil", sep);
+    }
+    return " ";
+}
+
+/*
+ * Dump field values of a context object to XD.
+ * CA[] describes fields.
+ * PTR points to context object.
+ */
+void
+xdflds(struct xdstr *xd, struct castr ca[], void *ptr)
+{
+    int i, j, n;
+    struct valstr val;
+    char *sep = "";
+
+    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;
+       j = 0;
+       do {
+           xdeval(&val, xd, &ca[i], ptr, j);
+           sep = xdprval(xd, &val, sep);
+       } while (++j < n);
+    }
+}
+
+/*
+ * Dump header for dump NAME.
+ * 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));
+}
+
+/* Dump footer for a dump that dumped N objects.  */
+void
+xdftr(struct xdstr *xd, int n)
+{
+    xd->pr("/%d\n", n);
+}
+
+/*
+ * Dump meta-data for items of type TYPE to XD.
+ * Return RET_OK.
+ */
+int
+xdmeta(struct xdstr *xd, int type)
+{
+    struct castr *ca = ef_cadef(type);
+    int i;
+    int n = 0;
+
+    if (!ca)
+       return RET_SYN;
+
+    xdhdr(xd, ef_nameof(type), 1);
+
+    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;
+       xdflds(xd, mdchr_ca, &ca[i]);
+       xd->pr("\n");
+       n++;
+    }
+
+    xdftr(xd, n);
+
+    return RET_OK;
+}
index a2b3bd42339f4fa6627f221a64baaf07c731a3e6..c33df1281b734f7b34b50a649a8df36a36506f73 100644 (file)
 #include <ctype.h>
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
 #include <time.h>
 #include "file.h"
 #include "match.h"
 #include "nsc.h"
 #include "optlist.h"
-#include "prototypes.h"
+#include "xdump.h"
 
 static char *fname;            /* Name of file being read */
 static int lineno;             /* Current line number */