Test coverage -- fix regression
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index 0b28f00a2411e4b1673e9836b604c9c24f22be31..e69fc9bdf495fe2c63b52e2d3e273509db3b5d54 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -7,9 +7,52 @@
 #include <ctype.h>
 
 #include "advent.h"
-#include "database.h"
 #include "linenoise/linenoise.h"
-#include "newdb.h"
+#include "dungeon.h"
+
+const char new_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',
+};
+
+const char new_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,
+
+    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,
+};
+
+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)
 {
@@ -19,7 +62,7 @@ void* xmalloc(size_t size)
         // 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);
-        // LCOV_EXCL_STOP 
+        // LCOV_EXCL_STOP
     }
     return (ptr);
 }
@@ -29,7 +72,7 @@ void packed_to_token(long packed, char token[6])
     // Unpack and map back to ASCII.
     for (int i = 0; i < 5; ++i) {
         char advent = (packed >> i * 6) & 63;
-        token[4 - i] = advent_to_ascii[(int) advent];
+        token[i] = new_advent_to_ascii[(int) advent];
     }
 
     // Ensure the last character is \0.
@@ -44,6 +87,54 @@ void packed_to_token(long packed, char token[6])
     }
 }
 
+long token_to_packed(const char token[6])
+{
+    size_t t_len = strlen(token);
+    long packed = 0;
+    for (size_t i = 0; i < t_len; ++i) {
+        char mapped = new_ascii_to_advent[(int) token[i]];
+        packed |= (mapped << (6 * i));
+    }
+    return (packed);
+}
+
+void tokenize(char* raw, long tokens[4])
+{
+    // 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]);
+
+    // 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]);
+
+    // pack the substrings
+    for (int i = 0; i < 4; ++i)
+        tokens[i] = token_to_packed(chunk_data[i]);
+}
+
 /* Hide the fact that wods are corrently packed longs */
 
 bool wordeq(token_t a, token_t b)
@@ -61,7 +152,7 @@ void wordclear(token_t *v)
     *v = 0;
 }
 
-/*  I/O routines (speak, pspeak, rspeak, GETIN, YES) */
+/*  I/O routines (speak, pspeak, rspeak, get_input, yes) */
 
 void vspeak(const char* msg, va_list ap)
 {
@@ -92,8 +183,8 @@ void vspeak(const char* msg, va_list ap)
             size--;
         } else {
             long arg = va_arg(ap, long);
-           if (arg == -1)
-             arg = 0;
+            if (arg == -1)
+                arg = 0;
             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.
             if (msg[i] == 'd') {
@@ -164,16 +255,19 @@ void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
     switch (mode) {
     case touch:
         vspeak(objects[msg].inventory, ap);
-       break;
-    case look: 
-        vspeak(objects[msg].longs[skip], ap);
-       break;
+        break;
+    case look:
+        vspeak(objects[msg].descriptions[skip], ap);
+        break;
     case hear:
         vspeak(objects[msg].sounds[skip], ap);
-       break;
+        break;
     case study:
         vspeak(objects[msg].texts[skip], ap);
-       break;
+        break;
+    case change:
+        vspeak(objects[msg].changes[skip], ap);
+        break;
     }
     va_end(ap);
 }
@@ -187,42 +281,6 @@ void rspeak(vocab_t i, ...)
     va_end(ap);
 }
 
-bool GETIN(FILE *input,
-           long *pword1, long *pword1x,
-           long *pword2, long *pword2x)
-/*  Get a command from the adventurer.  Snarf out the first word, pad it with
- *  blanks, and return it in WORD1.  Chars 6 thru 10 are returned in WORD1X, in
- *  case we need to print out the whole word in an error message.  Any number of
- *  blanks may follow the word.  If a second word appears, it is returned in
- *  WORD2 (chars 6 thru 10 in WORD2X), else WORD2 is -1. */
-{
-    long junk;
-
-    for (;;) {
-        if (game.blklin)
-            fputc('\n', stdout);;
-        if (!MAPLIN(input))
-            return false;
-        *pword1 = GETTXT(true, true, true);
-        if (game.blklin && *pword1 < 0)
-            continue;
-        *pword1x = GETTXT(false, true, true);
-        do {
-            junk = GETTXT(false, true, true);
-        } while
-        (junk > 0);
-        *pword2 = GETTXT(true, true, true);
-        *pword2x = GETTXT(false, true, true);
-        do {
-            junk = GETTXT(false, true, true);
-        } while
-        (junk > 0);
-        if (GETTXT(true, true, true) <= 0)
-            return true;
-        rspeak(TWO_WORDS);
-    }
-}
-
 void echo_input(FILE* destination, char* input_prompt, char* input)
 {
     size_t len = strlen(input_prompt) + strlen(input) + 1;
@@ -233,6 +291,22 @@ void echo_input(FILE* destination, char* input_prompt, char* input)
     free(prompt_and_input);
 }
 
