Add test for urn actions.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index ba9bed32991e7975275eeb064895714bea22b69c..c47ce1d8ed4007cf8dc8e14b6c446a36e85794a8 100644 (file)
--- a/misc.c
+++ b/misc.c
 #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);
+    }
+  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;
+    }
+}
 
 /*  I/O routines (SPEAK, PSPEAK, RSPEAK, SETPRM, GETIN, YES) */
 
-void SPEAK(vocab_t msg)
-/*  Print the message which starts at LINES[N].  Precede it with a blank line
- *  unless game.blklin is false. */
+void newspeak(char* msg)
 {
-    long blank, casemake, i, nxt, neg, nparms, param, prmtyp, state;
+  // Do nothing if we got a null pointer.
+  if (msg == NULL)
+    return;
 
-    if (msg == 0)
-       return;
-    blank=game.blklin;
-    nparms=1;
-    do {
-       nxt=labs(LINES[msg])-1;
-       ++msg;
-       LNLENG=0;
-       LNPOSN=1;
-       state=0;
-       for (i = msg; i <= nxt; i++) {
-           PUTTXT(LINES[i],&state,2);
-       }
-       LNPOSN=0;
-       ++LNPOSN;
+  // 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");
 
-       while (LNPOSN <= LNLENG) { 
-           if (INLINE[LNPOSN] != ascii_to_advent['%']) {
-               ++LNPOSN;
-               continue;
+  // Create a copy of our string, so we can edit it.
+  char* copy = xstrdup(msg);
+
+  // 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 < 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]);
            }
-           prmtyp = INLINE[LNPOSN+1];
-           /*  A "%"; the next character determine the type of
-            *  parameter: 1 (!) = suppress message completely, 29 (S) = NULL
-            *  If PARAM=1, else 'S' (optional plural ending), 33 (W) = word
-            *  (two 30-bit values) with trailing spaces suppressed, 22 (L) or
-            *  31 (U) = word but map to lower/upper case, 13 (C) = word in
-            *  lower case with first letter capitalised, 30 (T) = text ending
-            *  with a word of -1, 65-73 (1-9) = number using that many
-            *  characters, 12 (B) = variable number of blanks. */
-           if (prmtyp == ascii_to_advent['!'])
-               return;
-           if (prmtyp == ascii_to_advent['S']) {
-               SHFTXT(LNPOSN+2,-1);
-               INLINE[LNPOSN] = ascii_to_advent['s'];
-               if (PARMS[nparms] == 1)
-                   SHFTXT(LNPOSN+1,-1);
-               ++nparms;
-               continue;
+
+         // Unmodified string specifier.
+         if (msg[i + 1] == 's')
+           {
+             packed_to_token(PARMS[pi], parameters[pi]);
            }
-           if (prmtyp == ascii_to_advent['W'] || prmtyp == ascii_to_advent['L'] || prmtyp == ascii_to_advent['U'] || prmtyp == ascii_to_advent['C']) {
-               SHFTXT(LNPOSN+2,-2);
-               state = 0;
-               casemake = -1;
-               if (prmtyp == ascii_to_advent['U'])
-                   casemake=1;
-               if (prmtyp == ascii_to_advent['W'])
-                   casemake=0;
-               i = LNPOSN;
-               PUTTXT(PARMS[nparms],&state,casemake);
-               PUTTXT(PARMS[nparms+1],&state,casemake);
-               if (prmtyp == ascii_to_advent['C'] && INLINE[i] >= ascii_to_advent['a'] && INLINE[i] <= ascii_to_advent['z'])
-                 {
-                   // Convert to uppercase.
-                   // Round-trip to ASCII and back so that this code doesn't break when the mapping changes.
-                   // This can be simplified when mapping goes away.
-                   char this = advent_to_ascii[INLINE[i]];
-                   char uc_this = toupper(this);
-                   INLINE[i] = ascii_to_advent[uc_this];
-                 }
-               nparms += 2;
-               continue;
+
+         // 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", "");
+               }
            }
 
-           prmtyp=prmtyp-64;
-           if (prmtyp < ascii_to_advent['!'] || prmtyp > ascii_to_advent['-']) {
-               ++LNPOSN;
-               continue;
+         // All-lowercase specifier.
+         if (msg[i + 1] == 'L')
+           {
+             copy[i + 1] = 's';
+             packed_to_token(PARMS[pi], parameters[pi]);
+             for (int i = 0; i < strlen(parameters[pi]); ++i)
+               {
+                 parameters[pi][i] = tolower(parameters[pi][i]);
+               }
            }
-           SHFTXT(LNPOSN+2,prmtyp-2);
-           LNPOSN += prmtyp;
-           param=labs(PARMS[nparms]);
-           neg=0;
-           if (PARMS[nparms] < 0)
-               neg=9;
-           for (i=1; i <= prmtyp; i++) {
-               --LNPOSN;
-               INLINE[LNPOSN]=MOD(param,10)+64;
-               if (i != 1 && param == 0) {
-                   INLINE[LNPOSN]=neg;
-                   neg=0;
+
+         // First char uppercase, rest lowercase.
+         if (msg[i + 1] == 'C')
+           {
+             copy[i + 1] = 's';
+             packed_to_token(PARMS[pi], parameters[pi]);
+             for (int i = 0; i < strlen(parameters[pi]); ++i)
+               {
+                 parameters[pi][i] = tolower(parameters[pi][i]);
                }
-               param=param/10;
+             parameters[pi][0] = toupper(parameters[pi][0]);
            }
-           LNPOSN += prmtyp;
-           ++nparms;
-           continue;
-       }
+       }
+    }
 
-       if (blank)
-           TYPE0();
-       blank=false;
-       TYPE();
-       msg = nxt + 1;
-    } while
-       (LINES[msg] >= 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);
+
+  free(copy);
 }
 
 void PSPEAK(vocab_t msg,int skip)
@@ -120,25 +140,16 @@ void PSPEAK(vocab_t msg,int skip)
  *  the index of the inventory message for object.  (INVEN+N+1 message
  *  is game.prop=N message). */
 {
-    long i, m;
-
-    m=PTEXT[msg];
-    if (skip >= 0) {
-       for (i=0; i <=skip; i++) {
-           do {
-               m=labs(LINES[m]);
-           } while
-               (LINES[m] >= 0);
-       }
-    }
-    SPEAK(m);
+  if (skip >= 0)
+    newspeak(object_descriptions[msg].longs[skip]);
+  else
+    newspeak(object_descriptions[msg].inventory);
 }
 
 void RSPEAK(vocab_t i)
 /* Print the i-th "random" message (section 6 of database). */
 {
-    if (i != 0)
-       SPEAK(RTEXT[i]);
+  newspeak(arbitrary_messages[i]);
 }
 
 void SETPRM(long first, long p1, long p2)
@@ -282,66 +293,6 @@ token_t MAKEWD(long letters)
     return word;
 }
 
