/*
* 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-2018, 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 dumps
- *
+ *
* Known contributors to this file:
- * Markus Armbruster, 2004-2008
+ * Markus Armbruster, 2004-2016
*/
/*
* - 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
#include <ctype.h>
#include <limits.h>
-#include "file.h"
#include "nat.h"
#include "xdump.h"
/*
- * 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.
+ * Initialize @xd.
+ * If @cnum is NATID_BAD, this is an empdump export rather than an
+ * xdump command.
+ * Translate dump for country @cnum, except when @cnum is NATID_BAD.
+ * Ignore CA_DUMP_ONLY selectors when @cnum is NATID_BAD.
+ * If @human, dump in human-readable format.
+ * If @sloppy, try to cope with invalid data (may result in invalid
+ * dump).
+ * Dump is to be delivered through callback @pr.
+ * Return @xd.
*/
struct xdstr *
-xdinit(struct xdstr *xd, natid cnum, int human, void (*pr)(char *fmt, ...))
+xdinit(struct xdstr *xd, natid cnum, int human, int sloppy,
+ void (*pr)(char *fmt, ...))
{
xd->cnum = cnum;
xd->divine = cnum == NATID_BAD || getnatp(cnum)->nat_stat == STAT_GOD;
xd->human = human;
+ xd->sloppy = sloppy;
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.
+ * 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 *
+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);
+ return nstr_eval(val, xd->cnum, ptr, NSC_NOTYPE);
}
/*
- * Dump string STR to XD with funny characters escaped.
- * Dump at most N characters.
+ * Dump string @str to @xd with funny characters escaped.
+ * Dump at most @n characters.
*/
static void
xdpresc(struct xdstr *xd, char *str, size_t n)
{
- unsigned char *s, *e, *l;
+ unsigned char *s, *e;
s = (unsigned char *)str;
- l = s + n;
for (;;) {
for (e = s;
- e < l && *e != '"' && *e != '\\' && isgraph(*e);
- ++e)
+ n && *e != '"' && *e != '\\' && isgraph(*e);
+ e++, n--)
;
xd->pr("%.*s", (int)(e-s), s);
- if (e < l && *e)
- xd->pr("\\%03o", *e++);
- else
+ if (!n || !*e)
break;
+ xd->pr("\\%03o", *e++);
+ n--;
s = e;
}
}
/*
- * Dump VAL prefixed with SEP to XD, in machine readable format.
- * VAL must be evaluated.
+ * Dump @val prefixed with @sep to @xd, in machine readable format.
+ * @val must be evaluated.
* Return " ".
*/
static char *
}
/*
- * Dump symbol with value KEY from symbol table TYPE to XD.
- * Prefix with 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%ld", sep, key);
- else {
+ if (!sym) {
+ CANT_HAPPEN(!xd->sloppy);
+ xd->pr("%s%d", sep, key);
+ } else {
xd->pr("%s", sep);
xdpresc(xd, sym, INT_MAX);
}
}
/*
- * Dump VAL prefixed with SEP to XD, return " ".
- * VAL must be evaluated.
- * CA describes the field from which the value was fetched.
+ * 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)
+xdprval_sym(struct xdstr *xd, struct valstr *val, struct castr *ca,
+ char *sep)
{
unsigned long bit;
- struct castr *ca_sym = ef_cadef(ca->ca_table);
if (CANT_HAPPEN(val->val_cat != NSC_VAL)) {
xd->pr("%snil", sep);
}
if (!xd->human || val->val_type != NSC_LONG
- || ca->ca_table == EF_BAD || ca_sym != symbol_ca)
+ || ca->ca_table == EF_BAD || ef_cadef(ca->ca_table) != symbol_ca)
return xdprval_nosym(xd, val, sep);
if (ca->ca_flags & NSC_BITS) {
}
/*
- * Dump VAL prefixed with SEP to XD, return " ".
- * XD must not be human-readable.
- * VAL must be evaluated.
- */
-char *
-xdprval(struct xdstr *xd, struct valstr *val, char *sep)
-{
- CANT_HAPPEN(xd->human);
- return xdprval_nosym(xd, val, sep);
-}
-
-/*
- * Dump field values of a context object to XD.
- * CA[] describes fields.
- * PTR points to context object.
+ * 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)
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)
+ if (ca[i].ca_dump == CA_DUMP_NONE)
continue;
- n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
+ if (ca[i].ca_dump == CA_DUMP_ONLY && xd->cnum == NATID_BAD)
+ continue;
+ n = CA_ARRAY_LEN(&ca[i]);
j = 0;
do {
xdeval(&val, xd, &ca[i], ptr, j);
}
/*
- * Dump header for dump NAME to XD.
- * If META, it's for the meta-data dump rather than the data dump.
+ * 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)
}
/*
- * Dump column header to XD.
- * CA[] describes fields.
- * Does nothing unless XD is human-readable.
+ * Dump column header to @xd.
+ * @ca[] describes fields.
+ * Does nothing unless @xd is human-readable.
*/
void
xdcolhdr(struct xdstr *xd, struct castr ca[])
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)
+ if (ca[i].ca_dump == CA_DUMP_NONE)
continue;
- n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
+ n = CA_ARRAY_LEN(&ca[i]);
if (n) {
for (j = 0; j < n; j++) {
- xd->pr("%s%s(%d)",sep, ca[i].ca_name, j);
+ xd->pr("%s%s(%d)", sep, ca[i].ca_name, j);
sep = " ";
}
} else {
xd->pr("\n");
}
-/* Dump footer for a dump that dumped N objects to XD. */
+/* Dump footer for a dump that dumped N objects to XD. */
void
xdftr(struct xdstr *xd, int n)
{
else
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);
- xdcolhdr(xd, ca);
-
- 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;
-}
projects / empserver / blobdiff