git.pond.sub.org Git - empserver/blob - src/lib/subs/nstr.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2009, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  nstr.c: compile and execute the item selections on sectors
  29  *
  30  *  Known contributors to this file:
  31  *     Dave Pare, 1989
  32  *     Steve McClure, 1997
  33  *     Markus Armbruster, 2004-2008
  34  */
  35
  36 #include <config.h>
  37
  38 #include <ctype.h>
  39 #include <limits.h>
  40 #include "file.h"
  41 #include "match.h"
  42 #include "player.h"
  43 #include "prototypes.h"
  44
  45 static char *nstr_parse_val(char *, struct valstr *);
  46 static int nstr_match_ca(struct valstr *, struct castr *);
  47 static int nstr_is_name_of_ca(struct valstr *, struct castr *, int);
  48 static int nstr_ca_comparable(struct castr *, int, int);
  49 static int nstr_match_val(struct valstr *, struct castr *, int);
  50 static struct valstr *nstr_resolve_id(struct valstr *, struct castr *, int);
  51 static struct valstr *nstr_resolve_val(struct valstr *, int, struct castr *);
  52 static int nstr_optype(enum nsc_type, enum nsc_type);
  53
  54 /*
  55  * Compile conditions into array NP[LEN].
  56  * Return number of conditions, or -1 on error.
  57  * It is an error if there are more than LEN conditions.
  58  * TYPE is the context type, a file type.
  59  * STR is the condition string, in Empire syntax, without the leading
  60  * '?'.
  61  */
  62 int
  63 nstr_comp(struct nscstr *np, int len, int type, char *str)
  64 {
  65     struct castr *ca = ef_cadef(type);
  66     char *cond;
  67     char *tail;
  68     int i;
  69     struct nscstr dummy;
  70     int lft_caidx, rgt_caidx;
  71     int lft_val, rgt_val;
  72     int two_sels;
  73
  74     cond = str;
  75     for (i = 0; ; ++i, ++np) {
  76         if (i >= len)
  77             np = &dummy;
  78
  79         /* left operand */
  80         tail = nstr_parse_val(cond, &np->lft);
  81         lft_caidx = nstr_match_ca(&np->lft, ca);
  82
  83         /* operator */
  84         if (*tail != '<' && *tail != '=' && *tail != '>' && *tail != '#') {
  85             if (*tail)
  86                 pr("%s -- expected condition operator\n", cond);
  87             else
  88                 pr("%s -- missing condition operator\n", cond);
  89             return -1;
  90         }
  91         np->operator = *tail;
  92         ++tail;
  93
  94         /* right operand */
  95         tail = nstr_parse_val(tail, &np->rgt);
  96         rgt_caidx = nstr_match_ca(&np->rgt, ca);
  97
  98         /*
  99          * Resolve identifiers
 100          *
 101          * If just one operand is an identifier, it names a selector.
 102          * If both operands are identifiers, things get complicated:
 103          * either can then name a selector or a symbolic value for the
 104          * selector named by the other operand.
 105          */
 106         if (np->lft.val_cat == NSC_ID && np->rgt.val_cat == NSC_ID) {
 107             lft_val = nstr_match_val(&np->lft, ca, rgt_caidx);
 108             rgt_val = nstr_match_val(&np->rgt, ca, lft_caidx);
 109             two_sels = nstr_ca_comparable(ca, lft_caidx, rgt_caidx);
 110             /*
 111              * If lft_val >= 0 interpreting rgt as a selector and lft
 112              * as one of its values works.  Likewise for rgt_val >= 0.
 113              * If two_sels, interpreting both lft and rgt as selector
 114              * works.
 115              */
 116             switch ((lft_val >= 0) + (rgt_val >= 0) + !!two_sels) {
 117             case 0:             /* no interpretation */
 118                 if (lft_caidx >= 0 && rgt_caidx >= 0) {
 119                     /*
 120                      * Both identifiers name selectors.  Since
 121                      * !two_sels, they can't be comparable.
 122                      * Example: type=civil.
 123                      */
 124                     pr("%.*s -- not comparable\n", (int)(tail-cond), cond);
 125                     return -1;
 126                 }
 127                 /*
 128                  * At least one identifier doesn't name a selector,
 129                  * and nstr_resolve_id() will fail for it below
 130                  */
 131                 break;
 132             case 1:             /* one unambigous interpretation */
 133                 break;
 134             default:            /* multiple interpretations */
 135                 /*
 136                  * Last-resort disambiguation: if the identifier is
 137                  * the unabbreviated name of a selector, discard
 138                  * value, else discard selector interpretation.
 139                  * Example: resolve wing=g to wing='g', not wing=group
 140                  * or 'wing'=group.
 141                  */
 142                 if (nstr_is_name_of_ca(&np->lft, ca, lft_caidx))
 143                     lft_val = -1;
 144                 else
 145                     two_sels = 0;
 146                 if (nstr_is_name_of_ca(&np->rgt, ca, rgt_caidx))
 147                     rgt_val = -1;
 148                 else
 149                     two_sels = 0;
 150                 if ((lft_val >= 0) + (rgt_val >= 0) + !!two_sels == 1)
 151                     break;      /* last-resort disambiguation worked */
 152                 /*
 153                  * Example: n<n for sectors could mean newdes<n or
 154                  * n<newdes.
 155                  */
 156                 pr("%.*s -- condition ambiguous\n", (int)(tail-cond), cond);
 157                 return -1;
 158             }
 159             /* resolve identifiers naming values */
 160             if (lft_val >= 0)
 161                 nstr_resolve_val(&np->lft, lft_val, &ca[rgt_caidx]);
 162             if (rgt_val >= 0)
 163                 nstr_resolve_val(&np->rgt, rgt_val, &ca[lft_caidx]);
 164         }
 165         /* remaining identifiers name selectors */
 166         if (!nstr_resolve_id(&np->lft, ca, lft_caidx))
 167             return -1;
 168         if (!nstr_resolve_id(&np->rgt, ca, rgt_caidx))
 169             return -1;
 170
 171         /* find operator type */
 172         np->optype = nstr_optype(np->lft.val_type, np->rgt.val_type);
 173         if (np->optype == NSC_NOTYPE) {
 174             pr("%.*s -- not comparable\n", (int)(tail-cond), cond);
 175             return -1;
 176         }
 177
 178         /* another condition? */
 179         if (*tail == 0)
 180             break;
 181         if (*tail != '&') {
 182             pr("%s -- expected `&'\n", cond);
 183             return -1;
 184         }
 185         cond = tail + 1;
 186     }
 187
 188     if (i >= len) {
 189         /* could just return I and let caller gripe or enlarge buffer */
 190         pr("%s -- too many conditions\n", str);
 191         return -1;
 192     }
 193
 194     return i + 1;
 195 }
 196
 197 /* Like strcmp(S1, S2), but limit length of S1 to SZ1 and of S2 to SZ2.  */
 198 static int
 199 strnncmp(char *s1, size_t sz1, char *s2, size_t sz2)
 200 {
 201     int res;
 202     if (sz1 == sz2) return strncmp(s1, s2, sz2);
 203     if (sz1 < sz2) return -strnncmp(s2, sz2, s1, sz1);
 204     res = strncmp(s1, s2, sz2);
 205     return res ? res : s1[sz2];
 206 }
 207
 208 #define EVAL(op, lft, rgt)                      \
 209     ((op) == '<' ? (lft) < (rgt)                \
 210      : (op) == '=' ? (lft) == (rgt)             \
 211      : (op) == '>' ? (lft) > (rgt)              \
 212      : (op) == '#' ? (lft) != (rgt)             \
 213      : (CANT_REACH(), 0))
 214
 215 /*
 216  * Evaluate compiled conditions in array NP[NCOND].
 217  * Return non-zero iff they are all true.
 218  * PTR points to a context object of the type that was used to compile
 219  * the conditions.
 220  */
 221 int
 222 nstr_exec(struct nscstr *np, int ncond, void *ptr)
 223 {
 224     int i, op, optype, cmp;
 225     struct valstr lft, rgt;
 226
 227     for (i = 0; i < ncond; ++i) {
 228         op = np[i].operator;
 229         optype = np[i].optype;
 230         if (np[i].lft.val_cat == NSC_NOCAT || np[i].rgt.val_cat == NSC_NOCAT)
 231             return 0;
 232         lft = np[i].lft;
 233         nstr_exec_val(&lft, player->cnum, ptr, optype);
 234         rgt = np[i].rgt;
 235         nstr_exec_val(&rgt, player->cnum, ptr, optype);
 236         switch (optype) {
 237         case NSC_LONG:
 238             if (!EVAL(op, lft.val_as.lng, rgt.val_as.lng))
 239                 return 0;
 240             break;
 241         case NSC_DOUBLE:
 242             if (!EVAL(op, lft.val_as.dbl, rgt.val_as.dbl))
 243                 return 0;
 244             break;
 245         case NSC_STRING:
 246             cmp = strnncmp(lft.val_as.str.base, lft.val_as.str.maxsz,
 247                            rgt.val_as.str.base, rgt.val_as.str.maxsz);
 248             if (!EVAL(op, cmp, 0))
 249                 return 0;
 250             break;
 251         default:
 252             CANT_REACH();
 253             return 0;
 254         }
 255     }
 256
 257     return 1;
 258 }
 259
 260 /*
 261  * Parse a value in STR into VAL.
 262  * Return a pointer to the first character after the value.
 263  * Value is either evaluated into NSC_STRING, NSC_DOUBLE or NSC_LONG,
 264  * or an identifier.
 265  */
 266 static char *
 267 nstr_parse_val(char *str, struct valstr *val)
 268 {
 269     long l;
 270     double d;
 271     char *tail, *tail2;
 272
 273     /* string */
 274     if (str[0] == '\'') {
 275         for (tail = str + 1; *tail && *tail != '\''; ++tail) ;
 276         /* FIXME implement \ quoting */
 277         val->val_type = NSC_STRING;
 278         val->val_cat = NSC_VAL;
 279         val->val_as.str.base = str + 1;
 280         val->val_as.str.maxsz = tail - (str + 1);
 281         if (*tail) ++tail;
 282         /* FIXME else unclosed string */
 283         return tail;
 284     }
 285
 286     /* identifier */
 287     if (isalpha(str[0])) {
 288         for (tail = str+1; isalnum(*tail) || *tail == '_'; ++tail) ;
 289         val->val_type = NSC_NOTYPE;
 290         val->val_cat = NSC_ID;
 291         val->val_as.str.base = str;
 292         val->val_as.str.maxsz = tail - str;
 293         return tail;
 294     }
 295
 296     /* number */
 297     l = strtol(str, &tail, 0);
 298     d = strtod(str, &tail2);
 299     if (tail2 > tail) {
 300         val->val_type = NSC_DOUBLE;
 301         val->val_cat = NSC_VAL;
 302         val->val_as.dbl = d;
 303         return tail2;
 304     }
 305     if (tail != str) {
 306         val->val_type = NSC_LONG;
 307         val->val_cat = NSC_VAL;
 308         val->val_as.lng = l;
 309         return tail;
 310     }
 311
 312     /* funny character, interpret as identifier */
 313     tail = str+1;
 314     val->val_type = NSC_NOTYPE;
 315     val->val_cat = NSC_ID;
 316     val->val_as.str.base = str;
 317     val->val_as.str.maxsz = tail - str;
 318     return tail;
 319 }
 320
 321 /*
 322  * Match VAL in table of selector descriptors CA, return index.
 323  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 324  * several.
 325  * A VAL that is not an identifier doesn't match anything.  A null CA
 326  * is considered empty.
 327  */
 328 static int
 329 nstr_match_ca(struct valstr *val, struct castr *ca)
 330 {
 331     char id[32];
 332
 333     if (val->val_cat != NSC_ID || val->val_as.str.maxsz >= sizeof(id))
 334         return M_NOTFOUND;
 335
 336     if (!ca)
 337         return M_NOTFOUND;
 338
 339     memcpy(id, val->val_as.str.base, val->val_as.str.maxsz);
 340     id[val->val_as.str.maxsz] = 0;
 341
 342     return stmtch(id, ca, offsetof(struct castr, ca_name),
 343                   sizeof(struct castr));
 344 }
 345
 346 /*
 347  * Is identifier VAL the name of the selector given by CA and IDX?
 348  * Return non-zero if and only if IDX is non-negative and VAL is the
 349  * name of CA[IDX].
 350  * IDX must have been obtained from nstr_match_ca(VAL, CA).
 351  */
 352 static int
 353 nstr_is_name_of_ca(struct valstr *val, struct castr *ca, int idx)
 354 {
 355     if (CANT_HAPPEN(val->val_cat != NSC_ID && idx >= 0))
 356        return 0;
 357     return idx >= 0 && strlen(ca[idx].ca_name) == val->val_as.str.maxsz;
 358 }
 359
 360 /*
 361  * Do we have two comparable selectors?
 362  * Check selector descriptors CA[LFT_IDX] (unless LFT_IDX is negative)
 363  * and CA[RGT_IDX] (unless RGT_IDX is negative).  CA may be null when
 364  * both are negative.
 365  */
 366 static int
 367 nstr_ca_comparable(struct castr *ca, int lft_idx, int rgt_idx)
 368 {
 369     if (lft_idx < 0 || rgt_idx < 0)
 370         return 0;
 371     if (ca[lft_idx].ca_table != ca[rgt_idx].ca_table)
 372         return 0;               /* Example: land type=spy */
 373     return nstr_optype(ca[lft_idx].ca_type, ca[rgt_idx].ca_type)
 374         != NSC_NOTYPE;          /* Example: ship name=effic */
 375 }
 376
 377 /*
 378  * Match VAL in a selector's values, return its (non-negative) value.
 379  * Match values of selector descriptor CA[IDX], provided IDX is not
 380  * negative.  CA may be null when IDX is negative.
 381  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 382  * several.
 383  */
 384 static int
 385 nstr_match_val(struct valstr *val, struct castr *ca, int idx)
 386 {
 387     char id[32];
 388     enum nsc_type type;
 389
 390     if (val->val_cat != NSC_ID || idx < 0)
 391         return M_NOTFOUND;
 392
 393     type = nstr_promote(ca[idx].ca_type);
 394     if (type == NSC_STRING)
 395         return 0;
 396
 397     if (ca[idx].ca_table == EF_BAD || CANT_HAPPEN(type != NSC_LONG))
 398         return M_NOTFOUND;
 399
 400     if (val->val_as.str.maxsz >= sizeof(id))
 401         return M_NOTFOUND;
 402     memcpy(id, val->val_as.str.base, val->val_as.str.maxsz);
 403     id[val->val_as.str.maxsz] = 0;
 404     return ef_elt_byname(ca[idx].ca_table, id);
 405 }
 406
 407 /*
 408  * Change VAL to resolve identifier to selector.
 409  * Return VAL on success, NULL on error.
 410  * No change if VAL is not an identifier.
 411  * Else change VAL into symbolic value for selector CA[IDX] if IDX >=
 412  * 0, and error if not.
 413  */
 414 static struct valstr *
 415 nstr_resolve_id(struct valstr *val, struct castr *ca, int idx)
 416 {
 417     if (val->val_cat != NSC_ID)
 418         return val;
 419
 420     if (idx == M_NOTUNIQUE) {
 421         pr("%.*s -- ambiguous name\n",
 422            (int)val->val_as.str.maxsz, val->val_as.str.base);
 423         val->val_cat = NSC_NOCAT;
 424         return NULL;
 425     }
 426
 427     if (idx == M_NOTFOUND) {
 428         pr("%.*s -- unknown name\n",
 429            (int)val->val_as.str.maxsz, val->val_as.str.base);
 430         val->val_cat = NSC_NOCAT;
 431         return NULL;
 432     }
 433
 434     if ((ca[idx].ca_flags & NSC_DEITY) && !player->god) {
 435         pr("%.*s -- not accessible to mortals\n",
 436            (int)val->val_as.str.maxsz, val->val_as.str.base);
 437         val->val_cat = NSC_NOCAT;
 438         return NULL;
 439     }
 440
 441     return nstr_mksymval(val, &ca[idx], 0);
 442 }
 443
 444 /*
 445  * Change VAL to resolve identifier to value SELVAL for selector CA.
 446  * Return VAL.
 447  * VAL must be an identifier, and SELVAL must have been obtained from
 448  * nstr_match_val(VAL, CA0, IDX), where CA = &CA0[IDX].
 449  */
 450 static struct valstr *
 451 nstr_resolve_val(struct valstr *val, int selval, struct castr *ca)
 452 {
 453     enum nsc_type type = nstr_promote(ca->ca_type);
 454
 455     if (CANT_HAPPEN(val->val_cat != NSC_ID)) {
 456         val->val_cat = NSC_NOCAT;
 457         return val;
 458     }
 459
 460     if (type == NSC_STRING) {
 461         val->val_type = NSC_STRING;
 462         val->val_cat = NSC_VAL;
 463         /* map identifier ~ to empty string, like some commands do */
 464         if (val->val_as.str.maxsz == 1 && val->val_as.str.base[0] == '~')
 465             val->val_as.str.maxsz = 0;
 466         return val;
 467     }
 468
 469     if (CANT_HAPPEN(type != NSC_LONG || ca->ca_table == EF_BAD)) {
 470         val->val_type = NSC_NOTYPE;
 471         val->val_cat = NSC_NOCAT;
 472         return val;
 473     }
 474
 475     val->val_type = type;
 476     val->val_cat = NSC_VAL;
 477     val->val_as.lng = selval;
 478     return val;
 479 }
 480
 481 /*
 482  * Return operator type for operand types LFT, RGT.
 483  */
 484 static int
 485 nstr_optype(enum nsc_type lft, enum nsc_type rgt)
 486 {
 487     lft = nstr_promote(lft);
 488     rgt = nstr_promote(rgt);
 489     if (lft == rgt)
 490        return lft;
 491     if (lft == NSC_DOUBLE && rgt == NSC_LONG)
 492        return NSC_DOUBLE;
 493     if (rgt == NSC_DOUBLE && lft == NSC_LONG)
 494        return NSC_DOUBLE;
 495     return NSC_NOTYPE;
 496 }
 497
 498 /*
 499  * Compile a value in STR into VAL.
 500  * Return a pointer to the first character after the value on success,
 501  * NULL on error.
 502  * TYPE is the context type, a file type.
 503  * If STR names an array, VAL simply refers to the element with index
 504  * zero.
 505  */
 506 char *
 507 nstr_comp_val(char *str, struct valstr *val, int type)
 508 {
 509     struct castr *ca = ef_cadef(type);
 510     char *tail = nstr_parse_val(str, val);
 511     if (!nstr_resolve_id(val, ca, nstr_match_ca(val, ca)))
 512         return NULL;
 513     return tail;
 514 }