]> git.pond.sub.org Git - empserver/blobdiff - include/nsc.h
COPYING duplicates information from README. Remove. Move GPL from
[empserver] / include / nsc.h
index 6c381975756e92a1eeb16e9964292966c63059ed..7cf466a7c872e65c9740127310f811b06e55b32c 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2000, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                           Ken Stevens, Steve McClure
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -19,9 +19,9 @@
  *
  *  ---
  *
- *  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.
  *
  *  ---
  *
  * 
  *  Known contributors to this file:
  *     Dave Pare, 1989
+ *     Markus Armbruster, 2004
  */
 
-#ifndef _NSC_H_
-#define _NSC_H_
+#ifndef NSC_H
+#define NSC_H
 
+#include <stddef.h>
 #include "xy.h"
 
 #define NS_LSIZE       128
 #define NS_NCOND       16
 
+/* Value type */
+typedef enum {
+    NSC_NOTYPE,
+    /* promoted types */
+    NSC_LONG,                  /* long */
+    NSC_DOUBLE,                        /* double */
+    NSC_STRING,                        /* char *, zero-terminated string */
+    NSC_TYPEID,                        /* signed char, index into chr table */
+    /* unpromoted types */
+    NSC_CHAR,                  /* signed char */
+    NSC_UCHAR,                 /* unsigned char */
+    NSC_SHORT,                 /* short */
+    NSC_USHORT,                        /* unsigned short */
+    NSC_INT,                   /* int */
+    NSC_XCOORD,                        /* coord that needs x conversion */
+    NSC_YCOORD,                        /* coord that needs y conversion */
+    NSC_TIME,                  /* time_t */
+    NSC_FLOAT,                 /* float */
+    NSC_STRINGY,               /* char[], zero-terminated string */
+                               /* FIXME zero may be missing */
+    /* aliases, must match typedefs */
+    NSC_NATID = NSC_UCHAR      /* nation id */
+} nsc_type;
+typedef char packed_nsc_type;
+
+/* Return nsc_type for a signed integer with the same size as TYPE.  */
+#define NSC_SITYPE(type)                               \
+    (sizeof(type) == 1 ? NSC_CHAR                      \
+     : sizeof(type) == sizeof(short) ? NSC_SHORT       \
+     : sizeof(type) == sizeof(int) ? NSC_INT           \
+     : sizeof(type) == sizeof(long) ? NSC_LONG         \
+     : 1/0)
+
+/* Value category */
+typedef enum {
+    NSC_NOCAT,
+    NSC_VAL,                   /* evaluated value */
+    NSC_OFF,                   /* symbolic value: at offset in object */
+    NSC_ID                     /* unresolved identifier (internal use) */
+} nsc_cat;
+typedef char packed_nsc_cat;
+
+enum {
+    NSC_DEITY = bit(0),                /* access restricted to deity */
+    NSC_EXTRA = bit(1),                /* computable from other selectors */
+    NSC_CONST = bit(2),                /* field cannot be changed */
+    NSC_BITS = bit(3)          /* value consists of flag bits */
+};
+typedef unsigned char nsc_flags;
+
+/*
+ * Value, possibly symbolic.
+ * If type is NSC_NOTYPE, it's an error value.
+ * If category is NSC_OFF, the value is in a context object at offset
+ * val_as.sym.off + val_as.sym.idx * S, where S is the size of the
+ * value.
+ * If category is NSC_VAL, the value is in val_as, and the type is a
+ * promoted type.
+ */
+struct valstr {
+    packed_nsc_type val_type;  /* type of value */
+    packed_nsc_cat val_cat;    /* category of value */
+    union {
+       struct {                /* cat NSC_OFF */
+           ptrdiff_t off;
+           int len;
+           int idx;
+       } sym;
+       double dbl;             /* cat NSC_VAL, type NSC_DOUBLE */
+       struct {                /* cat NSC_VAL, type NSC_STRING, cat NSC_ID */
+           char *base;
+           size_t maxsz;
+       } str;
+       long lng;               /* cat NSC_VAL, type NSC_LONG, NSC_TYPEID */
+    } val_as;
+};
+
+/* Compiled condition */
 struct nscstr {
-    long fld1;                 /* first commodity or number */
-    long fld2;                 /* second commodity or number */
-    int oper;                  /* required relationship operator */
+    char operator;             /* '<', '=', '>', '#' */
+    packed_nsc_type optype;    /* operator type */
+    struct valstr lft;         /* left operand */
+    struct valstr rgt;         /* right operand */
 };
 
+/* Selection type */
+typedef enum {
+    NS_UNDEF,                  /* error value */
+    NS_LIST,                   /* list of IDs */
+    NS_DIST,                   /* circular area */
+    NS_AREA,                   /* rectangular area */
+    NS_ALL,                    /* everything */
+    NS_XY,                     /* one sector area */
+    NS_GROUP                   /* group, i.e. fleet, wing, army */
+} ns_seltype;
+
+/* Sector iterator */
 struct nstr_sect {
     coord x, y;                        /* current x-y */
     coord dx, dy;              /* accumlated x,y travel */
     int id;                    /* return value of sctoff */
-    int type;                  /* type of query */
+    ns_seltype type;           /* type of query */
     int curdist;               /* dist query: 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, caddr_t ptr);        /* read function */
+    int (*read)(int type, int id, void *ptr);  /* read function */
     int ncond;                 /* # of selection conditions */
     struct nscstr cond[NS_NCOND];      /* selection conditions */
 };
 
