Comment polishing.
[open-adventure.git] / misc.c
diff --git a/misc.c b/misc.c
index e005d8138d470dd05c227a641e20591dffe3150c..752bc8ee2cd3f483f5994abf0e5f750a24331ea6 100644 (file)
--- a/misc.c
+++ b/misc.c
 #include <stdio.h>
 #include <string.h>
 #include <sys/time.h>
+#include <ctype.h>
+
 #include "advent.h"
-#include "funcs.h"
 #include "database.h"
+#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);
+  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[advent];
+    }
 
-/* hack to ignore GCC Unused Result */
-#define IGNORE(r) do{if (r){}}while(0)
+  // Ensure the last character is \0.
+  token[5] = '\0';
 
-#define PERCENT        63      /* partly hide the packed encoding */
+  // 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=msg+1;
-       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;
 
-       while (LNPOSN <= LNLENG) { 
-           if (INLINE[LNPOSN] != PERCENT) {
-               ++LNPOSN;
-               continue;
+  // Print a newline if the global game.blklin says to.
+  if (game.blklin == true)
+    printf("\n");
+
+  // 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 == 1)
-               return;
-           if (prmtyp == 29) {
-               SHFTXT(LNPOSN+2,-1);
-               INLINE[LNPOSN] = 55;
-               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 == 30) {
-               SHFTXT(LNPOSN+2,-2);
-               state=0;
-               casemake=2;
-
-               while (PARMS[nparms] > 0) {
-                   if (PARMS[nparms+1] < 0)
-                       casemake=0;
-                   PUTTXT(PARMS[nparms],state,casemake);
-                   nparms=nparms+1;
+
+         // 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");
                }
-               ++nparms;
-               continue;
-           }
-           if (prmtyp == 12) {
-               prmtyp=PARMS[nparms];
-               SHFTXT(LNPOSN+2,prmtyp-2);
-               if (prmtyp != 0) {
-                   for (i=1; i<=prmtyp; i++) {
-                       INLINE[LNPOSN]=0;
-                       ++LNPOSN;
-                   }
+             else
+               {
+                 sprintf(parameters[pi], "%s", "");
                }
-               ++nparms;
-               continue;
-           }
-           if (prmtyp == 33 || prmtyp == 22 || prmtyp == 31 || prmtyp == 13) {
-               SHFTXT(LNPOSN+2,-2);
-               state = 0;
-               casemake = -1;
-               if (prmtyp == 31)
-                   casemake=1;
-               if (prmtyp == 33)
-                   casemake=0;
-               i = LNPOSN;
-               PUTTXT(PARMS[nparms],state,casemake);
-               PUTTXT(PARMS[nparms+1],state,casemake);
-               if (prmtyp == 13 && INLINE[i] >= 37 && INLINE[i] <= 62)
-                   INLINE[i] -= 26;
-               nparms += 2;
-               continue;
            }
 
-           prmtyp=prmtyp-64;
-           if (prmtyp < 1 || prmtyp > 9) {
-               ++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)
@@ -142,25 +151,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)
@@ -175,7 +175,7 @@ void SETPRM(long first, long p1, long p2)
     }
 }
 
