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-2000, 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_type;
  63 typedef char packed_nsc_type;
  64
  65 /* Value category */
  66 typedef enum {
  67     NSC_NOCAT,
  68     NSC_VAL,                    /* evaluated value */
  69     NSC_OFF                     /* symbolic value: at offset in object */
  70 } nsc_cat;
  71 typedef char packed_nsc_cat;
  72
  73 enum {
  74     NSC_DEITY = 1               /* access restricted to deity */
  75 };
  76 typedef unsigned char nsc_flags;
  77
  78 /*
  79  * Value, possibly symbolic.
  80  * If type is NSC_NOTYPE, it's an error value.
  81  * If category is NSC_OFF, the value is in a context object at offset
  82  * val_as.sym.off + val_as.sym.idx * S, where S is the size of the
  83  * value.
  84  * If category is NSC_VAL, the value is in val_as, and the type is a
  85  * promoted type.
  86  * Some values can also be interpreted as an object type.  The value's
  87  * consumer chooses how to interpret it, depending on context.
  88  */
  89 struct valstr {
  90     packed_nsc_type val_type;   /* type of value */
  91     packed_nsc_cat val_cat;     /* category of value */
  92     signed char val_as_type;    /* value interpreted as object type */
  93     union {
  94         struct {                /* cat NSC_OFF */
  95             ptrdiff_t off;
  96             int idx;
  97         } sym;
  98         double dbl;             /* cat NSC_VAL, type NSC_DOUBLE */
  99         char *str;              /* cat NSC_VAL, type NSC_STRING */
 100         long lng;               /* cat NSC_VAL, type NSC_LONG */
 101     } val_as;
 102 };
 103
 104 /* Compiled condition */
 105 struct nscstr {
 106     char operator;              /* '<', '=', '>', '#' */
 107     packed_nsc_type optype;     /* operator type */
 108     struct valstr lft;          /* left operand */
 109     struct valstr rgt;          /* right operand */
 110 };
 111
 112 /* Selection type */
 113 typedef enum {
 114     NS_UNDEF,                   /* error value */
 115     NS_LIST,                    /* list of IDs */
 116     NS_DIST,                    /* circular area */
 117     NS_AREA,                    /* rectangular area */
 118     NS_ALL,                     /* everything */
 119     NS_XY,                      /* one sector area */
 120     NS_GROUP                    /* group, i.e. fleet, wing, army */
 121 } ns_seltype;
 122
 123 /* Sector iterator */
 124 struct nstr_sect {
 125     coord x, y;                 /* current x-y */
 126     coord dx, dy;               /* accumlated x,y travel */
 127     int id;                     /* return value of sctoff */
 128     ns_seltype type;            /* type of query */
 129     int curdist;                /* dist query: current range */
 130     struct range range;         /* area of coverage */
 131     int dist;                   /* dist query: range */
 132     coord cx, cy;               /* dist query: center x-y */
 133     int (*read)(int type, int id, caddr_t ptr); /* read function */
 134     int ncond;                  /* # of selection conditions */
 135     struct nscstr cond[NS_NCOND];       /* selection conditions */
 136 };
 137
 138 /* Item iterator */
 139 struct nstr_item {
 140     int cur;                    /* current item */
 141     ns_seltype sel;             /* selection type */
 142     int type;                   /* item type being selected */
 143     int curdist;                /* if NS_DIST, current item's dist */
 144     struct range range;         /* NS_AREA/NS_DIST: range selector */
 145     int dist;                   /* NS_DIST: distance selector */
 146     coord cx, cy;               /* NS_DIST: center x-y, NS_XY: xy */
 147     int group;                  /* NS_GROUP: fleet/wing match */
 148     int size;                   /* NS_LIST: size of list */
 149     int index;                  /* NS_LIST: index */
 150     int list[NS_LSIZE];         /* NS_LIST: item list */
 151     int (*read)(int type, int id, caddr_t ptr); /* read function */
 152     int flags;                  /* ef_flags(TYPE) */
 153     int ncond;                  /* # of selection conditions */
 154     struct nscstr cond[NS_NCOND]; /* selection conditions */
 155 };
 156
 157 /*
 158  * Selector descriptor.
 159  * Value is at offset CA_OFF in the context object.
 160  */
 161 struct castr {
 162     packed_nsc_type ca_type;    /* type of value */
 163     nsc_flags ca_flags;
 164     unsigned short ca_len;      /* non-zero: is an array; #array elements */
 165     ptrdiff_t ca_off;
 166     char *ca_name;
 167 };
 168
 169 /* variables using the above */
 170
 171 extern struct castr sect_ca[];
 172 extern struct castr ship_ca[];
 173 extern struct castr plane_ca[];
 174 extern struct castr land_ca[];
 175 extern struct castr nuke_ca[];
 176 extern struct castr news_ca[];
 177 extern struct castr nat_ca[];
 178 extern struct castr treaty_ca[];
 179 extern struct castr trade_ca[];
 180 extern struct castr loan_ca[];
 181 extern struct castr genitem_ca[];
 182 extern struct castr lost_ca[];
 183 extern struct castr commodity_ca[];
 184
 185 /* src/lib/subs/nstr.c */
 186 extern int nstr_comp(struct nscstr *np, int len, int type, char *str);
 187 extern char *nstr_comp_val(char *, struct valstr*, int);
 188 extern int nstr_coerce_val(struct valstr *, nsc_type, char *);
 189 extern int nstr_exec(struct nscstr *, int, void *);
 190 extern void nstr_exec_val(struct valstr *, natid, void *, nsc_type);
 191
 192 #endif /* _NSC_H_ */