Comment cleanup, semantic types, information hiding.
[open-adventure.git] / advent.h
index d2b082cbbd785cbdfa880cc5126627c0421cc122..98d30925862a5d05a32966bccd1ebab0b80974be 100644 (file)
--- a/advent.h
+++ b/advent.h
 #include <stdbool.h>
 #include <stdarg.h>
 
-#include "common.h"
-#include "newdb.h"
-
-#define LINESIZE       100
-#define NDWARVES       6               /* number of dwarves */
-#define PIRATE         NDWARVES        /* must be NDWARVES-1 when zero-origin */
-#define DALTLC         LOC_NUGGET      /* alternate dwarf location */
-#define MAXPARMS       25              /* Max parameters for speak() */
-#define INVLIMIT       7               /* inverntory limit (# of objects) */
-#define INTRANSITIVE   -1              /* illegal object number */
-#define SPECIALBASE    300             /* base number of special rooms */
-#define GAMELIMIT      330             /* base limit of turns */
-#define NOVICELIMIT    1000    /* limit of turns for novice */
-#define WARNTIME       30              /* late game starts at game.limit-this */
-#define FLASHTIME      50      /*turns from first warning till blinding flash */
-#define PANICTIME      15              /* time left after closing */
-#define BATTERYLIFE    2500            /* turn limit increment from batteries */
-
-typedef long token_t;  /* word token - someday this will be char[TOKLEN+1] */
-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;
-    long clock1;       /* # turns from finding last treasure till closing */
-    long clock2;       /* # turns from first warning till blinding flash */
-    bool clshnt;       /* has player read the clue in the endgame? */
-    bool closed;       /* whether we're all the way closed */
-    bool closng;       /* whether it's closing time yet */
-    long conds;                /* min value for cond(loc) if loc has any hints */
-    long detail;
-    long dflag;
-    long dkill;
-    long dtotal;
-    long foobar;       /* current progress in saying "FEE FIE FOE FOO". */
-    long holdng;       /* number of objects being carried */
-    long iwest;                /* How many times he's said "west" instead of "w" */
-    long knfloc;       /* 0 if no knife here, loc if knife , -1 after caveat */
-    long limit;                /* lifetime of lamp (not set here) */
-    bool lmwarn;       /* has player been warned about lamp going dim? */
-    long loc;
-    long newloc;
-    bool novice;       /* asked for instructions at start-up? */
-    long numdie;       /* number of times killed so far */
-    long oldloc;
-    long oldlc2;
-    long oldobj;
-    bool panic;                /* has player found out he's trapped in the cave? */
-    long saved;                /* point penalty for saves */
-    long tally;
-    long thresh;
-    long trndex;
-    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 */
-    long zzword;
-    bool blooded;      /* has player drunk of dragon's blood? */
-    long abbrev[NLOCATIONS + 1];
-    long atloc[NLOCATIONS + 1];
-    long dseen[NDWARVES + 1];
-    long dloc[NDWARVES + 1];
-    long odloc[NDWARVES + 1];
-    long fixed[NOBJECTS + 1];
-    long link[NOBJECTS * 2 + 1];
-    long place[NOBJECTS + 1];
-    long hinted[NHINTS];
-    long hintlc[NHINTS];
-    long prop[NOBJECTS + 1];
-};
-
-extern struct game_t game;
-
-extern long LNLENG, LNPOSN;
-extern char rawbuf[LINESIZE], INLINE[LINESIZE + 1];
-extern const char ascii_to_advent[];
-extern const char advent_to_ascii[];
-extern FILE *logfp;
-extern bool oldstyle, editline, prompt;
-
-enum speaktype {touch, look, hear, study};
-
-/* b is not needed for POSIX but harmless */
-#define READ_MODE "rb"
-#define WRITE_MODE "wb"
-extern void* xmalloc(size_t size);
-extern void packed_to_token(long, char token[]);
-extern void token_to_packed(char token[], long*);
-extern void vspeak(const char*, 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 rspeak(vocab_t, ...);
-extern bool GETIN(FILE *, token_t*, token_t*, token_t*, token_t*);
-extern void echo_input(FILE*, char*, char*);
-extern char* get_input(void);
-extern bool YES(const char*, const char*, const char*);
-extern long GETTXT(bool, bool, bool);
-extern token_t MAKEWD(long);
-extern long VOCAB(long, long);
-extern void JUGGLE(long);
-extern void MOVE(long, long);
-extern long PUT(long, long, long);
-extern void CARRY(long, long);
-extern void DROP(long, long);
-extern long ATDWRF(long);
-extern long SETBIT(long);
-extern bool TSTBIT(long, int);
-extern long RNDVOC(long, long);
-extern bool MAPLIN(FILE *);
-extern void DATIME(long*, long*);
-
-enum termination {endgame, quitgame, scoregame};
-
-extern void set_seed(long);
-extern unsigned long get_next_lcg_value(void);
-extern long randrange(long);
-extern long score(enum termination);
-extern void terminate(enum termination) __attribute__((noreturn));
-extern int suspend(void);
-extern int resume(void);
-extern int restore(FILE *);
+#include "dungeon.h"
+
+#define LINESIZE       1024
+#define TOKLEN         5          // № sigificant characters in 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 INVLIMIT       7          // inverntory limit (№ of objects)
+#define INTRANSITIVE   -1         // illegal object number
+#define GAMELIMIT      330        // base limit of turns
+#define NOVICELIMIT    1000       // limit of turns for novice
+#define WARNTIME       30         // late game starts at game.limit-this
+#define FLASHTIME      50         // turns from first warning till blinding flash
+#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
+ *  MOD(N,M)    = Arithmetic modulus
+ *  AT(OBJ)     = true if on either side of two-placed object
  *  CNDBIT(L,N) = true if COND(L) has bit n set (bit 0 is units bit)
  *  DARK(LOC)   = true if location "LOC" is dark
  *  FORCED(LOC) = true if LOC moves without asking for input (COND=2)
  *  FOREST(LOC) = true if LOC is part of the forest
  *  GSTONE(OBJ) = true if OBJ is a gemstone
- *  HERE(OBJ)  = true if the OBJ is at "LOC" (or is being carried)
- *  LIQUID()   = object number of liquid in bottle
+ *  HERE(OBJ)   = true if the OBJ is at "LOC" (or is being carried)
+ *  LIQUID()    = object number of liquid in bottle
  *  LIQLOC(LOC) = object number of liquid (if any) at LOC
  *  PCT(N)      = true N% of the time (N integer from 0 to 100)
  *  TOTING(OBJ) = true if the OBJ is being carried */
+#define DESTROY(N)   move(N, LOC_NOWHERE)
+#define MOD(N,M)     ((N) % (M))
+#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 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)  (!CNDBIT(game.loc,COND_LIT) && (game.prop[LAMP] == LAMP_DARK || !HERE(LAMP)))
+#define PCT(N)       (randrange(100) < (N))
+#define GSTONE(OBJ)  ((OBJ) == EMERALD || (OBJ) == RUBY || (OBJ) == AMBER || (OBJ) == SAPPH)
+#define FOREST(LOC)  CNDBIT(LOC, COND_FOREST)
+#define OUTSID(LOC)  (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
+#define INSIDE(LOC)  (!OUTSID(LOC) || LOC == LOC_BUILDING)
+#define INDEEP(LOC)  ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
+#define BUG(x)       bug(x, #x)
+
+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,
+};
 
