fairland: Tidy up comments

[empserver] / include / nsc.h

diff --git a/include/nsc.h b/include/nsc.h
index 4797bcd34db0c137d4f94e8571643234357e3784..3e173929f32b4ee10307dd512857792b3a28f234 100644 (file)
--- a/include/nsc.h
+++ b/include/nsc.h
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2020, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                Ken Stevens, Steve McClure, Markus Armbruster
  *
  *  Empire is free software: you can redistribute it and/or modify
@@ -28,7 +28,7 @@
  *
  *  Known contributors to this file:
  *     Dave Pare, 1989
- *     Markus Armbruster, 2004-2015
+ *     Markus Armbruster, 2004-2016
  */
 
 #ifndef NSC_H
@@ -60,7 +60,7 @@ enum nsc_type {
     NSC_FLOAT,                 /* float */
     NSC_STRINGY,               /* char[] */
     /* aliases, must match typedefs */
-    NSC_NATID = NSC_UCHAR      /* nation id */
+    NSC_NATID = NSC_UCHAR      /* nation ID */
 };
 
 /* Is TYPE a promoted value type? */
@@ -152,7 +152,7 @@ enum ns_seltype {
 /* Sector iterator */
 struct nstr_sect {
     coord x, y;                        /* current x-y */
-    coord dx, dy;              /* accumlated x,y travel */
+    coord dx, dy;              /* accumulated x,y travel */
     int id;                    /* return value of sctoff */
     enum ns_seltype type;      /* selection type: NS_AREA or NS_DIST */
     int curdist;               /* NS_DIST: current range */
@@ -192,12 +192,19 @@ struct symbol {
 /* Selector flags */
 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 */
     NSC_HIDDEN = bit(4)                /* visibility depends on contact */
 };
 
+/* Selector use by xdump and xundump */
+enum ca_dump {
+    /* order is relevant */
+    CA_DUMP,                   /* xdump and xundump normally */
+    CA_DUMP_CONST,             /* same, but value can't be changed  */
+    CA_DUMP_ONLY,              /* only in xdump command */
+    CA_DUMP_NONE               /* do not xdump or xundump */
+};
+
 /*
  * Selector descriptor
  *
@@ -217,19 +224,18 @@ enum {
  * 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, by setting NSC_EXTRA.
- * If flag NSC_DEITY is set, only deities can use 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 flag NSC_HIDDEN is set, the selector must be an array of MAXNOC
- * elements, indexed by country number, and the context object must be
- * EF_NATION.  Array elements are masked for contact when opt_HIDDEN
- * is on.
+ * be made to ignore them, by setting @ca_dump to CA_DUMP_NONE.
  * If @ca_table is not EF_BAD, the datum refers to that Empire table;
- * @ca_type must be an integer type.  If flag NSC_BITS is set, the
- * datum consists of flag bits, and the referred table must be a
- * symbol table defining those bits.
+ * @ca_type must be an integer type.
+ * If NSC_BITS is set in @ca_flags, the datum consists of flag bits,
+ * and the referred table must be a symbol table defining those bits.
+ * If NSC_DEITY is set in @ca_flags, only deities can use this
+ * selector.
+ * If NSC_HIDDEN is set in @ca_flags, the selector must be an array of
+ * MAXNOC elements, indexed by country number.  Array elements are
+ * masked for contact when opt_HIDDEN is on.  Only implemented for
+ * integer types and context object EF_RELAT.
+ * @ca_dump specifies how xdump and xundump are to use the selector.
  */
 struct castr {
     char *ca_name;
@@ -239,6 +245,7 @@ struct castr {
     void *(*ca_get)(struct valstr *, struct natstr *, void *);
     int ca_table;
     int ca_flags;
+    enum ca_dump ca_dump;
 };
 
 /* Is CA an array? */
@@ -266,6 +273,9 @@ extern struct castr commodity_ca[];
 extern struct castr trade_ca[];
 extern struct castr nat_ca[];
 extern struct castr cou_ca[];
+extern struct castr relat_ca[];
+extern struct castr contact_ca[];
+extern struct castr reject_ca[];
 extern struct castr realm_ca[];
 extern struct castr game_ca[];
 extern struct castr intrchr_ca[];
@@ -292,6 +302,7 @@ extern struct symbol agreement_statuses[];
 extern struct symbol plague_stages[];
 extern struct symbol packing[];
 extern struct symbol resources[];
+extern struct symbol sect_chr_flags[];
 extern struct symbol sector_navigation[];
 
 /* src/lib/common/nstreval.c */