+int word_count(char* s)
+{
+    char* copy = xstrdup(s);
+    char delims[] = " \t";
+    int count = 0;
+    char* word;
+
+    word = strtok(copy, delims);
+    while (word != NULL) {
+        word = strtok(NULL, delims);
+        ++count;
+    }
+    free(copy);
+    return (count);
+}
+
 char* get_input()
 {
     // Set up the prompt
@@ -252,15 +326,17 @@ char* get_input()
             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.
+                // LCOV_EXCL_START
+                // Should be unreachable in tests, as they will use a non-interactive shell.
                 printf("%s", input_prompt);
-            // LCOV_EXCL_STOP 
-            IGNORE(getline(&input, &n, stdin));
+            // LCOV_EXCL_STOP
+            ssize_t numread = getline(&input, &n, stdin);
+            if (numread == -1) // Got EOF; return with it.
+                return (NULL);
         }
 
         if (input == NULL) // Got EOF; return with it.
-           return(input);
+            return (input);
         else if (input[0] == '#') // Ignore comments.
             continue;
         else // We have a 'normal' line; leave the loop.
@@ -281,6 +357,48 @@ char* get_input()
     return (input);
 }
 
+bool silent_yes()
+{
+    char* reply;
+    bool outcome;
+
+    for (;;) {
+        reply = get_input();
+        if (reply == NULL) {
+            // LCOV_EXCL_START
+            // Should be unreachable. Reply should never be NULL
+            linenoiseFree(reply);
+            exit(EXIT_SUCCESS);
+            // LCOV_EXCL_STOP
+        }
+
+        char* firstword = (char*) xmalloc(strlen(reply) + 1);
+        sscanf(reply, "%s", firstword);
+
+        for (int i = 0; i < (int)strlen(firstword); ++i)
+            firstword[i] = tolower(firstword[i]);
+
+        int yes = strncmp("yes", firstword, sizeof("yes") - 1);
+        int y = strncmp("y", firstword, sizeof("y") - 1);
+        int no = strncmp("no", firstword, sizeof("no") - 1);
+        int n = strncmp("n", firstword, sizeof("n") - 1);
+
+        free(firstword);
+
+        if (yes == 0 || y == 0) {
+            outcome = true;
+            break;
+        } else if (no == 0 || n == 0) {
+            outcome = false;
+            break;
+        } else
+            rspeak(PLEASE_ANSWER);
+    }
+    linenoiseFree(reply);
+    return (outcome);
+}
+
+
 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. */
@@ -297,10 +415,10 @@ bool yes(const char* question, const char* yes_response, const char* no_response
             // Should be unreachable. Reply should never be NULL
             linenoiseFree(reply);
             exit(EXIT_SUCCESS);
-            // LCOV_EXCL_STOP 
+            // LCOV_EXCL_STOP
         }
 
-        char* firstword = (char*) xmalloc(strlen(reply)+1);
+        char* firstword = (char*) xmalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
         for (int i = 0; i < (int)strlen(firstword); ++i)
@@ -328,107 +446,86 @@ bool yes(const char* question, const char* yes_response, const char* no_response
     return (outcome);
 }
 
-/*  Line-parsing routines (GETTXT, MAKEWD, PUTTXT, SHFTXT) */
+/*  Data structure  routines */
 
-long GETTXT(bool skip, bool onewrd, bool upper)
-/*  Take characters from an input line and pack them into 30-bit words.
- *  Skip says to skip leading blanks.  ONEWRD says stop if we come to a
- *  blank.  UPPER says to map all letters to uppercase.  If we reach the
- *  end of the line, the word is filled up with blanks (which encode as 0's).
- *  If we're already at end of line when TEXT is called, we return -1. */
+int get_motion_vocab_id(const char* word)
+// Return the first motion number that has 'word' as one of its words.
 {
-    long text;
-    static long splitting = -1;
-
-    if (LNPOSN != splitting)
-        splitting = -1;
-    text = -1;
-    while (true) {
-        if (LNPOSN > LNLENG)
-            return (text);
-        if ((!skip) || INLINE[LNPOSN] != 0)
-            break;
-        ++LNPOSN;
+    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)
+                return (i);
+        }
     }
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
+}
 
