misc.c

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