+/* Item iterator */
 struct nstr_item {
     int cur;                   /* current item */
-    int sel;                   /* selection type */
+    ns_seltype sel;            /* selection type */
     int type;                  /* item type being selected */
     int curdist;               /* if NS_DIST, current item's dist */
     struct range range;                /* NS_AREA/NS_DIST: range selector */
@@ -71,96 +165,86 @@ struct nstr_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, caddr_t ptr);        /* read function */
-    int flags;                 /* EFF_ flags */
+    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 */
+    struct nscstr cond[NS_NCOND]; /* selection conditions */
 };
 
-#define NS_UNDEF       0
-#define NS_LIST                1
-#define NS_DIST                2
-#define NS_AREA                3
-#define NS_ALL         4
-#define NS_XY          5
-#define NS_GROUP       6
-
-/*
- * looks something like this:
- * D: only deity can query on this field
- * R: round this value to the nearest 10 if not owner
- * T: type of pointer.
- * C: catagory of value.
- * V: value.
- *
- * 22 2  1 1    1
- * 32 0  8 6    2    8    4    0
- * xxxx xxxx xxxx xxxx xxxx xxxx
- * DRTT TTCC VVVV VVVV VVVV VVVV
- */
-
 /*
- * catagories
+ * Symbol binding: associate NAME with VALUE.
  */
-#define NSC_VAL                (0)     /* normal number */
-#define        NSC_VAR         (1<<16) /* is a vtype */
-#define NSC_OFF                (2<<16) /* is an offset */
-#define        NSC_CMASK       (3<<16)
+struct symbol {
+    int value;
+    char *name;
+};
 
 /*
- * how to interpret "offset" fields
+ * Selector descriptor.
  */
-#define NSC_CHAR       (1<<18) /* pointer to s_char */
-#define NSC_UCHAR      (2<<18) /* pointer to uchar */
-#define NSC_SHORT      (3<<18) /* pointer to short */
-#define NSC_USHORT     (4<<18) /* pointer to unsigned short */
-#define NSC_INT                (5<<18) /* pointer to int */
-#define        NSC_LONG        (6<<18) /* pointer to long */
-#define NSC_XCOORD     (7<<18) /* pointer to short that needs x conversion */
-#define NSC_YCOORD     (8<<18) /* pointer to short that needs y conversion */
-#define NSC_FLOAT      (9<<18) /* pointer to float */
-#define NSC_CHARP      (10<<18)        /* pointer to string pointer */
-#define NSC_TIME        (11<<18)       /* pointer to time_t */
-#define NSC_TMASK      (15<<18)
-
-#define NSC_NATID      NSC_UCHAR       /* change if natid typedef changes */
-
-#define NSC_MASK       (0xffff0000)
-
-#define NSC_ROUND      (1<<22)
-#define NSC_DEITY      (1<<23)
-
 struct castr {
-    long ca_code;              /* encoded form */
-    s_char *ca_name;           /* name used for matches */
-    u_short ca_len;            /* Used for arrays */
-    long ca_edv;               /* which commands is this field visible to? */
+    packed_nsc_type ca_type;   /* type of value */
+    nsc_flags ca_flags;
+    unsigned short ca_len;     /* non-zero: is an array; #array elements */
+    ptrdiff_t ca_off;          /* offset of value in the context object */
+    char *ca_name;
+    int ca_table;              /* referred table ID, or EF_BAD */
 };
 
 /* variables using the above */
 
-extern struct castr var_ca[];
+extern struct castr ichr_ca[];
+extern struct castr pchr_ca[];
 extern struct castr sect_ca[];
+extern struct castr dchr_ca[];
 extern struct castr ship_ca[];
+extern struct castr mchr_ca[];
 extern struct castr plane_ca[];
+extern struct castr plchr_ca[];
 extern struct castr land_ca[];
+extern struct castr lchr_ca[];
 extern struct castr nuke_ca[];
-extern struct castr news_ca[];
-extern struct castr nat_ca[];
+extern struct castr nchr_ca[];
 extern struct castr treaty_ca[];
-extern struct castr trade_ca[];
 extern struct castr loan_ca[];
-extern struct castr genitem_ca[];
-extern struct castr map_ca[];
-extern struct castr bmp_ca[];
+extern struct castr news_ca[];
 extern struct castr lost_ca[];
 extern struct castr commodity_ca[];
+extern struct castr trade_ca[];
+extern struct castr nat_ca[];
+extern struct castr cou_ca[];
+extern struct castr realm_ca[];
+extern struct castr intrchr_ca[];
+extern struct castr rpt_ca[];
+extern struct castr empfile_ca[];
+extern struct castr symbol_ca[];
+extern struct symbol ship_chr_flags[];
+extern struct symbol plane_chr_flags[];
+extern struct symbol land_chr_flags[];
+extern struct symbol nuke_chr_flags[];
+extern struct symbol treaty_flags[];
+extern struct castr mdchr_ca[];
+extern struct symbol meta_type[];
+extern struct symbol meta_flags[];
+extern struct symbol missions[];
+extern struct symbol plane_flags[];
+extern struct symbol retreat_flags[];
+extern struct symbol nation_status[];
+extern struct symbol nation_flags[];
+extern struct symbol nation_relations[];
+extern struct symbol level[];
+extern struct symbol agreement_statuses[];
+extern struct symbol plague_stages[];
+extern struct symbol packing[];
+extern struct symbol resources[];
+extern struct symbol sector_navigation[];
 
 /* src/lib/subs/nstr.c */
-extern s_char *nstr_comp(struct nscstr *, int *, int, s_char *);
-extern int encode(register s_char *, long *, int);
-
-
-extern s_char *decodep(register long code, register void *addr);
-
-#endif /* _NSC_H_ */
+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 *, nsc_type, char *);
+extern int nstr_exec(struct nscstr *, int, void *);
+extern void nstr_exec_val(struct valstr *, natid, void *, nsc_type);
+extern char *symbol_by_value(int, struct symbol *);
+
+#endif