Put some of important parameters into fixed width signed integers
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index d33bc510c9b7fa05d500c569df9cc7f7a4e5585e..302e61cc641d4faeac7b176839ddd2aa05cac9a1 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -6,13 +6,14 @@
 #include <sys/time.h>
 #include <ctype.h>
 #include <editline/readline.h>
+#include <inttypes.h>
 
 #include "advent.h"
 #include "dungeon.h"
 
-static void* xmalloc(size_t size)
+static void* xcalloc(size_t size)
 {
-    void* ptr = malloc(size);
+    void* ptr = calloc(size, 1);
     if (ptr == NULL) {
         // LCOV_EXCL_START
         // exclude from coverage analysis because we can't simulate an out of memory error in testing
@@ -23,38 +24,6 @@ static void* xmalloc(size_t size)
     return (ptr);
 }
 
-void tokenize(char* raw, struct command_t *cmd)
-{
-    memset(cmd, '\0', sizeof(struct command_t));
-
-    /* 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 enrire inout buffer. */
-    sscanf(raw, "%s%s", cmd->raw1, cmd->raw2);
-
-    /* (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
-     * mechanical translation of 2.5 to C retained the packing and
-     * thus this misfeature.
-     *
-     * It's philosophically questionable whether this is the right
-     * thing to do even in oldstyle mode.  On one hand, the text
-     * mangling was not authorial intent, but a result of limitations
-     * in their tools. On the other, not simulating this misbehavior
-     * goes against the goal of making oldstyle as accurate as
-     * possible an emulation of the original UI.
-     */
-    if (settings.oldstyle) {
-        cmd->raw1[TOKLEN + TOKLEN] = cmd->raw2[TOKLEN + TOKLEN] = '\0';
-        for (size_t i = 0; i < strlen(cmd->raw1); i++)
-            cmd->raw1[i] = toupper(cmd->raw1[i]);
-        for (size_t i = 0; i < strlen(cmd->raw2); i++)
-            cmd->raw2[i] = toupper(cmd->raw2[i]);
-    }
-}
-
 /*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
 static void vspeak(const char* msg, bool blank, va_list ap)
@@ -74,7 +43,7 @@ static void vspeak(const char* msg, bool blank, va_list ap)
 
     // Rendered string
     ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
-    char* rendered = xmalloc(size);
+    char* rendered = xcalloc(size);
     char* renderp = rendered;
 
     // Handle format specifiers (including the custom %S) by
@@ -96,24 +65,21 @@ static void vspeak(const char* msg, bool blank, va_list ap)
             }
         } else {
             i++;
-            // Integer specifier. In order to accommodate the fact
-            // that PARMS can have both legitimate integers *and*
-            // packed tokens, stringify everything. Future work may
-            // eliminate the need for this.
+            // Integer specifier.
             if (msg[i] == 'd') {
-               long arg = va_arg(ap, long);
-                int ret = snprintf(renderp, size, "%ld", arg);
+                int32_t arg = va_arg(ap, int32_t);
+                int ret = snprintf(renderp, size, "%" PRId32, arg);
                 if (ret < size) {
                     renderp += ret;
                     size -= ret;
                 }
-               pluralize = (arg != 1);
+                pluralize = (arg != 1);
             }
 
             // Unmodified string specifier.
             if (msg[i] == 's') {
-               char *arg = va_arg(ap, char *);
-                strncat(renderp, arg, size);
+                char *arg = va_arg(ap, char *);
+                strncat(renderp, arg, size - 1);
                 size_t len = strlen(renderp);
                 renderp += len;
                 size -= len;
@@ -121,13 +87,14 @@ static void vspeak(const char* msg, bool blank, va_list ap)
 
             // Singular/plural specifier.
             if (msg[i] == 'S') {
-               // look at the *previous* numeric parameter
+                // look at the *previous* numeric parameter
                 if (pluralize) {
                     *renderp++ = 's';
                     size--;
                 }
             }
 
+            // LCOV_EXCL_START - doesn't occur in test suite.
             /* Version specifier */
             if (msg[i] == 'V') {
                 strcpy(renderp, VERSION);
@@ -135,6 +102,7 @@ static void vspeak(const char* msg, bool blank, va_list ap)
                 renderp += len;
                 size -= len;
             }
+            // LCOV_EXCL_STOP
         }
     }
     *renderp = 0;
