Static analysis warnings squished
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index cd1b5bf1f94d487c7996b7fb0d90b29b7c2ee050..a2626b4d3f02ae66ea69ed4dbf99c4c1939debe0 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -5,24 +5,12 @@
 #include <stdarg.h>
 #include <sys/time.h>
 #include <ctype.h>
+#include <editline/readline.h>
 
 #include "advent.h"
-#include "linenoise/linenoise.h"
 #include "dungeon.h"
 
-char* xstrdup(const char* s)
-{
-    char* ptr = strdup(s);
-    if (ptr == NULL) {
-        // LCOV_EXCL_START
-        // exclude from coverage analysis because we can't simulate an out of memory error in testing
-        fprintf(stderr, "Out of memory!\n");
-        exit(EXIT_FAILURE);
-    }
-    return (ptr);
-}
-
-void* xmalloc(size_t size)
+static void* xmalloc(size_t size)
 {
     void* ptr = malloc(size);
     if (ptr == NULL) {
@@ -35,19 +23,19 @@ void* xmalloc(size_t size)
     return (ptr);
 }
 
-void packed_to_token(long packed, char token[6])
+void packed_to_token(long packed, char token[TOKLEN + 1])
 {
-  // The advent->ascii mapping.
-  const char advent_to_ascii[] = {
-    ' ', '!', '"', '#', '$', '%', '&', '\'',
-    '(', ')', '*', '+', ',', '-', '.', '/',
-    '0', '1', '2', '3', '4', '5', '6', '7',
-    '8', '9', ':', ';', '<', '=', '>', '?',
-    '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
-    'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
-    'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
-    'X', 'Y', 'Z', '\0', '\0', '\0', '\0', '\0',
-};
+    // The advent->ascii mapping.
+    const char advent_to_ascii[] = {
+        ' ', '!', '"', '#', '$', '%', '&', '\'',
+        '(', ')', '*', '+', ',', '-', '.', '/',
+        '0', '1', '2', '3', '4', '5', '6', '7',
+        '8', '9', ':', ';', '<', '=', '>', '?',
+        '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
+        'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
+        'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
+        'X', 'Y', 'Z', '\0', '\0', '\0', '\0', '\0',
+    };
 
     // Unpack and map back to ASCII.
     for (int i = 0; i < 5; ++i) {
@@ -60,80 +48,82 @@ void packed_to_token(long packed, char token[6])
 
     // Replace trailing whitespace with \0.
     for (int i = 4; i >= 0; --i) {
-        if (token[i] == ' ' || token[i] == '\t')
+        if (token[i] == ' ' ||
+            token[i] == '\t')
             token[i] = '\0';
         else
             break;
     }
 }
 
-long token_to_packed(const char token[6])
+long token_to_packed(const char token[])
 {
-  const char ascii_to_advent[] = {
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
+    const char ascii_to_advent[] = {
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
 
-    0, 1, 2, 3, 4, 5, 6, 7,
-    8, 9, 10, 11, 12, 13, 14, 15,
-    16, 17, 18, 19, 20, 21, 22, 23,
-    24, 25, 26, 27, 28, 29, 30, 31,
-    32, 33, 34, 35, 36, 37, 38, 39,
-    40, 41, 42, 43, 44, 45, 46, 47,
-    48, 49, 50, 51, 52, 53, 54, 55,
-    56, 57, 58, 59, 60, 61, 62, 63,
+        0, 1, 2, 3, 4, 5, 6, 7,
+        8, 9, 10, 11, 12, 13, 14, 15,
+        16, 17, 18, 19, 20, 21, 22, 23,
+        24, 25, 26, 27, 28, 29, 30, 31,
+        32, 33, 34, 35, 36, 37, 38, 39,
+        40, 41, 42, 43, 44, 45, 46, 47,
+        48, 49, 50, 51, 52, 53, 54, 55,
+        56, 57, 58, 59, 60, 61, 62, 63,
 
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
-    63, 63, 63, 63, 63, 63, 63, 63,
-};
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
+        63, 63, 63, 63, 63, 63, 63, 63,
+    };
 
     size_t t_len = strlen(token);
+    if (t_len > TOKLEN)
+        t_len = TOKLEN;
     long packed = 0;
     for (size_t i = 0; i < t_len; ++i) {
-        char mapped = ascii_to_advent[(int) token[i]];
+        char mapped = ascii_to_advent[(int) toupper(token[i])];
         packed |= (mapped << (6 * i));
     }
     return (packed);
 }
 
-void tokenize(char* raw, long tokens[4])
+void tokenize(char* raw, struct command_t *cmd)
 {
-    // set each token to 0
-    for (int i = 0; i < 4; ++i)
-        tokens[i] = 0;
-
-    // grab the first two words
-    char* words[2];
-    words[0] = (char*) xmalloc(strlen(raw) + 1);
-    words[1] = (char*) xmalloc(strlen(raw) + 1);
-    int word_count = sscanf(raw, "%s%s", words[0], words[1]);
-
-    // make space for substrings and zero it out
-    char chunk_data[][6] = {
-        {"\0\0\0\0\0"},
-        {"\0\0\0\0\0"},
-        {"\0\0\0\0\0"},
-        {"\0\0\0\0\0"},
-    };
-
-    // break the words into up to 4 5-char substrings
-    sscanf(words[0], "%5s%5s", chunk_data[0], chunk_data[1]);
-    if (word_count == 2)
-        sscanf(words[1], "%5s%5s", chunk_data[2], chunk_data[3]);
-    free(words[0]);
-    free(words[1]);
+    memset(cmd, '\0', sizeof(struct command_t));
 
-    // uppercase all the substrings
-    for (int i = 0; i < 4; ++i)
-        for (unsigned int j = 0; j < strlen(chunk_data[i]); ++j)
-            chunk_data[i][j] = (char) toupper(chunk_data[i][j]);
+    /* 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);
 
     // pack the substrings
-    for (int i = 0; i < 4; ++i)
-        tokens[i] = token_to_packed(chunk_data[i]);
+    cmd->wd1  = token_to_packed(cmd->raw1);
+    cmd->wd2  = token_to_packed(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]);
+    }
 }
 
 /* Hide the fact that wods are corrently packed longs */
@@ -153,9 +143,9 @@ void wordclear(token_t *v)
     *v = 0;
 }
 
-/*  I/O routines (speak, pspeak, rspeak, get_input, yes) */
+/*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
-void vspeak(const char* msg, va_list ap)
+void vspeak(const char* msg, bool blank, va_list ap)
 {
     // Do nothing if we got a null pointer.
     if (msg == NULL)
@@ -165,8 +155,7 @@ void vspeak(const char* msg, va_list ap)
     if (strlen(msg) == 0)
         return;
 
-    // Print a newline if the global game.blklin says to.
-    if (game.blklin == true)
+    if (blank == true)
         printf("\n");
 
     int msglen = strlen(msg);
@@ -187,7 +176,7 @@ void vspeak(const char* msg, va_list ap)
         } else {
             long arg = va_arg(ap, long);
             if (arg == -1)
-                arg = 0;
+                arg = 0; // LCOV_EXCL_LINE - don't think we can get here.
             i++;
             // Integer specifier. In order to accommodate the fact
             // that PARMS can have both legitimate integers *and*
@@ -217,25 +206,12 @@ void vspeak(const char* msg, va_list ap)
                 }
             }
 
-           /* Version specifier */
+            /* Version specifier */
             if (msg[i] == 'V') {
-               strcpy(renderp, VERSION);
+                strcpy(renderp, VERSION);
                 size_t len = strlen(VERSION);
                 renderp += len;
                 size -= len;
-           }
-           
-            // All-lowercase specifier.
-            if (msg[i] == 'L' || msg[i] == 'C') {
-                packed_to_token(arg, renderp); /* unpack directly to destination */
-                int len = strlen(renderp);
-                for (int j = 0; j < len; ++j) {
-                    renderp[j] = tolower(renderp[j]);
-                }
-                if (msg[i] == 'C') // First char uppercase, rest lowercase.
-                    renderp[0] = toupper(renderp[0]);
-                renderp += len;
-                size -= len;
             }
 
             previous_arg = arg;
@@ -243,11 +219,6 @@ void vspeak(const char* msg, va_list ap)
     }
     *renderp = 0;
 
-    // Deal with messages that are in YAML block format and therefore
-    // have their own trailing \n
-    if (renderp > rendered && renderp[-1] == '\n')
-       *--renderp = '\0';
-    
     // Print the message.
     printf("%s\n", rendered);
 
@@ -258,11 +229,21 @@ void speak(const char* msg, ...)
 {
     va_list ap;
     va_start(ap, msg);
-    vspeak(msg, ap);
+    vspeak(msg, true, ap);
     va_end(ap);
 }
 
-void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
+void sspeak(const long msg, ...)
+{
+    va_list ap;
+    va_start(ap, msg);
+    fputc('\n', stdout);
+    vprintf(arbitrary_messages[msg], ap);
+    fputc('\n', stdout);
+    va_end(ap);
+}
+
+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
@@ -270,22 +251,22 @@ void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
  * study = text on the object. */
 {
     va_list ap;
-    va_start(ap, skip);
+    va_start(ap, blank);
     switch (mode) {
     case touch:
-        vspeak(objects[msg].inventory, ap);
+        vspeak(objects[msg].inventory, blank, ap);
         break;
     case look:
-        vspeak(objects[msg].descriptions[skip], ap);
+        vspeak(objects[msg].descriptions[skip], blank, ap);
         break;
     case hear:
-        vspeak(objects[msg].sounds[skip], ap);
+        vspeak(objects[msg].sounds[skip], blank, ap);
         break;
     case study:
-        vspeak(objects[msg].texts[skip], ap);
+        vspeak(objects[msg].texts[skip], blank, ap);
         break;
     case change:
-        vspeak(objects[msg].changes[skip], ap);
+        vspeak(objects[msg].changes[skip], blank, ap);
         break;
     }
     va_end(ap);
@@ -296,11 +277,11 @@ void rspeak(vocab_t i, ...)
 {
     va_list ap;
     va_start(ap, i);
-    vspeak(arbitrary_messages[i], ap);
+    vspeak(arbitrary_messages[i], true, ap);
     va_end(ap);
 }
 
-void echo_input(FILE* destination, char* input_prompt, char* input)
+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);
@@ -310,19 +291,24 @@ void echo_input(FILE* destination, char* input_prompt, char* input)
     free(prompt_and_input);
 }
 
