misc.c

   1 /*
   2  * I/O and support riutines.
   3  *
   4  * Copyright (c) 1977, 2005 by Will Crowther and Don Woods
   5  * Copyright (c) 2017 by Eric S. Raymond
   6  * SPDX-License-Identifier: BSD-2-clause
   7  */
   8
   9 #include <unistd.h>
  10 #include <stdlib.h>
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <stdarg.h>
  14 #include <sys/time.h>
  15 #include <ctype.h>
  16 #include <editline/readline.h>
  17 #include <inttypes.h>
  18
  19 #include "advent.h"
  20 #include "dungeon.h"
  21
  22 static void* xcalloc(size_t size)
  23 {
  24     void* ptr = calloc(size, 1);
  25     if (ptr == NULL) {
  26         // LCOV_EXCL_START
  27         // exclude from coverage analysis because we can't simulate an out of memory error in testing
  28         fprintf(stderr, "Out of memory!\n");
  29         exit(EXIT_FAILURE);
  30         // LCOV_EXCL_STOP
  31     }
  32     return (ptr);
  33 }
  34
  35 /*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
  36
  37 static void vspeak(const char* msg, bool blank, va_list ap)
  38 {
  39     // Do nothing if we got a null pointer.
  40     if (msg == NULL)
  41         return;
  42
  43     // Do nothing if we got an empty string.
  44     if (strlen(msg) == 0)
  45         return;
  46
  47     if (blank == true)
  48         printf("\n");
  49
  50     int msglen = strlen(msg);
  51
  52     // Rendered string
  53     ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
  54     char* rendered = xcalloc(size);
  55     char* renderp = rendered;
  56
  57     // Handle format specifiers (including the custom %S) by
  58     // adjusting the parameter accordingly, and replacing the
  59     // specifier with %s.
  60     bool pluralize = false;
  61     for (int i = 0; i < msglen; i++) {
  62         if (msg[i] != '%') {
  63             /* Ugh.  Least obtrusive way to deal with artifacts "on the floor"
  64              * being dropped outside of both cave and building. */
  65             if (strncmp(msg + i, "floor", 5) == 0 && strchr(" .", msg[i + 5]) && !INSIDE(game.loc)) {
  66                 strcpy(renderp, "ground");
  67                 renderp += 6;
  68                 i += 4;
  69                 size -= 5;
  70             } else {
  71                 *renderp++ = msg[i];
  72                 size--;
  73             }
  74         } else {
  75             i++;
  76             // Integer specifier.
  77             if (msg[i] == 'd') {
  78                 int32_t arg = va_arg(ap, int32_t);
  79                 int ret = snprintf(renderp, size, "%" PRId32, arg);
  80                 if (ret < size) {
  81                     renderp += ret;
  82                     size -= ret;
  83                 }
  84                 pluralize = (arg != 1);
  85             }
  86
  87             // Unmodified string specifier.
  88             if (msg[i] == 's') {
  89                 char *arg = va_arg(ap, char *);
  90                 strncat(renderp, arg, size - 1);
  91                 size_t len = strlen(renderp);
  92                 renderp += len;
  93                 size -= len;
  94             }
  95
  96             // Singular/plural specifier.
  97             if (msg[i] == 'S') {
  98                 // look at the *previous* numeric parameter
  99                 if (pluralize) {
 100                     *renderp++ = 's';
 101                     size--;
 102                 }
 103             }
 104
 105             // LCOV_EXCL_START - doesn't occur in test suite.
 106             /* Version specifier */
 107             if (msg[i] == 'V') {
 108                 strcpy(renderp, VERSION);
 109                 size_t len = strlen(VERSION);
 110                 renderp += len;
 111                 size -= len;
 112             }
 113             // LCOV_EXCL_STOP
 114         }
 115     }
 116     *renderp = 0;
 117
 118     // Print the message.
 119     printf("%s\n", rendered);
 120
 121     free(rendered);
 122 }
 123
 124 void speak(const char* msg, ...)
 125 {
 126     va_list ap;
 127     va_start(ap, msg);
 128     vspeak(msg, true, ap);
 129     va_end(ap);
 130 }
 131
 132 void sspeak(const int msg, ...)
 133 {
 134     va_list ap;
 135     va_start(ap, msg);
 136     fputc('\n', stdout);
 137     vprintf(arbitrary_messages[msg], ap);
 138     fputc('\n', stdout);
 139     va_end(ap);
 140 }
 141
 142 void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...)
 143 /* Find the skip+1st message from msg and print it.  Modes are:
 144  * feel = for inventory, what you can touch
 145  * look = the full description for the state the object is in
 146  * listen = the sound for the state the object is in
 147  * study = text on the object. */
 148 {
 149     va_list ap;
 150     va_start(ap, blank);
 151     switch (mode) {
 152     case touch:
 153         vspeak(objects[msg].inventory, blank, ap);
 154         break;
 155     case look:
 156         vspeak(objects[msg].descriptions[skip], blank, ap);
 157         break;
 158     case hear:
 159         vspeak(objects[msg].sounds[skip], blank, ap);
 160         break;
 161     case study:
 162         vspeak(objects[msg].texts[skip], blank, ap);
 163         break;
 164     case change:
 165         vspeak(objects[msg].changes[skip], blank, ap);
 166         break;
 167     }
 168     va_end(ap);
 169 }
 170
 171 void rspeak(vocab_t i, ...)
 172 /* Print the i-th "random" message (section 6 of database). */
 173 {
 174     va_list ap;
 175     va_start(ap, i);
 176     vspeak(arbitrary_messages[i], true, ap);
 177     va_end(ap);
 178 }
 179
 180 void echo_input(FILE* destination, const char* input_prompt, const char* input)
 181 {
 182     size_t len = strlen(input_prompt) + strlen(input) + 1;
 183     char* prompt_and_input = (char*) xcalloc(len);
 184     strcpy(prompt_and_input, input_prompt);
 185     strcat(prompt_and_input, input);
 186     fprintf(destination, "%s\n", prompt_and_input);
 187     free(prompt_and_input);
 188 }
 189
 190 static int word_count(char* str)
 191 {
 192     char delims[] = " \t";
 193     int count = 0;
 194     int inblanks = true;
 195
 196     for (char *s = str; *s; s++)
 197         if (inblanks) {
 198             if (strchr(delims, *s) == 0) {
 199                 ++count;
 200                 inblanks = false;
 201             }
 202         } else {
 203             if (strchr(delims, *s) != 0) {
 204                 inblanks = true;
 205             }
 206         }
 207
 208     return (count);
 209 }
 210
 211 static char* get_input(void)
 212 {
 213     // Set up the prompt
 214     char input_prompt[] = "> ";
 215     if (!settings.prompt)
 216         input_prompt[0] = '\0';
 217
 218     // Print a blank line
 219     printf("\n");
 220
 221     char* input;
 222     while (true) {
 223         input = readline(input_prompt);
 224
 225         if (input == NULL) // Got EOF; return with it.
 226             return (input);
 227         if (input[0] == '#') { // Ignore comments.
 228             free(input);
 229             continue;
 230         }
 231         // We have a 'normal' line; leave the loop.
 232         break;
 233     }
 234
 235     // Strip trailing newlines from the input
 236     input[strcspn(input, "\n")] = 0;
 237
 238     add_history(input);
 239
 240     if (!isatty(0))
 241         echo_input(stdout, input_prompt, input);
 242
 243     if (settings.logfp)
 244         echo_input(settings.logfp, "", input);
 245
 246     return (input);
 247 }
 248
 249 bool silent_yes(void)
 250 {
 251     bool outcome = false;
 252
 253     for (;;) {
 254         char* reply = get_input();
 255         if (reply == NULL) {
 256             // LCOV_EXCL_START
 257             // Should be unreachable. Reply should never be NULL
 258             free(reply);
 259             exit(EXIT_SUCCESS);
 260             // LCOV_EXCL_STOP
 261         }
 262         if (strlen(reply) == 0) {
 263             free(reply);
 264             rspeak(PLEASE_ANSWER);
 265             continue;
 266         }
 267
 268         char* firstword = (char*) xcalloc(strlen(reply) + 1);
 269         sscanf(reply, "%s", firstword);
 270
 271         free(reply);
 272
 273         for (int i = 0; i < (int)strlen(firstword); ++i)
 274             firstword[i] = tolower(firstword[i]);
 275
 276         int yes = strncmp("yes", firstword, sizeof("yes") - 1);
 277         int y = strncmp("y", firstword, sizeof("y") - 1);
 278         int no = strncmp("no", firstword, sizeof("no") - 1);
 279         int n = strncmp("n", firstword, sizeof("n") - 1);
 280
 281         free(firstword);
 282
 283         if (yes == 0 ||
 284             y == 0) {
 285             outcome = true;
 286             break;
 287         } else if (no == 0 ||
 288                    n == 0) {
 289             outcome = false;
 290             break;
 291         } else
 292             rspeak(PLEASE_ANSWER);
 293     }
 294     return (outcome);
 295 }
 296
 297
 298 bool yes(const char* question, const char* yes_response, const char* no_response)
 299 /*  Print message X, wait for yes/no answer.  If yes, print Y and return true;
 300  *  if no, print Z and return false. */
 301 {
 302     bool outcome = false;
 303
 304     for (;;) {
 305         speak(question);
 306
 307         char* reply = get_input();
 308         if (reply == NULL) {
 309             // LCOV_EXCL_START
 310             // Should be unreachable. Reply should never be NULL
 311             free(reply);
 312             exit(EXIT_SUCCESS);
 313             // LCOV_EXCL_STOP
 314         }
 315
 316         if (strlen(reply) == 0) {
 317             free(reply);
 318             rspeak(PLEASE_ANSWER);
 319             continue;
 320         }
 321
 322         char* firstword = (char*) xcalloc(strlen(reply) + 1);
 323         sscanf(reply, "%s", firstword);
 324
 325         free(reply);
 326
 327         for (int i = 0; i < (int)strlen(firstword); ++i)
 328             firstword[i] = tolower(firstword[i]);
 329
 330         int yes = strncmp("yes", firstword, sizeof("yes") - 1);
 331         int y = strncmp("y", firstword, sizeof("y") - 1);
 332         int no = strncmp("no", firstword, sizeof("no") - 1);
 333         int n = strncmp("n", firstword, sizeof("n") - 1);
 334
 335         free(firstword);
 336
 337         if (yes == 0 ||
 338             y == 0) {
 339             speak(yes_response);
 340             outcome = true;
 341             break;
 342         } else if (no == 0 ||
 343                    n == 0) {
 344             speak(no_response);
 345             outcome = false;
 346             break;
 347         } else
 348             rspeak(PLEASE_ANSWER);
 349
 350     }
 351
 352     return (outcome);
 353 }
 354
 355 /*  Data structure  routines */
 356
 357 static int get_motion_vocab_id(const char* word)
 358 // Return the first motion number that has 'word' as one of its words.
 359 {
 360     for (int i = 0; i < NMOTIONS; ++i) {
 361         for (int j = 0; j < motions[i].words.n; ++j) {
 362             if (strncasecmp(word, motions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
 363                     strchr(ignore, word[0]) == NULL ||
 364                     !settings.oldstyle))
 365                 return (i);
 366         }
 367     }
 368     // If execution reaches here, we didn't find the word.
 369     return (WORD_NOT_FOUND);
 370 }
 371
 372 static int get_object_vocab_id(const char* word)
 373 // Return the first object number that has 'word' as one of its words.
 374 {
 375     for (int i = 0; i < NOBJECTS + 1; ++i) { // FIXME: the + 1 should go when 1-indexing for objects is removed
 376         for (int j = 0; j < objects[i].words.n; ++j) {
 377             if (strncasecmp(word, objects[i].words.strs[j], TOKLEN) == 0)
 378                 return (i);
 379         }
 380     }
 381     // If execution reaches here, we didn't find the word.
 382     return (WORD_NOT_FOUND);
 383 }
 384
 385 static int get_action_vocab_id(const char* word)
 386 // Return the first motion number that has 'word' as one of its words.
 387 {
 388     for (int i = 0; i < NACTIONS; ++i) {
 389         for (int j = 0; j < actions[i].words.n; ++j) {
 390             if (strncasecmp(word, actions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
 391                     strchr(ignore, word[0]) == NULL ||
 392                     !settings.oldstyle))
 393                 return (i);
 394         }
 395     }
 396     // If execution reaches here, we didn't find the word.
 397     return (WORD_NOT_FOUND);
 398 }
 399
 400 static bool is_valid_int(const char *str)
 401 /* Returns true if the string passed in is represents a valid integer,
 402  * that could then be parsed by atoi() */
 403 {
 404     // Handle negative number
 405     if (*str == '-')
 406         ++str;
 407
 408     // Handle empty string or just "-". Should never reach this
 409     // point, because this is only used with transitive verbs.
 410     if (!*str)
 411         return false; // LCOV_EXCL_LINE
 412
 413     // Check for non-digit chars in the rest of the stirng.
 414     while (*str) {
 415         if (!isdigit(*str))
 416             return false;
 417         else
 418             ++str;
 419     }
 420
 421     return true;
 422 }
 423
 424 static void get_vocab_metadata(command_word_t* word)
 425 {
 426     /* Check for an empty string */
 427     if (strncmp(word->raw, "", sizeof("")) == 0) {
 428         word->id = WORD_EMPTY;
 429         word->type = NO_WORD_TYPE;
 430         return;
 431     }
 432
 433     vocab_t ref_num;
 434
 435     ref_num = get_motion_vocab_id(word->raw);
 436     if (ref_num != WORD_NOT_FOUND) {
 437         word->id = ref_num;
 438         word->type = MOTION;
 439         return;
 440     }
 441
 442     ref_num = get_object_vocab_id(word->raw);
 443     if (ref_num != WORD_NOT_FOUND) {
 444         word->id = ref_num;
 445         word->type = OBJECT;
 446         return;
 447     }
 448
 449     ref_num = get_action_vocab_id(word->raw);
 450     if (ref_num != WORD_NOT_FOUND) {
 451         word->id = ref_num;
 452         word->type = ACTION;
 453         return;
 454     }
 455
 456     // Check for the reservoir magic word.
 457     if (strcasecmp(word->raw, game.zzword) == 0) {
 458         word->id = PART;
 459         word->type = ACTION;
 460         return;
 461     }
 462
 463     // Check words that are actually numbers.
 464     if (is_valid_int(word->raw)) {
 465         word->id = WORD_EMPTY;
 466         word->type = NUMERIC;
 467         return;
 468     }
 469
 470     word->id = WORD_NOT_FOUND;
 471     word->type = NO_WORD_TYPE;
 472     return;
 473 }
 474
 475 static void tokenize(char* raw, command_t *cmd)
 476 {
 477     memset(cmd, '\0', sizeof(command_t));
 478
 479     /* Bound prefix on the %s would be needed to prevent buffer
 480      * overflow.  but we shortstop this more simply by making each
 481      * raw-input buffer as long as the entire input buffer. */
 482     sscanf(raw, "%s%s", cmd->word[0].raw, cmd->word[1].raw);
 483
 484     /* (ESR) In oldstyle mode, simulate the uppercasing and truncating
 485      * effect on raw tokens of packing them into sixbit characters, 5
 486      * to a 32-bit word.  This is something the FORTRAN version did
 487      * becuse archaic FORTRAN had no string types.  Don Wood's
 488      * mechanical translation of 2.5 to C retained the packing and
 489      * thus this misfeature.
 490      *
 491      * It's philosophically questionable whether this is the right
 492      * thing to do even in oldstyle mode.  On one hand, the text
 493      * mangling was not authorial intent, but a result of limitations
 494      * in their tools. On the other, not simulating this misbehavior
 495      * goes against the goal of making oldstyle as accurate as
 496      * possible an emulation of the original UI.
 497      */
 498     if (settings.oldstyle) {
 499         cmd->word[0].raw[TOKLEN + TOKLEN] = cmd->word[1].raw[TOKLEN + TOKLEN] = '\0';
 500         for (size_t i = 0; i < strlen(cmd->word[0].raw); i++)
 501             cmd->word[0].raw[i] = toupper(cmd->word[0].raw[i]);
 502         for (size_t i = 0; i < strlen(cmd->word[1].raw); i++)
 503             cmd->word[1].raw[i] = toupper(cmd->word[1].raw[i]);
 504     }
 505
 506     /* populate command with parsed vocabulary metadata */
 507     get_vocab_metadata(&(cmd->word[0]));
 508     get_vocab_metadata(&(cmd->word[1]));
 509 }
 510
 511 bool get_command_input(command_t *command)
 512 /* Get user input on stdin, parse and map to command */
 513 {
 514     char inputbuf[LINESIZE];
 515     char* input;
 516
 517     for (;;) {
 518         input = get_input();
 519         if (input == NULL)
 520             return false;
 521         if (word_count(input) > 2) {
 522             rspeak(TWO_WORDS);
 523             free(input);
 524             continue;
 525         }
 526         if (strcmp(input, "") != 0)
 527             break;
 528         free(input);
 529     }
 530
 531     strncpy(inputbuf, input, LINESIZE - 1);
 532     free(input);
 533
 534     tokenize(inputbuf, command);
 535
 536     return true;
 537 }
 538
 539 void juggle(obj_t object)
 540 /*  Juggle an object by picking it up and putting it down again, the purpose
 541  *  being to get the object to the front of the chain of things at its loc. */
 542 {
 543     loc_t i, j;
 544
 545     i = game.place[object];
 546     j = game.fixed[object];
 547     move(object, i);
 548     move(object + NOBJECTS, j);
 549 }
 550
 551 void move(obj_t object, loc_t where)
 552 /*  Place any object anywhere by picking it up and dropping it.  May
 553  *  already be toting, in which case the carry is a no-op.  Mustn't
 554  *  pick up objects which are not at any loc, since carry wants to
 555  *  remove objects from game.atloc chains. */
 556 {
 557     loc_t from;
 558
 559     if (object > NOBJECTS)
 560         from = game.fixed[object - NOBJECTS];
 561     else
 562         from = game.place[object];
 563     /* (ESR) Used to check for !SPECIAL(from). I *think* that was wrong... */
 564     if (from != LOC_NOWHERE && from != CARRIED)
 565         carry(object, from);
 566     drop(object, where);
 567 }
 568
 569 loc_t put(obj_t object, loc_t where, long pval)
 570 /*  put() is the same as move(), except it returns a value used to set up the
 571  *  negated game.prop values for the repository objects. */
 572 {
 573     move(object, where);
 574     return STASHED(pval);
 575 }
 576
 577 void carry(obj_t object, loc_t where)
 578 /*  Start toting an object, removing it from the list of things at its former
 579  *  location.  Incr holdng unless it was already being toted.  If object>NOBJECTS
 580  *  (moving "fixed" second loc), don't change game.place or game.holdng. */
 581 {
 582     long temp;
 583
 584     if (object <= NOBJECTS) {
 585         if (game.place[object] == CARRIED)
 586             return;
 587         game.place[object] = CARRIED;
 588
 589         if (object!= BIRD)
 590             ++game.holdng;
 591     }
 592     if (game.atloc[where] == object) {
 593         game.atloc[where] = game.link[object];
 594         return;
 595     }
 596     temp = game.atloc[where];
 597     while (game.link[temp] != object) {
 598         temp = game.link[temp];
 599     }
 600     game.link[temp] = game.link[object];
 601 }
 602
 603 void drop(obj_t object, loc_t where)
 604 /*  Place an object at a given loc, prefixing it onto the game.atloc list.  Decr
 605  *  game.holdng if the object was being toted. */
 606 {
 607     if (object > NOBJECTS)
 608         game.fixed[object - NOBJECTS] = where;
 609     else {
 610         if (game.place[object] == CARRIED)
 611             if (object != BIRD)
 612                 /* The bird has to be weightless.  This ugly hack (and the
 613                  * corresponding code in the drop function) brought to you
 614                  * by the fact that when the bird is caged, we need to be able
 615                  * to either 'take bird' or 'take cage' and have the right thing
 616                  * happen.
 617                  */
 618                 --game.holdng;
 619         game.place[object] = where;
 620     }
 621     if (where == LOC_NOWHERE ||
 622         where == CARRIED)
 623         return;
 624     game.link[object] = game.atloc[where];
 625     game.atloc[where] = object;
 626 }
 627
 628 int atdwrf(loc_t where)
 629 /*  Return the index of first dwarf at the given location, zero if no dwarf is
 630  *  there (or if dwarves not active yet), -1 if all dwarves are dead.  Ignore
 631  *  the pirate (6th dwarf). */
 632 {
 633     int at;
 634
 635     at = 0;
 636     if (game.dflag < 2)
 637         return at;
 638     at = -1;
 639     for (long i = 1; i <= NDWARVES - 1; i++) {
 640         if (game.dloc[i] == where)
 641             return i;
 642         if (game.dloc[i] != 0)
 643             at = 0;
 644     }
 645     return at;
 646 }
 647
 648 /*  Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
 649  *  randrange) */
 650
 651 long setbit(int bit)
 652 /*  Returns 2**bit for use in constructing bit-masks. */
 653 {
 654     return (1L << bit);
 655 }
 656
 657 bool tstbit(long mask, int bit)
 658 /*  Returns true if the specified bit is set in the mask. */
 659 {
 660     return (mask & (1 << bit)) != 0;
 661 }
 662
 663 void set_seed(int32_t seedval)
 664 /* Set the LCG seed */
 665 {
 666     game.lcg_x = seedval % LCG_M;
 667     if (game.lcg_x < 0) {
 668         game.lcg_x = LCG_M + game.lcg_x;
 669     }
 670     // once seed is set, we need to generate the Z`ZZZ word
 671     for (int i = 0; i < 5; ++i) {
 672         game.zzword[i] = 'A' + randrange(26);
 673     }
 674     game.zzword[1] = '\''; // force second char to apostrophe
 675     game.zzword[5] = '\0';
 676 }
 677
 678 static int32_t get_next_lcg_value(void)
 679 /* Return the LCG's current value, and then iterate it. */
 680 {
 681     int32_t old_x = game.lcg_x;
 682     game.lcg_x = (LCG_A * game.lcg_x + LCG_C) % LCG_M;
 683     return old_x;
 684 }
 685
 686 int32_t randrange(int32_t range)
 687 /* Return a random integer from [0, range). */
 688 {
 689     return range * get_next_lcg_value() / LCG_M;
 690 }
 691
 692 // LCOV_EXCL_START
 693 void bug(enum bugtype num, const char *error_string)
 694 {
 695     fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
 696     exit(EXIT_FAILURE);
 697 }
 698 // LCOV_EXCL_STOP
 699
 700 /* end */
 701
 702 void state_change(obj_t obj, int state)
 703 /* Object must have a change-message list for this to be useful; only some do */
 704 {
 705     game.prop[obj] = state;
 706     pspeak(obj, change, state, true);
 707 }
 708
 709 /* end */