/*
* 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
*
* Known contributors to this file:
* Dave Pare, 1989
- * Markus Armbruster, 2004-2014
+ * Markus Armbruster, 2004-2016
*/
#ifndef NSC_H
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? */
+/* Is TYPE a promoted value type? */
#define NSC_IS_PROMOTED(type) (NSC_LONG <= (type) && (type) <= NSC_STRING)
-/* Return nsc_type for a signed integer with the same size as TYPE. */
-#define NSC_SITYPE(type) \
+/* Return nsc_type for a signed integer with the same size as TYPE. */
+#define NSC_SITYPE(type) \
+ (BUILD_ASSERT_ONE(NSC_SITYPE_(type) != NSC_NOTYPE) * NSC_SITYPE_(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)
+ : NSC_NOTYPE)
/* Value category */
enum nsc_cat {
* Value, possibly symbolic
*
* If type is NSC_NOTYPE, it's an error value.
- * If category is NSC_VAL, the value is in val_as, and the type is a
+ * If category is NSC_VAL, the value is in @val_as, and the type is a
* promoted type.
* If category is NSC_OFF, the value is in a context object, and
- * val_as.sym specifies how to get it, as follows.
+ * @val_as.sym specifies how to get it, as follows.
* If sym.get is null, and type is NSC_STRINGY, the value is a string
* stored in sym.len characters starting at sym.offs in the context
* object. sym.idx must be zero. Ugly wart: if sym.len is one, the
/* 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 */
};
/*
- * Symbol binding: associate NAME with VALUE.
+ * Symbol binding: associate @name with @value.
*/
struct symbol {
int value;
/* 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
*
* A selector describes an attribute of some context object.
- * A selector with ca_type NSC_NOTYPE is invalid.
- * If ca_get is null, the selector describes a datum of type ca_type
- * at offset ca_offs in the context object.
+ * A selector with @ca_type NSC_NOTYPE is invalid.
+ * If @ca_get is null, the selector describes a datum of type @ca_type
+ * at offset @ca_offs in the context object.
* A datum of type NSC_STRINGY is a string stored in an array of
- * ca_len characters. Ugly wart: if ca_len is one, the terminating
+ * @ca_len characters. Ugly wart: if @ca_len is one, the terminating
* null character may be omitted.
* 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, NP, CTXO), where VAL has been
+ * @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, NP, CTXO), where VAL has been
* initialized from the selector and an index by nstr_mksymval(),
* 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, 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.
- * 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.
+ * 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 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;
void *(*ca_get)(struct valstr *, struct natstr *, void *);
int ca_table;
int ca_flags;
+ enum ca_dump ca_dump;
};
/* Is CA an array? */
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[];
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 */
enum nsc_type);
extern int nstr_promote(int);
extern char *symbol_by_value(int, struct symbol *);
+extern int symbol_set_fmt(char *, size_t, int, struct symbol *,
+ char *, int);
/* src/lib/global/nsc.c */
extern void nsc_init(void);
/* src/lib/subs/nxtitem.c */
projects / empserver / blobdiff