-int word_count(char* s)
+int word_count(char* str)
 {
-    char* copy = xstrdup(s);
     char delims[] = " \t";
     int count = 0;
-    char* word;
+    int inblanks = true;
+
+    for (char *s = str; *s; s++)
+        if (inblanks) {
+            if (strchr(delims, *s) == 0) {
+                ++count;
+                inblanks = false;
+            }
+        } else {
+            if (strchr(delims, *s) != 0) {
+                inblanks = true;
+            }
+        }
 
-    word = strtok(copy, delims);
-    while (word != NULL) {
-        word = strtok(NULL, delims);
-        ++count;
-    }
-    free(copy);
     return (count);
 }
 
@@ -330,34 +316,20 @@ char* get_input()
 {
     // Set up the prompt
     char input_prompt[] = "> ";
-    if (!prompt)
+    if (!settings.prompt)
         input_prompt[0] = '\0';
 
-    // Print a blank line if game.blklin tells us to.
-    if (game.blklin == true)
-        printf("\n");
+    // Print a blank line
+    printf("\n");
 
     char* input;
     while (true) {
-        if (editline)
-            input = linenoise(input_prompt);
-        else {
-            input = NULL;
-            size_t n = 0;
-            if (isatty(0))
-                // LCOV_EXCL_START
-                // Should be unreachable in tests, as they will use a non-interactive shell.
-                printf("%s", input_prompt);
-            // LCOV_EXCL_STOP
-            ssize_t numread = getline(&input, &n, stdin);
-            if (numread == -1) // Got EOF; return with it.
-                return (NULL);
-        }
+        input = readline(input_prompt);
 
         if (input == NULL) // Got EOF; return with it.
             return (input);
         else if (input[0] == '#') { // Ignore comments.
-            linenoiseFree(input);
+            free(input);
             continue;
         } else // We have a 'normal' line; leave the loop.
             break;
@@ -366,28 +338,27 @@ char* get_input()
     // Strip trailing newlines from the input
     input[strcspn(input, "\n")] = 0;
 
-    linenoiseHistoryAdd(input);
+    add_history(input);
 
     if (!isatty(0))
         echo_input(stdout, input_prompt, input);
 
-    if (logfp)
-        echo_input(logfp, input_prompt, input);
+    if (settings.logfp)
+        echo_input(settings.logfp, "", input);
 
     return (input);
 }
 
 bool silent_yes()
 {
-    char* reply;
     bool outcome;
 
     for (;;) {
-        reply = get_input();
+        char* reply = get_input();
         if (reply == NULL) {
             // LCOV_EXCL_START
             // Should be unreachable. Reply should never be NULL
-            linenoiseFree(reply);
+            free(reply);
             exit(EXIT_SUCCESS);
             // LCOV_EXCL_STOP
         }
@@ -395,7 +366,7 @@ bool silent_yes()
         char* firstword = (char*) xmalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
-        linenoiseFree(reply);
+        free(reply);
 
         for (int i = 0; i < (int)strlen(firstword); ++i)
             firstword[i] = tolower(firstword[i]);
@@ -407,10 +378,12 @@ bool silent_yes()
 
         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
@@ -424,17 +397,16 @@ bool yes(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. */
 {
-    char* reply;
     bool outcome;
 
     for (;;) {
         speak(question);
 
-        reply = get_input();
+        char*        reply = get_input();
         if (reply == NULL) {
             // LCOV_EXCL_START
             // Should be unreachable. Reply should never be NULL
-            linenoiseFree(reply);
+            free(reply);
             exit(EXIT_SUCCESS);
             // LCOV_EXCL_STOP
         }
@@ -442,7 +414,7 @@ bool yes(const char* question, const char* yes_response, const char* no_response
         char* firstword = (char*) xmalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
-        linenoiseFree(reply);
+        free(reply);
 
         for (int i = 0; i < (int)strlen(firstword); ++i)
             firstword[i] = tolower(firstword[i]);
@@ -454,11 +426,13 @@ bool yes(const char* question, const char* yes_response, const char* no_response
 
         free(firstword);
 
-        if (yes == 0 || y == 0) {
+        if (yes == 0 ||
+            y == 0) {
             speak(yes_response);
             outcome = true;
             break;
-        } else if (no == 0 || n == 0) {
+        } else if (no == 0 ||
+                   n == 0) {
             speak(no_response);
             outcome = false;
             break;
@@ -477,7 +451,9 @@ int get_motion_vocab_id(const char* word)
 {
     for (int i = 0; i < NMOTIONS; ++i) {
         for (int j = 0; j < motions[i].words.n; ++j) {
-            if (strcasecmp(word, motions[i].words.strs[j]) == 0)
+            if (strcasecmp(word, motions[i].words.strs[j]) == 0 && (strlen(word) > 1 ||
+                    strchr(ignore, word[0]) == NULL ||
+                    !settings.oldstyle))
                 return (i);
         }
     }
@@ -503,7 +479,9 @@ int get_action_vocab_id(const char* word)
 {
     for (int i = 0; i < NACTIONS; ++i) {
         for (int j = 0; j < actions[i].words.n; ++j) {
-            if (strcasecmp(word, actions[i].words.strs[j]) == 0)
+            if (strcasecmp(word, actions[i].words.strs[j]) == 0 && (strlen(word) > 1 ||
+                    strchr(ignore, word[0]) == NULL ||
+                    !settings.oldstyle))
                 return (i);
         }
     }
@@ -527,27 +505,32 @@ int get_special_vocab_id(const char* word)
 long get_vocab_id(const char* word)
 // Search the vocab categories in order for the supplied word.
 {
+    /* Check for an empty string */
+    if (strncmp(word, "", sizeof("")) == 0)
+        return (WORD_EMPTY);
+
     long ref_num;
 
+    /* FIXME: Magic numbers related to vocabulary */
     ref_num = get_motion_vocab_id(word);
     if (ref_num != WORD_NOT_FOUND)
-        return (ref_num + 0); // FIXME: replace with a proper hash
+        return MOTION_WORD(ref_num);
 
     ref_num = get_object_vocab_id(word);
     if (ref_num != WORD_NOT_FOUND)
-        return (ref_num + 1000); // FIXME: replace with a proper hash
+        return OBJECT_WORD(ref_num);
 
     ref_num = get_action_vocab_id(word);
     if (ref_num != WORD_NOT_FOUND)
-        return (ref_num + 2000); // FIXME: replace with a proper hash
+        return ACTION_WORD(ref_num);
 
     ref_num = get_special_vocab_id(word);
     if (ref_num != WORD_NOT_FOUND)
-        return (ref_num + 3000); // FIXME: replace with a proper hash
+        return SPECIAL_WORD(ref_num);
 
     // Check for the reservoir magic word.
     if (strcasecmp(word, game.zzword) == 0)
-        return (PART + 2000); // FIXME: replace with a proper hash
+        return ACTION_WORD(PART);
 
     return (WORD_NOT_FOUND);
 }
@@ -650,8 +633,8 @@ long atdwrf(long where)
     return (at);
 }
 
-/*  Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
- *  randrange, RNDVOC) */
+/*  Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
+ *  randrange) */
 
 long setbit(long bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
@@ -669,6 +652,9 @@ void set_seed(long seedval)
 /* Set the LCG seed */
 {
     game.lcg_x = (unsigned long) seedval % game.lcg_m;
+
+    // once seed is set, we need to generate the Z`ZZZ word
+    make_zzword(game.zzword);
 }
 
 unsigned long get_next_lcg_value(void)
@@ -685,7 +671,7 @@ long randrange(long range)
     return range * get_next_lcg_value() / game.lcg_m;
 }
 
-void make_zzword(char zzword[6])
+void make_zzword(char zzword[TOKLEN + 1])
 {
     for (int i = 0; i < 5; ++i) {
         zzword[i] = 'A' + randrange(26);
@@ -694,14 +680,6 @@ void make_zzword(char zzword[6])
     zzword[5] = '\0';
 }
 
-void datime(long* d, long* t)
-{
-    struct timeval tv;
-    gettimeofday(&tv, NULL);
-    *d = (long) tv.tv_sec;
-    *t = (long) tv.tv_usec;
-}
-
 // LCOV_EXCL_START
 void bug(enum bugtype num, const char *error_string)
 {