Magic-number elimination.
[open-adventure.git] / advent.h
index 2437c2301acf8156c0f2dddf7132a96ea234e468..45b1c0c034256834de840433552860e28d1940e9 100644 (file)
--- a/advent.h
+++ b/advent.h
@@ -5,6 +5,8 @@
 
 #include "dungeon.h"
 
+#define LINESIZE       1024
+#define TOKLEN        5          // # sigificant character sin a token */
 #define NDWARVES       6          // number of dwarves
 #define PIRATE         NDWARVES   // must be NDWARVES-1 when zero-origin
 #define DALTLC         LOC_NUGGET // alternate dwarf location
 #define PANICTIME      15         // time left after closing
 #define BATTERYLIFE    2500       // turn limit increment from batteries
 #define WORD_NOT_FOUND -1         // "Word not found" flag value for the vocab hash functions.
+#define WORD_EMPTY     0          // "Word empty" flag value for the vocab hash functions
 #define CARRIED        -1         // Player is toting it
 #define READ_MODE      "rb"       // b is not needed for POSIX but harmless
 #define WRITE_MODE     "wb"       // b is not needed for POSIX but harmless
 
+/* Special object-state values - integers > 0 are object-specific */
+#define STATE_NOTFOUND  -1       // 'Not found" state of treasures */
+#define STATE_FOUND    0         // After discovered, before messed with
+#define STATE_IN_CAVITY        1         // State value common to all gemstones
+
+/* Special fixed object-state values - integers > 0 are location */
+#define IS_FIXED -1
+#define IS_FREE 0
+
+/* Map a state property value to a negative range, where the object cannot be
+ * picked up but the value can be recovered later.  Avoid colliding with -1,
+ * which has its own meaning. */
+#define STASHED(obj)   (-1 - game.prop[obj])
+
 /*
  *  MOD(N,M)    = Arithmetic modulus
  *  AT(OBJ)     = true if on either side of two-placed object
 #define TOTING(OBJ)  (game.place[OBJ] == CARRIED)
 #define AT(OBJ)      (game.place[OBJ] == game.loc || game.fixed[OBJ] == game.loc)
 #define HERE(OBJ)    (AT(OBJ) || TOTING(OBJ))
-#define LIQ2(PBOTL)  ((1-(PBOTL))*WATER+((PBOTL)/2)*(WATER+OIL))
-#define LIQUID()     (LIQ2(game.prop[BOTTLE]<0 ? -1-game.prop[BOTTLE] : game.prop[BOTTLE]))
-#define LIQLOC(LOC)  (LIQ2((MOD(conditions[LOC]/2*2,8)-5)*MOD(conditions[LOC]/4,2)+1))
 #define CNDBIT(L,N)  (tstbit(conditions[L],N))
+#define LIQUID()     (game.prop[BOTTLE] == WATER_BOTTLE? WATER : game.prop[BOTTLE] == OIL_BOTTLE ? OIL : NO_OBJECT )
+#define LIQLOC(LOC)  (CNDBIT((LOC),COND_FLUID)? CNDBIT((LOC),COND_OILY) ? OIL : WATER : NO_OBJECT)
 #define FORCED(LOC)  CNDBIT(LOC, COND_FORCED)
 #define DARK(DUMMY)  ((!tstbit(conditions[game.loc],COND_LIT)) && (game.prop[LAMP] == LAMP_DARK || !HERE(LAMP)))
 #define PCT(N)       (randrange(100) < (N))
 #define OUTSID(LOC)  (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
 #define INDEEP(LOC)  ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
 #define BUG(x)       bug(x, #x)
+#define MOTION_WORD(n)  ((n) + 0)
+#define OBJECT_WORD(n)  ((n) + 1000)
+#define ACTION_WORD(n)  ((n) + 2000)
+#define SPECIAL_WORD(n) ((n) + 3000)
+#define PROMOTE_WORD(n) ((n) + 1000)
+#define DEMOTE_WORD(n)  ((n) - 1000)
 
 enum bugtype {
-   SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST,
-   VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,
-   INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
-   TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
-   CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,
-   LOCATION_HAS_NO_TRAVEL_ENTRIES,
-   HINT_NUMBER_EXCEEDS_GOTO_LIST,
-   SPEECHPART_NOT_TRANSITIVE_OR_INTRANSITIVE_OR_UNKNOWN,
-   ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH,
+    SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST,
+    VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,
+    INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
+    TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
+    CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,
+    LOCATION_HAS_NO_TRAVEL_ENTRIES,
+    HINT_NUMBER_EXCEEDS_GOTO_LIST,
+    SPEECHPART_NOT_TRANSITIVE_OR_INTRANSITIVE_OR_UNKNOWN,
+    ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH,
 };
 
 enum speaktype {touch, look, hear, study, change};
@@ -77,19 +99,19 @@ enum speechpart {unknown, intransitive, transitive};
  * The values don't matter, but perturb their order at your peril.
  */
 enum phase_codes {
-  GO_TERMINATE,
-  GO_MOVE,
-  GO_TOP,
-  GO_CLEAROBJ,
-  GO_CHECKHINT,
-  GO_CHECKFOO,
-  GO_DIRECTION,
-  GO_LOOKUP,
-  GO_WORD2,
-  GO_SPECIALS,
-  GO_UNKNOWN,
-  GO_ACTION,
-  GO_DWARFWAKE,
+    GO_TERMINATE,
+    GO_MOVE,
+    GO_TOP,
+    GO_CLEAROBJ,
+    GO_CHECKHINT,
+    GO_CHECKFOO,
+    GO_DIRECTION,
+    GO_LOOKUP,
+    GO_WORD2,
+    GO_SPECIALS,
+    GO_UNKNOWN,
+    GO_ACTION,
+    GO_DWARFWAKE,
 };
 
 typedef long token_t;  // word token - someday this will be char[TOKLEN+1]