-bool fGETIN(FILE *input, 
+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
@@ -189,8 +189,7 @@ bool fGETIN(FILE *input,
     for (;;) {
        if (game.blklin)
            TYPE0();
-       MAPLIN(input);
-       if (feof(input))
+       if (!MAPLIN(input))
            return false;
        *pword1=GETTXT(true,true,true);
        if (game.blklin && *pword1 < 0)
@@ -220,7 +219,7 @@ long YES(FILE *input, vocab_t x, vocab_t y, vocab_t z)
 
     for (;;) {
        RSPEAK(x);
-       GETIN(input, reply,junk1,junk2,junk3);
+       GETIN(input, &reply, &junk1, &junk2, &junk3);
        if (reply == MAKEWD(250519) || reply == MAKEWD(25)) {
            RSPEAK(y);
            return true;
@@ -253,7 +252,7 @@ long GETTXT(bool skip, bool onewrd, bool upper)
            return(text);
        if ((!skip) || INLINE[LNPOSN] != 0)
            break;
-       LNPOSN=LNPOSN+1;
+       ++LNPOSN;
     }
 
     text=0;
@@ -262,23 +261,23 @@ long GETTXT(bool skip, bool onewrd, bool upper)
        if (LNPOSN > LNLENG || (onewrd && INLINE[LNPOSN] == 0))
            continue;
        char current=INLINE[LNPOSN];
-       if (current < PERCENT) {
+       if (current < ascii_to_advent['%']) {
            splitting = -1;
-           if (upper && current >= 37)
+           if (upper && current >= ascii_to_advent['a'])
                current=current-26;
            text=text+current;
-           LNPOSN=LNPOSN+1;
+           ++LNPOSN;
            continue;
        }
        if (splitting != LNPOSN) {
-           text=text+PERCENT;
+           text=text+ascii_to_advent['%'];
            splitting = LNPOSN;
            continue;
        }
 
-       text=text+current-PERCENT;
+       text=text+current-ascii_to_advent['%'];
        splitting = -1;
-       LNPOSN=LNPOSN+1;
+       ++LNPOSN;
     }
 
     return text;
@@ -305,7 +304,7 @@ token_t MAKEWD(long letters)
     return word;
 }
 
-void fPUTTXT(token_t word, long *state, long casemake)
+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
@@ -333,15 +332,15 @@ void fPUTTXT(token_t word, long *state, long casemake)
            return;
        byte=w/div;
        w=(w-byte*div)*64;
-       if (!(*state != 0 || byte != PERCENT)) {
-           *state=PERCENT;
+       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=LNPOSN+1;
+       ++LNPOSN;
        *state=0;
     }
 }
@@ -378,91 +377,6 @@ void TYPE0(void)
     return;
 }
 
-/*  Suspend/resume I/O routines (SAVWDS, SAVARR, SAVWRD) */
-
-void fSAVWDS(long *W1, long *W2, long *W3, long *W4,
-            long *W5, long *W6, long *W7)
-/* Write or read 7 variables.  See SAVWRD. */
-{
-    SAVWRD(0,(*W1));
-    SAVWRD(0,(*W2));
-    SAVWRD(0,(*W3));
-    SAVWRD(0,(*W4));
-    SAVWRD(0,(*W5));
-    SAVWRD(0,(*W6));
-    SAVWRD(0,(*W7));
-}
-
-void fSAVARR(long arr[], long n)
-/* Write or read an array of n words.  See SAVWRD. */
-{
-    long i;
-
-    for (i=1; i<=n; i++) {
-       SAVWRD(0,arr[i]);
-    }
-    return;
-}
-
-void fSAVWRD(long op, long *pword) 
-/*  If OP<0, start writing a file, using word to initialise encryption; save
- *  word in the file.  If OP>0, start reading a file; read the file to find
- *  the value with which to decrypt the rest.  In either case, if a file is
- *  already open, finish writing/reading it and don't start a new one.  If OP=0,
- *  read/write a single word.  Words are buffered in case that makes for more
- *  efficient disk use.  We also compute a simple checksum to catch elementary
- *  poking within the saved file.  When we finish reading/writing the file,
- *  we store zero into *PWORD if there's no checksum error, else nonzero. */
-{
-    static long buf[250], cksum = 0, h1, hash = 0, n = 0, state = 0;
-
-    if (op != 0)
-    {
-       long ifvar = state; 
-       switch (ifvar<0 ? -1 : (ifvar>0 ? 1 : 0)) 
-       { 
-       case -1:
-       case 1:
-           if (n == 250)SAVEIO(1,state > 0,buf);
-           n=MOD(n,250)+1;
-           if (state <= 0) {
-               n--; buf[n]=cksum; n++;
-               SAVEIO(1,false,buf);
-           }
-           n--; *pword=buf[n]-cksum; n++;
-           SAVEIO(-1,state > 0,buf);
-           state=0;
-           break;
-       case 0: /* FIXME: Huh? should be impossible */
-           state=op;
-           SAVEIO(0,state > 0,buf);
-           n=1;
-           if (state <= 0) {
-               hash=MOD(*pword,1048576L);
-               buf[0]=1234L*5678L-hash;
-           }
-           SAVEIO(1,true,buf);
-           hash=MOD(1234L*5678L-buf[0],1048576L);
-           cksum=buf[0];
-           return;
-       }
-    }
-    if (state == 0)
-       return;
-    if (n == 250)
-       SAVEIO(1,state > 0,buf);
-    n=MOD(n,250)+1;
-    h1=MOD(hash*1093L+221573L,1048576L);
-    hash=MOD(h1*1093L+221573L,1048576L);
-    h1=MOD(h1,1234)*765432+MOD(hash,123);
-    n--;
-    if (state > 0)
-       *pword=buf[n]+h1;
-    buf[n]=*pword-h1;
-    n++;
-    cksum=MOD(cksum*13+*pword,1000000000L);
-}
-
 /*  Data structure  routines */
 
 long VOCAB(long id, long init) 
@@ -548,7 +462,7 @@ void CARRY(long object, long where)
        if (game.place[object] == -1)
            return;
        game.place[object]= -1;
-       game.holdng=game.holdng+1;
+       ++game.holdng;
     }
     if (game.atloc[where] == object) {
        game.atloc[where]=game.link[object];
@@ -605,7 +519,7 @@ long ATDWRF(long where)
 long SETBIT(long bit)
 /*  Returns 2**bit for use in constructing bit-masks. */
 {
-    return(2 << bit);
+    return(1 << bit);
 }
 
 bool TSTBIT(long mask, int bit)
@@ -694,11 +608,12 @@ void BUG(long num)
     exit(0);
 }
 