-#define DESTROY(N)     MOVE(N, LOC_NOWHERE)
-#define MOD(N,M)       ((N) % (M))
-#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 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 GSTONE(OBJ)    ((OBJ) == EMERALD || (OBJ) == RUBY || (OBJ) == AMBER || (OBJ) == SAPPH)
-#define FOREST(LOC)    CNDBIT(LOC, COND_FOREST)
-#define VOCWRD(LETTRS,SECT)    (VOCAB(MAKEWD(LETTRS),SECT))
-#define SPECIAL(LOC)   ((LOC) > SPECIALBASE)
-#define OUTSID(LOC)    (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
-
-#define INDEEP(LOC)    ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
+enum speaktype {touch, look, hear, study, change};
 
-/* vocabulary items */
-extern long AMBER, ATTACK, AXE, BACK, BATTERY, BEAR,
-       BIRD, BLOOD, BOTTLE, CAGE, CAVE, CAVITY, CHAIN, CHASM, CHEST,
-       CLAM, COINS, DOOR, DPRSSN, DRAGON, DWARF, EGGS,
-       EMERALD, ENTER, ENTRNC, FIND, FISSURE, FOOD, GRATE, HINT, INVENT,
-       JADE, KEYS, KNIFE, LAMP, LOCK, LOOK, MAGAZINE, MESSAG, MIRROR, NUGGET, NUL,
-       OGRE, OIL, OYSTER, PANIC, PEARL, PILLOW, PLANT, PLANT2, PYRAMID,
-       RESER, ROD, ROD2, RUBY, RUG, SAPPH, SAY, SIGN, SNAKE,
-       STEPS, STICK, STREAM, THROW, TRIDENT, TROLL, TROLL2,
-       URN, VASE, VEND, VOLCANO, WATER;
+enum termination {endgame, quitgame, scoregame};
 
 enum speechpart {unknown, intransitive, transitive};
 
