]> git.pond.sub.org Git - empserver/blobdiff - src/lib/commands/xdump.c
Update copyright notice
[empserver] / src / lib / commands / xdump.c
index 31e651aeaeb3a66161edffe1c5b8927a55948ac2..8373d7b07ab937041246a44e45eaecf3000867a9 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-2013, 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/>.
  *
  *  ---
  *
  *  ---
  *
  *  xdump.c: Extended dump
- * 
- *  Known contributors to this file:
- *     Markus Armbruster, 2004-2007
- */
-
-/*
- * 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!
+ *  Known contributors to this file:
+ *     Markus Armbruster, 2004-2011
  */
 
-/* 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"
-
-/*
- * Evaluate a attribute of an object into VAL, return VAL.
- * CA describes the attribute.
- * PTR points to the context object.
- * IDX is the index within the attribute.
- */
-static struct valstr *
-xdeval(struct valstr *val, struct castr *ca, void *ptr, int idx)
-{
-    val->val_type = ca->ca_type;
-    val->val_cat = NSC_OFF;
-    val->val_as.sym.off = ca->ca_off;
-    val->val_as.sym.len = ca->ca_len;
-    val->val_as.sym.idx = idx;
-    val->val_as.sym.get = ca->ca_get;
-    return nstr_exec_val(val, player->cnum, ptr, NSC_NOTYPE);
-}
-
-/*
- * Dump VAL prefixed with SEP, return " ".
- * VAL must be evaluated.
- */
-static char *
-xdprval(struct valstr *val, char *sep)
-{
-    unsigned char *s, *e, *l;
-
-    if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
-       pr("%snil", sep);
-       return " ";
-    }
-
-    switch (val->val_type) {
-    case NSC_LONG:
-       pr("%s%ld", sep, val->val_as.lng);
-       break;
-    case NSC_DOUBLE:
-       pr("%s%#g", sep, val->val_as.dbl);
-       break;
-    case NSC_STRING:
-       s = (unsigned char *)val->val_as.str.base;
-       if (s) {
-           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)
-                   ;
-               pr("%.*s", (int)(e-s), s);
-               if (e < l && *e)
-                   pr("\\%03o", *e++);
-               else
-                   break;
-               s = e;
-           }
-           pr("\"");
-       } else
-           pr("%snil", sep);
-       break;
-    default:
-       CANT_REACH();
-       pr("%snil", sep);
-    }
-    return " ";
-}
-
-/*
- * Dump field values of a context object.
- * CA[] describes fields.
- * PTR points to context object.
- */
-static void
-xdflds(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 && !player->god)
-           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, &ca[i], ptr, j);
-           sep = xdprval(&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(char *name, int meta)
-{
-    pr("XDUMP %s%s %ld\n", meta ? "meta " : "", name, (long)time(NULL));
-}
-
-/* Dump footer for a dump that dumped N objects.  */
-static void
-xdftr(int n)
-{
-    pr("/%d\n", n);
-}
+#include "xdump.h"
 
 /*
  * Is object P of type TYPE visible to the player?
@@ -209,37 +51,31 @@ xdvisible(int type, void *p)
     struct natstr *natp;
     int tlev;
 
+    if (!empobj_in_use(type, p))
+       return 0;
+
     switch (type) {
     case EF_SECTOR:
-    case EF_REALM:
-       return gp->own == player->cnum || player->god;
     case EF_SHIP:
     case EF_PLANE:
     case EF_LAND:
     case EF_NUKE:
     case EF_LOST:
-       return gp->own != 0 && (gp->own == player->cnum || player->god);
-    case EF_NATION:
-       return ((struct natstr *)p)->nat_stat != STAT_UNUSED;
+    case EF_REALM:
+       return gp->own == player->cnum || player->god;
     case EF_COUNTRY:
        return gp->own == player->cnum;
     case EF_NEWS:
-       return ((struct nwsstr *)p)->nws_vrb != 0
-           && (!opt_HIDDEN || player->god); /* FIXME */
+       return !opt_HIDDEN || player->god; /* FIXME */
     case EF_TREATY:
-       return tp->trt_status != TS_FREE
-           && (tp->trt_cna == player->cnum || tp->trt_cnb == player->cnum
-               || player->god);
+       return tp->trt_cna == player->cnum
+           || tp->trt_cnb == player->cnum
+           || player->god;
     case EF_LOAN:
-       if (lp->l_status == LS_FREE)
-           return 0;
        if (lp->l_status == LS_SIGNED)
            return 1;
        return lp->l_loner == player->cnum || lp->l_lonee == player->cnum
            || player->god;
-    case EF_TRADE:
-    case EF_COMM:
-       return gp->own != 0;
     case EF_SHIP_CHR:
        tlev = ((struct mchrstr *)p)->m_tech;
        goto tech;
@@ -260,8 +96,6 @@ xdvisible(int type, void *p)
                return player->god;
        }
        goto tech;
