/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2005, 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/>.
*
* ---
*
- * See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- * related information and legal notices. It is expected that any future
- * projects/authors will amend these files as needed.
+ * 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.
*
* ---
*
* nstr.c: compile and execute the item selections on sectors
- *
+ *
* Known contributors to this file:
* Dave Pare, 1989
* Steve McClure, 1997
- * Markus Armbruster, 2004
+ * Markus Armbruster, 2004-2008
*/
+#include <config.h>
+
+#include <ctype.h>
#include <limits.h>
-#include "misc.h"
#include "file.h"
#include "match.h"
-#include "nsc.h"
+#include "player.h"
#include "prototypes.h"
static char *nstr_parse_val(char *, struct valstr *);
static int nstr_match_ca(struct valstr *, struct castr *);
-static int nstr_match_val(struct valstr *, int, struct castr *, int);
-static struct valstr *nstr_resolve_sel(struct valstr *, struct castr *);
-static struct valstr *nstr_mkselval(struct valstr *, int, struct castr *);
+static int nstr_is_name_of_ca(struct valstr *, struct castr *, int);
+static int nstr_ca_comparable(struct castr *, int, int);
+static int nstr_match_val(struct valstr *, struct castr *, int);
static struct valstr *nstr_resolve_id(struct valstr *, struct castr *, int);
-static int nstr_promote(int);
-
+static struct valstr *nstr_resolve_val(struct valstr *, int, struct castr *);
+static int nstr_optype(enum nsc_type, enum nsc_type);
/*
* Compile conditions into array NP[LEN].
struct nscstr dummy;
int lft_caidx, rgt_caidx;
int lft_val, rgt_val;
- int lft_type, rgt_type;
+ int two_sels;
cond = str;
for (i = 0; ; ++i, ++np) {
/*
* Resolve identifiers
*
- * An identifier can name a selector or, if the other operand
- * is a selector, a value for that. The condition is
- * ambiguous if both selector x value and value x selector are
- * possible. Example: n<n for sectors could mean newdes<n or
- * n<newdes.
- */
- lft_val = nstr_match_val(&np->lft, type, ca, rgt_caidx);
- rgt_val = nstr_match_val(&np->rgt, type, ca, lft_caidx);
- /*
- * if lft_val >= 0, then rhs names a selector and lhs names
- * one of its values. Likewise for rgt_val.
+ * If just one operand is an identifier, it names a selector.
+ * If both operands are identifiers, things get complicated:
+ * either can then name a selector or a symbolic value for the
+ * selector named by the other operand.
*/
- if (lft_val >= 0 && rgt_val >= 0) {
- pr("%.*s -- condition ambiguous\n", (int)(tail-cond), cond);
- return -1;
- } else if (rgt_val >= 0) {
- /* selector x value */
- if (!nstr_resolve_sel(&np->lft, &ca[lft_caidx]))
- return -1;
- nstr_mkselval(&np->rgt, rgt_val, &ca[lft_caidx]);
- } else if (lft_val >= 0) {
- /* value x selector */
- nstr_mkselval(&np->lft, lft_val, &ca[rgt_caidx]);
- if (!nstr_resolve_sel(&np->rgt, &ca[rgt_caidx]))
- return -1;
- } else {
+ if (np->lft.val_cat == NSC_ID && np->rgt.val_cat == NSC_ID) {
+ lft_val = nstr_match_val(&np->lft, ca, rgt_caidx);
+ rgt_val = nstr_match_val(&np->rgt, ca, lft_caidx);
+ two_sels = nstr_ca_comparable(ca, lft_caidx, rgt_caidx);
/*
- * Neither side works as selector value; any identifiers
- * must name selectors.
+ * If lft_val >= 0 interpreting rgt as a selector and lft
+ * as one of its values works. Likewise for rgt_val >= 0.
+ * If two_sels, interpreting both lft and rgt as selector
+ * works.
*/
- if (!nstr_resolve_id(&np->lft, ca, lft_caidx))
- return -1;
- if (!nstr_resolve_id(&np->rgt, ca, rgt_caidx))
+ switch ((lft_val >= 0) + (rgt_val >= 0) + !!two_sels) {
+ case 0: /* no interpretation */
+ if (lft_caidx >= 0 && rgt_caidx >= 0) {
+ /*
+ * Both identifiers name selectors. Since
+ * !two_sels, they can't be comparable.
+ * Example: type=civil.
+ */
+ pr("%.*s -- not comparable\n", (int)(tail-cond), cond);
+ return -1;
+ }
+ /*
+ * At least one identifier doesn't name a selector,
+ * and nstr_resolve_id() will fail for it below
+ */
+ break;
+ case 1: /* one unambigous interpretation */
+ break;
+ default: /* multiple interpretations */
+ /*
+ * Last-resort disambiguation: if the identifier is
+ * the unabbreviated name of a selector, discard
+ * value, else discard selector interpretation.
+ * Example: resolve wing=g to wing='g', not wing=group
+ * or 'wing'=group.
+ */
+ if (nstr_is_name_of_ca(&np->lft, ca, lft_caidx))
+ lft_val = -1;
+ else
+ two_sels = 0;
+ if (nstr_is_name_of_ca(&np->rgt, ca, rgt_caidx))
+ rgt_val = -1;
+ else
+ two_sels = 0;
+ if ((lft_val >= 0) + (rgt_val >= 0) + !!two_sels == 1)
+ break; /* last-resort disambiguation worked */
+ /*
+ * Example: n<n for sectors could mean newdes<n or
+ * n<newdes.
+ */
+ pr("%.*s -- condition ambiguous\n", (int)(tail-cond), cond);
return -1;
+ }
+ /* resolve identifiers naming values */
+ if (lft_val >= 0)
+ nstr_resolve_val(&np->lft, lft_val, &ca[rgt_caidx]);
+ if (rgt_val >= 0)
+ nstr_resolve_val(&np->rgt, rgt_val, &ca[lft_caidx]);
}
+ /* remaining identifiers name selectors */
+ if (!nstr_resolve_id(&np->lft, ca, lft_caidx))
+ return -1;
+ if (!nstr_resolve_id(&np->rgt, ca, rgt_caidx))
+ return -1;
- /* find operator type, coerce operands */
- lft_type = nstr_promote(np->lft.val_type);
- rgt_type = nstr_promote(np->rgt.val_type);
- np->optype = NSC_NOTYPE;
- if (lft_type == NSC_TYPEID) {
- if (!nstr_coerce_val(&np->rgt, NSC_TYPEID, str))
- np->optype = NSC_TYPEID;
- } else if (rgt_type == NSC_TYPEID) {
- if (!nstr_coerce_val(&np->lft, NSC_TYPEID, str))
- np->optype = NSC_TYPEID;
- } else if (lft_type == NSC_STRING) {
- if (!nstr_coerce_val(&np->rgt, NSC_STRING, str))
- np->optype = NSC_STRING;
- } else if (rgt_type == NSC_STRING) {
- if (!nstr_coerce_val(&np->lft, NSC_STRING, str))
- np->optype = NSC_STRING;
- } else if (lft_type == NSC_DOUBLE) {
- if (!nstr_coerce_val(&np->rgt, NSC_DOUBLE, str))
- np->optype = NSC_DOUBLE;
- } else if (rgt_type == NSC_DOUBLE) {
- if (!nstr_coerce_val(&np->lft, NSC_DOUBLE, str))
- np->optype = NSC_DOUBLE;
- } else {
- if (!nstr_coerce_val(&np->lft, NSC_LONG, str)
- && !nstr_coerce_val(&np->rgt, NSC_LONG, str))
- np->optype = NSC_LONG;
- }
- if (np->optype == NSC_NOTYPE)
+ /* find operator type */
+ np->optype = nstr_optype(np->lft.val_type, np->rgt.val_type);
+ if (np->optype == NSC_NOTYPE) {
+ pr("%.*s -- not comparable\n", (int)(tail-cond), cond);
return -1;
+ }
/* another condition? */
if (*tail == 0)
strnncmp(char *s1, size_t sz1, char *s2, size_t sz2)
{
int res;
- if (sz1 == sz2) return strncmp(s1, s2, sz2);
- if (sz1 < sz2) return -strnncmp(s2, sz2, s1, sz1);
+ if (sz1 == sz2)
+ return strncmp(s1, s2, sz2);
+ if (sz1 < sz2)
+ return -strnncmp(s2, sz2, s1, sz1);
res = strncmp(s1, s2, sz2);
return res ? res : s1[sz2];
}
: (op) == '=' ? (lft) == (rgt) \
: (op) == '>' ? (lft) > (rgt) \
: (op) == '#' ? (lft) != (rgt) \
- : 0)
+ : (CANT_REACH(), 0))
/*
* Evaluate compiled conditions in array NP[NCOND].
rgt = np[i].rgt;
nstr_exec_val(&rgt, player->cnum, ptr, optype);
switch (optype) {
- case NSC_TYPEID:
case NSC_LONG:
if (!EVAL(op, lft.val_as.lng, rgt.val_as.lng))
return 0;
return 0;
break;
default:
- CANT_HAPPEN("bad OPTYPE");
+ CANT_REACH();
return 0;
}
}
/*
* Parse a value in STR into VAL.
* Return a pointer to the first character after the value.
- * Value is either evaluated (but not NSC_TYPEID) or an identifier.
+ * Value is either evaluated into NSC_STRING, NSC_DOUBLE or NSC_LONG,
+ * or an identifier.
*/
static char *
nstr_parse_val(char *str, struct valstr *val)
val->val_cat = NSC_VAL;
val->val_as.str.base = str + 1;
val->val_as.str.maxsz = tail - (str + 1);
- if (*tail) ++tail;
+ if (*tail)
+ ++tail;
+ /* FIXME else unclosed string */
return tail;
}
sizeof(struct castr));
}
+/*
+ * Is identifier VAL the name of the selector given by CA and IDX?
+ * Return non-zero if and only if IDX is non-negative and VAL is the
+ * name of CA[IDX].
+ * IDX must have been obtained from nstr_match_ca(VAL, CA).
+ */
+static int
+nstr_is_name_of_ca(struct valstr *val, struct castr *ca, int idx)
+{
+ if (CANT_HAPPEN(val->val_cat != NSC_ID && idx >= 0))
+ return 0;
+ return idx >= 0 && strlen(ca[idx].ca_name) == val->val_as.str.maxsz;
+}
+
+/*
+ * Do we have two comparable selectors?
+ * Check selector descriptors CA[LFT_IDX] (unless LFT_IDX is negative)
+ * and CA[RGT_IDX] (unless RGT_IDX is negative). CA may be null when
+ * both are negative.
+ */
+static int
+nstr_ca_comparable(struct castr *ca, int lft_idx, int rgt_idx)
+{
+ if (lft_idx < 0 || rgt_idx < 0)
+ return 0;
+ if (ca[lft_idx].ca_table != ca[rgt_idx].ca_table)
+ return 0; /* Example: land type=spy */
+ return nstr_optype(ca[lft_idx].ca_type, ca[rgt_idx].ca_type)
+ != NSC_NOTYPE; /* Example: ship name=effic */
+}
+
/*
* Match VAL in a selector's values, return its (non-negative) value.
- * TYPE is the context type, a file type.
- * CA is ef_cadef(TYPE).
- * Match values of selector descriptor CA[IDX], provided CA is not
- * null and IDX is not negative.
+ * Match values of selector descriptor CA[IDX], provided IDX is not
+ * negative. CA may be null when IDX is negative.
* Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
* several.
- * TODO: This is just a stub and works only for NSC_TYPEID.
- * Generalize: give struct castr enough info to find values, remove
- * parameter `type'.
*/
static int
-nstr_match_val(struct valstr *val, int type, struct castr *ca, int idx)
+nstr_match_val(struct valstr *val, struct castr *ca, int idx)
{
char id[32];
+ enum nsc_type type;
- if (val->val_cat != NSC_ID || val->val_as.str.maxsz >= sizeof(id))
+ if (val->val_cat != NSC_ID || idx < 0)
return M_NOTFOUND;
- if (idx < 0 || ca[idx].ca_type != NSC_TYPEID)
+ type = nstr_promote(ca[idx].ca_type);
+ if (type == NSC_STRING)
+ return 0;
+
+ if (ca[idx].ca_table == EF_BAD || CANT_HAPPEN(type != NSC_LONG))
return M_NOTFOUND;
+ if (val->val_as.str.maxsz >= sizeof(id))
+ return M_NOTFOUND;
memcpy(id, val->val_as.str.base, val->val_as.str.maxsz);
id[val->val_as.str.maxsz] = 0;
-
- return typematch(id, type);
+ return ef_elt_byname(ca[idx].ca_table, id);
}
/*
- * Change VAL to resolve identifier to selector or string.
+ * Change VAL to resolve identifier to selector.
* Return VAL on success, NULL on error.
* No change if VAL is not an identifier.
- * Else error if IDX == M_NOTUNIQUE, string if IDX == M_NOTFOUND, and
- * selector CA[IDX] otherwise.
+ * Else change VAL into symbolic value for selector CA[IDX] if IDX >=
+ * 0, and error if not.
*/
static struct valstr *
nstr_resolve_id(struct valstr *val, struct castr *ca, int idx)
}
if (idx == M_NOTFOUND) {
- /* interpret unbound identifier as string */
- val->val_type = NSC_STRING;
- val->val_cat = NSC_VAL;
- return val;
- }
-
- return nstr_resolve_sel(val, &ca[idx]);
-}
-
-/*
- * Change VAL to resolve identifier to selector CA.
- * Return VAL on success, NULL if the player is denied access to the
- * selector.
- * VAL must be an identifier.
- */
-static struct valstr *
-nstr_resolve_sel(struct valstr *val, struct castr *ca)
-{
- if (CANT_HAPPEN(val->val_cat != NSC_ID)) {
+ pr("%.*s -- unknown name\n",
+ (int)val->val_as.str.maxsz, val->val_as.str.base);
val->val_cat = NSC_NOCAT;
- return val;
+ return NULL;
}
- if ((ca->ca_flags & NSC_DEITY) && !player->god) {
+ if ((ca[idx].ca_flags & NSC_DEITY) && !player->god) {
pr("%.*s -- not accessible to mortals\n",
(int)val->val_as.str.maxsz, val->val_as.str.base);
val->val_cat = NSC_NOCAT;
return NULL;
}
- 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 = 0;
- return val;
+ return nstr_mksymval(val, &ca[idx], 0);
}
/*
- * Initialize VAL to value SELVAL for selector CA, return VAL.
+ * Change VAL to resolve identifier to value SELVAL for selector CA.
+ * Return VAL.
+ * VAL must be an identifier, and SELVAL must have been obtained from
+ * nstr_match_val(VAL, CA0, IDX), where CA = &CA0[IDX].
*/
static struct valstr *
-nstr_mkselval(struct valstr *val, int selval, struct castr *ca)
+nstr_resolve_val(struct valstr *val, int selval, struct castr *ca)
{
- if (CANT_HAPPEN(ca->ca_type != NSC_TYPEID)) {
+ enum nsc_type type = nstr_promote(ca->ca_type);
+
+ if (CANT_HAPPEN(val->val_cat != NSC_ID)) {
+ val->val_cat = NSC_NOCAT;
+ return val;
+ }
+
+ if (type == NSC_STRING) {
+ val->val_type = NSC_STRING;
+ val->val_cat = NSC_VAL;
+ /* map identifier ~ to empty string, like some commands do */
+ if (val->val_as.str.maxsz == 1 && val->val_as.str.base[0] == '~')
+ val->val_as.str.maxsz = 0;
+ return val;
+ }
+
+ if (CANT_HAPPEN(type != NSC_LONG || ca->ca_table == EF_BAD)) {
val->val_type = NSC_NOTYPE;
val->val_cat = NSC_NOCAT;
return val;
}
- val->val_type = ca->ca_type;
+ val->val_type = type;
val->val_cat = NSC_VAL;
val->val_as.lng = selval;
return val;
}
+/*
+ * Return operator type for operand types LFT, RGT.
+ */
+static int
+nstr_optype(enum nsc_type lft, enum nsc_type rgt)
+{
+ lft = nstr_promote(lft);
+ rgt = nstr_promote(rgt);
+ if (lft == rgt)
+ return lft;
+ if (lft == NSC_DOUBLE && rgt == NSC_LONG)
+ return NSC_DOUBLE;
+ if (rgt == NSC_DOUBLE && lft == NSC_LONG)
+ return NSC_DOUBLE;
+ return NSC_NOTYPE;
+}
+
/*
* Compile a value in STR into VAL.
* Return a pointer to the first character after the value on success,
{
struct castr *ca = ef_cadef(type);
char *tail = nstr_parse_val(str, val);
- return nstr_resolve_id(val, ca, nstr_match_ca(val, ca)) ? tail : NULL;
-}
-
-
-/*
- * Promote VALTYPE.
- * If VALTYPE is an integer type, return NSC_LONG.
- * If VALTYPE is a floating-point type, return NSC_DOUBLE.
- * If VALTYPE is NSC_STRINGY, return NSC_STRING.
- * If VALTYPE is NSC_NOTYPE, NSC_STRING or NSC_TYPEID, return VALTYPE.
- */
-static int
-nstr_promote(int valtype)
-{
- switch (valtype) {
- case NSC_NOTYPE:
- case NSC_LONG:
- case NSC_DOUBLE:
- case NSC_STRING:
- case NSC_TYPEID:
- break;
- case NSC_CHAR:
- case NSC_UCHAR:
- case NSC_SHORT:
- case NSC_USHORT:
- case NSC_INT:
- case NSC_XCOORD:
- case NSC_YCOORD:
- case NSC_TIME:
- valtype = NSC_LONG;
- break;
- case NSC_FLOAT:
- valtype = NSC_DOUBLE;
- break;
- case NSC_STRINGY:
- valtype = NSC_STRING;
- break;
- default:
- CANT_HAPPEN("bad VALTYPE");
- valtype = NSC_NOTYPE;
- }
- return valtype;
-}
-
-static int
-cond_type_mismatch(char *str)
-{
- if (str)
- pr("%s -- condition operand type mismatch\n", str);
- return -1;
-}
-
-/*
- * Coerce VAL to promoted value type TO.
- * Return 0 on success, -1 on error.
- * If VAL is evaluated, convert it, else only check.
- * STR is the condition text to be used for error messages. Suppress
- * messages if it is a null pointer.
- */
-int
-nstr_coerce_val(struct valstr *val, nsc_type to, char *str)
-{
- /* FIXME get rid of promotion? */
- nsc_type from = nstr_promote(val->val_type);
-
- if (from == NSC_NOTYPE)
- return 0;
-
- if (from != to) {
- switch (to) {
- case NSC_TYPEID:
- return cond_type_mismatch(str);
- case NSC_STRING:
- return cond_type_mismatch(str); /* FIXME implement */
- case NSC_DOUBLE:
- if (from == NSC_LONG) {
- if (val->val_cat == NSC_VAL)
- val->val_as.dbl = val->val_as.lng;
- } else
- return cond_type_mismatch(str);
- break;
- case NSC_LONG:
- return cond_type_mismatch(str);
- default:
- CANT_HAPPEN("bad TO argument");
- to = from;
- }
- }
-
- if (val->val_cat == NSC_VAL) {
- /* coord literals don't occur, conversion not implemented */
- CANT_HAPPEN(val->val_type == NSC_XCOORD
- || val->val_type == NSC_YCOORD);
- val->val_type = to;
- }
-
- return 0;
-}
-
-/*
- * Evaluate VAL.
- * If VAL is symbolic, evaluate it into a promoted value type.
- * Use coordinate system of country CNUM.
- * PTR points to a context object of the type that was used to compile
- * the value.
- * Unless WANT is NSC_NOTYPE, coerce the value to promoted value type
- * WANT. VAL must be coercible. That's the case if a previous
- * nstr_coerce_val(VAL, WANT, STR) succeeded.
- */
-void
-nstr_exec_val(struct valstr *val, natid cnum, void *ptr, nsc_type want)
-{
- char *memb_ptr;
- nsc_type valtype;
- int idx;
-
- switch (val->val_cat) {
- default:
- CANT_HAPPEN("Bad VAL category");
- /* fall through */
- case NSC_VAL:
- valtype = val->val_type;
- break;
- case NSC_OFF:
- valtype = NSC_LONG;
- memb_ptr = ptr;
- memb_ptr += val->val_as.sym.off;
- idx = val->val_as.sym.idx;
- switch (val->val_type) {
- case NSC_CHAR:
- val->val_as.lng = ((signed char *)memb_ptr)[idx];
- break;
- case NSC_UCHAR:
- val->val_as.lng = ((unsigned char *)memb_ptr)[idx];
- break;
- case NSC_SHORT:
- val->val_as.lng = ((short *)memb_ptr)[idx];
- break;
- case NSC_USHORT:
- val->val_as.lng = ((unsigned short *)memb_ptr)[idx];
- break;
- case NSC_INT:
- val->val_as.lng = ((int *)memb_ptr)[idx];
- break;
- case NSC_LONG:
- val->val_as.lng = ((long *)memb_ptr)[idx];
- break;
- case NSC_XCOORD:
- val->val_as.lng = xrel(getnatp(cnum), ((short *)memb_ptr)[idx]);
- break;
- case NSC_YCOORD:
- val->val_as.lng = yrel(getnatp(cnum), ((short *)memb_ptr)[idx]);
- break;
- case NSC_FLOAT:
- val->val_as.dbl = ((float *)memb_ptr)[idx];
- valtype = NSC_DOUBLE;
- break;
- case NSC_DOUBLE:
- val->val_as.dbl = ((double *)memb_ptr)[idx];
- valtype = NSC_DOUBLE;
- break;
- case NSC_STRINGY:
- CANT_HAPPEN(idx);
- val->val_as.str.maxsz = val->val_as.sym.len;
- val->val_as.str.base = (char *)memb_ptr;
- valtype = NSC_STRING;
- break;
- case NSC_STRING:
- val->val_as.str.base = ((char **)memb_ptr)[idx];
- val->val_as.str.maxsz = INT_MAX;
- valtype = NSC_STRING;
- break;
- case NSC_TIME:
- val->val_as.lng = ((time_t *)memb_ptr)[idx];
- break;
- case NSC_TYPEID:
- val->val_as.lng = ((signed char *)memb_ptr)[idx];
- valtype = NSC_TYPEID;
- break;
- default:
- CANT_HAPPEN("Bad VAL type");
- val->val_as.lng = 0;
- }
- val->val_cat = NSC_VAL;
- }
-
- if (valtype == want)
- ;
- else if (want == NSC_DOUBLE) {
- if (valtype == NSC_LONG) {
- valtype = want;
- val->val_as.dbl = val->val_as.lng;
- }
- } else if (want == NSC_STRING)
- CANT_HAPPEN("unimplemented WANT"); /* FIXME */
-
- if (CANT_HAPPEN(valtype != want && want != NSC_NOTYPE)) {
- valtype = want;
- switch (want) {
- case NSC_TYPEID:
- case NSC_LONG: val->val_as.lng = 0; break;
- case NSC_DOUBLE: val->val_as.dbl = 0.0; break;
- case NSC_STRING: val->val_as.str.base = NULL; break;
- default:
- CANT_HAPPEN("bad WANT argument");
- }
- }
-
- val->val_type = valtype;
+ if (!nstr_resolve_id(val, ca, nstr_match_ca(val, ca)))
+ return NULL;
+ return tail;
}