-struct command_t {
-    enum speechpart part;
-    vocab_t verb;
-    vocab_t obj;
-    token_t wd1, wd1x;
-    token_t wd2, wd2x;
-};
+enum wordtype {NO_WORD_TYPE, MOTION, OBJECT, ACTION, SPECIAL};
 
-void initialise(void);
-int action(FILE *input, struct command_t *command);
+typedef enum scorebonus {none, splatter, defeat, victory} score_t;
 
 /* Phase codes for action returns.
  * These were at one time FORTRAN line numbers.
  * The values don't matter, but perturb their order at your peril.
  */
-#define GO_TERMINATE   2
-#define GO_MOVE                8
-#define GO_TOP         2000
-#define GO_CLEAROBJ    2012
-#define GO_CHECKHINT   2600
-#define GO_CHECKFOO    2607
-#define GO_DIRECTION   2620
-#define GO_LOOKUP      2630
-#define GO_WORD2       2800
-#define GO_SPECIALS    1900
-#define GO_UNKNOWN     8000
-#define GO_ACTION      40000
-#define GO_DWARFWAKE   19000
+enum phase_codes {
+    GO_TERMINATE,
+    GO_MOVE,
+    GO_TOP,
+    GO_CLEAROBJ,
+    GO_CHECKHINT,
+    GO_DIRECTION,
+    GO_WORD2,
+    GO_SPECIALS,
+    GO_UNKNOWN,
+    GO_ACTION,
+    GO_DWARFWAKE,
+};
+
+typedef long token_t;  // token index */
+typedef long vocab_t;  // index into a vocabulary array */
+typedef long verb_t;   // index into an actions array */
+typedef long obj_t;    // index into the object array */
+typedef long loc_t;    // index into the locations array */
+typedef long turn_t;   // turn counter or threshold */
 