-    text = 0;
-    for (int I = 1; I <= TOKLEN; I++) {
-        text = text * 64;
-        if (LNPOSN > LNLENG || (onewrd && INLINE[LNPOSN] == 0))
-            continue;
-        char current = INLINE[LNPOSN];
-        if (current < ascii_to_advent['%']) {
-            splitting = -1;
-            if (upper && current >= ascii_to_advent['a'])
-                current = current - 26;
-            text = text + current;
-            ++LNPOSN;
-            continue;
-        }
-        if (splitting != LNPOSN) {
-            text = text + ascii_to_advent['%'];
-            splitting = LNPOSN;
-            continue;
+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
+        for (int j = 0; j < objects[i].words.n; ++j) {
+            if (strcasecmp(word, objects[i].words.strs[j]) == 0)
+                return (i);
         }
-
-        text = text + current - ascii_to_advent['%'];
-        splitting = -1;
-        ++LNPOSN;
     }
-
-    return text;
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
 }
 
-token_t MAKEWD(long letters)
-/*  Combine TOKLEN (currently 5) uppercase letters (represented by
- *  pairs of decimal digits in lettrs) to form a 30-bit value matching
- *  the one that GETTXT would return given those characters plus
- *  trailing blanks.  Caution: lettrs will overflow 31 bits if
- *  5-letter word starts with V-Z.  As a kludgey workaround, you can
- *  increment a letter by 5 by adding 50 to the next pair of
- *  digits. */
+int get_action_vocab_id(const char* word)
+// Return the first motion number that has 'word' as one of its words.
 {
-    long i = 1, word = 0;
-
-    for (long k = letters; k != 0; k = k / 100) {
-        word = word + i * (MOD(k, 50) + 10);
-        i = i * 64;
-        if (MOD(k, 100) > 50)word = word + i * 5;
+    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)
+                return (i);
+        }
     }
-    i = 64L * 64L * 64L * 64L * 64L / i;
-    word = word * i;
-    return word;
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
 }
 
-/*  Data structure  routines */
-
-long vocab(long id, long init)
-/*  Look up ID in the vocabulary (ATAB) and return its "definition" (KTAB), or
- *  -1 if not found.  If INIT is positive, this is an initialisation call setting
- *  up a keyword variable, and not finding it constitutes a bug.  It also means
- *  that only KTAB values which taken over 1000 equal INIT may be considered.
- *  (Thus "STEPS", which is a motion verb as well as an object, may be located
- *  as an object.)  And it also means the KTAB value is taken modulo 1000. */
-{
-    long lexeme;
-
-    for (long i = 1; i <= TABSIZ; i++) {
-        if (KTAB[i] == -1) {
-            lexeme = -1;
-            if (init < 0)
-                return (lexeme);
-            BUG(REQUIRED_VOCABULARY_WORD_NOT_FOUND); // LCOV_EXCL_LINE
-        }
-        if (init >= 0 && KTAB[i] / 1000 != init)
-            continue;
-        if (ATAB[i] == id) {
-            lexeme = KTAB[i];
-            if (init >= 0)
-                lexeme = MOD(lexeme, 1000);
-            return (lexeme);
+int get_special_vocab_id(const char* word)
+// Return the first special number that has 'word' as one of its words.
+{
+    for (int i = 0; i < NSPECIALS; ++i) {
+        for (int j = 0; j < specials[i].words.n; ++j) {
+            if (strcasecmp(word, specials[i].words.strs[j]) == 0)
+                return (i);
         }
     }
-    BUG(RAN_OFF_END_OF_VOCABULARY_TABLE); // LCOV_EXCL_LINE
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
+}
+
+long get_vocab_id(const char* word)
+// Search the vocab categories in order for the supplied word.
+{
+    long ref_num;
+
+    ref_num = get_motion_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND)
+        return (ref_num + 0); // FIXME: replace with a proper hash
+
+    ref_num = get_object_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND)
+        return (ref_num + 1000); // FIXME: replace with a proper hash
+
+    ref_num = get_action_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND)
+        return (ref_num + 2000); // FIXME: replace with a proper hash
+
+    ref_num = get_special_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND)
+        return (ref_num + 3000); // FIXME: replace with a proper hash
+
+    // Check for the reservoir magic word.
+    if (strcasecmp(word, game.zzword) == 0)
+        return (PART + 2000); // FIXME: replace with a proper hash
+
+    return (WORD_NOT_FOUND);
 }
 
 void juggle(long object)
@@ -535,7 +632,7 @@ long atdwrf(long where)
 long setbit(long bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
 {
-    return (1 << bit);
+    return (1L << bit);
 }
 
 bool tstbit(long mask, int bit)
@@ -564,128 +661,13 @@ long randrange(long range)
     return range * get_next_lcg_value() / game.lcg_m;
 }
 
