Bugfix: bird starts caged in endgame.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index 0d9405eb589551c5d2b7c21fc40b616af36bc6c6..0bcfb26387b7edb2487d636c2991ca40c6fabc93 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);
@@ -139,7 +142,7 @@ void sspeak(const int msg, ...)
     va_end(ap);
 }
 
-void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...)
+void pspeak(vocab_t msg, enum speaktype mode, bool blank, int skip, ...)
 /* Find the skip+1st message from msg and print it.  Modes are:
  * feel = for inventory, what you can touch
  * look = the full description for the state the object is in
@@ -147,7 +150,7 @@ void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...)
  * study = text on the object. */
 {
     va_list ap;
-    va_start(ap, blank);
+    va_start(ap, skip);
     switch (mode) {
     case touch:
         vspeak(objects[msg].inventory, blank, ap);
@@ -211,16 +214,16 @@ static int word_count(char* str)
 static char* get_input(void)
 {
     // Set up the prompt
-    char input_prompt[] = "> ";
+    char input_prompt[] = PROMPT;
     if (!settings.prompt)
         input_prompt[0] = '\0';
 
     // Print a blank line
     printf("\n");
 
-    char* input;
-    while (true) {
-        input = readline(input_prompt);
+    char* input = "";
+    for (;;) {
+        input = myreadline(input_prompt);
 
         if (input == NULL) // Got EOF; return with it.
             return (input);
@@ -246,7 +249,7 @@ static char* get_input(void)
     return (input);
 }
 
-bool silent_yes(void)
+bool silent_yes_or_no(void)
 {
     bool outcome = false;
 
@@ -280,12 +283,10 @@ bool silent_yes(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
@@ -295,7 +296,7 @@ bool silent_yes(void)
 }
 
 
-bool yes(const char* question, const char* yes_response, const char* no_response)
+bool yes_or_no(const char* question, const char* yes_response, const char* no_response)
 /*  Print message X, wait for yes/no answer.  If yes, print Y and return true;
  *  if no, print Z and return false. */
 {
@@ -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));
@@ -483,13 +484,13 @@ static void tokenize(char* raw, command_t *cmd)
 
     /* Bound prefix on the %s would be needed to prevent buffer
      * overflow.  but we shortstop this more simply by making each
-     * raw-input buffer as long as the entire input buffer. */
+     * raw-input buffer as int as the entire input buffer. */
     sscanf(raw, "%s%s", cmd->word[0].raw, cmd->word[1].raw);
 
     /* (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.
      *
@@ -511,6 +512,7 @@ static void tokenize(char* raw, command_t *cmd)
     /* populate command with parsed vocabulary metadata */
     get_vocab_metadata(cmd->word[0].raw, &(cmd->word[0].id), &(cmd->word[0].type));
     get_vocab_metadata(cmd->word[1].raw, &(cmd->word[1].id), &(cmd->word[1].type));
+    cmd->state = TOKENIZED;
 }
 
 bool get_command_input(command_t *command)
@@ -538,9 +540,33 @@ bool get_command_input(command_t *command)
 
     tokenize(inputbuf, command);
 
+#ifdef GDEBUG
+    /* Needs to stay synced with enum word_type_t */
+    const char *types[] = {"NO_WORD_TYPE", "MOTION", "OBJECT", "ACTION", "NUMERIC"};
+    /* needs to stay synced with enum speechpart */
+    const char *roles[] = {"unknown", "intransitive", "transitive"};
+    printf("Command: role = %s type1 = %s, id1 = %d, type2 = %s, id2 = %d\n",
+           roles[command->part],
+           types[command->word[0].type],
+           command->word[0].id,
+           types[command->word[1].type],
+           command->word[1].id);
+#endif
+
+    command->state = GIVEN;
     return true;
 }
 
+void clear_command(command_t *cmd)
+/* Resets the state of the command to empty */
+{
+    cmd->verb = ACT_NULL;
+    cmd->part = unknown;
+    game.oldobj = cmd->obj;
+    cmd->obj = NO_OBJECT;
+    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. */
@@ -571,12 +597,12 @@ void move(obj_t object, loc_t where)
     drop(object, where);
 }
 
-loc_t put(obj_t object, loc_t where, long pval)
+loc_t put(obj_t object, loc_t where, int pval)
 /*  put() is the same as move(), except it returns a value used to set up the
  *  negated game.prop values for the repository objects. */
 {
     move(object, where);
-    return STASHED(pval);
+    return (-1) - pval;;
 }
 
 void carry(obj_t object, loc_t where)
@@ -584,13 +610,20 @@ void carry(obj_t object, loc_t where)
  *  location.  Incr holdng unless it was already being toted.  If object>NOBJECTS
  *  (moving "fixed" second loc), don't change game.place or game.holdng. */
 {
-    long temp;
+    int temp;
 
     if (object <= NOBJECTS) {
         if (game.place[object] == CARRIED)
             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;
     }
@@ -607,7 +640,7 @@ void carry(obj_t object, loc_t where)
 
 void drop(obj_t object, loc_t where)
 /*  Place an object at a given loc, prefixing it onto the game.atloc list.  Decr
- *  game.holdng if the object was being toted. */
+ *  game.holdng if the object was being toted. No state change on the object. */
 {
     if (object > NOBJECTS)
         game.fixed[object - NOBJECTS] = where;
@@ -615,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.
@@ -641,7 +674,7 @@ int atdwrf(loc_t where)
     if (game.dflag < 2)
         return at;
     at = -1;
-    for (long i = 1; i <= NDWARVES - 1; i++) {
+    for (int i = 1; i <= NDWARVES - 1; i++) {
         if (game.dloc[i] == where)
             return i;
         if (game.dloc[i] != 0)
@@ -653,13 +686,13 @@ int atdwrf(loc_t where)
 /*  Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
  *  randrange) */
 
-long setbit(int bit)
+int setbit(int bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
 {
     return (1L << bit);
 }
 
-bool tstbit(long mask, int bit)
+bool tstbit(int mask, int bit)
 /*  Returns true if the specified bit is set in the mask. */
 {
     return (mask & (1 << bit)) != 0;
@@ -702,13 +735,11 @@ void bug(enum bugtype num, const char *error_string)
 }
 // LCOV_EXCL_STOP
 
-/* end */
-
 void state_change(obj_t obj, int state)
 /* Object must have a change-message list for this to be useful; only some do */
 {
     game.prop[obj] = state;
-    pspeak(obj, change, state, true);
+    pspeak(obj, change, true, state);
 }
 
 /* end */