]> git.pond.sub.org Git - empserver/blobdiff - include/nsc.h
Update known contributors comments
[empserver] / include / nsc.h
index 03af0206f91e387ddce82182dee245afcbf9aeeb..45876681b77e055aab6a744886f0628b6828bf17 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2008, 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,
@@ -14,8 +14,7 @@
  *  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/>.
  *
  *  ---
  *
  *  ---
  *
  *  nsc.h: Definitions for Empire conditionals
- * 
+ *
  *  Known contributors to this file:
  *     Dave Pare, 1989
- *     Markus Armbruster, 2004
+ *     Markus Armbruster, 2004-2010
  */
 
 #ifndef NSC_H
@@ -48,7 +47,7 @@ enum nsc_type {
     /* promoted types */
     NSC_LONG,                  /* long */
     NSC_DOUBLE,                        /* double */
-    NSC_STRING,                        /* char *, zero-terminated string */
+    NSC_STRING,                        /* character string */
     /* unpromoted types */
     NSC_CHAR,                  /* signed char */
     NSC_UCHAR,                 /* unsigned char */
@@ -61,7 +60,7 @@ enum nsc_type {
                                   may need hiding */
     NSC_TIME,                  /* time_t */
     NSC_FLOAT,                 /* float */
-    NSC_STRINGY,               /* char[], may be zero-terminated */
+    NSC_STRINGY,               /* char[] */
     /* aliases, must match typedefs */
     NSC_NATID = NSC_UCHAR      /* nation id */
 };
@@ -103,11 +102,11 @@ enum nsc_cat {
  * in the context object.  I.e. the value is at sym.off + sym.idx *
  * SZ, where SZ is the size of the value.
  * If sym.get is not null, you obtain the value by calling get() like
- * VAL->get(VAL, CNUM, CTXO), where CNUM is the country to use for
- * coordinate translation and access control, and CTXO is the context
- * object.  get() either returns a null pointer and sets VAL->val_as
- * to the value, as appropriate for the type.  Or it returns another
- * context object and sets VAL->val_as.sym for it.
+ * VAL->get(VAL, NP, CTXO), where NP points to the country to use for
+ * coordinate translation and access control (null for none), and CTXO
+ * is the context object.  get() either returns a null pointer and
+ * sets VAL->val_as to the value, as appropriate for the type.  Or it
+ * returns another context object and sets VAL->val_as.sym for it.
  */
 struct valstr {
     enum nsc_type val_type;    /* type of value */
@@ -117,7 +116,7 @@ struct valstr {
            ptrdiff_t off;
            int len;
            int idx;
-           void *(*get)(struct valstr *, natid, void *);
+           void *(*get)(struct valstr *, struct natstr *, void *);
        } sym;
        double dbl;             /* cat NSC_VAL, type NSC_DOUBLE */
        struct {                /* cat NSC_VAL, type NSC_STRING, cat NSC_ID */
@@ -144,7 +143,8 @@ enum ns_seltype {
     NS_AREA,                   /* rectangular area */
     NS_ALL,                    /* everything */
     NS_XY,                     /* one sector area */
-    NS_GROUP                   /* group, i.e. fleet, wing, army */
+    NS_GROUP,                  /* group, i.e. fleet, wing, army */
+    NS_CARGO                   /* loaded on the same carrier */
 };
 
 /* Sector iterator */
@@ -152,31 +152,29 @@ struct nstr_sect {
     coord x, y;                        /* current x-y */
     coord dx, dy;              /* accumlated x,y travel */
     int id;                    /* return value of sctoff */
-    enum ns_seltype type;              /* type of query */
-    int curdist;               /* dist query: current range */
+    enum ns_seltype type;      /* selection type: NS_AREA or NS_DIST */
+    int curdist;               /* NS_DIST: 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, void *ptr);  /* read function */
+    int dist;                  /* NS_DIST: range */
+    coord cx, cy;              /* NS_DIST: center x-y */
     int ncond;                 /* # of selection conditions */
-    struct nscstr cond[NS_NCOND];      /* selection conditions */
+    struct nscstr cond[NS_NCOND]; /* selection conditions */
 };
 
 /* Item iterator */
 struct nstr_item {
     int cur;                   /* current item */
-    enum ns_seltype sel;       /* selection type */
+    enum ns_seltype sel;       /* selection type, any but NS_UNDEF */
     int type;                  /* item type being selected */
     int curdist;               /* if NS_DIST, current item's dist */
     struct range range;                /* NS_AREA/NS_DIST: range selector */
     int dist;                  /* NS_DIST: distance selector */
     coord cx, cy;              /* NS_DIST: center x-y, NS_XY: xy */
-    int group;                 /* NS_GROUP: fleet/wing match */
+    char group;                        /* NS_GROUP: fleet/wing match */
+    int next;                  /* NS_CARGO: next 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, void *ptr);  /* read function */
-    int flags;                 /* ef_flags(TYPE) */
     int ncond;                 /* # of selection conditions */
     struct nscstr cond[NS_NCOND]; /* selection conditions */
 };
@@ -208,13 +206,15 @@ enum {
  * A datum of any other type is either a scalar of that type (if
  * ca_len is zero), or an array of ca_len elements of that type.
  * If ca_get is not null, the selector is virtual.  Values can be
- * obtained by calling ca_get(VAL, CNUM, CTXO), where VAL has been
+ * obtained by calling ca_get(VAL, NP, CTXO), where VAL has been
  * initialized my from the selector and an index by nstr_mksymval(),
- * CNUM is the country to use for coordinate translation and access
- * control, and CTXO is the context object.  See struct valstr for
- * details.
+ * NP points to the country to use for coordinate translation and
+ * access control (null for none), and CTXO is the context object.
+ * See struct valstr for details.
+ * Because virtual selectors don't have a setter method, xundump must
+ * be made to ignore them, e.g. by setting NSC_EXTRA.
  * If flag NSC_DEITY is set, only to deities can use this selector.
- * If flag NSC_EXTRA is set, xdump ignores this selector.
+ * If flag NSC_EXTRA is set, xdump and xundump ignore this selector.
  * If flag NSC_CONST is set, the datum can't be changed from its
  * initial value (xundump obeys that).
  * If ca_table is not EF_BAD, the datum refers to that Empire table;
@@ -227,7 +227,7 @@ struct castr {
     ptrdiff_t ca_off;
     enum nsc_type ca_type;
     unsigned short ca_len;
-    void *(*ca_get)(struct valstr *, natid, void *);
+    void *(*ca_get)(struct valstr *, struct natstr *, void *);
     int ca_table;
     int ca_flags;
 };
@@ -283,17 +283,41 @@ extern struct symbol packing[];
 extern struct symbol resources[];
 extern struct symbol sector_navigation[];
 
-/* src/lib/subs/nstr.c */
-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 *, enum nsc_type, char *);
-extern int nstr_exec(struct nscstr *, int, void *);
 /* src/lib/common/nstreval.c */
 extern struct valstr *nstr_mksymval(struct valstr *, struct castr *, int);
-extern struct valstr *nstr_exec_val(struct valstr *, natid, void *, enum nsc_type);
+extern struct valstr *nstr_exec_val(struct valstr *, natid, void *,
+                                   enum nsc_type);
 extern int nstr_promote(int);
 extern char *symbol_by_value(int, struct symbol *);
 /* src/lib/global/nsc.c */
 extern void nsc_init(void);
+/* src/lib/subs/nxtitem.c */
+extern int nxtitem(struct nstr_item *, void *);
+/* src/lib/subs/nxtsct.c */
+extern int nxtsct(struct nstr_sect *, struct sctstr *);
+/* src/lib/subs/snxtitem.c */
+extern int snxtitem(struct nstr_item *, int, char *, char *);
+extern void snxtitem_area(struct nstr_item *, int, struct range *);
+extern void snxtitem_dist(struct nstr_item *, int, int, int, int);
+extern void snxtitem_xy(struct nstr_item *, int, coord, coord);
+extern void snxtitem_all(struct nstr_item *, int);
+extern void snxtitem_group(struct nstr_item *, int, char);
+extern void snxtitem_rewind(struct nstr_item *);
+extern int snxtitem_list(struct nstr_item *, int, int *, int);
+extern void snxtitem_cargo(struct nstr_item *, int, int, int);
+extern int snxtitem_use_condarg(struct nstr_item *);
+/* src/lib/subs/snxtsct.c */
+extern int snxtsct(struct nstr_sect *, char *);
+extern void snxtsct_area(struct nstr_sect *, struct range *);
+extern void snxtsct_all(struct nstr_sect *);
+extern void snxtsct_rewind(struct nstr_sect *);
+extern void snxtsct_dist(struct nstr_sect *, coord, coord, int);
+extern int snxtsct_use_condarg(struct nstr_sect *);
+/* src/lib/subs/nstr.c */
+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_exec(struct nscstr *, int, void *);
+/* src/lib/update/nxtitemp.c */
+extern void *nxtitemp(struct nstr_item *);
 
 #endif