Comment cleanup, semantic types, information hiding.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index 906834291e7cca0b21c894e26913178889f75cf2..120a503351a0d899349d98c162dd7c0f35900866 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -5,74 +5,27 @@
 #include <stdarg.h>
 #include <sys/time.h>
 #include <ctype.h>
+#include <editline/readline.h>
 
 #include "advent.h"
-#include "database.h"
-#include "linenoise/linenoise.h"
-#include "newdb.h"
+#include "dungeon.h"
 
-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
         fprintf(stderr, "Out of memory!\n");
         exit(EXIT_FAILURE);
+        // LCOV_EXCL_STOP
     }
     return (ptr);
 }
 
-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];
-    }
-
-    // Ensure the last character is \0.
-    token[5] = '\0';
-
-    // Replace trailing whitespace with \0.
-    for (int i = 4; i >= 0; --i) {
-        if (token[i] == ' ' || token[i] == '\t')
-            token[i] = '\0';
-        else
-            break;
-    }
-}
-
-void token_to_packed(char token[6], long* packed)
-{
-  *packed = 0;
-  for (size_t i = 0; i < 5; ++i)
-    {
-      if (token[4 - i] == '\0')
-       continue;       
-      char mapped = ascii_to_advent[(int) token[4 - i]];
-      *packed |= (mapped << (6 * i));
-    }
-}
-
-/* Hide the fact that wods are corrently packed longs */
-
-bool wordeq(token_t a, token_t b)
-{
-    return a == b;
-}
-
-bool wordempty(token_t a)
-{
-    return a == 0;
-}
-
-void wordclear(token_t *v)
-{
-    *v = 0;
-}
-
-/*  I/O routines (speak, pspeak, rspeak, GETIN, YES) */
+/*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
-void vspeak(const char* msg, va_list ap)
+static void vspeak(const char* msg, bool blank, va_list ap)
 {
     // Do nothing if we got a null pointer.
     if (msg == NULL)
@@ -82,40 +35,50 @@ 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);
 
     // 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 %C, %L, %S) by adjusting the parameter accordingly, and replacing the specifier with %s.
-    long previous_arg = 0;
+    // Handle format specifiers (including the custom %S) by
+    // adjusting the parameter accordingly, and replacing the
+    // specifier with %s.
+    bool pluralize = false;
     for (int i = 0; i < msglen; i++) {
         if (msg[i] != '%') {
-            *renderp++ = msg[i];
-            size--;
+            /* Ugh.  Least obtrusive way to deal with artifacts "on the floor"
+             * being dropped outside of both cave and building. */
+            if (strncmp(msg + i, "floor", 5) == 0 && strchr(" .", msg[i + 5]) && !INSIDE(game.loc)) {
+                strcpy(renderp, "ground");
+                renderp += 6;
+                i += 4;
+                size -= 5;
+            } else {
+                *renderp++ = msg[i];
+                size--;
+            }
         } else {
-            long arg = va_arg(ap, long);
-           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.
+            // Integer specifier.
             if (msg[i] == 'd') {
+                long arg = va_arg(ap, long);
                 int ret = snprintf(renderp, size, "%ld", arg);
                 if (ret < size) {
                     renderp += ret;
                     size -= ret;
                 }
+                pluralize = (arg != 1);
             }
 
             // Unmodified string specifier.
             if (msg[i] == 's') {
-                packed_to_token(arg, renderp); /* unpack directly to destination */
+                char *arg = va_arg(ap, char *);
+                strncat(renderp, arg, size - 1);
                 size_t len = strlen(renderp);
                 renderp += len;
                 size -= len;
@@ -123,26 +86,20 @@ void vspeak(const char* msg, va_list ap)
 
             // Singular/plural specifier.
             if (msg[i] == 'S') {
-                if (previous_arg > 1) { // look at the *previous* parameter (which by necessity must be numeric)
+                // look at the *previous* numeric parameter
+                if (pluralize) {
                     *renderp++ = 's';
                     size--;
                 }
             }
 
-            // 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]);
+            /* Version specifier */
+            if (msg[i] == 'V') {
+                strcpy(renderp, VERSION);
+                size_t len = strlen(VERSION);
                 renderp += len;
                 size -= len;
             }
-
-            previous_arg = arg;
         }
     }
     *renderp = 0;
@@ -157,32 +114,45 @@ 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 int 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
+ * 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. */
 {
     va_list ap;
-    va_start(ap, skip);
+    va_start(ap, blank);
     switch (mode) {
     case touch:
-        vspeak(object_descriptions[msg].inventory, ap);
-       break;
-    case look: 
-        vspeak(object_descriptions[msg].longs[skip], ap);
-       break;
+        vspeak(objects[msg].inventory, blank, ap);
+        break;
+    case look:
+        vspeak(objects[msg].descriptions[skip], blank, ap);
+        break;
     case hear:
-        vspeak(object_descriptions[msg].sounds[skip], ap);
-       break;
+        vspeak(objects[msg].sounds[skip], blank, ap);
+        break;
     case study:
-        vspeak(object_descriptions[msg].texts[skip], ap);
-       break;
+        vspeak(objects[msg].texts[skip], blank, ap);
+        break;
+    case change:
+        vspeak(objects[msg].changes[skip], blank, ap);
+        break;
     }
     va_end(ap);
 }
@@ -192,120 +162,157 @@ 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);
 }
 