@@ -98,7 +120,6 @@ typedef long vocab_t;  // index into a vocabulary array */
 struct game_t {
     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
     long abbnum;                 // How often to print non-abbreviated descriptions
-    long blklin;
     long bonus;
     long chloc;
     long chloc2;
@@ -109,7 +130,15 @@ struct game_t {
     bool closng;                 // whether it's closing time yet
     long conds;                  // min value for cond(loc) if loc has any hints
     long detail;
+
+    /*  dflag controls the level of activation of dwarves:
+     * 0       No dwarf stuff yet (wait until reaches Hall Of Mists)
+     * 1       Reached Hall Of Mists, but hasn't met first dwarf
+     * 2       Met first dwarf, others start moving, no knives thrown yet
+     * 3       A knife has been thrown (first set always misses)
+     * 3+      Dwarves are mad (increases their accuracy) */
     long dflag;
+
     long dkill;
     long dtotal;
     long foobar;                 // current progress in saying "FEE FIE FOE FOO".
@@ -133,46 +162,57 @@ struct game_t {
     long trnluz;                 // # points lost so far due to number of turns used
     long turns;                  // how many commands he's given (ignores yes/no)
     bool wzdark;                 // whether the loc he's leaving was dark
-    char zzword[6];              // randomly generated magic word from bird
+    char zzword[TOKLEN + 1];     // randomly generated magic word from bird
     bool blooded;                // has player drunk of dragon's blood?
-    long abbrev[NLOCATIONS + 1]; 
+    long abbrev[NLOCATIONS + 1];
     long atloc[NLOCATIONS + 1];
-    long dseen[NDWARVES + 1];
-    long dloc[NDWARVES + 1];
-    long odloc[NDWARVES + 1];
+    long dseen[NDWARVES + 1];    // true if dwarf has seen him
+    long dloc[NDWARVES + 1];     // location of dwarves, initially hard-wired in
+    long odloc[NDWARVES + 1];    // prior loc of each dwarf, initially garbage
     long fixed[NOBJECTS + 1];
     long link[NOBJECTS * 2 + 1];
     long place[NOBJECTS + 1];
-    long hinted[NHINTS];
-    long hintlc[NHINTS];
+    long hinted[NHINTS];         // hintlc[i] is how long he's been at LOC with cond bit i
+    long hintlc[NHINTS];         // hinted[i] is true iff hint i has been used.
     long prop[NOBJECTS + 1];
 };
 
+/*
+ * Game application settings - settings, but not state of the game, per se.
+ * This data is not saved in a saved game.
+ */
+struct settings_t {
+    FILE *logfp;
+    bool oldstyle;
+    bool prompt;
+};
+
 struct command_t {
     enum speechpart part;
     vocab_t verb;
     vocab_t obj;
-    token_t wd1, wd1x;
-    token_t wd2, wd2x;
+    token_t wd1;
+    token_t wd2;
+    long id1;
+    long id2;
+    char raw1[LINESIZE], raw2[LINESIZE];
 };
 
 extern struct game_t game;
-extern FILE *logfp;
-extern bool oldstyle, editline, prompt;
+extern struct settings_t settings;
 
-extern char* xstrdup(const char* s);
-extern void* xmalloc(size_t size);
 extern void packed_to_token(long, char token[]);
-extern long token_to_packed(const char token[6]);
-extern void tokenize(char*, long tokens[4]);
-extern void vspeak(const char*, va_list);
+extern long token_to_packed(const char token[]);
+extern void tokenize(char*, struct command_t *);
+extern void vspeak(const char*, bool, va_list);
 extern bool wordeq(token_t, token_t);
 extern bool wordempty(token_t);
 extern void wordclear(token_t *);
 extern void speak(const char*, ...);
-extern void pspeak(vocab_t, enum speaktype, int, ...);
+extern void sspeak(long msg, ...);
+extern void pspeak(vocab_t, enum speaktype, int, bool, ...);
 extern void rspeak(vocab_t, ...);
-extern void echo_input(FILE*, char*, char*);
+extern void echo_input(FILE*, const char*, const char*);
 extern int word_count(char*);
 extern char* get_input(void);
 extern bool silent_yes(void);
@@ -191,7 +231,6 @@ extern long atdwrf(long);
 extern long setbit(long);
 extern bool tstbit(long, int);
 extern void make_zzword(char*);
-extern void datime(long*, long*);
 extern void set_seed(long);
 extern unsigned long get_next_lcg_value(void);
 extern long randrange(long);
@@ -201,10 +240,9 @@ extern int savefile(FILE *, long);
 extern int suspend(void);
 extern int resume(void);
 extern int restore(FILE *);
-extern void initialise(void);
+extern long initialise(void);
 extern int action(struct command_t *command);
 
-/* Alas, declaring this static confuses the coverage analyzer */
 void bug(enum bugtype, const char *) __attribute__((__noreturn__));
 
 /* end */