-/* Special object statuses in game.place - can also be a location number (> 0) */
-#define CARRIED                -1      /* Player is toting it */
+struct game_t {
+    unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
+    long abbnum;                 // How often to print long descriptions
+    score_t bonus;               // What kind of finishing bonus we are getting
+    long chloc;                  // pirate chest location
+    long chloc2;                 // pirate chest alternate location
+    long clock1;                 // # turns from finding last treasure to close
+    long clock2;                 // # turns from warning till blinding flash
+    bool clshnt;                 // has player read the clue in the endgame?
+    bool closed;                 // whether we're all the way closed
+    bool closng;                 // whether it's closing time yet
+    long conds;                  // min value for cond[loc] if loc has any hints
+    long detail;                 // level of detail in descriptions
+
+    /*  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;
 
-/* hack to ignore GCC Unused Result */
-#define IGNORE(r) do{if (r){}}while(0)
+    long dkill;                  // dwarves killed
+    long dtotal;                 // total dwarves (including pirate)
+    long foobar;                 // progress in saying "FEE FIE FOE FOO".
+    long holdng;                 // number of objects being carried
+    long igo;                    // # uses of "go" instead of a direction
+    long iwest;                  // # times he's said "west" instead of "w"
+    long knfloc;                 // knife location; 0 if none, -1 after caveat
+    long limit;                  // lifetime of lamp (not set here)
+    bool lmwarn;                 // has player been warned about lamp going dim?
+    loc_t loc;                   // where player is now
+    loc_t newloc;                // where player is going
+    bool novice;                 // asked for instructions at start-up?
+    long numdie;                 // number of times killed so far
+    loc_t oldloc;                // where player was
+    loc_t oldlc2;                // where player was two moves ago 
+    obj_t oldobj;                // last object player handled
+    bool panic;                  // has player found out he's trapped?
+    long saved;                  // point penalty for saves
+    long tally;                  // count of treasures gained
+    long thresh;                 // current threshold for endgame scoring tier
+    turn_t trndex;               // FIXME: not used, remove on next format bump
+    turn_t trnluz;               // # points lost so far due to turns used
+    turn_t turns;                // counts commands given (ignores yes/no)
+    bool wzdark;                 // whether the loc he's leaving was dark
+    char zzword[TOKLEN + 1];     // randomly generated magic word from bird
+    bool blooded;                // has player drunk of dragon's blood?
+    long abbrev[NLOCATIONS + 1]; // has location been seen?
+    long atloc[NLOCATIONS + 1];  // head of object linked list per location
+    long dseen[NDWARVES + 1];    // true if dwarf has seen him
+    loc_t dloc[NDWARVES + 1];    // location of dwarves, initially hard-wired in
+    loc_t odloc[NDWARVES + 1];   // prior loc of each dwarf, initially garbage
+    loc_t fixed[NOBJECTS + 1];   // fixed location of object (if  not IS_FREE)
+    long link[NOBJECTS * 2 + 1]; // object-list links
+    loc_t place[NOBJECTS + 1];   // location of object
+    long hinted[NHINTS];         // hinted[i] = true iff hint i has been used.
+    long hintlc[NHINTS];         // hintlc[i] = how long at LOC with cond bit i
+    long prop[NOBJECTS + 1];     // object state array */
+};
 
 /*
- * FIXME: These constants should be replaced by strings, at their usage sites.
- * They are sixbit-packed representations of vocabulary words.  This, and code
- * left in misc.c, is the only place left in the runtime that knows about 
- * word packing.
+ * Game application settings - settings, but not state of the game, per se.
+ * This data is not saved in a saved game.
  */
