/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ * Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
* Ken Stevens, Steve McClure
*
* This program is free software; you can redistribute it and/or modify
* ---
*
* nsc.h: Definitions for Empire conditionals
- *
+ *
* Known contributors to this file:
* Dave Pare, 1989
- * Markus Armbruster, 2004
+ * Markus Armbruster, 2004-2008
*/
#ifndef NSC_H
/* promoted types */
NSC_LONG, /* long */
NSC_DOUBLE, /* double */
- NSC_STRING, /* char *, zero-terminated string */
+ NSC_STRING, /* character string */
/* unpromoted types */
NSC_CHAR, /* signed char */
NSC_UCHAR, /* unsigned char */
may need hiding */
NSC_TIME, /* time_t */
NSC_FLOAT, /* float */
- NSC_STRINGY, /* char[], may be zero-terminated */
+ NSC_STRINGY, /* char[] */
/* aliases, must match typedefs */
NSC_NATID = NSC_UCHAR /* nation id */
};
* in the context object. I.e. the value is at sym.off + sym.idx *
* SZ, where SZ is the size of the value.
* If sym.get is not null, you obtain the value by calling get() like
- * VAL->get(VAL, CNUM, CTXO), where CNUM is the country to use for
- * coordinate translation and access control, and CTXO is the context
- * object. get() either returns a null pointer and sets VAL->val_as
- * to the value, as appropriate for the type. Or it returns another
- * context object and sets VAL->val_as.sym for it.
+ * VAL->get(VAL, NP, CTXO), where NP points to the country to use for
+ * coordinate translation and access control (null for none), and CTXO
+ * is the context object. get() either returns a null pointer and
+ * sets VAL->val_as to the value, as appropriate for the type. Or it
+ * returns another context object and sets VAL->val_as.sym for it.
*/
struct valstr {
enum nsc_type val_type; /* type of value */
ptrdiff_t off;
int len;
int idx;
- void *(*get)(struct valstr *, natid, void *);
+ void *(*get)(struct valstr *, struct natstr *, void *);
} sym;
double dbl; /* cat NSC_VAL, type NSC_DOUBLE */
struct { /* cat NSC_VAL, type NSC_STRING, cat NSC_ID */
NS_AREA, /* rectangular area */
NS_ALL, /* everything */
NS_XY, /* one sector area */
- NS_GROUP /* group, i.e. fleet, wing, army */
+ NS_GROUP, /* group, i.e. fleet, wing, army */
+ NS_CARGO /* loaded on the same carrier */
};
/* Sector iterator */
coord x, y; /* current x-y */
coord dx, dy; /* accumlated x,y travel */
int id; /* return value of sctoff */
- enum ns_seltype type; /* type of query */
- int curdist; /* dist query: current range */
+ enum ns_seltype type; /* selection type: NS_AREA or NS_DIST */
+ int curdist; /* NS_DIST: current range */
struct range range; /* area of coverage */
- int dist; /* dist query: range */
- coord cx, cy; /* dist query: center x-y */
- int (*read)(int type, int id, void *ptr); /* read function */
+ int dist; /* NS_DIST: range */
+ coord cx, cy; /* NS_DIST: center x-y */
int ncond; /* # of selection conditions */
- struct nscstr cond[NS_NCOND]; /* selection conditions */
+ struct nscstr cond[NS_NCOND]; /* selection conditions */
};
/* Item iterator */
struct nstr_item {
int cur; /* current item */
- enum ns_seltype sel; /* selection type */
+ enum ns_seltype sel; /* selection type, any but NS_UNDEF */
int type; /* item type being selected */
int curdist; /* if NS_DIST, current item's dist */
struct range range; /* NS_AREA/NS_DIST: range selector */
int dist; /* NS_DIST: distance selector */
coord cx, cy; /* NS_DIST: center x-y, NS_XY: xy */
- int group; /* NS_GROUP: fleet/wing match */
+ char group; /* NS_GROUP: fleet/wing match */
+ int next; /* NS_CARGO: next item */
int size; /* NS_LIST: size of list */
int index; /* NS_LIST: index */
int list[NS_LSIZE]; /* NS_LIST: item list */
- int (*read)(int type, int id, void *ptr); /* read function */
- int flags; /* ef_flags(TYPE) */
int ncond; /* # of selection conditions */
struct nscstr cond[NS_NCOND]; /* selection conditions */
};
* A datum of any other type is either a scalar of that type (if
* ca_len is zero), or an array of ca_len elements of that type.
* If ca_get is not null, the selector is virtual. Values can be
- * obtained by calling ca_get(VAL, CNUM, CTXO), where VAL has been
+ * obtained by calling ca_get(VAL, NP, CTXO), where VAL has been
* initialized my from the selector and an index by nstr_mksymval(),
- * CNUM is the country to use for coordinate translation and access
- * control, and CTXO is the context object. See struct valstr for
- * details.
+ * NP points to the country to use for coordinate translation and
+ * access control (null for none), and CTXO is the context object.
+ * See struct valstr for details.
+ * Because virtual selectors don't have a setter method, xundump must
+ * be made to ignore them, e.g. by setting NSC_EXTRA.
* If flag NSC_DEITY is set, only to deities can use this selector.
- * If flag NSC_EXTRA is set, xdump ignores this selector.
+ * If flag NSC_EXTRA is set, xdump and xundump ignore this selector.
* If flag NSC_CONST is set, the datum can't be changed from its
* initial value (xundump obeys that).
* If ca_table is not EF_BAD, the datum refers to that Empire table;
ptrdiff_t ca_off;
enum nsc_type ca_type;
unsigned short ca_len;
- void *(*ca_get)(struct valstr *, natid, void *);
+ void *(*ca_get)(struct valstr *, struct natstr *, void *);
int ca_table;
int ca_flags;
};
/* src/lib/subs/nstr.c */
extern int nstr_comp(struct nscstr *np, int len, int type, char *str);
extern char *nstr_comp_val(char *, struct valstr*, int);
-extern int nstr_coerce_val(struct valstr *, enum nsc_type, char *);
extern int nstr_exec(struct nscstr *, int, void *);
/* src/lib/common/nstreval.c */
extern struct valstr *nstr_mksymval(struct valstr *, struct castr *, int);