Add a comment to the code that fixes the inventory-count bug.

[open-adventure.git] / misc.c

diff --git a/misc.c b/misc.c
index 968e2a1840d5a6acc6c04a79c44bfcaf418a95ee..d04760266c45903d7897ac100e5091df67069d18 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -1,5 +1,5 @@
 /*
- * I/O and support riutines.
+ * I/O and support routines.
  *
  * Copyright (c) 1977, 2005 by Will Crowther and Don Woods
  * Copyright (c) 2017 by Eric S. Raymond
@@ -35,6 +35,7 @@ static void* xcalloc(size_t size)
 /*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
 static void vspeak(const char* msg, bool blank, va_list ap)
+/* Engine for various speak functions */
 {
     // Do nothing if we got a null pointer.
     if (msg == NULL)
@@ -122,6 +123,7 @@ static void vspeak(const char* msg, bool blank, va_list ap)
 }
 
 void speak(const char* msg, ...)
+/* speak a specified string */
 {
     va_list ap;
     va_start(ap, msg);
@@ -130,6 +132,7 @@ void speak(const char* msg, ...)
 }
 
 void sspeak(const int msg, ...)
+/* Speak a message from the arbitrary-messages list */
 {
     va_list ap;
     va_start(ap, msg);
@@ -218,8 +221,8 @@ static char* get_input(void)
     // Print a blank line
     printf("\n");
 
-    char* input;
-    while (true) {
+    char* input = "";
+    for (;;) {
         input = myreadline(input_prompt);
 
         if (input == NULL) // Got EOF; return with it.
@@ -280,12 +283,10 @@ bool silent_yes_or_no(void)
 
         free(firstword);
 
-        if (yes == 0 ||
-            y == 0) {
+        if (yes == 0 || y == 0) {
             outcome = true;
             break;
-        } else if (no == 0 ||
-                   n == 0) {
+        } else if (no == 0 || n == 0) {
             outcome = false;
             break;
         } else
@@ -410,7 +411,7 @@ static bool is_valid_int(const char *str)
     if (!*str)
         return false; // LCOV_EXCL_LINE
 
-    // Check for non-digit chars in the rest of the stirng.
+    // Check for non-digit chars in the rest of the string.
     while (*str) {
         if (!isdigit(*str))
             return false;
@@ -475,7 +476,7 @@ static void get_vocab_metadata(const char* word, vocab_t* id, word_type_t* type)
 static void tokenize(char* raw, command_t *cmd)
 {
     /*
-     * Be caereful about modifing this. We do not want to nuke the
+     * Be careful about modifying this. We do not want to nuke the
      * the speech part or ID from the previous turn.
      */
     memset(&cmd->word[0].raw, '\0', sizeof(cmd->word[0].raw));
@@ -489,7 +490,7 @@ static void tokenize(char* raw, command_t *cmd)
     /* (ESR) In oldstyle mode, simulate the uppercasing and truncating
      * effect on raw tokens of packing them into sixbit characters, 5
      * to a 32-bit word.  This is something the FORTRAN version did
-     * becuse archaic FORTRAN had no string types.  Don Wood's
+     * because archaic FORTRAN had no string types.  Don Wood's
      * mechanical translation of 2.5 to C retained the packing and
      * thus this misfeature.
      *
@@ -566,7 +567,6 @@ void clear_command(command_t *cmd)
     cmd->state = EMPTY;
 }
 
-
 void juggle(obj_t object)
 /*  Juggle an object by picking it up and putting it down again, the purpose
  *  being to get the object to the front of the chain of things at its loc. */
@@ -617,6 +617,13 @@ void carry(obj_t object, loc_t where)
             return;
         game.place[object] = CARRIED;
 
+       /*
+        * Without this conditional your inventory is overcounted
+        * when you pick up the bird while it's caged. This fixes
+        * a cosmetic bug in the original.
+        *
+        * Possibly this check should be skipped whwn oldstyle is on.
+        */
         if (object != BIRD)
             ++game.holdng;
     }
@@ -641,7 +648,7 @@ void drop(obj_t object, loc_t where)
         if (game.place[object] == CARRIED)
             if (object != BIRD)
                 /* The bird has to be weightless.  This ugly hack (and the
-                 * corresponding code in the drop function) brought to you
+                 * corresponding code in the carry function) brought to you
                  * by the fact that when the bird is caged, we need to be able
                  * to either 'take bird' or 'take cage' and have the right thing
                  * happen.