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
   9 #include "advent.h"
  10 #include "linenoise/linenoise.h"
  11 #include "dungeon.h"
  12
  13 char* xstrdup(const char* s)
  14 {
  15     char* ptr = strdup(s);
  16     if (ptr == NULL) {
  17         // LCOV_EXCL_START
  18         // exclude from coverage analysis because we can't simulate an out of memory error in testing
  19         fprintf(stderr, "Out of memory!\n");
  20         exit(EXIT_FAILURE);
  21     }
  22     return (ptr);
  23 }
  24
  25 void* xmalloc(size_t size)
  26 {
  27     void* ptr = malloc(size);
  28     if (ptr == NULL) {
  29         // LCOV_EXCL_START
  30         // exclude from coverage analysis because we can't simulate an out of memory error in testing
  31         fprintf(stderr, "Out of memory!\n");
  32         exit(EXIT_FAILURE);
  33         // LCOV_EXCL_STOP
  34     }
  35     return (ptr);
  36 }
  37
  38 void packed_to_token(long packed, char token[6])
  39 {
  40   // The advent->ascii mapping.
  41   const char advent_to_ascii[] = {
  42     ' ', '!', '"', '#', '$', '%', '&', '\'',
  43     '(', ')', '*', '+', ',', '-', '.', '/',
  44     '0', '1', '2', '3', '4', '5', '6', '7',
  45     '8', '9', ':', ';', '<', '=', '>', '?',
  46     '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
  47     'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
  48     'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
  49     'X', 'Y', 'Z', '\0', '\0', '\0', '\0', '\0',
  50 };
  51
  52     // Unpack and map back to ASCII.
  53     for (int i = 0; i < 5; ++i) {
  54         char advent = (packed >> i * 6) & 63;
  55         token[i] = advent_to_ascii[(int) advent];
  56     }
  57
  58     // Ensure the last character is \0.
  59     token[5] = '\0';
  60
  61     // Replace trailing whitespace with \0.
  62     for (int i = 4; i >= 0; --i) {
  63         if (token[i] == ' ' || token[i] == '\t')
  64             token[i] = '\0';
  65         else
  66             break;
  67     }
  68 }
  69
  70 long token_to_packed(const char token[6])
  71 {
  72   const char ascii_to_advent[] = {
  73     63, 63, 63, 63, 63, 63, 63, 63,
  74     63, 63, 63, 63, 63, 63, 63, 63,
  75     63, 63, 63, 63, 63, 63, 63, 63,
  76     63, 63, 63, 63, 63, 63, 63, 63,
  77
  78     0, 1, 2, 3, 4, 5, 6, 7,
  79     8, 9, 10, 11, 12, 13, 14, 15,
  80     16, 17, 18, 19, 20, 21, 22, 23,
  81     24, 25, 26, 27, 28, 29, 30, 31,
  82     32, 33, 34, 35, 36, 37, 38, 39,
  83     40, 41, 42, 43, 44, 45, 46, 47,
  84     48, 49, 50, 51, 52, 53, 54, 55,
  85     56, 57, 58, 59, 60, 61, 62, 63,
  86
  87     63, 63, 63, 63, 63, 63, 63, 63,
  88     63, 63, 63, 63, 63, 63, 63, 63,
  89     63, 63, 63, 63, 63, 63, 63, 63,
  90     63, 63, 63, 63, 63, 63, 63, 63,
  91 };
  92
  93     size_t t_len = strlen(token);
  94     long packed = 0;
  95     for (size_t i = 0; i < t_len; ++i) {
  96         char mapped = ascii_to_advent[(int) token[i]];
  97         packed |= (mapped << (6 * i));
  98     }
  99     return (packed);
 100 }
 101
 102 void tokenize(char* raw, long tokens[4])
 103 {
 104     // set each token to 0
 105     for (int i = 0; i < 4; ++i)
 106         tokens[i] = 0;
 107
 108     // grab the first two words
 109     char* words[2];
 110     words[0] = (char*) xmalloc(strlen(raw) + 1);
 111     words[1] = (char*) xmalloc(strlen(raw) + 1);
 112     int word_count = sscanf(raw, "%s%s", words[0], words[1]);
 113
 114     // make space for substrings and zero it out
 115     char chunk_data[][6] = {
 116         {"\0\0\0\0\0"},
 117         {"\0\0\0\0\0"},
 118         {"\0\0\0\0\0"},
 119         {"\0\0\0\0\0"},
 120     };
 121
 122     // break the words into up to 4 5-char substrings
 123     sscanf(words[0], "%5s%5s", chunk_data[0], chunk_data[1]);
 124     if (word_count == 2)
 125         sscanf(words[1], "%5s%5s", chunk_data[2], chunk_data[3]);
 126     free(words[0]);
 127     free(words[1]);
 128
 129     // uppercase all the substrings
 130     for (int i = 0; i < 4; ++i)
 131         for (unsigned int j = 0; j < strlen(chunk_data[i]); ++j)
 132             chunk_data[i][j] = (char) toupper(chunk_data[i][j]);
 133
 134     // pack the substrings
 135     for (int i = 0; i < 4; ++i)
 136         tokens[i] = token_to_packed(chunk_data[i]);
 137 }
 138
 139 /* Hide the fact that wods are corrently packed longs */
 140
 141 bool wordeq(token_t a, token_t b)
 142 {
 143     return a == b;
 144 }
 145
 146 bool wordempty(token_t a)
 147 {
 148     return a == 0;
 149 }
 150
 151 void wordclear(token_t *v)
 152 {
 153     *v = 0;
 154 }
 155
 156 /*  I/O routines (speak, pspeak, rspeak, get_input, yes) */
 157
 158 void vspeak(const char* msg, va_list ap)
 159 {
 160     // Do nothing if we got a null pointer.
 161     if (msg == NULL)
 162         return;
 163
 164     // Do nothing if we got an empty string.
 165     if (strlen(msg) == 0)
 166         return;
 167
 168     // Print a newline if the global game.blklin says to.
 169     if (game.blklin == true)
 170         printf("\n");
 171
 172     int msglen = strlen(msg);
 173
 174     // Rendered string
 175     ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
 176     char* rendered = xmalloc(size);
 177     char* renderp = rendered;
 178
 179     // Handle format specifiers (including the custom %C, %L, %S) by adjusting the parameter accordingly, and replacing the specifier with %s.
 180     long previous_arg = 0;
 181     for (int i = 0; i < msglen; i++) {
 182         if (msg[i] != '%') {
 183             *renderp++ = msg[i];
 184             size--;
 185         } else {
 186             long arg = va_arg(ap, long);
 187             if (arg == -1)
 188                 arg = 0;
 189             i++;
 190             // 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.
 191             if (msg[i] == 'd') {
 192                 int ret = snprintf(renderp, size, "%ld", arg);
 193                 if (ret < size) {
 194                     renderp += ret;
 195                     size -= ret;
 196                 }
 197             }
 198
 199             // Unmodified string specifier.
 200             if (msg[i] == 's') {
 201                 packed_to_token(arg, renderp); /* unpack directly to destination */
 202                 size_t len = strlen(renderp);
 203                 renderp += len;
 204                 size -= len;
 205             }
 206
 207             // Singular/plural specifier.
 208             if (msg[i] == 'S') {
 209                 if (previous_arg > 1) { // look at the *previous* parameter (which by necessity must be numeric)
 210                     *renderp++ = 's';
 211                     size--;
 212                 }
 213             }
 214
 215             // All-lowercase specifier.
 216             if (msg[i] == 'L' || msg[i] == 'C') {
 217                 packed_to_token(arg, renderp); /* unpack directly to destination */
 218                 int len = strlen(renderp);
 219                 for (int j = 0; j < len; ++j) {
 220                     renderp[j] = tolower(renderp[j]);
 221                 }
 222                 if (msg[i] == 'C') // First char uppercase, rest lowercase.
 223                     renderp[0] = toupper(renderp[0]);
 224                 renderp += len;
 225                 size -= len;
 226             }
 227
 228             previous_arg = arg;
 229         }
 230     }
 231     *renderp = 0;
 232
 233     // Print the message.
 234     printf("%s\n", rendered);
 235
 236     free(rendered);
 237 }
 238
 239 void speak(const char* msg, ...)
 240 {
 241     va_list ap;
 242     va_start(ap, msg);
 243     vspeak(msg, ap);
 244     va_end(ap);
 245 }
 246
 247 void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
 248 /* Find the skip+1st message from msg and print it.  Modes are:
 249  * feel = for inventory, what you can touch
 250  * look = the long description for the state the object is in
 251  * listen = the sound for the state the object is in
 252  * study = text on the object. */
 253 {
 254     va_list ap;
 255     va_start(ap, skip);
 256     switch (mode) {
 257     case touch:
 258         vspeak(objects[msg].inventory, ap);
 259         break;
 260     case look:
 261         vspeak(objects[msg].descriptions[skip], ap);
 262         break;
 263     case hear:
 264         vspeak(objects[msg].sounds[skip], ap);
 265         break;
 266     case study:
 267         vspeak(objects[msg].texts[skip], ap);
 268         break;
 269     case change:
 270         vspeak(objects[msg].changes[skip], ap);
 271         break;
 272     }
 273     va_end(ap);
 274 }
 275
 276 void rspeak(vocab_t i, ...)
 277 /* Print the i-th "random" message (section 6 of database). */
 278 {
 279     va_list ap;
 280     va_start(ap, i);
 281     vspeak(arbitrary_messages[i], ap);
 282     va_end(ap);
 283 }
 284
 285 void echo_input(FILE* destination, char* input_prompt, char* input)
 286 {
 287     size_t len = strlen(input_prompt) + strlen(input) + 1;
 288     char* prompt_and_input = (char*) xmalloc(len);
 289     strcpy(prompt_and_input, input_prompt);
 290     strcat(prompt_and_input, input);
 291     fprintf(destination, "%s\n", prompt_and_input);
 292     free(prompt_and_input);
 293 }
 294
 295 int word_count(char* s)
 296 {
 297     char* copy = xstrdup(s);
 298     char delims[] = " \t";
 299     int count = 0;
 300     char* word;
 301
 302     word = strtok(copy, delims);
 303     while (word != NULL) {
 304         word = strtok(NULL, delims);
 305         ++count;
 306     }
 307     free(copy);
 308     return (count);
 309 }
 310
 311 char* get_input()
 312 {
 313     // Set up the prompt
 314     char input_prompt[] = "> ";
 315     if (!prompt)
 316         input_prompt[0] = '\0';
 317
 318     // Print a blank line if game.blklin tells us to.
 319     if (game.blklin == true)
 320         printf("\n");
 321
 322     char* input;
 323     while (true) {
 324         if (editline)
 325             input = linenoise(input_prompt);
 326         else {
 327             input = NULL;
 328             size_t n = 0;
 329             if (isatty(0))
 330                 // LCOV_EXCL_START
 331                 // Should be unreachable in tests, as they will use a non-interactive shell.
 332                 printf("%s", input_prompt);
 333             // LCOV_EXCL_STOP
 334             ssize_t numread = getline(&input, &n, stdin);
 335             if (numread == -1) // Got EOF; return with it.
 336                 return (NULL);
 337         }
 338
 339         if (input == NULL) // Got EOF; return with it.
 340             return (input);
 341         else if (input[0] == '#') // Ignore comments.
 342             continue;
 343         else // We have a 'normal' line; leave the loop.
 344             break;
 345     }
 346
 347     // Strip trailing newlines from the input
 348     input[strcspn(input, "\n")] = 0;
 349
 350     linenoiseHistoryAdd(input);
 351
 352     if (!isatty(0))
 353         echo_input(stdout, input_prompt, input);
 354
 355     if (logfp)
 356         echo_input(logfp, input_prompt, input);
 357
 358     return (input);
 359 }
 360
 361 bool silent_yes()
 362 {
 363     char* reply;
 364     bool outcome;
 365
 366     for (;;) {
 367         reply = get_input();
 368         if (reply == NULL) {
 369             // LCOV_EXCL_START
 370             // Should be unreachable. Reply should never be NULL
 371             linenoiseFree(reply);
 372             exit(EXIT_SUCCESS);
 373             // LCOV_EXCL_STOP
 374         }
 375
 376         char* firstword = (char*) xmalloc(strlen(reply) + 1);
 377         sscanf(reply, "%s", firstword);
 378
 379         for (int i = 0; i < (int)strlen(firstword); ++i)
 380             firstword[i] = tolower(firstword[i]);
 381
 382         int yes = strncmp("yes", firstword, sizeof("yes") - 1);
 383         int y = strncmp("y", firstword, sizeof("y") - 1);
 384         int no = strncmp("no", firstword, sizeof("no") - 1);
 385         int n = strncmp("n", firstword, sizeof("n") - 1);
 386
 387         free(firstword);
 388
 389         if (yes == 0 || y == 0) {
 390             outcome = true;
 391             break;
 392         } else if (no == 0 || n == 0) {
 393             outcome = false;
 394             break;
 395         } else
 396             rspeak(PLEASE_ANSWER);
 397     }
 398     linenoiseFree(reply);
 399     return (outcome);
 400 }
 401
 402
 403 bool yes(const char* question, const char* yes_response, const char* no_response)
 404 /*  Print message X, wait for yes/no answer.  If yes, print Y and return true;
 405  *  if no, print Z and return false. */
 406 {
 407     char* reply;
 408     bool outcome;
 409
 410     for (;;) {
 411         speak(question);
 412
 413         reply = get_input();
 414         if (reply == NULL) {
 415             // LCOV_EXCL_START
 416             // Should be unreachable. Reply should never be NULL
 417             linenoiseFree(reply);
 418             exit(EXIT_SUCCESS);
 419             // LCOV_EXCL_STOP
 420         }
 421
 422         char* firstword = (char*) xmalloc(strlen(reply) + 1);
 423         sscanf(reply, "%s", firstword);
 424
 425         for (int i = 0; i < (int)strlen(firstword); ++i)
 426             firstword[i] = tolower(firstword[i]);
 427
 428         int yes = strncmp("yes", firstword, sizeof("yes") - 1);
 429         int y = strncmp("y", firstword, sizeof("y") - 1);
 430         int no = strncmp("no", firstword, sizeof("no") - 1);
 431         int n = strncmp("n", firstword, sizeof("n") - 1);
 432
 433         free(firstword);
 434
 435         if (yes == 0 || y == 0) {
 436             speak(yes_response);
 437             outcome = true;
 438             break;
 439         } else if (no == 0 || n == 0) {
 440             speak(no_response);
 441             outcome = false;
 442             break;
 443         } else
 444             rspeak(PLEASE_ANSWER);
 445     }
 446     linenoiseFree(reply);
 447     return (outcome);
 448 }
 449
 450 /*  Data structure  routines */
 451
 452 int get_motion_vocab_id(const char* word)
 453 // Return the first motion number that has 'word' as one of its words.
 454 {
 455     for (int i = 0; i < NMOTIONS; ++i) {
 456         for (int j = 0; j < motions[i].words.n; ++j) {
 457             if (strcasecmp(word, motions[i].words.strs[j]) == 0)
 458                 return (i);
 459         }
 460     }
 461     // If execution reaches here, we didn't find the word.
 462     return (WORD_NOT_FOUND);
 463 }
 464
 465 int get_object_vocab_id(const char* word)
 466 // Return the first object number that has 'word' as one of its words.
 467 {
 468     for (int i = 0; i < NOBJECTS + 1; ++i) { // FIXME: the + 1 should go when 1-indexing for objects is removed
 469         for (int j = 0; j < objects[i].words.n; ++j) {
 470             if (strcasecmp(word, objects[i].words.strs[j]) == 0)
 471                 return (i);
 472         }
 473     }
 474     // If execution reaches here, we didn't find the word.
 475     return (WORD_NOT_FOUND);
 476 }
 477
 478 int get_action_vocab_id(const char* word)
 479 // Return the first motion number that has 'word' as one of its words.
 480 {
 481     for (int i = 0; i < NACTIONS; ++i) {
 482         for (int j = 0; j < actions[i].words.n; ++j) {
 483             if (strcasecmp(word, actions[i].words.strs[j]) == 0)
 484                 return (i);
 485         }
 486     }
 487     // If execution reaches here, we didn't find the word.
 488     return (WORD_NOT_FOUND);
 489 }
 490
 491 int get_special_vocab_id(const char* word)
 492 // Return the first special number that has 'word' as one of its words.
 493 {
 494     for (int i = 0; i < NSPECIALS; ++i) {
 495         for (int j = 0; j < specials[i].words.n; ++j) {
 496             if (strcasecmp(word, specials[i].words.strs[j]) == 0)
 497                 return (i);
 498         }
 499     }
 500     // If execution reaches here, we didn't find the word.
 501     return (WORD_NOT_FOUND);
 502 }
 503
 504 long get_vocab_id(const char* word)
 505 // Search the vocab categories in order for the supplied word.
 506 {
 507     long ref_num;
 508
 509     ref_num = get_motion_vocab_id(word);
 510     if (ref_num != WORD_NOT_FOUND)
 511         return (ref_num + 0); // FIXME: replace with a proper hash
 512
 513     ref_num = get_object_vocab_id(word);
 514     if (ref_num != WORD_NOT_FOUND)
 515         return (ref_num + 1000); // FIXME: replace with a proper hash
 516
 517     ref_num = get_action_vocab_id(word);
 518     if (ref_num != WORD_NOT_FOUND)
 519         return (ref_num + 2000); // FIXME: replace with a proper hash
 520
 521     ref_num = get_special_vocab_id(word);
 522     if (ref_num != WORD_NOT_FOUND)
 523         return (ref_num + 3000); // FIXME: replace with a proper hash
 524
 525     // Check for the reservoir magic word.
 526     if (strcasecmp(word, game.zzword) == 0)
 527         return (PART + 2000); // FIXME: replace with a proper hash
 528
 529     return (WORD_NOT_FOUND);
 530 }
 531
 532 void juggle(long object)
 533 /*  Juggle an object by picking it up and putting it down again, the purpose
 534  *  being to get the object to the front of the chain of things at its loc. */
 535 {
 536     long i, j;
 537
 538     i = game.place[object];
 539     j = game.fixed[object];
 540     move(object, i);
 541     move(object + NOBJECTS, j);
 542 }
 543
 544 void move(long object, long where)
 545 /*  Place any object anywhere by picking it up and dropping it.  May
 546  *  already be toting, in which case the carry is a no-op.  Mustn't
 547  *  pick up objects which are not at any loc, since carry wants to
 548  *  remove objects from game.atloc chains. */
 549 {
 550     long from;
 551
 552     if (object > NOBJECTS)
 553         from = game.fixed[object - NOBJECTS];
 554     else
 555         from = game.place[object];
 556     if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
 557         carry(object, from);
 558     drop(object, where);
 559 }
 560
 561 long put(long object, long 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 (-1) - pval;;
 567 }
 568
 569 void carry(long object, long 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(long object, long 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 <= 0)
 605         return;
 606     game.link[object] = game.atloc[where];
 607     game.atloc[where] = object;
 608 }
 609
 610 long atdwrf(long where)
 611 /*  Return the index of first dwarf at the given location, zero if no dwarf is
 612  *  there (or if dwarves not active yet), -1 if all dwarves are dead.  Ignore
 613  *  the pirate (6th dwarf). */
 614 {
 615     long at;
 616
 617     at = 0;
 618     if (game.dflag < 2)
 619         return (at);
 620     at = -1;
 621     for (long i = 1; i <= NDWARVES - 1; i++) {
 622         if (game.dloc[i] == where)
 623             return i;
 624         if (game.dloc[i] != 0)
 625             at = 0;
 626     }
 627     return (at);
 628 }
 629
 630 /*  Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
 631  *  randrange, RNDVOC) */
 632
 633 long setbit(long bit)
 634 /*  Returns 2**bit for use in constructing bit-masks. */
 635 {
 636     return (1L << bit);
 637 }
 638
 639 bool tstbit(long mask, int bit)
 640 /*  Returns true if the specified bit is set in the mask. */
 641 {
 642     return (mask & (1 << bit)) != 0;
 643 }
 644
 645 void set_seed(long seedval)
 646 /* Set the LCG seed */
 647 {
 648     game.lcg_x = (unsigned long) seedval % game.lcg_m;
 649 }
 650
 651 unsigned long get_next_lcg_value(void)
 652 /* Return the LCG's current value, and then iterate it. */
 653 {
 654     unsigned long old_x = game.lcg_x;
 655     game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m;
 656     return old_x;
 657 }
 658
 659 long randrange(long range)
 660 /* Return a random integer from [0, range). */
 661 {
 662     return range * get_next_lcg_value() / game.lcg_m;
 663 }
 664
 665 void make_zzword(char zzword[6])
 666 {
 667     for (int i = 0; i < 5; ++i) {
 668         zzword[i] = 'A' + randrange(26);
 669     }
 670     zzword[1] = '\''; // force second char to apostrophe
 671     zzword[5] = '\0';
 672 }
 673
 674 void datime(long* d, long* t)
 675 {
 676     struct timeval tv;
 677     gettimeofday(&tv, NULL);
 678     *d = (long) tv.tv_sec;
 679     *t = (long) tv.tv_usec;
 680 }
 681
 682 // LCOV_EXCL_START
 683 void bug(enum bugtype num, const char *error_string)
 684 {
 685     fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
 686     exit(EXIT_FAILURE);
 687 }
 688 // LCOV_EXCL_STOP
 689
 690 /* end */