-    case EF_NEWS_CHR:
-       return ((struct rptstr *)p)->r_newspage != 0;
     case EF_TABLE:
        return ((struct empfile *)p)->cadef != NULL;
     default:
@@ -270,67 +104,68 @@ xdvisible(int type, void *p)
 }
 
 /*
- * Dump items of type TYPE selected by ARG.
- * Return RET_OK on success, RET_SYN on error.
+ * Dump meta-data for items of type TYPE to XD.
+ * Return RET_SYN when TYPE doesn't have meta-data, else RET_OK.
  */
 static int
-xditem(int type, char *arg)
+xdmeta(struct xdstr *xd, int type)
 {
-    struct castr *ca;
-    struct nstr_item ni;
-    int n;
-    char buf[2048];            /* FIXME buffer size? */
+    struct castr *ca = ef_cadef(type);
+    int i;
+    int n = 0;
 
-    ca = ef_cadef(type);
     if (!ca)
        return RET_SYN;
 
-    if (!snxtitem(&ni, type, arg))
-       return RET_SYN;
-
-    xdhdr(ef_nameof(type), 0);
+    xdhdr(xd, ef_nameof(type), 1);
+    xdcolhdr(xd, ca);
 
-    n = 0;
-    while (nxtitem(&ni, buf)) {
-       if (!xdvisible(type, buf))
+    for (i = 0; ca[i].ca_name; i++) {
+       if (ca[i].ca_flags & NSC_DEITY && !xd->divine)
            continue;
-       ++n;
-       xdflds(ca, buf);
-       pr("\n");
+       if (ca[i].ca_flags & NSC_EXTRA)
+           continue;
+       xdflds(xd, mdchr_ca, &ca[i]);
+       xd->pr("\n");
+       n++;
     }
 
-    xdftr(n);
+    xdftr(xd, n);
 
     return RET_OK;
 }
 
 /*
- * Dump meta-data for items of type TYPE.
- * Return RET_OK.
+ * Dump items of type TYPE selected by ARG to XD.
+ * Return RET_OK on success, RET_SYN on error.
  */
 static int
-xdmeta(int type)
+xditem(struct xdstr *xd, int type, char *arg)
 {
-    struct castr *ca = ef_cadef(type);
-    int i;
-    int n = 0;
+    struct castr *ca;
+    struct nstr_item ni;
+    int n;
+    char buf[2048];            /* FIXME buffer size? */
 
+    ca = ef_cadef(type);
     if (!ca)
        return RET_SYN;
 
-    xdhdr(ef_nameof(type), 1);
+    if (!snxtitem(&ni, type, arg, NULL))
+       return RET_SYN;
 
-    for (i = 0; ca[i].ca_name; i++) {
-       if (ca[i].ca_flags & NSC_DEITY && !player->god)
-           continue;
-       if (ca[i].ca_flags & NSC_EXTRA)
+    xdhdr(xd, ef_nameof(type), 0);
+
+    n = 0;
+    while (nxtitem(&ni, buf)) {
+       if (!xdvisible(type, buf))
            continue;
-       xdflds(mdchr_ca, &ca[i]);
-       pr("\n");
-       n++;
+       ++n;
+       xdflds(xd, ca, buf);
+       xd->pr("\n");
     }
 
-    xdftr(n);
+    xdftr(xd, n);
 
     return RET_OK;
 }
@@ -341,9 +176,10 @@ xdump(void)
 {
     char *p;
     char buf[1024];
+    struct xdstr xd;
+    struct natstr *natp;
     int type;
     int meta = 0;
-    struct natstr *natp;
 
     p = getstarg(player->argp[1], "Table name, or meta? ", buf);
     if (p && strcmp(p, "meta") == 0) {
@@ -353,19 +189,17 @@ xdump(void)
     if (!p || !*p)
        return RET_SYN;
 
+    xdinit(&xd, player->cnum, 0, pr);
     natp = getnatp(player->cnum);
     type = isdigit(p[0]) ? atoi(p) : ef_byname(p);
     if (type < 0 || type >= EF_MAX)
        return RET_SYN;
-
     if (meta)
-       return xdmeta(type);
+       return xdmeta(&xd, type);
     if ((EF_IS_GAME_STATE(type) || EF_IS_VIEW(type))
        && !(natp->nat_stat == STAT_ACTIVE || player->god)) {
        pr("Access to table %s denied\n", ef_nameof(type));
        return RET_FAIL;
     }
-    if (type == EF_VERSION && !player->argp[2])
-       return xditem(type, "*"); /* backward compatibility */
-    return xditem(type, player->argp[2]);
+    return xditem(&xd, type, player->argp[2]);
 }