misc.c

   1 #include <unistd.h>
   2 #include <stdlib.h>
   3 #include <stdio.h>
   4 #include <string.h>
   5 #include <sys/time.h>
   6 #include <ctype.h>
   7
   8 #include "advent.h"
   9 #include "database.h"
  10 #include "linenoise/linenoise.h"
  11 #include "newdb.h"
  12
  13 void* xmalloc(size_t size)
  14 {
  15     void* ptr = malloc(size);
  16     if (ptr == NULL) {
  17         fprintf(stderr, "Out of memory!\n");
  18         exit(EXIT_FAILURE);
  19     }
  20     return (ptr);
  21 }
  22
  23 char* xstrdup(const char* s)
  24 {
  25     char* ptr = strdup(s);
  26     if (ptr == NULL) {
  27         fprintf(stderr, "Out of memory!\n");
  28         exit(EXIT_FAILURE);
  29     }
  30     return (ptr);
  31 }
  32
  33 void packed_to_token(long packed, char token[6])
  34 {
  35     // Unpack and map back to ASCII.
  36     for (int i = 0; i < 5; ++i) {
  37         char advent = (packed >> i * 6) & 63;
  38         token[4 - i] = advent_to_ascii[(int) advent];
  39     }
  40
  41     // Ensure the last character is \0.
  42     token[5] = '\0';
  43
  44     // Replace trailing whitespace with \0.
  45     for (int i = 4; i >= 0; --i) {
  46         if (token[i] == ' ' || token[i] == '\t')
  47             token[i] = '\0';
  48         else
  49             break;
  50     }
  51 }
  52
  53 void token_to_packed(char token[6], long* packed)
  54 {
  55   *packed = 0;
  56   for (size_t i = 0; i < 5; ++i)
  57     {
  58       if (token[4 - i] == '\0')
  59         continue;
  60       char mapped = ascii_to_advent[(int) token[4 - i]];
  61       *packed |= (mapped << (6 * i));
  62     }
  63 }
  64
  65 /* Hide the fact that wods are corrently packed longs */
  66
  67 bool wordeq(token_t a, token_t b)
  68 {
  69     return a == b;
  70 }
  71
  72 bool wordempty(token_t a)
  73 {
  74     return a == 0;
  75 }
  76
  77 void wordclear(token_t *v)
  78 {
  79     *v = 0;
  80 }
  81
  82 /*  I/O routines (SPEAK, PSPEAK, RSPEAK, SETPRM, GETIN, YES) */
  83
  84 void speak(const char* msg)
  85 {
  86     // Do nothing if we got a null pointer.
  87     if (msg == NULL)
  88         return;
  89
  90     // Do nothing if we got an empty string.
  91     if (strlen(msg) == 0)
  92         return;
  93
  94     // Print a newline if the global game.blklin says to.
  95     if (game.blklin == true)
  96         printf("\n");
  97
  98     // Create a copy of our string, so we can edit it.
  99     char* copy = xstrdup(msg);
 100
 101     // Staging area for stringified parameters.
 102     char parameters[5][100]; // FIXME: to be replaced with dynamic allocation
 103
 104     // Handle format specifiers (including the custom %C, %L, %S) by adjusting the parameter accordingly, and replacing the specifier with %s.
 105     int pi = 0; // parameter index
 106     for (int i = 0; i < (int)strlen(msg); ++i) {
 107         if (msg[i] == '%') {
 108             ++pi;
 109
 110             // 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.
 111             if (msg[i + 1] == 'd') {
 112                 copy[i + 1] = 's';
 113                 sprintf(parameters[pi], "%ld", PARMS[pi]);
 114             }
 115
 116             // Unmodified string specifier.
 117             if (msg[i + 1] == 's') {
 118                 packed_to_token(PARMS[pi], parameters[pi]);
 119             }
 120
 121             // Singular/plural specifier.
 122             if (msg[i + 1] == 'S') {
 123                 copy[i + 1] = 's';
 124                 if (PARMS[pi - 1] > 1) { // look at the *previous* parameter (which by necessity must be numeric)
 125                     sprintf(parameters[pi], "%s", "s");
 126                 } else {
 127                     sprintf(parameters[pi], "%s", "");
 128                 }
 129             }
 130
 131             // All-lowercase specifier.
 132             if (msg[i + 1] == 'L') {
 133                 copy[i + 1] = 's';
 134                 packed_to_token(PARMS[pi], parameters[pi]);
 135                 for (int j = 0; j < (int)strlen(parameters[pi]); ++j) {
 136                     parameters[pi][j] = tolower(parameters[pi][j]);
 137                 }
 138             }
 139
 140             // First char uppercase, rest lowercase.
 141             if (msg[i + 1] == 'C') {
 142                 copy[i + 1] = 's';
 143                 packed_to_token(PARMS[pi], parameters[pi]);
 144                 for (int j = 0; j < (int)strlen(parameters[pi]); ++j) {
 145                     parameters[pi][j] = tolower(parameters[pi][j]);
 146                 }
 147                 parameters[pi][0] = toupper(parameters[pi][0]);
 148             }
 149         }
 150     }
 151
 152     // Render the final string.
 153     char rendered[2000]; // FIXME: to be replaced with dynamic allocation
 154     sprintf(rendered, copy, parameters[1], parameters[2], parameters[3], parameters[4]); // FIXME: to be replaced with vsprintf()
 155
 156     // Print the message.
 157     printf("%s\n", rendered);
 158
 159     free(copy);
 160 }
 161
 162 void PSPEAK(vocab_t msg, int skip)
 163 /*  Find the skip+1st message from msg and print it.  msg should be
 164  *  the index of the inventory message for object.  (INVEN+N+1 message
 165  *  is game.prop=N message). */
 166 {
 167     if (skip >= 0)
 168         speak(object_descriptions[msg].longs[skip]);
 169     else
 170         speak(object_descriptions[msg].inventory);
 171 }
 172
 173 void RSPEAK(vocab_t i)
 174 /* Print the i-th "random" message (section 6 of database). */
 175 {
 176     speak(arbitrary_messages[i]);
 177 }
 178
 179 void SETPRM(long first, long p1, long p2)
 180 /*  Stores parameters into the PRMCOM parms array for use by speak.  P1 and P2
 181  *  are stored into PARMS(first) and PARMS(first+1). */
 182 {
 183     if (first >= MAXPARMS)
 184         BUG(TOO_MANY_PARAMETERS_GIVEN_TO_SETPRM);
 185     else {
 186         PARMS[first] = p1;
 187         PARMS[first + 1] = p2;
 188     }
 189 }
 190
 191 bool GETIN(FILE *input,
 192            long *pword1, long *pword1x,
 193            long *pword2, long *pword2x)
 194 /*  Get a command from the adventurer.  Snarf out the first word, pad it with
 195  *  blanks, and return it in WORD1.  Chars 6 thru 10 are returned in WORD1X, in
 196  *  case we need to print out the whole word in an error message.  Any number of
 197  *  blanks may follow the word.  If a second word appears, it is returned in
 198  *  WORD2 (chars 6 thru 10 in WORD2X), else WORD2 is -1. */
 199 {
 200     long junk;
 201
 202     for (;;) {
 203         if (game.blklin)
 204             fputc('\n', stdout);;
 205         if (!MAPLIN(input))
 206             return false;
 207         *pword1 = GETTXT(true, true, true);
 208         if (game.blklin && *pword1 < 0)
 209             continue;
 210         *pword1x = GETTXT(false, true, true);
 211         do {
 212             junk = GETTXT(false, true, true);
 213         } while
 214         (junk > 0);
 215         *pword2 = GETTXT(true, true, true);
 216         *pword2x = GETTXT(false, true, true);
 217         do {
 218             junk = GETTXT(false, true, true);
 219         } while
 220         (junk > 0);
 221         if (GETTXT(true, true, true) <= 0)
 222             return true;
 223         RSPEAK(TWO_WORDS);
 224     }
 225 }
 226
 227 void echo_input(FILE* destination, char* input_prompt, char* input)
 228 {
 229     size_t len = strlen(input_prompt) + strlen(input) + 1;
 230     char* prompt_and_input = (char*) xmalloc(len);
 231     strcpy(prompt_and_input, input_prompt);
 232     strcat(prompt_and_input, input);
 233     fprintf(destination, "%s\n", prompt_and_input);
 234     free(prompt_and_input);
 235 }
 236
 237 char* get_input()
 238 {
 239     // Set up the prompt
 240     char input_prompt[] = "> ";
 241     if (!prompt)
 242         input_prompt[0] = '\0';
 243
 244     // Print a blank line if game.blklin tells us to.
 245     if (game.blklin == true)
 246         printf("\n");
 247
 248     char* input;
 249     while (true) {
 250         if (editline)
 251             input = linenoise(input_prompt);
 252         else {
 253             input = NULL;
 254             size_t n = 0;
 255             if (isatty(0))
 256                 printf("%s", input_prompt);
 257             IGNORE(getline(&input, &n, stdin));
 258         }
 259
 260         if (input == NULL) // Got EOF; quit.
 261             exit(EXIT_SUCCESS);
 262         else if (input[0] == '#') // Ignore comments.
 263             continue;
 264         else // We have a 'normal' line; leave the loop.
 265             break;
 266     }
 267
 268     // Strip trailing newlines from the input
 269     input[strcspn(input, "\n")] = 0;
 270
 271     linenoiseHistoryAdd(input);
 272
 273     if (!isatty(0))
 274         echo_input(stdout, input_prompt, input);
 275
 276     if (logfp)
 277         echo_input(logfp, input_prompt, input);
 278
 279     return (input);
 280 }
 281
 282 bool YES(const char* question, const char* yes_response, const char* no_response)
 283 /*  Print message X, wait for yes/no answer.  If yes, print Y and return true;
 284  *  if no, print Z and return false. */
 285 {
 286     char* reply;
 287     bool outcome;
 288
 289     for (;;) {
 290         speak(question);
 291
 292         reply = get_input();
 293
 294         char* firstword = (char*) xmalloc(strlen(reply)+1);
 295         sscanf(reply, "%s", firstword);
 296
 297         for (int i = 0; i < (int)strlen(firstword); ++i)
 298             firstword[i] = tolower(firstword[i]);
 299
 300         int yes = strncmp("yes", firstword, sizeof("yes") - 1);
 301         int y = strncmp("y", firstword, sizeof("y") - 1);
 302         int no = strncmp("no", firstword, sizeof("no") - 1);
 303         int n = strncmp("n", firstword, sizeof("n") - 1);
 304
 305         free(firstword);
 306
 307         if (yes == 0 || y == 0) {
 308             speak(yes_response);
 309             outcome = true;
 310             break;
 311         } else if (no == 0 || n == 0) {
 312             speak(no_response);
 313             outcome = false;
 314             break;
 315         } else
 316             RSPEAK(PLEASE_ANSWER);
 317     }
 318     linenoiseFree(reply);
 319     return (outcome);
 320 }
 321
 322 /*  Line-parsing routines (GETTXT, MAKEWD, PUTTXT, SHFTXT) */
 323
 324 long GETTXT(bool skip, bool onewrd, bool upper)
 325 /*  Take characters from an input line and pack them into 30-bit words.
 326  *  Skip says to skip leading blanks.  ONEWRD says stop if we come to a
 327  *  blank.  UPPER says to map all letters to uppercase.  If we reach the
 328  *  end of the line, the word is filled up with blanks (which encode as 0's).
 329  *  If we're already at end of line when TEXT is called, we return -1. */
 330 {
 331     long text;
 332     static long splitting = -1;
 333
 334     if (LNPOSN != splitting)
 335         splitting = -1;
 336     text = -1;
 337     while (true) {
 338         if (LNPOSN > LNLENG)
 339             return (text);
 340         if ((!skip) || INLINE[LNPOSN] != 0)
 341             break;
 342         ++LNPOSN;
 343     }
 344
 345     text = 0;
 346     for (int I = 1; I <= TOKLEN; I++) {
 347         text = text * 64;
 348         if (LNPOSN > LNLENG || (onewrd && INLINE[LNPOSN] == 0))
 349             continue;
 350         char current = INLINE[LNPOSN];
 351         if (current < ascii_to_advent['%']) {
 352             splitting = -1;
 353             if (upper && current >= ascii_to_advent['a'])
 354                 current = current - 26;
 355             text = text + current;
 356             ++LNPOSN;
 357             continue;
 358         }
 359         if (splitting != LNPOSN) {
 360             text = text + ascii_to_advent['%'];
 361             splitting = LNPOSN;
 362             continue;
 363         }
 364
 365         text = text + current - ascii_to_advent['%'];
 366         splitting = -1;
 367         ++LNPOSN;
 368     }
 369
 370     return text;
 371 }
 372
 373 token_t MAKEWD(long letters)
 374 /*  Combine TOKLEN (currently 5) uppercase letters (represented by
 375  *  pairs of decimal digits in lettrs) to form a 30-bit value matching
 376  *  the one that GETTXT would return given those characters plus
 377  *  trailing blanks.  Caution: lettrs will overflow 31 bits if
 378  *  5-letter word starts with V-Z.  As a kludgey workaround, you can
 379  *  increment a letter by 5 by adding 50 to the next pair of
 380  *  digits. */
 381 {
 382     long i = 1, word = 0;
 383
 384     for (long k = letters; k != 0; k = k / 100) {
 385         word = word + i * (MOD(k, 50) + 10);
 386         i = i * 64;
 387         if (MOD(k, 100) > 50)word = word + i * 5;
 388     }
 389     i = 64L * 64L * 64L * 64L * 64L / i;
 390     word = word * i;
 391     return word;
 392 }
 393
 394 /*  Data structure  routines */
 395
 396 long VOCAB(long id, long init)
 397 /*  Look up ID in the vocabulary (ATAB) and return its "definition" (KTAB), or
 398  *  -1 if not found.  If INIT is positive, this is an initialisation call setting
 399  *  up a keyword variable, and not finding it constitutes a bug.  It also means
 400  *  that only KTAB values which taken over 1000 equal INIT may be considered.
 401  *  (Thus "STEPS", which is a motion verb as well as an object, may be located
 402  *  as an object.)  And it also means the KTAB value is taken modulo 1000. */
 403 {
 404     long lexeme;
 405
 406     for (long i = 1; i <= TABSIZ; i++) {
 407         if (KTAB[i] == -1) {
 408             lexeme = -1;
 409             if (init < 0)
 410                 return (lexeme);
 411             BUG(REQUIRED_VOCABULARY_WORD_NOT_FOUND);
 412         }
 413         if (init >= 0 && KTAB[i] / 1000 != init)
 414             continue;
 415         if (ATAB[i] == id) {
 416             lexeme = KTAB[i];
 417             if (init >= 0)
 418                 lexeme = MOD(lexeme, 1000);
 419             return (lexeme);
 420         }
 421     }
 422     BUG(RAN_OFF_END_OF_VOCABULARY_TABLE);
 423 }
 424
 425 void JUGGLE(long object)
 426 /*  Juggle an object by picking it up and putting it down again, the purpose
 427  *  being to get the object to the front of the chain of things at its loc. */
 428 {
 429     long i, j;
 430
 431     i = game.place[object];
 432     j = game.fixed[object];
 433     MOVE(object, i);
 434     MOVE(object + NOBJECTS, j);
 435 }
 436
 437 void MOVE(long object, long where)
 438 /*  Place any object anywhere by picking it up and dropping it.  May
 439  *  already be toting, in which case the carry is a no-op.  Mustn't
 440  *  pick up objects which are not at any loc, since carry wants to
 441  *  remove objects from game.atloc chains. */
 442 {
 443     long from;
 444
 445     if (object > NOBJECTS)
 446         from = game.fixed[object - NOBJECTS];
 447     else
 448         from = game.place[object];
 449     if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
 450         CARRY(object, from);
 451     DROP(object, where);
 452 }
 453
 454 long PUT(long object, long where, long pval)
 455 /*  PUT is the same as MOVE, except it returns a value used to set up the
 456  *  negated game.prop values for the repository objects. */
 457 {
 458     MOVE(object, where);
 459     return (-1) - pval;;
 460 }
 461
 462 void CARRY(long object, long where)
 463 /*  Start toting an object, removing it from the list of things at its former
 464  *  location.  Incr holdng unless it was already being toted.  If object>NOBJECTS
 465  *  (moving "fixed" second loc), don't change game.place or game.holdng. */
 466 {
 467     long temp;
 468
 469     if (object <= NOBJECTS) {
 470         if (game.place[object] == CARRIED)
 471             return;
 472         game.place[object] = CARRIED;
 473         ++game.holdng;
 474     }
 475     if (game.atloc[where] == object) {
 476         game.atloc[where] = game.link[object];
 477         return;
 478     }
 479     temp = game.atloc[where];
 480     while (game.link[temp] != object) {
 481         temp = game.link[temp];
 482     }
 483     game.link[temp] = game.link[object];
 484 }
 485
 486 void DROP(long object, long where)
 487 /*  Place an object at a given loc, prefixing it onto the game.atloc list.  Decr
 488  *  game.holdng if the object was being toted. */
 489 {
 490     if (object > NOBJECTS)
 491         game.fixed[object - NOBJECTS] = where;
 492     else {
 493         if (game.place[object] == CARRIED)
 494             --game.holdng;
 495         game.place[object] = where;
 496     }
 497     if (where <= 0)
 498         return;
 499     game.link[object] = game.atloc[where];
 500     game.atloc[where] = object;
 501 }
 502
 503 long ATDWRF(long where)
 504 /*  Return the index of first dwarf at the given location, zero if no dwarf is
 505  *  there (or if dwarves not active yet), -1 if all dwarves are dead.  Ignore
 506  *  the pirate (6th dwarf). */
 507 {
 508     long at;
 509
 510     at = 0;
 511     if (game.dflag < 2)
 512         return (at);
 513     at = -1;
 514     for (long i = 1; i <= NDWARVES - 1; i++) {
 515         if (game.dloc[i] == where)
 516             return i;
 517         if (game.dloc[i] != 0)
 518             at = 0;
 519     }
 520     return (at);
 521 }
 522
 523 /*  Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
 524  *  randrange, RNDVOC) */
 525
 526 long SETBIT(long bit)
 527 /*  Returns 2**bit for use in constructing bit-masks. */
 528 {
 529     return (1 << bit);
 530 }
 531
 532 bool TSTBIT(long mask, int bit)
 533 /*  Returns true if the specified bit is set in the mask. */
 534 {
 535     return (mask & (1 << bit)) != 0;
 536 }
 537
 538 void set_seed(long seedval)
 539 /* Set the LCG seed */
 540 {
 541     game.lcg_x = (unsigned long) seedval % game.lcg_m;
 542 }
 543
 544 unsigned long get_next_lcg_value(void)
 545 /* Return the LCG's current value, and then iterate it. */
 546 {
 547     unsigned long old_x = game.lcg_x;
 548     game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m;
 549     return old_x;
 550 }
 551
 552 long randrange(long range)
 553 /* Return a random integer from [0, range). */
 554 {
 555     return range * get_next_lcg_value() / game.lcg_m;
 556 }
 557
 558 long RNDVOC(long second, long force)
 559 /*  Searches the vocabulary ATAB for a word whose second character is
 560  *  char, and changes that word such that each of the other four
 561  *  characters is a random letter.  If force is non-zero, it is used
 562  *  as the new word.  Returns the new word. */
 563 {
 564     long rnd = force;
 565
 566     if (rnd == 0) {
 567         for (int i = 1; i <= 5; i++) {
 568             long j = 11 + randrange(26);
 569             if (i == 2)
 570                 j = second;
 571             rnd = rnd * 64 + j;
 572         }
 573     }
 574
 575     long div = 64L * 64L * 64L;
 576     for (int i = 1; i <= TABSIZ; i++) {
 577         if (MOD(ATAB[i] / div, 64L) == second) {
 578             ATAB[i] = rnd;
 579             break;
 580         }
 581     }
 582
 583     return rnd;
 584 }
 585
 586
 587 /*  Machine dependent routines (MAPLIN, SAVEIO) */
 588
 589 bool MAPLIN(FILE *fp)
 590 {
 591     bool eof;
 592
 593     /* Read a line of input, from the specified input source.
 594      * This logic is complicated partly because it has to serve
 595      * several cases with different requirements and partly because
 596      * of a quirk in linenoise().
 597      *
 598      * The quirk shows up when you paste a test log from the clipboard
 599      * to the program's command prompt.  While fgets (as expected)
 600      * consumes it a line at a time, linenoise() returns the first
 601      * line and discards the rest.  Thus, there needs to be an
 602      * editline (-s) option to fall back to fgets while still
 603      * prompting.  Note that linenoise does behave properly when
 604      * fed redirected stdin.
 605      *
 606      * The logging is a bit of a mess because there are two distinct cases
 607      * in which you want to echo commands.  One is when shipping them to
 608      * a log under the -l option, in which case you want to suppress
 609      * prompt generation (so test logs are unadorned command sequences).
 610      * On the other hand, if you redirected stdin and are feeding the program
 611      * a logfile, you *do* want prompt generation - it makes checkfiles
 612      * easier to read when the commands are marked by a preceding prompt.
 613      */
 614     do {
 615         if (!editline) {
 616             if (prompt)
 617                 fputs("> ", stdout);
 618             IGNORE(fgets(rawbuf, sizeof(rawbuf) - 1, fp));
 619             eof = (feof(fp));
 620         } else {
 621             char *cp = linenoise("> ");
 622             eof = (cp == NULL);
 623             if (!eof) {
 624                 strncpy(rawbuf, cp, sizeof(rawbuf) - 1);
 625                 linenoiseHistoryAdd(rawbuf);
 626                 strncat(rawbuf, "\n", sizeof(rawbuf) - strlen(rawbuf) - 1);
 627                 linenoiseFree(cp);
 628             }
 629         }
 630     } while
 631     (!eof && rawbuf[0] == '#');
 632     if (eof) {
 633         if (logfp && fp == stdin)
 634             fclose(logfp);
 635         return false;
 636     } else {
 637         FILE *efp = NULL;
 638         if (logfp && fp == stdin)
 639             efp = logfp;
 640         else if (!isatty(0))
 641             efp = stdout;
 642         if (efp != NULL) {
 643             if (prompt && efp == stdout)
 644                 fputs("> ", efp);
 645             IGNORE(fputs(rawbuf, efp));
 646         }
 647         strcpy(INLINE + 1, rawbuf);
 648         /*  translate the chars to integers in the range 0-126 and store
 649          *  them in the common array "INLINE".  Integer values are as follows:
 650          *     0   = space [ASCII CODE 40 octal, 32 decimal]
 651          *    1-2  = !" [ASCII 41-42 octal, 33-34 decimal]
 652          *    3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
 653          *   11-36 = upper-case letters
 654          *   37-62 = lower-case letters
 655          *    63   = percent (%) [ASCII 45 octal, 37 decimal]
 656          *   64-73 = digits, 0 through 9
 657          *  Remaining characters can be translated any way that is convenient;
 658          *  The above mappings are required so that certain special
 659          *  characters are known to fit in 6 bits and/or can be easily spotted.
 660          *  Array elements beyond the end of the line should be filled with 0,
 661          *  and LNLENG should be set to the index of the last character.
 662          *
 663          *  If the data file uses a character other than space (e.g., tab) to
 664          *  separate numbers, that character should also translate to 0.
 665          *
 666          *  This procedure may use the map1,map2 arrays to maintain static data for
 667          *  the mapping.  MAP2(1) is set to 0 when the program starts
 668          *  and is not changed thereafter unless the routines on this page choose
 669          *  to do so. */
 670         LNLENG = 0;
 671         for (long i = 1; i <= (long)sizeof(INLINE) && INLINE[i] != 0; i++) {
 672             long val = INLINE[i];
 673             INLINE[i] = ascii_to_advent[val];
 674             if (INLINE[i] != 0)
 675                 LNLENG = i;
 676         }
 677         LNPOSN = 1;
 678         return true;
 679     }
 680 }
 681
 682 void DATIME(long* d, long* t)
 683 {
 684     struct timeval tv;
 685     gettimeofday(&tv, NULL);
 686     *d = (long) tv.tv_sec;
 687     *t = (long) tv.tv_usec;
 688 }
 689
 690 void bug(enum bugtype num, const char *error_string)
 691 {
 692     fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
 693     exit(EXIT_FAILURE);
 694 }
 695
 696 /* end */