Jettison MAKEWD(), GETTXT(), vocab(), GETIN(), and the old db compiler.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index cf75e6442c42452ec02ca6db6ab75bb4a4e23c02..dbf4abb8f0dee6f63be8cec42cdc78e4d06a2fcd 100644 (file)
--- a/misc.c
+++ b/misc.c
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
+#include <stdarg.h>
 #include <sys/time.h>
 #include <ctype.h>
 
 #include "advent.h"
-#include "database.h"
 #include "linenoise/linenoise.h"
 #include "newdb.h"
 
 char* xstrdup(const char* s)
 {
   char* ptr = strdup(s);
-  if (ptr == NULL)
-    {
-      fprintf(stderr, "Out of memory!\n");
-      exit(EXIT_FAILURE);
-    }
+  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)
+{
+    void* ptr = malloc(size);
+    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)
-    {
+    // 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.
-  token[5] = '\0';
+    // Ensure the last character is \0.
+    token[5] = '\0';
 
-  // Replace trailing whitespace with \0.
-  for (int i = 4; i >= 0; --i)
+    // Replace trailing whitespace with \0.
+    for (int i = 4; i >= 0; --i) {
+        if (token[i] == ' ' || token[i] == '\t')
+            token[i] = '\0';
+        else
+            break;
+    }
+}
+
+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)
     {
-      if (token[i] == ' ' || token[i] == '\t')
-       token[i] = '\0';
-      else
-       break;
+      char mapped = new_ascii_to_advent[(int) token[i]];
+      packed |= (mapped << (6 * i));
     }
+  return(packed);
 }
 
-/*  I/O routines (SPEAK, PSPEAK, RSPEAK, SETPRM, GETIN, YES) */
+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));
+  words[1] = (char*) xmalloc(strlen(raw));
+  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]);
+}
 
-void newspeak(char* msg)
+/* Hide the fact that wods are corrently packed longs */
+
+bool wordeq(token_t a, token_t b)
 {
-  // Do nothing if we got a null pointer.
-  if (msg == NULL)
-    return;
+    return a == b;
+}
 
-  // Do nothing if we got an empty string.
-  if (strlen(msg) == 0)
-    return;
+bool wordempty(token_t a)
+{
+    return a == 0;
+}
 
-  // Print a newline if the global game.blklin says to.
-  if (game.blklin == true)
-    printf("\n");
+void wordclear(token_t *v)
+{
+    *v = 0;
+}
 
-  // Create a copy of our string, so we can edit it.
-  char* copy = xstrdup(msg);
+/*  I/O routines (speak, pspeak, rspeak, GETIN, YES) */
 
