Jettison MAKEWD(), GETTXT(), vocab(), GETIN(), and the old db compiler.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index b6230ec618454ede5a1d3dfb11fe97faf5697060..dbf4abb8f0dee6f63be8cec42cdc78e4d06a2fcd 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -7,26 +7,30 @@
 #include <ctype.h>
 
 #include "advent.h"
-#include "database.h"
 #include "linenoise/linenoise.h"
 #include "newdb.h"
 
-void* xmalloc(size_t size)
+char* xstrdup(const char* s)
 {
-    void* ptr = malloc(size);
-    if (ptr == NULL) {
-        fprintf(stderr, "Out of memory!\n");
-        exit(EXIT_FAILURE);
-    }
-    return (ptr);
+  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);
 }
 
-char* xstrdup(const char* s)
+void* xmalloc(size_t size)
 {
-    char* ptr = strdup(s);
+    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);
 }
@@ -35,8 +39,8 @@ 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];
+      char advent = (packed >> i * 6) & 63;
+        token[i] = new_advent_to_ascii[(int) advent];
     }
 
     // Ensure the last character is \0.
@@ -51,16 +55,53 @@ void packed_to_token(long packed, char token[6])
     }
 }
 
-void token_to_packed(char token[6], long* packed)
+long token_to_packed(const char token[6])
 {
-  *packed = 0;
-  for (size_t i = 0; i < 5; ++i)
+  size_t t_len = strlen(token);
+  long packed = 0;
+  for (size_t i = 0; i < t_len; ++i)
     {
-      if (token[4 - i] == '\0')
-       continue;       
-      char mapped = ascii_to_advent[(int) token[4 - i]];
-      *packed |= (mapped << (6 * 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));
+  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]);
 }
 
 /* Hide the fact that wods are corrently packed longs */
@@ -111,6 +152,8 @@ void vspeak(const char* msg, va_list ap)
             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') {
@@ -169,17 +212,32 @@ void speak(const char* msg, ...)
     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. */
 {
     va_list ap;
     va_start(ap, skip);
-    if (skip >= 0)
-        vspeak(object_descriptions[msg].longs[skip], ap);
-    else
-        vspeak(object_descriptions[msg].inventory, ap);
+    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);
 }
 
@@ -192,42 +250,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;
@@ -238,6 +260,23 @@ 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
@@ -257,8 +296,13 @@ 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.
                 printf("%s", input_prompt);
-            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.
@@ -283,7 +327,49 @@ char* get_input()
     return (input);
 }
 
-bool YES(const char* question, const char* yes_response, const char* no_response)
+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. */
 {
@@ -294,10 +380,13 @@ bool YES(const char* question, const char* yes_response, const char* no_response
         speak(question);
 
         reply = get_input();
-       if (reply == NULL) {
-         linenoiseFree(reply);
-         exit(EXIT_SUCCESS);
-       }
+        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);
@@ -313,7 +402,7 @@ bool YES(const char* question, const char* yes_response, const char* no_response
         free(firstword);
 
         if (yes == 0 || y == 0) {
-            speak(yes_response);
+           speak(yes_response);
             outcome = true;
             break;
         } else if (no == 0 || n == 0) {
@@ -327,110 +416,97 @@ 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;
-        }
-
-        text = text + current - ascii_to_advent['%'];
-        splitting = -1;
-        ++LNPOSN;
+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);
+       }
     }
-
-    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);
 }
 
-/*  Data structure  routines */
+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
 
-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);
-        }
-        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(RAN_OFF_END_OF_VOCABULARY_TABLE);
+  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)
+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. */
 {
@@ -438,11 +514,11 @@ void JUGGLE(long object)
 
     i = game.place[object];
     j = game.fixed[object];
-    MOVE(object, i);
-    MOVE(object + NOBJECTS, j);
+    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
@@ -455,19 +531,19 @@ void MOVE(long object, long where)
     else
         from = game.place[object];
     if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
-        CARRY(object, from);
-    DROP(object, where);
+        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);
+    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. */
@@ -491,7 +567,7 @@ void CARRY(long object, long where)
     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. */
 {
@@ -508,7 +584,7 @@ void DROP(long object, long 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). */
@@ -531,13 +607,13 @@ long ATDWRF(long where)
 /*  Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
  *  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;
@@ -563,35 +639,16 @@ 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);
     }
-
-    return rnd;
+  zzword[1] = '\''; // force second char to apostrophe
+  zzword[5] = '\0';
 }
 
-
 /*  Machine dependent routines (MAPLIN, SAVEIO) */
 
 bool MAPLIN(FILE *fp)
@@ -687,7 +744,7 @@ bool MAPLIN(FILE *fp)
     }
 }
 
-void DATIME(long* d, long* t)
+void datime(long* d, long* t)
 {
     struct timeval tv;
     gettimeofday(&tv, NULL);
@@ -695,10 +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 */