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