-  // Staging area for stringified parameters.
-  char parameters[5][100]; // FIXME: to be replaced with dynamic allocation
-  // Handle format specifiers (including the custom %C, %L, %S) by adjusting the parameter accordingly, and replacing the specifier with %s.
-  int pi = 0; // parameter index
-  for (int i = 0; i < (int)strlen(msg); ++i)
-    {
-      if (msg[i] == '%')
-       {
-         ++pi;
-
-         // 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 + 1] == 'd')
-           {
-             copy[i + 1] = 's';
-             sprintf(parameters[pi], "%ld", PARMS[pi]);
-           }
-
-         // Unmodified string specifier.
-         if (msg[i + 1] == 's')
-           {
-             packed_to_token(PARMS[pi], parameters[pi]);
-           }
-
-         // Singular/plural specifier.
-         if (msg[i + 1] == 'S')
-           {
-             copy[i + 1] = 's';
-             if (PARMS[pi - 1] > 1) // look at the *previous* parameter (which by necessity must be numeric)
-               {
-                 sprintf(parameters[pi], "%s", "s");
-               }
-             else
-               {
-                 sprintf(parameters[pi], "%s", "");
-               }
-           }
-
-         // All-lowercase specifier.
-         if (msg[i + 1] == 'L')
-           {
-             copy[i + 1] = 's';
-             packed_to_token(PARMS[pi], parameters[pi]);
-             for (int j = 0; j < (int)strlen(parameters[pi]); ++j)
-               {
-                 parameters[pi][j] = tolower(parameters[pi][j]);
-               }
-           }
-
-         // First char uppercase, rest lowercase.
-         if (msg[i + 1] == 'C')
-           {
-             copy[i + 1] = 's';
-             packed_to_token(PARMS[pi], parameters[pi]);
-             for (int j = 0; j < (int)strlen(parameters[pi]); ++j)
-               {
-                 parameters[pi][j] = tolower(parameters[pi][j]);
-               }
-             parameters[pi][0] = toupper(parameters[pi][0]);
-           }
-       }
+void vspeak(const char* msg, va_list ap)
+{
+    // Do nothing if we got a null pointer.
+    if (msg == NULL)
+        return;
+
+    // Do nothing if we got an empty string.
+    if (strlen(msg) == 0)
+        return;
+
+    // Print a newline if the global game.blklin says to.
+    if (game.blklin == true)
+        printf("\n");
+
+    int msglen = strlen(msg);
+
+    // Rendered string
+    ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
+    char* rendered = xmalloc(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;
+    for (int i = 0; i < msglen; i++) {
+        if (msg[i] != '%') {
+            *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.
+            if (msg[i] == 'd') {
+                int ret = snprintf(renderp, size, "%ld", arg);
+                if (ret < size) {
+                    renderp += ret;
+                    size -= ret;
+                }
+            }
+
+            // Unmodified string specifier.
+            if (msg[i] == 's') {
+                packed_to_token(arg, renderp); /* unpack directly to destination */
+                size_t len = strlen(renderp);
+                renderp += len;
+                size -= len;
+            }
+
+            // Singular/plural specifier.
+            if (msg[i] == 'S') {
+                if (previous_arg > 1) { // look at the *previous* parameter (which by necessity must be numeric)
+                    *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]);
+                renderp += len;
+                size -= len;
+            }
+
+            previous_arg = arg;
+        }
     }
+    *renderp = 0;
 
-  // Render the final string.
-  char rendered[2000]; // FIXME: to be replaced with dynamic allocation
-  sprintf(rendered, copy, parameters[1], parameters[2], parameters[3], parameters[4]); // FIXME: to be replaced with vsprintf()
+    // Print the message.
+    printf("%s\n", rendered);
 
-  // Print the message.
-  printf("%s\n", rendered);
+    free(rendered);
+}
 
-  free(copy);
+void speak(const char* msg, ...)
+{
+    va_list ap;
+    va_start(ap, msg);
+    vspeak(msg, ap);
+    va_end(ap);
 }
 
-void PSPEAK(vocab_t msg,int skip)
-/*  Find the skip+1st message from msg and print it.  msg should be
- *  the index of the inventory message for object.  (INVEN+N+1 message
- *  is game.prop=N message). */
+void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
+/* 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
+ * listen = the sound for the state the object is in
+ * study = text on the object. */
 {
-  if (skip >= 0)
-    newspeak(object_descriptions[msg].longs[skip]);
-  else
-    newspeak(object_descriptions[msg].inventory);
+    va_list ap;
+    va_start(ap, skip);
+    switch (mode) {
+    case touch:
+        vspeak(objects[msg].inventory, ap);
+       break;
+    case look: 
+        vspeak(objects[msg].descriptions[skip], ap);
+       break;
+    case hear:
+        vspeak(objects[msg].sounds[skip], ap);
+       break;
+    case study:
+        vspeak(objects[msg].texts[skip], ap);
+       break;
+    case change:
+        vspeak(objects[msg].changes[skip], ap);
+       break;
+    }
+    va_end(ap);
 }
 
-void RSPEAK(vocab_t i)
+void rspeak(vocab_t i, ...)
 /* Print the i-th "random" message (section 6 of database). */
 {
-  newspeak(arbitrary_messages[i]);
+    va_list ap;
+    va_start(ap, i);
+    vspeak(arbitrary_messages[i], ap);
+    va_end(ap);
 }
 
-void SETPRM(long first, long p1, long p2)
-/*  Stores parameters into the PRMCOM parms array for use by speak.  P1 and P2
- *  are stored into PARMS(first) and PARMS(first+1). */
+void echo_input(FILE* destination, char* input_prompt, char* input)
 {
-    if (first >= MAXPARMS)
-       BUG(29);
-    else {
-       PARMS[first] = p1;
-       PARMS[first+1] = p2;
+    size_t len = strlen(input_prompt) + strlen(input) + 1;
+    char* prompt_and_input = (char*) xmalloc(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* 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);
 }
 
-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. */
+char* get_input()
 {
-    long junk;
+    // Set up the prompt
+    char input_prompt[] = "> ";
+    if (!prompt)
+        input_prompt[0] = '\0';
 
-    for (;;) {
-       if (game.blklin)
-           TYPE0();
-       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);
+    // Print a blank line if game.blklin tells us to.
+    if (game.blklin == true)
+        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);
+        }
+
+        if (input == NULL) // Got EOF; return with it.
+           return(input);
+        else if (input[0] == '#') // Ignore comments.
+            continue;
+        else // We have a 'normal' line; leave the loop.
+            break;
+    }
+
+    // Strip trailing newlines from the input
+    input[strcspn(input, "\n")] = 0;
+
+    linenoiseHistoryAdd(input);
+
+    if (!isatty(0))
+        echo_input(stdout, input_prompt, input);
+
+    if (logfp)
+        echo_input(logfp, input_prompt, 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);
 }
 