-void PUTTXT(token_t word, long *state, long casemake)
-/*  Unpack the 30-bit value in word to obtain up to TOKLEN (currently
- *  5) integer-encoded chars, and store them in inline starting at
- *  LNPOSN.  If LNLENG>=LNPOSN, shift existing characters to the right
- *  to make room.  STATE will be zero when puttxt is called with the
- *  first of a sequence of words, but is thereafter unchanged by the
- *  caller, so PUTTXT can use it to maintain state across calls.
- *  LNPOSN and LNLENG are incremented by the number of chars stored.
- *  If CASEMAKE=1, all letters are made uppercase; if -1, lowercase; if 0,
- *  as is.  any other value for case is the same as 0 but also causes
- *  trailing blanks to be included (in anticipation of subsequent
- *  additional text). */
-{
-    long alph1, alph2, byte, div, i, w;
-
-    alph1=13*casemake+24;
-    alph2=26*labs(casemake)+alph1;
-    if (labs(casemake) > 1)
-       alph1=alph2;
-    /*  alph1&2 define range of wrong-case chars, 11-36 or 37-62 or empty. */
-    div=64L*64L*64L*64L;
-    w=word;
-    for (i=1; i<=TOKLEN; i++) 
-    {
-       if (w <= 0 && *state == 0 && labs(casemake) <= 1)
-           return;
-       byte=w/div;
-       w=(w-byte*div)*64;
-       if (!(*state != 0 || byte != ascii_to_advent['%'])) {
-           *state=ascii_to_advent['%'];
-           continue;
-       }
-       SHFTXT(LNPOSN,1);
-       *state=*state+byte;
-       if (*state < alph2 && *state >= alph1)*state=*state-26*casemake;
-       INLINE[LNPOSN]=*state;
-       ++LNPOSN;
-       *state=0;
-    }
-}
-#define PUTTXT(WORD,STATE,CASE) fPUTTXT(WORD,&STATE,CASE)
-
-void SHFTXT(long from, long delta) 
-/*  Move INLINE(N) to INLINE(N+DELTA) for N=FROM,LNLENG.  Delta can be
- *  negative.  LNLENG is updated; LNPOSN is not changed. */
-{
-    long I, k, j;
-
-    if (!(LNLENG < from || delta == 0)) {
-       for (I=from; I<=LNLENG; I++) {
-           k=I;
-           if (delta > 0)
-               k=from+LNLENG-I;
-           j=k+delta;
-           INLINE[j]=INLINE[k];
-       }
-    }
-    LNLENG=LNLENG+delta;
-}
-
 void TYPE0(void)
 /*  Type a blank line.  This procedure is provided as a convenience for callers
  *  who otherwise have no use for MAPCOM. */
@@ -593,35 +544,31 @@ bool MAPLIN(FILE *fp)
     long i, val;
     bool eof;
 
-    /*  Read a line of input, from the specified input source,
-     *  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.
+    /* 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().
      *
-     *  If the data file uses a character other than space (e.g., tab) to
-     *  separate numbers, that character should also translate to 0.
+     * 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.
      *
-     *  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. */
-
-    if (!oldstyle && !isatty(1))
-       fputs("> ", stdout);
+     * 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 (oldstyle) {
+       if (!editline) {
+           if (prompt)
+               fputs("> ", stdout);
            IGNORE(fgets(rawbuf,sizeof(rawbuf)-1,fp));
            eof = (feof(fp));
        } else {
@@ -641,11 +588,41 @@ bool MAPLIN(FILE *fp)
            fclose(logfp);
        return false;
     } else {
+       FILE *efp = NULL;
        if (logfp && fp == stdin)
-           IGNORE(fputs(rawbuf, logfp));
+           efp = logfp;
        else if (!isatty(0))
-           IGNORE(fputs(rawbuf, stdout));
+           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 (i=1; i<=(long)sizeof(INLINE) && INLINE[i]!=0; i++) {
            val=INLINE[i];
@@ -671,7 +648,7 @@ void TYPE(void)
     }
 
     for (i=1; i<=LNLENG; i++) {
-       INLINE[i]=advent_to_ascii[INLINE[i]];
+      INLINE[i]=advent_to_ascii[(int) INLINE[i]];
     }
     INLINE[LNLENG+1]=0;
     printf("%s\n", INLINE+1);
@@ -686,7 +663,4 @@ void DATIME(long* d, long* t)
     *t = (long) tv.tv_usec;
 }
 
-long MOD(long n, long m) 
-{
-    return(n%m);
-}
+/* end */