Documentation improvements.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index 3960347f36bc77bcc10d30a86f8d307569f1611d..075e9d08eee3235b72ce8ef8b6283d8298cb880b 100644 (file)
--- a/misc.c
+++ b/misc.c
 #include "linenoise/linenoise.h"
 #include "newdb.h"
 
-void* xmalloc(size_t size)
-{
-  void* ptr = malloc(size);
-  if (ptr == NULL)
-    {
-      fprintf(stderr, "Out of memory!\n");
-      exit(EXIT_FAILURE);
-    }
-  return(ptr);
-}
-
 char* xstrdup(const char* s)
 {
   char* ptr = strdup(s);
@@ -304,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. */
@@ -615,39 +544,35 @@ 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 (prompt)
-       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 (!editline) {
+           if (prompt)
+               fputs("> ", stdout);
            IGNORE(fgets(rawbuf,sizeof(rawbuf)-1,fp));
            eof = (feof(fp));
        } else {
-           char *cp = linenoise(prompt ? "> ": "");
+           char *cp = linenoise("> ");
            eof = (cp == NULL);
            if (!eof) {
                strncpy(rawbuf, cp, sizeof(rawbuf)-1);
@@ -663,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];