-long YES(FILE *input, vocab_t x, vocab_t y, vocab_t z)
+
+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. */
 {
-    token_t reply, junk1, junk2, junk3;
+    char* reply;
+    bool outcome;
 
     for (;;) {
-       RSPEAK(x);
-       GETIN(input, &reply, &junk1, &junk2, &junk3);
-       if (reply == MAKEWD(250519) || reply == MAKEWD(25)) {
-           RSPEAK(y);
-           return true;
-       }
-       if (reply == MAKEWD(1415) || reply == MAKEWD(14)) {
-           RSPEAK(z);
-           return false;
-       }
-       RSPEAK(PLEASE_ANSWER);
+        speak(question);
+
+        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) {
+           speak(yes_response);
+            outcome = true;
+            break;
+        } 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, TYPE0) */
+/*  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 (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);
+       }
+    }
+  // If execution reaches here, we didn't find the word.
+  return(WORD_NOT_FOUND);
+}
 
-    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;
+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);
+       }
     }
-    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);
 }
 
-void TYPE0(void)
-/*  Type a blank line.  This procedure is provided as a convenience for callers
- *  who otherwise have no use for MAPCOM. */
+long get_vocab_id(const char* word)
+// Search the vocab categories in order for the supplied word.
 {
-    long temp;
+  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
 
-    temp=LNLENG;
-    LNLENG=0;
-    TYPE();
-    LNLENG=temp;
-    return;
-}
+  ref_num = get_object_vocab_id(word);
+  if (ref_num != WORD_NOT_FOUND)
+    return(ref_num + 1000); // FIXME: replace with a proper hash
 
-/*  Data structure  routines */
+  ref_num = get_action_vocab_id(word);
+  if (ref_num != WORD_NOT_FOUND)
+    return(ref_num + 2000); // FIXME: replace with a proper hash
 
-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(5);
-       }
-       if (init >= 0 && KTAB[i]/1000 != init)
-           continue;
-       if (ATAB[i] == id) {
-           lexeme=KTAB[i];
-           if (init >= 0)
-               lexeme=MOD(lexeme,1000);
-           return(lexeme);
-       }
-    }
-    BUG(21);
+  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)
+void juggle(long 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;
 
-    i=game.place[object];
-    j=game.fixed[object];
-    MOVE(object,i);
-    MOVE(object+NOBJECTS,j);
+    i = game.place[object];
+    j = game.fixed[object];
+    move(object, i);
+    move(object + NOBJECTS, j);
 }
 
-void MOVE(long object, long where)
+void move(long object, long 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
@@ -357,24 +526,24 @@ void MOVE(long object, long where)
 {
     long from;
 
-    if (object > NOBJECTS) 
-       from=game.fixed[object-NOBJECTS];
+    if (object > NOBJECTS)
+        from = game.fixed[object - NOBJECTS];
     else
-       from=game.place[object];
-    if (from != NOWHERE && from != CARRIED && !SPECIAL(from))
-       CARRY(object,from);
-    DROP(object,where);
+        from = game.place[object];
+    if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
+        carry(object, from);
+    drop(object, where);
 }
 
-long PUT(long object, long where, long pval)
+long put(long object, long 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;;
+    move(object, where);
+    return (-1) - pval;;
 }
 
-void CARRY(long object, long where) 
+void carry(long object, long 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. */
@@ -382,70 +551,69 @@ void CARRY(long object, long where)
     long temp;
 
     if (object <= NOBJECTS) {
-       if (game.place[object] == CARRIED)
-           return;
-       game.place[object] = CARRIED;
-       ++game.holdng;
+        if (game.place[object] == CARRIED)
+            return;
+        game.place[object] = CARRIED;
+        ++game.holdng;
     }
     if (game.atloc[where] == object) {
-       game.atloc[where]=game.link[object];
-       return;
+        game.atloc[where] = game.link[object];
+        return;
     }
-    temp=game.atloc[where];
+    temp = game.atloc[where];
     while (game.link[temp] != object) {
-       temp=game.link[temp];
+        temp = game.link[temp];
     }
-    game.link[temp]=game.link[object];
+    game.link[temp] = game.link[object];
 }
 
-void DROP(long object, long where)
+void drop(long object, long where)
 /*  Place an object at a given loc, prefixing it onto the game.atloc list.  Decr
  *  game.holdng if the object was being toted. */
 {
     if (object > NOBJECTS)
-       game.fixed[object-NOBJECTS] = where;
-    else
-    {
-       if (game.place[object] == CARRIED)
-           --game.holdng;
-       game.place[object] = where;
+        game.fixed[object - NOBJECTS] = where;
+    else {
+        if (game.place[object] == CARRIED)
+            --game.holdng;
+        game.place[object] = where;
     }
     if (where <= 0)
-       return;
+        return;
     game.link[object] = game.atloc[where];
     game.atloc[where] = object;
 }
 
-long ATDWRF(long where)
+long atdwrf(long 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;
 
-    at =0;
+    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)
-           return i;
-       if (game.dloc[i] != 0)
-           at=0;
+    for (long i = 1; i <= NDWARVES - 1; i++) {
+        if (game.dloc[i] == where)
+            return i;
+        if (game.dloc[i] != 0)
+            at = 0;
     }
-    return(at);
+    return (at);
 }
 
 /*  Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
- *  randrange, RNDVOC, BUG) */
+ *  randrange, RNDVOC) */
 
