git.pond.sub.org Git - empserver/blob - include/nsc.h

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2004, 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 the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  nsc.h: Definitions for Empire conditionals
  29  *
  30  *  Known contributors to this file:
  31  *     Dave Pare, 1989
  32  *     Markus Armbruster, 2004
  33  */
  34
  35 #ifndef _NSC_H_
  36 #define _NSC_H_
  37
  38 #include <stddef.h>
  39 #include "xy.h"
  40
  41 #define NS_LSIZE        128
  42 #define NS_NCOND        16
  43
  44 /* Value type */
  45 typedef enum {
  46     NSC_NOTYPE,
  47     /* promoted types */
  48     NSC_LONG,                   /* long */
  49     NSC_DOUBLE,                 /* double */
  50     NSC_STRING,                 /* char *, zero-terminated string */
  51     NSC_TYPEID,                 /* signed char, index into chr table */
  52     /* unpromoted types */
  53     NSC_CHAR,                   /* signed char */
  54     NSC_UCHAR,                  /* unsigned char */
  55     NSC_SHORT,                  /* short */
  56     NSC_USHORT,                 /* unsigned short */
  57     NSC_INT,                    /* int */
  58     NSC_XCOORD,                 /* coord that needs x conversion */
  59     NSC_YCOORD,                 /* coord that needs y conversion */
  60     NSC_TIME,                   /* time_t */
  61     NSC_FLOAT,                  /* float */
  62     NSC_STRINGY,                /* char[], zero-terminated string */
  63     /* aliases, must match typedefs */
  64     NSC_NATID = NSC_UCHAR       /* nation id */
  65 } nsc_type;
  66 typedef char packed_nsc_type;
  67
  68 /* Value category */
  69 typedef enum {
  70     NSC_NOCAT,
  71     NSC_VAL,                    /* evaluated value */
  72     NSC_OFF                     /* symbolic value: at offset in object */
  73 } nsc_cat;
  74 typedef char packed_nsc_cat;
  75
  76 enum {
  77     NSC_DEITY = bit(0),         /* access restricted to deity */
  78     NSC_EXTRA = bit(1)          /* computable from other selectors */
  79 };
  80 typedef unsigned char nsc_flags;
  81
  82 /*
  83  * Value, possibly symbolic.
  84  * If type is NSC_NOTYPE, it's an error value.
  85  * If category is NSC_OFF, the value is in a context object at offset
  86  * val_as.sym.off + val_as.sym.idx * S, where S is the size of the
  87  * value.
  88  * If category is NSC_VAL, the value is in val_as, and the type is a
  89  * promoted type.
  90  * Some values can also be interpreted as an object type.  The value's
  91  * consumer chooses how to interpret it, depending on context.
  92  */
  93 struct valstr {
  94     packed_nsc_type val_type;   /* type of value */
  95     packed_nsc_cat val_cat;     /* category of value */
  96     signed char val_as_type;    /* value interpreted as object type */
  97     union {
  98         struct {                /* cat NSC_OFF */
  99             ptrdiff_t off;
 100             int idx;
 101         } sym;
 102         double dbl;             /* cat NSC_VAL, type NSC_DOUBLE */
 103         char *str;              /* cat NSC_VAL, type NSC_STRING */
 104         long lng;               /* cat NSC_VAL, type NSC_LONG */
 105     } val_as;
 106 };
 107
 108 /* Compiled condition */
 109 struct nscstr {
 110     char operator;              /* '<', '=', '>', '#' */
 111     packed_nsc_type optype;     /* operator type */
 112     struct valstr lft;          /* left operand */
 113     struct valstr rgt;          /* right operand */
 114 };
 115
 116 /* Selection type */
 117 typedef enum {
 118     NS_UNDEF,                   /* error value */
 119     NS_LIST,                    /* list of IDs */
 120     NS_DIST,                    /* circular area */
 121     NS_AREA,                    /* rectangular area */
 122     NS_ALL,                     /* everything */
 123     NS_XY,                      /* one sector area */
 124     NS_GROUP                    /* group, i.e. fleet, wing, army */
 125 } ns_seltype;
 126
 127 /* Sector iterator */
 128 struct nstr_sect {
 129     coord x, y;                 /* current x-y */
 130     coord dx, dy;               /* accumlated x,y travel */
 131     int id;                     /* return value of sctoff */
 132     ns_seltype type;            /* type of query */
 133     int curdist;                /* dist query: current range */
 134     struct range range;         /* area of coverage */
 135     int dist;                   /* dist query: range */
 136     coord cx, cy;               /* dist query: center x-y */
 137     int (*read)(int type, int id, void *ptr);   /* read function */
 138     int ncond;                  /* # of selection conditions */
 139     struct nscstr cond[NS_NCOND];       /* selection conditions */
 140 };
 141
 142 /* Item iterator */
 143 struct nstr_item {
 144     int cur;                    /* current item */
 145     ns_seltype sel;             /* selection type */
 146     int type;                   /* item type being selected */
 147     int curdist;                /* if NS_DIST, current item's dist */
 148     struct range range;         /* NS_AREA/NS_DIST: range selector */
 149     int dist;                   /* NS_DIST: distance selector */
 150     coord cx, cy;               /* NS_DIST: center x-y, NS_XY: xy */
 151     int group;                  /* NS_GROUP: fleet/wing match */
 152     int size;                   /* NS_LIST: size of list */
 153     int index;                  /* NS_LIST: index */
 154     int list[NS_LSIZE];         /* NS_LIST: item list */
 155     int (*read)(int type, int id, void *ptr);   /* read function */
 156     int flags;                  /* ef_flags(TYPE) */
 157     int ncond;                  /* # of selection conditions */
 158     struct nscstr cond[NS_NCOND]; /* selection conditions */
 159 };
 160
 161 /*
 162  * Selector descriptor.
 163  * Value is at offset CA_OFF in the context object.
 164  */
 165 struct castr {
 166     packed_nsc_type ca_type;    /* type of value */
 167     nsc_flags ca_flags;
 168     unsigned short ca_len;      /* non-zero: is an array; #array elements */
 169     ptrdiff_t ca_off;
 170     char *ca_name;
 171 };
 172
 173 /* variables using the above */
 174
 175 extern struct castr sect_ca[];
 176 extern struct castr ship_ca[];
 177 extern struct castr plane_ca[];
 178 extern struct castr land_ca[];
 179 extern struct castr nuke_ca[];
 180 extern struct castr news_ca[];
 181 extern struct castr nat_ca[];
 182 extern struct castr treaty_ca[];
 183 extern struct castr trade_ca[];
 184 extern struct castr loan_ca[];
 185 extern struct castr genitem_ca[];
 186 extern struct castr lost_ca[];
 187 extern struct castr commodity_ca[];
 188
 189 /* src/lib/subs/nstr.c */
 190 extern int nstr_comp(struct nscstr *np, int len, int type, char *str);
 191 extern char *nstr_comp_val(char *, struct valstr*, int);
 192 extern int nstr_coerce_val(struct valstr *, nsc_type, char *);
 193 extern int nstr_exec(struct nscstr *, int, void *);
 194 extern void nstr_exec_val(struct valstr *, natid, void *, nsc_type);
 195
 196 #endif /* _NSC_H_ */