Documentation and comment cleanup.

Also, renove uused enums.

advent.h

@@ -6,23 +6,23 @@
 #include "dungeon.h"
 
 #define LINESIZE       100
-#define NDWARVES	6		/* number of dwarves */
+#define NDWARVES       6          // number of dwarves
-#define PIRATE		NDWARVES	/* must be NDWARVES-1 when zero-origin */
+#define PIRATE         NDWARVES   // must be NDWARVES-1 when zero-origin
-#define DALTLC		LOC_NUGGET	/* alternate dwarf location */
+#define DALTLC         LOC_NUGGET // alternate dwarf location
-#define MAXPARMS	25		/* Max parameters for speak() */
+#define MAXPARMS       25         // Max parameters for speak()
-#define INVLIMIT	7		/* inverntory limit (# of objects) */
+#define INVLIMIT       7          // inverntory limit (# of objects)
-#define INTRANSITIVE	-1		/* illegal object number */
+#define INTRANSITIVE   -1         // illegal object number
-#define SPECIALBASE	300		/* base number of special rooms */
+#define SPECIALBASE    300        // base number of special rooms
-#define GAMELIMIT	330		/* base limit of turns */
+#define GAMELIMIT      330        // base limit of turns
-#define NOVICELIMIT	1000	/* limit of turns for novice */
+#define NOVICELIMIT    1000       // limit of turns for novice
-#define WARNTIME	30		/* late game starts at game.limit-this */
+#define WARNTIME       30         // late game starts at game.limit-this
-#define FLASHTIME	50	/*turns from first warning till blinding flash */
+#define FLASHTIME      50         // turns from first warning till blinding flash
-#define PANICTIME	15		/* time left after closing */
+#define PANICTIME      15         // time left after closing
-#define BATTERYLIFE	2500		/* turn limit increment from batteries */
+#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_NOT_FOUND -1         // "Word not found" flag value for the vocab hash functions.
 
-typedef long token_t;	/* word token - someday this will be char[TOKLEN+1] */
+typedef long token_t;  // word token - someday this will be char[TOKLEN+1]
-typedef long vocab_t;	/* index into a vocabulary array */
+typedef long vocab_t;  // index into a vocabulary array */
 
 extern const char advent_to_ascii[128];
 extern const char ascii_to_advent[128];
@@ -30,12 +30,8 @@ extern const char new_advent_to_ascii[64];
 extern const char new_ascii_to_advent[128];
 
 enum bugtype {
-   TOO_MANY_VOCABULARY_WORDS,                             // 4
-   REQUIRED_VOCABULARY_WORD_NOT_FOUND,                    // 5
-   INVALID_SECTION_NUMBER_IN_DATABASE,                    // 9
    SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST = 20,   // 20
-   RAN_OFF_END_OF_VOCABULARY_TABLE,                       // 21
+   VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3 = 22,    // 22
-   VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,       // 22
    INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,              // 23
    TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,                // 24
    CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,             // 25
@@ -52,44 +48,44 @@ void bug(enum bugtype, const char *) __attribute__((__noreturn__));
 
 struct game_t {
     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
-    long abbnum;	/* How often to print non-abbreviated descriptions */
+    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 clock1;                 // # turns from finding last treasure till closing
-    long clock2;	/* # turns from first warning till blinding flash */
+    long clock2;                 // # turns from first warning till blinding flash
-    bool clshnt;	/* has player read the clue in the endgame? */
+    bool clshnt;                 // has player read the clue in the endgame?
-    bool closed;	/* whether we're all the way closed */
+    bool closed;                 // whether we're all the way closed
-    bool closng;	/* whether it's closing time yet */
+    bool closng;                 // whether it's closing time yet
-    long conds;		/* min value for cond(loc) if loc has any hints */
+    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 foobar;                 // current progress in saying "FEE FIE FOE FOO".
-    long holdng;	/* number of objects being carried */
+    long holdng;                 // number of objects being carried
-    long iwest;		/* How many times he's said "west" instead of "w" */
+    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 knfloc;                 // 0 if no knife here, loc if knife , -1 after caveat
-    long limit;		/* lifetime of lamp (not set here) */
+    long limit;                  // lifetime of lamp (not set here)
-    bool lmwarn;	/* has player been warned about lamp going dim? */
+    bool lmwarn;                 // has player been warned about lamp going dim?
     long loc;
     long newloc;
-    bool novice;	/* asked for instructions at start-up? */
+    bool novice;                 // asked for instructions at start-up?
-    long numdie;	/* number of times killed so far */
+    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? */
+    bool panic;                  // has player found out he's trapped in the cave?
-    long saved;		/* point penalty for saves */
+    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 trnluz;                 // # points lost so far due to number of turns used
-    long turns;		/* how many commands he's given (ignores yes/no) */
+    long turns;                  // how many commands he's given (ignores yes/no)
-    bool wzdark;	/* whether the loc he's leaving was dark */
+    bool wzdark;                 // whether the loc he's leaving was dark
-    char zzword[6];
+    char zzword[6];              // randomly generated magic word from bird
-    bool blooded;	/* has player drunk of dragon's blood? */
+    bool blooded;                // has player drunk of dragon's blood?
     long abbrev[NLOCATIONS + 1]; 
     long atloc[NLOCATIONS + 1];
     long dseen[NDWARVES + 1];

misc.c

@@ -152,7 +152,7 @@ void wordclear(token_t *v)
     *v = 0;
 }
 
-/*  I/O routines (speak, pspeak, rspeak, GETIN, YES) */
+/*  I/O routines (speak, pspeak, rspeak, get_input, yes) */
 
 void vspeak(const char* msg, va_list ap)
 {

tests/saveresume.1.chk

@@ -19,6 +19,17 @@ it will cost you 5 points.
 
 Is this acceptable?
 
+> n
+
+OK
+
+> save
+
+I can suspend your Adventure for you so that you can resume later, but
+it will cost you 5 points.
+
+Is this acceptable?
+
 > y
 
 OK

tests/saveresume.1.log

@@ -2,6 +2,8 @@
 n
 seed 1240742801
 save
+n
+save
 y
 saveresume.adv
 y

tests/saveresume.2.chk

@@ -7,8 +7,38 @@ You are standing at the end of a road before a small brick building.
 Around you is a forest.  A small stream flows out of the building and
 down a gully.
 
+> in
+
+You are inside a building, a well house for a large spring.
+
+There are some keys on the ground here.
+
+There is a shiny brass lamp nearby.
+
+There is food here.
+
+There is a bottle of water here.
+
 > resume
 
+To resume an earlier Adventure, you must abandon the current one.
+
+Is this acceptable?
+
+> n
+
+OK
+
+> resume
+
+To resume an earlier Adventure, you must abandon the current one.
+
+Is this acceptable?
+
+> y
+
+OK
+
 You're in front of building.
 
 > quit
@@ -19,7 +49,7 @@ Do you really want to quit now?
 
 OK
 
-You scored 27 out of a possible 430, using 2 turns.
+You scored 27 out of a possible 430, using 3 turns.
 
 You are obviously a rank amateur.  Better luck next time.
 

tests/saveresume.2.log

@@ -1,6 +1,10 @@
 ## Resume and then quit
 n
+in
 resume
+n
+resume
+y
 saveresume.adv
 quit
 yes