@@ -153,7 +121,7 @@ void speak(const char* msg, ...)
     va_end(ap);
 }
 
-void sspeak(const long msg, ...)
+void sspeak(const int msg, ...)
 {
     va_list ap;
     va_start(ap, msg);
@@ -166,7 +134,7 @@ void sspeak(const long msg, ...)
 void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...)
 /* Find the skip+1st message from msg and print it.  Modes are:
  * feel = for inventory, what you can touch
- * look = the long description for the state the object is in
+ * look = the full description for the state the object is in
  * listen = the sound for the state the object is in
  * study = text on the object. */
 {
@@ -204,14 +172,14 @@ void rspeak(vocab_t i, ...)
 void echo_input(FILE* destination, const char* input_prompt, const char* input)
 {
     size_t len = strlen(input_prompt) + strlen(input) + 1;
-    char* prompt_and_input = (char*) xmalloc(len);
+    char* prompt_and_input = (char*) xcalloc(len);
     strcpy(prompt_and_input, input_prompt);
     strcat(prompt_and_input, input);
     fprintf(destination, "%s\n", prompt_and_input);
     free(prompt_and_input);
 }
 
-int word_count(char* str)
+static int word_count(char* str)
 {
     char delims[] = " \t";
     int count = 0;
@@ -232,7 +200,7 @@ int word_count(char* str)
     return (count);
 }
 
-char* get_input()
+static char* get_input(void)
 {
     // Set up the prompt
     char input_prompt[] = "> ";
@@ -270,7 +238,7 @@ char* get_input()
     return (input);
 }
 
-bool silent_yes()
+bool silent_yes(void)
 {
     bool outcome = false;
 
@@ -289,7 +257,7 @@ bool silent_yes()
             continue;
         }
 
-        char* firstword = (char*) xmalloc(strlen(reply) + 1);
+        char* firstword = (char*) xcalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
         free(reply);
@@ -343,7 +311,7 @@ bool yes(const char* question, const char* yes_response, const char* no_response
             continue;
         }
 
-        char* firstword = (char*) xmalloc(strlen(reply) + 1);
+        char* firstword = (char*) xcalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
         free(reply);
@@ -378,7 +346,7 @@ bool yes(const char* question, const char* yes_response, const char* no_response
 
 /*  Data structure  routines */
 
-int get_motion_vocab_id(const char* word)
+static int get_motion_vocab_id(const char* word)
 // Return the first motion number that has 'word' as one of its words.
 {
     for (int i = 0; i < NMOTIONS; ++i) {
@@ -393,7 +361,7 @@ int get_motion_vocab_id(const char* word)
     return (WORD_NOT_FOUND);
 }
 
-int get_object_vocab_id(const char* word)
+static int get_object_vocab_id(const char* word)
 // Return the first object number that has 'word' as one of its words.
 {
     for (int i = 0; i < NOBJECTS + 1; ++i) { // FIXME: the + 1 should go when 1-indexing for objects is removed
@@ -406,7 +374,7 @@ int get_object_vocab_id(const char* word)
     return (WORD_NOT_FOUND);
 }
 
-int get_action_vocab_id(const char* word)
+static int get_action_vocab_id(const char* word)
 // Return the first motion number that has 'word' as one of its words.
 {
     for (int i = 0; i < NACTIONS; ++i) {
@@ -421,70 +389,145 @@ int get_action_vocab_id(const char* word)
     return (WORD_NOT_FOUND);
 }
 
-int get_special_vocab_id(const char* word)
-// Return the first special number that has 'word' as one of its words.
+static bool is_valid_int(const char *str)
+/* Returns true if the string passed in is represents a valid integer,
+ * that could then be parsed by atoi() */
 {
-    for (int i = 0; i < NSPECIALS; ++i) {
-        for (int j = 0; j < specials[i].words.n; ++j) {
-            if (strncasecmp(word, specials[i].words.strs[j], TOKLEN) == 0)
-                return (i);
-        }
+    // Handle negative number
+    if (*str == '-')
+        ++str;
+
+    // Handle empty string or just "-". Should never reach this
+    // point, because this is only used with transitive verbs.
+    if (!*str)
+        return false; // LCOV_EXCL_LINE
+
+    // Check for non-digit chars in the rest of the stirng.
+    while (*str) {
+        if (!isdigit(*str))
+            return false;
+        else
+            ++str;
     }
-    // If execution reaches here, we didn't find the word.
-    return (WORD_NOT_FOUND);
+
+    return true;
 }
 
-void get_vocab_metadata(const char* word, long* id, enum wordtype* type)
+static void get_vocab_metadata(command_word_t* word)
 {
     /* Check for an empty string */
-    if (strncmp(word, "", sizeof("")) == 0) {
-        *id = WORD_EMPTY;
-        *type = NO_WORD_TYPE;
+    if (strncmp(word->raw, "", sizeof("")) == 0) {
+        word->id = WORD_EMPTY;
+        word->type = NO_WORD_TYPE;
         return;
     }
 
-    long ref_num;
+    vocab_t ref_num;
 
-    ref_num = get_motion_vocab_id(word);
+    ref_num = get_motion_vocab_id(word->raw);
     if (ref_num != WORD_NOT_FOUND) {
-        *id = ref_num;
-        *type = MOTION;
+        word->id = ref_num;
+        word->type = MOTION;
         return;
     }
 
-    ref_num = get_object_vocab_id(word);
+    ref_num = get_object_vocab_id(word->raw);
     if (ref_num != WORD_NOT_FOUND) {
-        *id = ref_num;
-        *type = OBJECT;
+        word->id = ref_num;
+        word->type = OBJECT;
         return;
     }
 
-    ref_num = get_action_vocab_id(word);
+    ref_num = get_action_vocab_id(word->raw);
     if (ref_num != WORD_NOT_FOUND) {
-        *id = ref_num;
-        *type = ACTION;
+        word->id = ref_num;
+        word->type = ACTION;
         return;
     }
 
-    ref_num = get_special_vocab_id(word);
-    if (ref_num != WORD_NOT_FOUND) {
-        *id = ref_num;
-        *type = SPECIAL;
+    // Check for the reservoir magic word.
+    if (strcasecmp(word->raw, game.zzword) == 0) {
+        word->id = PART;
+        word->type = ACTION;
         return;
     }
 
-    // Check for the reservoir magic word.
-    if (strcasecmp(word, game.zzword) == 0) {
-        *id = PART;
-        *type = ACTION;
+    // Check words that are actually numbers.
+    if (is_valid_int(word->raw)) {
+        word->id = WORD_EMPTY;
+        word->type = NUMERIC;
         return;
     }
 
-    *id = WORD_NOT_FOUND;
-    *type = NO_WORD_TYPE;
+    word->id = WORD_NOT_FOUND;
+    word->type = NO_WORD_TYPE;
     return;
 }
 
+static void tokenize(char* raw, command_t *cmd)
+{
+    memset(cmd, '\0', sizeof(command_t));
+
+    /* 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. */
+    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
+     * mechanical translation of 2.5 to C retained the packing and
+     * thus this misfeature.
+     *
+     * It's philosophically questionable whether this is the right
+     * thing to do even in oldstyle mode.  On one hand, the text
+     * mangling was not authorial intent, but a result of limitations
+     * in their tools. On the other, not simulating this misbehavior
+     * goes against the goal of making oldstyle as accurate as
+     * possible an emulation of the original UI.
+     */
+    if (settings.oldstyle) {
+        cmd->word[0].raw[TOKLEN + TOKLEN] = cmd->word[1].raw[TOKLEN + TOKLEN] = '\0';
+        for (size_t i = 0; i < strlen(cmd->word[0].raw); i++)
+            cmd->word[0].raw[i] = toupper(cmd->word[0].raw[i]);
+        for (size_t i = 0; i < strlen(cmd->word[1].raw); i++)
+            cmd->word[1].raw[i] = toupper(cmd->word[1].raw[i]);
+    }
+
+    /* populate command with parsed vocabulary metadata */
+    get_vocab_metadata(&(cmd->word[0]));
+    get_vocab_metadata(&(cmd->word[1]));
+}
+
+bool get_command_input(command_t *command)
+/* Get user input on stdin, parse and map to command */
+{
+    char inputbuf[LINESIZE];
+    char* input;
+
+    for (;;) {
+        input = get_input();
+        if (input == NULL)
+            return false;
+        if (word_count(input) > 2) {
+            rspeak(TWO_WORDS);
+            free(input);
+            continue;
+        }
+        if (strcmp(input, "") != 0)
+            break;
+        free(input);
+    }
+
+    strncpy(inputbuf, input, LINESIZE - 1);
+    free(input);
+
+    tokenize(inputbuf, command);
+
+    return true;
+}
+
 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. */
@@ -503,7 +546,7 @@ void move(obj_t object, loc_t where)
  *  pick up objects which are not at any loc, since carry wants to
  *  remove objects from game.atloc chains. */
 {
-    long from;
+    loc_t from;
 
     if (object > NOBJECTS)
         from = game.fixed[object - NOBJECTS];
@@ -515,7 +558,7 @@ void move(obj_t object, loc_t where)
     drop(object, where);
 }
 
-long put(obj_t object, loc_t where, long pval)
+loc_t put(obj_t object, loc_t where, long 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. */
 {
@@ -565,16 +608,16 @@ void drop(obj_t object, loc_t where)
     game.atloc[where] = object;
 }
 
-long atdwrf(loc_t where)
+int atdwrf(loc_t where)
 /*  Return the index of first dwarf at the given location, zero if no dwarf is
  *  there (or if dwarves not active yet), -1 if all dwarves are dead.  Ignore
  *  the pirate (6th dwarf). */
 {
-    long at;
+    int at;
 
     at = 0;
     if (game.dflag < 2)
-        return (at);
+        return at;
     at = -1;
     for (long i = 1; i <= NDWARVES - 1; i++) {
         if (game.dloc[i] == where)
@@ -582,13 +625,13 @@ long atdwrf(loc_t where)
         if (game.dloc[i] != 0)
             at = 0;
     }
-    return (at);
+    return at;
 }
 
 /*  Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
  *  randrange) */
 
-long setbit(long bit)
+long setbit(int bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
 {
     return (1L << bit);
@@ -600,36 +643,31 @@ bool tstbit(long mask, int bit)
     return (mask & (1 << bit)) != 0;
 }
 
-void set_seed(long seedval)
+void set_seed(int32_t seedval)
 /* Set the LCG seed */
 {
-    game.lcg_x = (unsigned long) seedval % game.lcg_m;
+    game.lcg_x = (uint32_t) seedval % LCG_M;
 
     // once seed is set, we need to generate the Z`ZZZ word
-    make_zzword(game.zzword);
+    for (int i = 0; i < 5; ++i) {
+        game.zzword[i] = 'A' + randrange(26);
+    }
+    game.zzword[1] = '\''; // force second char to apostrophe
+    game.zzword[5] = '\0';
 }
 
-unsigned long get_next_lcg_value(void)
+static int32_t get_next_lcg_value(void)
 /* Return the LCG's current value, and then iterate it. */
 {
-    unsigned long old_x = game.lcg_x;
-    game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m;
+    int32_t old_x = game.lcg_x;
+    game.lcg_x = (LCG_A * game.lcg_x + LCG_C) % LCG_M;
     return old_x;
 }
 
-long randrange(long range)
+int32_t randrange(int32_t range)
 /* Return a random integer from [0, range). */
 {
-    return range * get_next_lcg_value() / game.lcg_m;
-}
-
-void make_zzword(char zzword[TOKLEN + 1])
-{
-    for (int i = 0; i < 5; ++i) {
-        zzword[i] = 'A' + randrange(26);
-    }
-    zzword[1] = '\''; // force second char to apostrophe
-    zzword[5] = '\0';
+    return range * get_next_lcg_value() / LCG_M;
 }
 
 // LCOV_EXCL_START
@@ -642,7 +680,7 @@ void bug(enum bugtype num, const char *error_string)
 
 /* end */
 
-void state_change(obj_t obj, long state)
+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;