Ready for 1.8 release.
[open-adventure.git] / advent.h
index d2357070a6e891d4511b32a1ffccaec9b843beee..a1fc4542da778986a9f4e83315ab96144d61f69a 100644 (file)
--- a/advent.h
+++ b/advent.h
@@ -2,15 +2,22 @@
 #include <stdlib.h>
 #include <stdbool.h>
 #include <stdarg.h>
+#include <inttypes.h>
 
 #include "dungeon.h"
 
+/* LCG PRNG parameters tested against
+ * Knuth vol. 2. by the original authors */
+#define LCG_A 1093L
+#define LCG_C 221587L
+#define LCG_M 1048576L
+
 #define LINESIZE       1024
-#define TOKLEN         5          //  sigificant characters in a token */
+#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 INVLIMIT       7          // inventory 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 STASHED(obj)   (-1 - game.prop[obj])
 
 /*
+ *  DESTROY(N)  = Get rid of an item by putting it in LOC_NOWHERE
  *  MOD(N,M)    = Arithmetic modulus
+ *  TOTING(OBJ) = true if the OBJ is being carried
  *  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)
+ *  CNDBIT(L,N) = true if COND(L) has bit n set (bit 0 is units bit)
  *  LIQUID()    = object number of liquid in bottle
  *  LIQLOC(LOC) = object number of liquid (if any) at LOC
+ *  FORCED(LOC) = true if LOC moves without asking for input (COND=2)
+ *  DARK(LOC)   = true if location "LOC" is dark
  *  PCT(N)      = true N% of the time (N integer from 0 to 100)
- *  TOTING(OBJ) = true if the OBJ is being carried */
+ *  GSTONE(OBJ) = true if OBJ is a gemstone
+ *  FOREST(LOC) = true if LOC is part of the forest
+ *  OUTSID(LOC) = true if location not in the cave
+ *  INSIDE(LOC) = true if location is in the cave or the building at the beginning of the game
+ *  INDEEP(LOC) = true if location is in the Hall of Mists or deeper
+ *  BUG(X)      = report bug and exit
+ */
 #define DESTROY(N)   move(N, LOC_NOWHERE)
 #define MOD(N,M)     ((N) % (M))
 #define TOTING(OBJ)  (game.place[OBJ] == CARRIED)
@@ -95,7 +108,7 @@ typedef enum scorebonus {none, splatter, defeat, victory} score_t;
  * These were at one time FORTRAN line numbers.
  * The values don't matter, but perturb their order at your peril.
  */
-enum phase_codes {
+typedef enum {
     GO_TERMINATE,
     GO_MOVE,
     GO_TOP,
@@ -104,17 +117,17 @@ enum phase_codes {
     GO_WORD2,
     GO_UNKNOWN,
     GO_DWARFWAKE,
-};
+} phase_codes_t;
 
-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 */
+typedef int vocab_t;  // index into a vocabulary array */
+typedef int verb_t;   // index into an actions array */
+typedef int obj_t;    // index into the object array */
+typedef int loc_t;    // index into the locations array */
+typedef int turn_t;   // turn counter or threshold */
 
 struct game_t {
-    unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
-    long abbnum;                 // How often to print long descriptions
+    int32_t lcg_x;
+    int abbnum;                  // How often to print int descriptions
     score_t bonus;               // What kind of finishing bonus we are getting
     loc_t chloc;                 // pirate chest location
     loc_t chloc2;                // pirate chest alternate location
@@ -123,8 +136,13 @@ struct game_t {
     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
+    bool lmwarn;                 // has player been warned about lamp going dim?
+    bool novice;                 // asked for instructions at start-up?
+    bool panic;                  // has player found out he's trapped?
+    bool wzdark;                 // whether the loc he's leaving was dark
+    bool blooded;                // has player drunk of dragon's blood?
+    int conds;                   // min value for cond[loc] if loc has any hints
+    int 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)
@@ -132,45 +150,40 @@ struct game_t {
      * 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;                  // 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
+    int dflag;
+
+    int dkill;                   // dwarves killed
+    int dtotal;                  // total dwarves (including pirate) in loc
+    int foobar;                  // progress in saying "FEE FIE FOE FOO".
+    int holdng;                  // number of objects being carried
+    int igo;                     // # uses of "go" instead of a direction
+    int iwest;                   // # times he's said "west" instead of "w"
+    int knfloc;                  // knife location; 0 if none, -1 after caveat
     turn_t limit;                // lifetime of lamp
-    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?
     turn_t numdie;               // number of times killed so far
     loc_t oldloc;                // where player was
-    loc_t oldlc2;                // where player was two moves ago 
+    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
+    int saved;                   // point penalty for saves
+    int tally;                   // count of treasures gained
+    int 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
+    int abbrev[NLOCATIONS + 1];  // has location been seen?
+    int atloc[NLOCATIONS + 1];   // head of object linked list per location
+    int 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
+    obj_t 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 */
+    int hinted[NHINTS];          // hinted[i] = true iff hint i has been used.
+    int hintlc[NHINTS];          // hintlc[i] = how int at LOC with cond bit i
+    int prop[NOBJECTS + 1];      // object state array */
 };
 
 /*
@@ -184,53 +197,61 @@ struct settings_t {
 };
 
 typedef struct {
-  vocab_t id;
-  word_type_t type;
+    char raw[LINESIZE];
+    vocab_t id;
+    word_type_t type;
 } command_word_t;
 
-struct command_t {
-    char raw1[LINESIZE], raw2[LINESIZE];
+typedef enum {EMPTY, RAW, TOKENIZED, GIVEN, PREPROCESSED, PROCESSING, EXECUTED} command_state_t;
+
+typedef struct {
     enum speechpart part;
-    vocab_t id1;
-    vocab_t id2;
-    word_type_t type1;
-    word_type_t type2;
+    command_word_t word[2];
     verb_t verb;
-    obj_t   obj;
-};
+    obj_t obj;
+    command_state_t state;
+} command_t;
 
 extern struct game_t game;
 extern struct settings_t settings;
 
-extern bool get_command_input(struct command_t *);
+extern bool get_command_input(command_t *);
+extern void clear_command(command_t *);
 extern void speak(const char*, ...);
 extern void sspeak(int msg, ...);
-extern void pspeak(vocab_t, enum speaktype, int, bool, ...);
+extern void pspeak(vocab_t, enum speaktype, bool, int, ...);
 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 loc_t put(obj_t, int, int);
 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 int setbit(int);
+extern bool tstbit(int, int);
+extern void set_seed(int32_t);
+extern int32_t randrange(int32_t);
+extern int score(enum termination);
 extern void terminate(enum termination) __attribute__((noreturn));
-extern int savefile(FILE *, long);
+extern int savefile(FILE *, int32_t);
 extern int suspend(void);
 extern int resume(void);
 extern int restore(FILE *);
-extern long initialise(void);
-extern int action(struct command_t command);
+extern int initialise(void);
+extern phase_codes_t action(command_t);
 extern void state_change(obj_t, int);
-
+extern bool is_valid(struct game_t);
 
 void bug(enum bugtype, const char *) __attribute__((__noreturn__));
 
+/* represent an empty command word */
+static const command_word_t empty_command_word = {
+    .raw = "",
+    .id = WORD_EMPTY,
+    .type = NO_WORD_TYPE,
+};
+
 /* end */