empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

nsc: Replace NSC_EXTRA, NSC_CONST by enum ca_dump

Browse source 
struct castr ca_flag NSC_EXTRA was introduced in commit 3e5c064
(v4.2.18) to permit selectors that aren't in xdump.

Flag NSC_CONST was introduced in commit 445dfec, and put to use in
commit d8422ca (both v4.3.0) to protect certain table elements that
should not be changed in customized tables.

Both flags apply only to xdump, not to other uses of struct castr,
such as conditionals.

Combining NSC_EXTRA | NSC_CONST makes no sense.

I'll shortly need a way to keep selectors out of configuration tables
for conditional selector and xdump command forward compatibility.
Doing it as a third flag would add more nonsensical combinations.

Convert the flags to a separate enum ca_dump instead:

    neither   -> CA_DUMP
    NSC_CONST -> CA_DUMP_CONST
    NSC_EXTRA -> CA_DUMP_NONE

Bonus: unlike the flags it replaces, ca_dump is not visible in xdump.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
This commit is contained in:
Markus Armbruster 2016-05-29 23:31:31 +02:00
parent 9289eb0525
commit dc58018cd7
9 changed files with 564 additions and 488 deletions
Download patch file Download diff file Expand all files Collapse all files

36
include/nsc.h
View file

@ -28,7 +28,7 @@
*
* Known contributors to this file:
* Dave Pare, 1989
* Markus Armbruster, 2004-2015
* Markus Armbruster, 2004-2016
*/
#ifndef NSC_H
@ -192,12 +192,18 @@ 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_NONE /* do not xdump or xundump */
};
/*
* Selector descriptor
*
@ -217,19 +223,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, and the context object
* must be EF_NATION. Array elements are masked for contact when
* opt_HIDDEN is on.
* @ca_dump specifies how xdump and xundump are to use the selector.
*/
struct castr {
char *ca_name;
@ -239,6 +244,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? */