-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)
+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);
 }
 
-char* get_input()
+static int word_count(char* str)
+{
+    char delims[] = " \t";
+    int count = 0;
+    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;
+            }
+        }
+
+    return (count);
+}
+
+static char* get_input(void)
 {
     // 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))
-                printf("%s", input_prompt);
-            IGNORE(getline(&input, &n, stdin));
-        }
+        input = readline(input_prompt);
 
         if (input == NULL) // Got EOF; return with it.
-           return(input);
-        else if (input[0] == '#') // Ignore comments.
+            return (input);
+        if (input[0] == '#') { // Ignore comments.
+            free(input);
             continue;
-        else // We have a 'normal' line; leave the loop.
-            break;
+        }
+        // We have a 'normal' line; leave the loop.
+        break;
     }
 
     // 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(void)
+{
+    bool outcome = false;
+
+    for (;;) {
+        char* reply = get_input();
+        if (reply == NULL) {
+            // LCOV_EXCL_START
+            // Should be unreachable. Reply should never be NULL
+            free(reply);
+            exit(EXIT_SUCCESS);
+            // LCOV_EXCL_STOP
+        }
+        if (strlen(reply) == 0) {
+            free(reply);
+            rspeak(PLEASE_ANSWER);
+            continue;
+        }
+
+        char* firstword = (char*) xcalloc(strlen(reply) + 1);
+        sscanf(reply, "%s", firstword);
+
+        free(reply);
+
+        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);
+    }
+    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. */
 {
-    char* reply;
-    bool outcome;
+    bool outcome = false;
 
     for (;;) {
         speak(question);
 
-        reply = get_input();
-       if (reply == NULL) {
-         linenoiseFree(reply);
-         exit(EXIT_SUCCESS);
-       }
+        char* reply = get_input();
+        if (reply == NULL) {
+            // LCOV_EXCL_START
+            // Should be unreachable. Reply should never be NULL
+            free(reply);
+            exit(EXIT_SUCCESS);
+            // LCOV_EXCL_STOP
+        }
+
+        if (strlen(reply) == 0) {
+            free(reply);
+            rspeak(PLEASE_ANSWER);
+            continue;
+        }
 
-        char* firstword = (char*) xmalloc(strlen(reply)+1);
+        char* firstword = (char*) xcalloc(strlen(reply) + 1);
         sscanf(reply, "%s", firstword);
 
+        free(reply);
+
         for (int i = 0; i < (int)strlen(firstword); ++i)
             firstword[i] = tolower(firstword[i]);
 
@@ -316,129 +323,202 @@ 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;
         } else
             rspeak(PLEASE_ANSWER);
+
     }
-    linenoiseFree(reply);
+
     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. */
+static 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;
+    for (int i = 0; i < NMOTIONS; ++i) {
+        for (int j = 0; j < motions[i].words.n; ++j) {
+            if (strncasecmp(word, motions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
+                    strchr(ignore, word[0]) == NULL ||
+                    !settings.oldstyle))
+                return (i);
+        }
+    }
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
+}
 
-    if (LNPOSN != splitting)
-        splitting = -1;
-    text = -1;
-    while (true) {
-        if (LNPOSN > LNLENG)
-            return (text);
-        if ((!skip) || INLINE[LNPOSN] != 0)
-            break;
-        ++LNPOSN;
+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
+        for (int j = 0; j < objects[i].words.n; ++j) {
+            if (strncasecmp(word, objects[i].words.strs[j], TOKLEN) == 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;
+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) {
+        for (int j = 0; j < actions[i].words.n; ++j) {
+            if (strncasecmp(word, actions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
+                    strchr(ignore, word[0]) == NULL ||
+                    !settings.oldstyle))
+                return (i);
         }
-        if (splitting != LNPOSN) {
-            text = text + ascii_to_advent['%'];
-            splitting = LNPOSN;
-            continue;
+    }
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
+}
+
+static 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 (strncasecmp(word, specials[i].words.strs[j], TOKLEN) == 0)
+                return (i);
         }
+    }
+    // If execution reaches here, we didn't find the word.
+    return (WORD_NOT_FOUND);
+}
 
-        text = text + current - ascii_to_advent['%'];
-        splitting = -1;
-        ++LNPOSN;
+static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* type)
+{
+    /* Check for an empty string */
+    if (strncmp(word, "", sizeof("")) == 0) {
+        *id = WORD_EMPTY;
+        *type = NO_WORD_TYPE;
+        return;
+    }
+
+    vocab_t ref_num;
+
+    ref_num = get_motion_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND) {
+        *id = ref_num;
+        *type = MOTION;
+        return;
+    }
+
+    ref_num = get_object_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND) {
+        *id = ref_num;
+        *type = OBJECT;
+        return;
+    }
+
+    ref_num = get_action_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND) {
+        *id = ref_num;
+        *type = ACTION;
+        return;
     }
 