-long SETBIT(long bit)
+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)
+bool tstbit(long mask, int bit)
 /*  Returns true if the specified bit is set in the mask. */
 {
     return (mask & (1 << bit)) != 0;
@@ -471,74 +639,24 @@ 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;
-       }
+  for (int i = 0; i < 5; ++i)
+    {
+      zzword[i] = 'A' + randrange(26);
     }
+  zzword[1] = '\''; // force second char to apostrophe
+  zzword[5] = '\0';
+}
 
-    return rnd;
-}
-
-void BUG(long num)
-/*  The following conditions are currently considered fatal bugs.  Numbers < 20
- *  are detected while reading the database; the others occur at "run time".
- *     0       Message line > 70 characters
- *     1       Null line in message
- *     2       Too many words of messages
- *     3       Too many travel options
- *     4       Too many vocabulary words
- *     5       Required vocabulary word not found
- *     6       Too many RTEXT messages
- *     7       Too many hints
- *     8       Location has cond bit being set twice
- *     9       Invalid section number in database
- *     10      Too many locations
- *     11      Too many class or turn messages
- *     20      Special travel (500>L>300) exceeds goto list
- *     21      Ran off end of vocabulary table
- *     22      Vocabulary type (N/1000) not between 0 and 3
- *     23      Intransitive action verb exceeds goto list
- *     24      Transitive action verb exceeds goto list
- *     25      Conditional travel entry with no alternative
- *     26      Location has no travel entries
- *     27      Hint number exceeds goto list
- *     28      Invalid month returned by date function
- *     29      Too many parameters given to SETPRM */
-{
-
-    printf("Fatal error %ld.  See source code for interpretation.\n", num);
-    exit(0);
-}
-
-/*  Machine dependent routines (MAPLIN, TYPE, SAVEIO) */
+/*  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 
+     * This logic is complicated partly because it has to serve
      * several cases with different requirements and partly because
      * of a quirk in linenoise().
      *
@@ -551,104 +669,82 @@ bool MAPLIN(FILE *fp)
      * 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 
+     * 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 
+     * 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);
-           }
-       }
+        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] == '#');
+    (!eof && rawbuf[0] == '#');
     if (eof) {
-       if (logfp && fp == stdin)
-           fclose(logfp);
-       return false;
+        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 "TYPE" routine below is used to map them back to characters when
-     *  necessary.  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
-     *  the mapping.  MAP2(1) is set to 0 when the program starts
-     *  and is not changed thereafter unless the routines on this page 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;
-    }
-}
-
-void TYPE(void)
-/*  Type the first "LNLENG" characters stored in inline, mapping them
- *  from integers to text per the rules described above.  INLINE
- *  may be changed by this routine. */
-{
-    long i;
-
-    if (LNLENG == 0) {
-       printf("\n");
-       return;
-    }
-
-    for (i=1; i<=LNLENG; i++) {
-      INLINE[i]=advent_to_ascii[(int) INLINE[i]];
+        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;
     }
-    INLINE[LNLENG+1]=0;
-    printf("%s\n", INLINE+1);
-    return;
 }
 
-void DATIME(long* d, long* t)
+void datime(long* d, long* t)
 {
     struct timeval tv;
     gettimeofday(&tv, NULL);
@@ -656,4 +752,12 @@ void DATIME(long* d, long* t)
     *t = (long) tv.tv_usec;
 }
 
+// LCOV_EXCL_START
+void bug(enum bugtype num, const char *error_string)
+{
+    fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
+    exit(EXIT_FAILURE);
+}
+// LCOV_EXCL_STOP
+
 /* end */