-long rndvoc(long second, long force)
-/*  Searches the vocabulary ATAB for a word whose second character is
- *  char, and changes that word such that each of the other four
- *  characters is a random letter.  If force is non-zero, it is used
- *  as the new word.  Returns the new word. */
+void make_zzword(char zzword[6])
 {
-    long rnd = force;
-
-    if (rnd == 0) {
-        for (int i = 1; i <= 5; i++) {
-            long j = 11 + randrange(26);
-            if (i == 2)
-                j = second;
-            rnd = rnd * 64 + j;
-        }
-    }
-
-    long div = 64L * 64L * 64L;
-    for (int i = 1; i <= TABSIZ; i++) {
-        if (MOD(ATAB[i] / div, 64L) == second) {
-            ATAB[i] = rnd;
-            break;
-        }
-    }
-
-    return rnd;
-}
-
-
-/*  Machine dependent routines (MAPLIN, SAVEIO) */
-
-bool MAPLIN(FILE *fp)
-{
-    bool eof;
-
-    /* Read a line of input, from the specified input source.
-     * This logic is complicated partly because it has to serve
-     * several cases with different requirements and partly because
-     * of a quirk in linenoise().
-     *
-     * The quirk shows up when you paste a test log from the clipboard
-     * to the program's command prompt.  While fgets (as expected)
-     * consumes it a line at a time, linenoise() returns the first
-     * line and discards the rest.  Thus, there needs to be an
-     * editline (-s) option to fall back to fgets while still
-     * prompting.  Note that linenoise does behave properly when
-     * fed redirected stdin.
-     *
-     * The logging is a bit of a mess because there are two distinct cases
-     * in which you want to echo commands.  One is when shipping them to
-     * a log under the -l option, in which case you want to suppress
-     * prompt generation (so test logs are unadorned command sequences).
-     * On the other hand, if you redirected stdin and are feeding the program
-     * a logfile, you *do* want prompt generation - it makes checkfiles
-     * easier to read when the commands are marked by a preceding prompt.
-     */
-    do {
-        if (!editline) {
-            if (prompt)
-                fputs("> ", stdout);
-            IGNORE(fgets(rawbuf, sizeof(rawbuf) - 1, fp));
-            eof = (feof(fp));
-        } else {
-            char *cp = linenoise("> ");
-            eof = (cp == NULL);
-            if (!eof) {
-                strncpy(rawbuf, cp, sizeof(rawbuf) - 1);
-                linenoiseHistoryAdd(rawbuf);
-                strncat(rawbuf, "\n", sizeof(rawbuf) - strlen(rawbuf) - 1);
-                linenoiseFree(cp);
-            }
-        }
-    } while
-    (!eof && rawbuf[0] == '#');
-    if (eof) {
-        if (logfp && fp == stdin)
-            fclose(logfp);
-        return false;
-    } else {
-        FILE *efp = NULL;
-        if (logfp && fp == stdin)
-            efp = logfp;
-        else if (!isatty(0))
-            efp = stdout;
-        if (efp != NULL) {
-            if (prompt && efp == stdout)
-                fputs("> ", efp);
-            IGNORE(fputs(rawbuf, efp));
-        }
-        strcpy(INLINE + 1, rawbuf);
-        /*  translate the chars to integers in the range 0-126 and store
-         *  them in the common array "INLINE".  Integer values are as follows:
-         *     0   = space [ASCII CODE 40 octal, 32 decimal]
-         *    1-2  = !" [ASCII 41-42 octal, 33-34 decimal]
-         *    3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
-         *   11-36 = upper-case letters
-         *   37-62 = lower-case letters
-         *    63   = percent (%) [ASCII 45 octal, 37 decimal]
-         *   64-73 = digits, 0 through 9
-         *  Remaining characters can be translated any way that is convenient;
-         *  The above mappings are required so that certain special
-         *  characters are known to fit in 6 bits and/or can be easily spotted.
-         *  Array elements beyond the end of the line should be filled with 0,
-         *  and LNLENG should be set to the index of the last character.
-         *
-         *  If the data file uses a character other than space (e.g., tab) to
-         *  separate numbers, that character should also translate to 0.
-         *
-         *  This procedure may use the map1,map2 arrays to maintain
-         *  static data for he mapping.  MAP2(1) is set to 0 when the
-         *  program starts and is not changed thereafter unless the
-         *  routines in this module choose to do so. */
-        LNLENG = 0;
-        for (long i = 1; i <= (long)sizeof(INLINE) && INLINE[i] != 0; i++) {
-            long val = INLINE[i];
-            INLINE[i] = ascii_to_advent[val];
-            if (INLINE[i] != 0)
-                LNLENG = i;
-        }
-        LNPOSN = 1;
-        return true;
+    for (int i = 0; i < 5; ++i) {
+        zzword[i] = 'A' + randrange(26);
     }
+    zzword[1] = '\''; // force second char to apostrophe
+    zzword[5] = '\0';
 }
 
 void datime(long* d, long* t)