Comment cleanup, semantic types, information hiding.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index d5b7f6554a1b95f3ad74645a918a0579d4ac1c6d..120a503351a0d899349d98c162dd7c0f35900866 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -23,38 +23,6 @@ static void* xcalloc(size_t size)
     return (ptr);
 }
 
-void tokenize(char* raw, struct command_t *cmd)
-{
-    memset(cmd, '\0', sizeof(struct command_t));
-
-    /* Bound prefix on the %s would be needed to prevent buffer
-     * overflow.  but we shortstop this more simply by making each
-     * raw-input buffer as long as the enrire inout buffer. */
-    sscanf(raw, "%s%s", cmd->raw1, cmd->raw2);
-
-    /* (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/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
 static void vspeak(const char* msg, bool blank, va_list ap)
@@ -96,23 +64,20 @@ static void vspeak(const char* msg, bool blank, va_list ap)
             }
         } else {
             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);
+                long arg = va_arg(ap, long);
                 int ret = snprintf(renderp, size, "%ld", arg);
                 if (ret < size) {
                     renderp += ret;
                     size -= ret;
                 }
-               pluralize = (arg != 1);
+                pluralize = (arg != 1);
             }
 
             // Unmodified string specifier.
             if (msg[i] == 's') {
-               char *arg = va_arg(ap, char *);
+                char *arg = va_arg(ap, char *);
                 strncat(renderp, arg, size - 1);
                 size_t len = strlen(renderp);
                 renderp += len;
@@ -121,7 +86,7 @@ static void vspeak(const char* msg, bool blank, va_list ap)
 
             // Singular/plural specifier.
             if (msg[i] == 'S') {
-               // look at the *previous* numeric parameter
+                // look at the *previous* numeric parameter
                 if (pluralize) {
                     *renderp++ = 's';
                     size--;
@@ -153,7 +118,7 @@ void speak(const char* msg, ...)
     va_end(ap);
 }
 
-void sspeak(const long msg, ...)
+void sspeak(const int msg, ...)
 {
     va_list ap;
     va_start(ap, msg);
@@ -166,7 +131,7 @@ void sspeak(const long msg, ...)
 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. */
 {
@@ -211,7 +176,7 @@ void echo_input(FILE* destination, const char* input_prompt, const char* input)
     free(prompt_and_input);
 }
 
-int word_count(char* str)
+static int word_count(char* str)
 {
     char delims[] = " \t";
     int count = 0;
@@ -232,7 +197,7 @@ int word_count(char* str)
     return (count);
 }
 
-char* get_input()
+static char* get_input(void)
 {
     // Set up the prompt
     char input_prompt[] = "> ";
@@ -270,7 +235,7 @@ char* get_input()
     return (input);
 }
 
-bool silent_yes()
+bool silent_yes(void)
 {
     bool outcome = false;
 
@@ -434,7 +399,7 @@ static int get_special_vocab_id(const char* word)
     return (WORD_NOT_FOUND);
 }
 
-void get_vocab_metadata(const char* word, long* id, enum wordtype* type)
+static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* type)
 {
     /* Check for an empty string */
     if (strncmp(word, "", sizeof("")) == 0) {
@@ -443,7 +408,7 @@ void get_vocab_metadata(const char* word, long* id, enum wordtype* type)
         return;
     }
 
-    long ref_num;
+    vocab_t ref_num;
 
     ref_num = get_motion_vocab_id(word);
     if (ref_num != WORD_NOT_FOUND) {
@@ -485,6 +450,70 @@ void get_vocab_metadata(const char* word, long* id, enum wordtype* type)
     return;
 }
 
+static void tokenize(char* raw, struct command_t *cmd)
+{
+    memset(cmd, '\0', sizeof(struct command_t));
+
+    /* 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]);
+    }
+
+    /* populate command with parsed vocabulary metadata */
+    get_vocab_metadata(cmd->raw1, &(cmd->id1), &(cmd->type1));
+    get_vocab_metadata(cmd->raw2, &(cmd->id2), &(cmd->type2));
+}
+
+bool get_command_input(struct command_t *command)
+/* Get user input on stdin, parse and map to command */
+{
+    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 (strcmp(input, "") != 0)
+            break;
+        free(input);
+    }
+
+    strncpy(inputbuf, input, LINESIZE - 1);
+    free(input);
+
+    tokenize(inputbuf, command);
+
+    return true;
+}
+
 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. */
@@ -503,7 +532,7 @@ void move(obj_t object, loc_t where)
  *  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];
@@ -515,7 +544,7 @@ void move(obj_t object, loc_t where)
     drop(object, where);
 }
 
-long put(obj_t object, loc_t where, long pval)
+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. */
 {
@@ -565,16 +594,16 @@ void drop(obj_t object, loc_t where)
     game.atloc[where] = object;
 }
 
-long atdwrf(loc_t 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)
@@ -582,13 +611,13 @@ long atdwrf(loc_t where)
         if (game.dloc[i] != 0)
             at = 0;
     }
-    return (at);
+    return at;
 }
 
 /*  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 (1L << bit);
@@ -606,7 +635,11 @@ void set_seed(long seedval)
     game.lcg_x = (unsigned long) seedval % game.lcg_m;
 
     // once seed is set, we need to generate the Z`ZZZ word
-    make_zzword(game.zzword);
+    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)
@@ -623,15 +656,6 @@ long randrange(long range)
     return range * get_next_lcg_value() / game.lcg_m;
 }
 
-void make_zzword(char zzword[TOKLEN + 1])
-{
-    for (int i = 0; i < 5; ++i) {
-        zzword[i] = 'A' + randrange(26);
-    }
-    zzword[1] = '\''; // force second char to apostrophe
-    zzword[5] = '\0';
-}
-
 // LCOV_EXCL_START
 void bug(enum bugtype num, const char *error_string)
 {
@@ -642,7 +666,7 @@ void bug(enum bugtype num, const char *error_string)
 
 /* end */
 
-void state_change(obj_t obj, long state)
+void state_change(obj_t obj, int state)
 /* Object must have a change-message list for this to be useful; only some do */
 {
     game.prop[obj] = state;