LOC_* coverage - at 98.4%

[open-adventure.git] / main.c

diff --git a/main.c b/main.c
index 5a9c7c396df492eba7f5324333a2bc0e26455fb7..f24c5bc4162cb6480b3f232d69f338b86d663204 100644 (file)
--- a/main.c
+++ b/main.c
@@ -9,9 +9,8 @@
  * to idiomatic C, the following is more appropriate:
  *
  * ESR apologizes for the remaing gotos (now confined to one function
- * in this file - there used to be over 350 of them, *everywhere*),
- * and for the offensive globals.  Applying the Structured Program
- * Theorem can be hard.
+ * in this file - there used to be over 350 of them, *everywhere*).
+ * Applying the Structured Program Theorem can be hard.
  */
 
 #include <stdlib.h>
@@ -247,12 +246,12 @@ static bool spotted_by_pirate(int i)
     if (i != PIRATE)
         return false;
 
-    /*  The pirate's spotted him.  He leaves him alone once we've
+    /*  The pirate's spotted him.  Pirate leaves him alone once we've
      *  found chest.  K counts if a treasure is here.  If not, and
      *  tally=1 for an unseen chest, let the pirate be spotted.  Note
      *  that game.place[CHEST] = LOC_NOWHERE might mean that he's thrown
      *  it to the troll, but in that case he's seen the chest
-     *  (game.prop=0). */
+     *  (game.prop[CHEST] == STATE_FOUND). */
     if (game.loc == game.chloc ||
         game.prop[CHEST] != STATE_NOTFOUND)
         return true;
@@ -322,15 +321,14 @@ static bool dwarfmove(void)
      *  variables.  Remember sixth dwarf is pirate and is thus
      *  very different except for motion rules. */
 
-    /*  First off, don't let the dwarves follow him into a pit or
-     *  a wall.  Activate the whole mess the first time he gets as
-     *  far as the hall of mists (loc 15).  If game.newloc is
-     *  forbidden to pirate (in particular, if it's beyond the
+    /*  First off, don't let the dwarves follow him into a pit or a
+     *  wall.  Activate the whole mess the first time he gets as far
+     *  as the Hall of Mists (what INDEEP() tests).  If game.newloc
+     *  is forbidden to pirate (in particular, if it's beyond the
      *  troll bridge), bypass dwarf stuff.  That way pirate can't
      *  steal return toll, and dwarves can't meet the bear.  Also
      *  means dwarves won't follow him into dead end in maze, but
-     *  c'est la vie.  They'll wait for him outside the dead
-     *  end. */
+     *  c'est la vie.  They'll wait for him outside the dead end. */
     if (game.loc == LOC_NOWHERE ||
         FORCED(game.loc) ||
         CNDBIT(game.newloc, COND_NOARRR))
@@ -344,7 +342,7 @@ static bool dwarfmove(void)
     }
 
     /*  When we encounter the first dwarf, we kill 0, 1, or 2 of
-     *  the 5 dwarves.  If any of the survivors is at loc,
+     *  the 5 dwarves.  If any of the survivors is at game.loc,
      *  replace him with the alternate. */
     if (game.dflag == 1) {
         if (!INDEEP(game.loc) ||
@@ -399,7 +397,8 @@ static bool dwarfmove(void)
                 else if (j > 1 && game.newloc == tk[j - 1])
                     continue;
                 else if (j >= DIM(tk) - 1)
-                    continue;
+                   /* This can't actually happen. */
+                    continue; // LCOV_EXCL_LINE
                 else if (game.newloc == game.dloc[i])
                     continue;
                 else if (FORCED(game.newloc))
@@ -645,7 +644,6 @@ static void playermove( int motion)
     /* (ESR) We've found a destination that goes with the motion verb.
      * Next we need to check any conditional(s) on this destination, and
      * possibly on following entries. */
-    /* FIXME: Magic numbers related to move opcodes */
     do {
         for (;;) { /* L12 loop */
             for (;;) {
@@ -729,10 +727,11 @@ static void playermove( int motion)
                      * wander across and encounter the bear.  (They
                      * won't follow the player there because that
                      * region is forbidden to the pirate.)  If
-                     * game.prop(TROLL)=1, he's crossed since paying,
-                     * so step out and block him.  (standard travel
-                     * entries check for game.prop(TROLL)=0.)  Special
-                     * stuff for bear. */
+                     * game.prop[TROLL]=TROLL_PAIDONCE, he's crossed
+                     * since paying, so step out and block him.
+                     * (standard travel entries check for
+                     * game.prop[TROLL]=TROLL_UNPAID.)  Special stuff
+                     * for bear. */
                     if (game.prop[TROLL] == TROLL_PAIDONCE) {
                         pspeak(TROLL, look, TROLL_PAIDONCE, true);
                         game.prop[TROLL] = TROLL_UNPAID;
@@ -1009,7 +1008,7 @@ static bool get_command_input(struct command_t *command)
     packed_to_token(command->wd2, word2);
     command->id1 = get_vocab_id(word1);
     command->id2 = get_vocab_id(word2);
-    
+
     return true;
 }
 
@@ -1101,9 +1100,9 @@ Lclearobj:
         game.wzdark = DARK(game.loc);
         if (game.knfloc > 0 && game.knfloc != game.loc)
             game.knfloc = 0;
-        
+
         // Get command input from user
-        if(!get_command_input(&command)) 
+        if (!get_command_input(&command))
             return false;
 
 Lclosecheck:
@@ -1117,11 +1116,11 @@ Lclosecheck:
 
         if (command.id1 == ENTER && (command.id2 == STREAM ||
                                      command.id2 == PROMOTE_WORD(WATER))) {
-            if (LIQLOC(game.loc) == WATER) 
+            if (LIQLOC(game.loc) == WATER)
                 rspeak(FEET_WET);
             else
                 rspeak(WHERE_QUERY);
-            
+
             goto Lclearobj;
         }
         if (command.id1 == ENTER && command.id2 != WORD_NOT_FOUND && command.id2 != WORD_EMPTY) {
@@ -1175,7 +1174,7 @@ Lookup:
         default:
             BUG(VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3); // LCOV_EXCL_LINE
         }
-        
+
         switch (action(&command)) {
         case GO_TERMINATE:
             return true;
@@ -1201,7 +1200,7 @@ Lookup:
             command.raw1[0] = toupper(command.raw1[0]);
             sspeak(DO_WHAT, command.raw1);
             command.obj = 0;
-            // Fallthrough
+        // Fallthrough
         case GO_CHECKHINT: // Fallthrough
         case GO_CLEAROBJ:
             goto Lclearobj;