-#define WORD_AXE       12405
-#define WORD_BATTERY   201202005
-#define WORD_BEAR      2050118
-#define WORD_BIRD      2091804
-#define WORD_BLOOD     212151504
-#define WORD_BOTTLE    215202012
-#define WORD_CAGE      3010705
-#define WORD_CATCH     301200308
-#define WORD_CAVITY    301220920
-#define WORD_CHASM     308011913
-#define WORD_CLAM      3120113
-#define WORD_DOOR      4151518
-#define WORD_DRAGON    418010715
-#define WORD_DWARF     423011806
-#define WORD_FISSURE   609191921
-#define WORD_FOOD      6151504
-#define WORD_GO                715
-#define WORD_GRATE     718012005
-#define WORD_KEYS      11052519
-#define WORD_KNIFE     1114090605
-#define WORD_LAMP      12011316
-#define WORD_MAGAZINE  1301070126
-#define WORD_MESSAG    1305191901
-#define WORD_MIRROR    1309181815
-#define WORD_OGRE      15071805
-#define WORD_OIL       150912
-#define WORD_OYSTER    1525192005
-#define WORD_PILLOW    1609121215
-#define WORD_PLANT     1612011420
-#define WORD_POUR      16152118
-#define WORD_RESER     1805190518
-#define WORD_ROD       181504
-#define WORD_SIGN      19090714
-#define WORD_SNAKE     1914011105
-#define WORD_STEPS     1920051619
-#define WORD_TROLL     2018151212
-#define WORD_URN       211814
-#define WORD_VEND      1755140409
-#define WORD_VOLCANO   1765120301
-#define WORD_WATER     1851200518
-#define WORD_AMBER     113020518
-#define WORD_CHAIN     308010914
-#define WORD_CHEST     308051920
-#define WORD_COINS     315091419
-#define WORD_EGGS      5070719
-#define WORD_EMERALD   513051801
-#define WORD_JADE      10010405
-#define WORD_NUGGET    7151204
-#define WORD_PEARL     1605011812
-#define WORD_PYRAMID   1625180113
-#define WORD_RUBY      18210225
-#define WORD_RUG       182107
-#define WORD_SAPPH     1901161608
-#define WORD_TRIDENT   2018090405
-#define WORD_VASE      22011905
-#define WORD_BACK      2010311
-#define WORD_CAVE      3012205
-#define WORD_DPRSSN    405161805
-#define WORD_ENTER     514200518
-#define WORD_ENTRNC    514201801
-#define WORD_LOOK      12151511
-#define WORD_NUL       14211212
-#define WORD_STREAM    1920180501
-#define WORD_FIND      6091404
-#define WORD_INVENT    914220514
-#define WORD_LOCK      12150311
-#define WORD_SAY       190125
-#define WORD_THROW     2008181523
-#define WORD_WEST      23051920
-#define WORD_YES       250519
-#define WORD_YINIT     25
+struct settings_t {
+    FILE *logfp;
+    bool oldstyle;
+    bool prompt;
+};
 
-/* end */
+struct command_t {
+    enum speechpart part;
+    verb_t verb;
+    obj_t   obj;
+    token_t id1;
+    token_t id2;
+    char raw1[LINESIZE], raw2[LINESIZE];
+    enum wordtype type1;
+    enum wordtype type2;
+};
+
+extern struct game_t game;
+extern struct settings_t settings;
+
+extern bool get_command_input(struct command_t *);
+extern void speak(const char*, ...);
+extern void sspeak(int msg, ...);
+extern void pspeak(vocab_t, enum speaktype, int, bool, ...);
+extern void rspeak(vocab_t, ...);
+extern void echo_input(FILE*, const char*, const char*);
+extern bool silent_yes(void);
+extern bool yes(const char*, const char*, const char*);
+extern void juggle(obj_t);
+extern void move(obj_t, loc_t);
+extern loc_t put(obj_t, long, long);
+extern void carry(obj_t, loc_t);
+extern void drop(obj_t, loc_t);
+extern int atdwrf(loc_t);
+extern long setbit(int);
+extern bool tstbit(long, int);
+extern void set_seed(long);
+extern long randrange(long);
+extern long score(enum termination);
+extern void terminate(enum termination) __attribute__((noreturn));
+extern int savefile(FILE *, long);
+extern int suspend(void);
+extern int resume(void);
+extern int restore(FILE *);
+extern long initialise(void);
+extern int action(struct command_t *command);
+extern void state_change(obj_t, int);
 
+
+void bug(enum bugtype, const char *) __attribute__((__noreturn__));
+
+/* end */