-/*  Machine dependent routines (MAPLIN, TYPE, MPINIT, SAVEIO) */
+/*  Machine dependent routines (MAPLIN, TYPE, SAVEIO) */
 
-void MAPLIN(FILE *fp)
+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
@@ -725,32 +640,50 @@ void MAPLIN(FILE *fp)
      *  and is not changed thereafter unless the routines on this page choose
      *  to do so. */
 
-    if (MAP2[1] == 0)
-       MPINIT();
-
-    if (!oldstyle && fp == stdin)
-       fputs("> ", stdout);
     do {
-       IGNORE(fgets(rawbuf,sizeof(rawbuf)-1,fp));
+       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)-1);
+               linenoiseFree(cp);
+           }
+       }
     } while
-           (!feof(fp) && rawbuf[0] == '#');
-    if (feof(fp)) {
+           (!eof && rawbuf[0] == '#');
+    if (eof) {
        if (logfp && fp == stdin)
            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)
+               fputs("> ", efp);
+           IGNORE(fputs(rawbuf, efp));
+       }
        strcpy(INLINE+1, rawbuf);
        LNLENG=0;
        for (i=1; i<=(long)sizeof(INLINE) && INLINE[i]!=0; i++) {
-           val=INLINE[i]+1;
-           INLINE[i]=MAP1[val];
+           val=INLINE[i];
+           INLINE[i]=ascii_to_advent[val];
            if (INLINE[i] != 0)
                LNLENG=i;
        }
        LNPOSN=1;
+       return true;
     }
 }
 
@@ -766,85 +699,14 @@ void TYPE(void)
        return;
     }
 
-    if (MAP2[1] == 0)
-       MPINIT();
     for (i=1; i<=LNLENG; i++) {
-       INLINE[i]=MAP2[INLINE[i]+1];
+       INLINE[i]=advent_to_ascii[INLINE[i]];
     }
     INLINE[LNLENG+1]=0;
     printf("%s\n", INLINE+1);
     return;
 }
 
-void MPINIT(void) 
-{
-    long first, i, j, last, val;
-    static long RUNS[7][2] = { {32,34}, {39,46}, {65,90}, {97,122}, 
-                              {37,37}, {48,57}, {0,126} };
-    for (i=1; i<=128; i++) {
-       MAP1[i]= -1;
-    }
-    val=0;
-    for (i=0; i<7; i++) {
-       first =RUNS[i][0];
-       last = RUNS[i][1];
-       for (j=first; j<=last; j++) {
-           j++; 
-           if (MAP1[j] < 0) {
-               MAP1[j]=val;
-               ++val;
-           }       
-           j--;
-       }
-    }
-    MAP1[128]=MAP1[10];
-    /*  For this version, tab (9) maps to space (32), so del (127)
-     *  uses tab's value */
-    MAP1[10]=MAP1[33];
-    MAP1[11]=MAP1[33];
-
-    for (i=0; i<=126; i++) {
-       i++; val=MAP1[i]+1; i--;
-       MAP2[val] = i*('B'-'A');
-       if (i >= 64)
-           MAP2[val]=(i-64)*('B'-'A')+'@';
-    }
-}
-
-void fSAVEIO(long op, long in, long arr[]) 
-/*  If OP=0, ask for a file name and open a file.  (If IN=true, the file is for
- *  input, else output.)  If OP>0, read/write ARR from/into the previously-opened
- *  file.  (ARR is a 250-integer array.)  If OP<0, finish reading/writing the
- *  file.  (Finishing writing can be a no-op if a "stop" statement does it
- *  automatically.  Finishing reading can be a no-op as long as a subsequent
- *  SAVEIO(0,false,X) will still work.) */
-{
-    static FILE *fp = NULL; 
-    char name[50];
-
-    switch (op < 0 ? -1 : (op > 0 ? 1 : 0)) 
-    { 
-    case -1:
-       fclose(fp);
-       break;
-    case 0:
-       while (fp == NULL) {
-           printf("\nFile name: ");
-           IGNORE(fgets(name, sizeof(name), stdin));
-           fp = fopen(name,(in ? READ_MODE : WRITE_MODE));
-           if (fp == NULL)
-               printf("Can't open file %s, try again.\n", name); 
-       }
-       break;
-    case 1: 
-       if (in)
-           IGNORE(fread(arr,sizeof(long),250,fp));
-       else
-           IGNORE(fwrite(arr,sizeof(long),250,fp));
-       break;
-    }
-}
-
 void DATIME(long* d, long* t)
 {
     struct timeval tv;
@@ -853,7 +715,4 @@ void DATIME(long* d, long* t)
     *t = (long) tv.tv_usec;
 }
 
-long MOD(long n, long m) 
-{
-    return(n%m);
-}
+/* end */