/*
* 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,
* 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.
- * TYPE is the attribute's type.
- * PTR points to the context object.
- * The attribute is stored there at offset OFF + IDX * S, where S is
- * its size.
- * LEN is the #array elements if it is an array, else zero.
- */
-static struct valstr *
-xdeval(struct valstr *val,
- nsc_type type, void *ptr, ptrdiff_t off, int idx, int len)
-{
- val->val_type = type;
- val->val_cat = NSC_OFF;
- val->val_as.sym.off = off;
- val->val_as.sym.len = len;
- val->val_as.sym.idx = idx;
- nstr_exec_val(val, player->cnum, ptr, NSC_NOTYPE);
- return val; /* FIXME nstr_exec_val() should return VAL */
-}
-
-/* Dump VAL prefixed with SEP, return " ". */
-static char *
-xdprval(struct valstr *val, char *sep)
-{
- unsigned char *s, *e, *l;
-
- 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("0");
- }
- 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].ca_type, ptr, ca[i].ca_off, j, ca[i].ca_len);
- 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?
}
/*
- * 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)
-{
- struct castr *ca;
- struct nstr_item ni;
- int n;
- char buf[2048]; /* FIXME buffer size? */
-
- ca = ef_cadef(type);
- if (!ca)
- return RET_SYN;
-
- if (!snxtitem(&ni, type, arg))
- return RET_SYN;
-
- xdhdr(ef_nameof(type), 0);
-
- n = 0;
- while (nxtitem(&ni, buf)) {
- if (!xdvisible(type, buf))
- continue;
- ++n;
- xdflds(ca, buf);
- pr("\n");
- }
-
- xdftr(n);
-
- return RET_OK;
-}
-
-/*
- * Dump meta-data for items of type TYPE.
- * Return RET_OK.
- */
-static int
-xdmeta(int type)
+xdmeta(struct xdstr *xd, int type)
{
struct castr *ca = ef_cadef(type);
int i;
if (!ca)
return RET_SYN;
- xdhdr(ef_nameof(type), 1);
+ xdhdr(xd, ef_nameof(type), 1);
+ xdcolhdr(xd, ca);
for (i = 0; ca[i].ca_name; i++) {
- if (ca[i].ca_flags & NSC_DEITY && !player->god)
+ if (ca[i].ca_flags & NSC_DEITY && !xd->divine)
continue;
if (ca[i].ca_flags & NSC_EXTRA)
continue;
- xdflds(mdchr_ca, &ca[i]);
- pr("\n");
+ xdflds(xd, mdchr_ca, &ca[i]);
+ xd->pr("\n");
n++;
}
- xdftr(n);
+ xdftr(xd, n);
return RET_OK;
}
/*
- * Dump configkeys[], return RET_OK.
- * If META, dump meta-data rather than data.
+ * Dump items of type TYPE selected by ARG to XD.
+ * Return RET_OK on success, RET_SYN on error.
*/
static int
-xdver(int meta)
+xditem(struct xdstr *xd, int type, char *arg)
{
- static struct castr vers_ca = {
- NSC_STRINGY, 0, sizeof(PACKAGE_STRING), 0, "version", EF_BAD
- };
- struct keymatch *kp;
- char *sep;
+ struct castr *ca;
+ struct nstr_item ni;
int n;
- struct castr ca;
- struct valstr val;
+ char buf[2048]; /* FIXME buffer size? */
- xdhdr("version", meta);
+ ca = ef_cadef(type);
+ if (!ca)
+ return RET_SYN;
- if (meta) {
- n = 0;
- xdflds(mdchr_ca, &vers_ca);
- pr("\n");
- n++;
- for (kp = configkeys; kp->km_key; ++kp) {
- if (kp->km_type != NSC_NOTYPE && !(kp->km_flags & KM_INTERNAL)) {
- ca.ca_type = kp->km_type;
- ca.ca_flags = 0;
- ca.ca_len = 0;
- ca.ca_off = 0;
- ca.ca_name = kp->km_key;
- ca.ca_table = EF_BAD;
- xdflds(mdchr_ca, &ca);
- pr("\n");
- n++;
- }
- }
- xdftr(n);
- return RET_OK;
- }
+ if (!snxtitem(&ni, type, arg, NULL))
+ return RET_SYN;
- xdeval(&val, vers_ca.ca_type, version, vers_ca.ca_off, 0, vers_ca.ca_len);
- sep = xdprval(&val, "");
- for (kp = configkeys; kp->km_key; ++kp) {
- if (kp->km_type != NSC_NOTYPE && !(kp->km_flags & KM_INTERNAL)) {
- xdeval(&val, kp->km_type, kp->km_data, 0, 0, 0);
- sep = xdprval(&val, sep);
- }
+ xdhdr(xd, ef_nameof(type), 0);
+
+ n = 0;
+ while (nxtitem(&ni, buf)) {
+ if (!xdvisible(type, buf))
+ continue;
+ ++n;
+ xdflds(xd, ca, buf);
+ xd->pr("\n");
}
- pr("\n");
- xdftr(1);
+ xdftr(xd, n);
return RET_OK;
}
-/* Experimental extended dump command */
+/* Extended dump command */
int
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) {
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) {
- if (meta)
- return xdmeta(type);
- else 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;
- } else
- return xditem(type, player->argp[2]);
- } else if (!strncmp(p, "ver", strlen(p))) {
- return xdver(meta);
+ if (type < 0 || type >= EF_MAX)
+ return RET_SYN;
+ if (meta)
+ 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;
}
-
- return RET_SYN;
+ return xditem(&xd, type, player->argp[2]);
}
projects / empserver / blobdiff