-    return text;
+    ref_num = get_special_vocab_id(word);
+    if (ref_num != WORD_NOT_FOUND) {
+        *id = ref_num;
+        *type = SPECIAL;
+        return;
+    }
+
+    // Check for the reservoir magic word.
+    if (strcasecmp(word, game.zzword) == 0) {
+        *id = PART;
+        *type = ACTION;
+        return;
+    }
+
+    *id = WORD_NOT_FOUND;
+    *type = NO_WORD_TYPE;
+    return;
 }
 
-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. */
+static void tokenize(char* raw, struct command_t *cmd)
 {
-    long i = 1, word = 0;
+    memset(cmd, '\0', sizeof(struct command_t));
 
-    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;
+    /* 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->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 = 64L * 64L * 64L * 64L * 64L / i;
-    word = word * i;
-    return word;
-}
 
-/*  Data structure  routines */
+    /* populate command with parsed vocabulary metadata */
+    get_vocab_metadata(cmd->raw1, &(cmd->id1), &(cmd->type1));
+    get_vocab_metadata(cmd->raw2, &(cmd->id2), &(cmd->type2));
+}
 
-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. */
+bool get_command_input(struct command_t *command)
+/* Get user input on stdin, parse and map to command */
 {
-    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);
-        }
-        if (init >= 0 && KTAB[i] / 1000 != init)
+    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 (ATAB[i] == id) {
-            lexeme = KTAB[i];
-            if (init >= 0)
-                lexeme = MOD(lexeme, 1000);
-            return (lexeme);
         }
+        if (strcmp(input, "") != 0)
+            break;
+        free(input);
     }
-    BUG(RAN_OFF_END_OF_VOCABULARY_TABLE);
+
+    strncpy(inputbuf, input, LINESIZE - 1);
+    free(input);
+
+    tokenize(inputbuf, command);
+
+    return true;
 }
 
-void juggle(long object)
+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. */
 {
-    long i, j;
+    loc_t i, j;
 
     i = game.place[object];
     j = game.fixed[object];
@@ -446,32 +526,33 @@ void juggle(long object)
     move(object + NOBJECTS, j);
 }
 
-void move(long object, long where)
+void move(obj_t object, loc_t where)
 /*  Place any object anywhere by picking it up and dropping it.  May
  *  already be toting, in which case the carry is a no-op.  Mustn't
  *  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];
     else
         from = game.place[object];
-    if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
+    /* (ESR) Used to check for !SPECIAL(from). I *think* that was wrong... */
+    if (from != LOC_NOWHERE && from != CARRIED)
         carry(object, from);
     drop(object, where);
 }
 
-long put(long object, long where, long pval)
-/*  PUT is the same as MOVE, except it returns a value used to set up the
+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. */
 {
     move(object, where);
-    return (-1) - pval;;
+    return STASHED(pval);
 }
 
-void carry(long object, long where)
+void carry(obj_t object, loc_t where)
 /*  Start toting an object, removing it from the list of things at its former
  *  location.  Incr holdng unless it was already being toted.  If object>NOBJECTS
  *  (moving "fixed" second loc), don't change game.place or game.holdng. */
@@ -495,7 +576,7 @@ void carry(long object, long where)
     game.link[temp] = game.link[object];
 }
 
-void drop(long object, long 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. */
 {
@@ -506,22 +587,23 @@ void drop(long object, long where)
             --game.holdng;
         game.place[object] = where;
     }
-    if (where <= 0)
+    if (where == LOC_NOWHERE ||
+        where == CARRIED)
         return;
     game.link[object] = game.atloc[where];
     game.atloc[where] = object;
 }
 
-long atdwrf(long 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)
@@ -529,16 +611,16 @@ long atdwrf(long where)
         if (game.dloc[i] != 0)
             at = 0;
     }
-    return (at);
+    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)
+long setbit(int bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
 {
-    return (1 << bit);
+    return (1L << bit);
 }
 
 bool tstbit(long mask, int bit)
@@ -551,6 +633,13 @@ 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
+    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)
@@ -567,142 +656,21 @@ 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. */
-{
-    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)
+// LCOV_EXCL_START
+void bug(enum bugtype num, const char *error_string)
 {
-    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;
-    }
+    fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
+    exit(EXIT_FAILURE);
 }
+// LCOV_EXCL_STOP
 
-void datime(long* d, long* t)
-{
-    struct timeval tv;
-    gettimeofday(&tv, NULL);
-    *d = (long) tv.tv_sec;
-    *t = (long) tv.tv_usec;
-}
+/* end */
 
-void bug(enum bugtype num, const char *error_string)
+void state_change(obj_t obj, int state)
+/* Object must have a change-message list for this to be useful; only some do */
 {
-    fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
-    exit(EXIT_FAILURE);
+    game.prop[obj] = state;
+    pspeak(obj, change, state, true);
 }
 
 /* end */