Improve state-macro encapsulation.
[open-adventure.git] / misc.c
1 /*
2  * I/O and support routines.
3  *
4  * SPDX-FileCopyrightText: 1977, 2005 by Will Crowther and Don Woods
5  * SPDX-FileCopyrightText: 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 || y == 0) {
339             speak(yes_response);
340             outcome = true;
341             break;
342         } else if (no == 0 || n == 0) {
343             speak(no_response);
344             outcome = false;
345             break;
346         } else
347             rspeak(PLEASE_ANSWER);
348
349     }
350
351     return (outcome);
352 }
353
354 /*  Data structure  routines */
355
356 static int get_motion_vocab_id(const char* word)
357 // Return the first motion number that has 'word' as one of its words.
358 {
359     for (int i = 0; i < NMOTIONS; ++i) {
360         for (int j = 0; j < motions[i].words.n; ++j) {
361             if (strncasecmp(word, motions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
362                     strchr(ignore, word[0]) == NULL ||
363                     !settings.oldstyle))
364                 return (i);
365         }
366     }
367     // If execution reaches here, we didn't find the word.
368     return (WORD_NOT_FOUND);
369 }
370
371 static int get_object_vocab_id(const char* word)
372 // Return the first object number that has 'word' as one of its words.
373 {
374     for (int i = 0; i < NOBJECTS + 1; ++i) { // FIXME: the + 1 should go when 1-indexing for objects is removed
375         for (int j = 0; j < objects[i].words.n; ++j) {
376             if (strncasecmp(word, objects[i].words.strs[j], TOKLEN) == 0)
377                 return (i);
378         }
379     }
380     // If execution reaches here, we didn't find the word.
381     return (WORD_NOT_FOUND);
382 }
383
384 static int get_action_vocab_id(const char* word)
385 // Return the first motion number that has 'word' as one of its words.
386 {
387     for (int i = 0; i < NACTIONS; ++i) {
388         for (int j = 0; j < actions[i].words.n; ++j) {
389             if (strncasecmp(word, actions[i].words.strs[j], TOKLEN) == 0 && (strlen(word) > 1 ||
390                     strchr(ignore, word[0]) == NULL ||
391                     !settings.oldstyle))
392                 return (i);
393         }
394     }
395     // If execution reaches here, we didn't find the word.
396     return (WORD_NOT_FOUND);
397 }
398
399 static bool is_valid_int(const char *str)
400 /* Returns true if the string passed in is represents a valid integer,
401  * that could then be parsed by atoi() */
402 {
403     // Handle negative number
404     if (*str == '-')
405         ++str;
406
407     // Handle empty string or just "-". Should never reach this
408     // point, because this is only used with transitive verbs.
409     if (!*str)
410         return false; // LCOV_EXCL_LINE
411
412     // Check for non-digit chars in the rest of the string.
413     while (*str) {
414         if (!isdigit(*str))
415             return false;
416         else
417             ++str;
418     }
419
420     return true;
421 }
422
423 static void get_vocab_metadata(const char* word, vocab_t* id, word_type_t* type)
424 {
425     /* Check for an empty string */
426     if (strncmp(word, "", sizeof("")) == 0) {
427         *id = WORD_EMPTY;
428         *type = NO_WORD_TYPE;
429         return;
430     }
431
432     vocab_t ref_num;
433
434     ref_num = get_motion_vocab_id(word);
435     if (ref_num != WORD_NOT_FOUND) {
436         *id = ref_num;
437         *type = MOTION;
438         return;
439     }
440
441     ref_num = get_object_vocab_id(word);
442     if (ref_num != WORD_NOT_FOUND) {
443         *id = ref_num;
444         *type = OBJECT;
445         return;
446     }
447
448     ref_num = get_action_vocab_id(word);
449     if (ref_num != WORD_NOT_FOUND) {
450         *id = ref_num;
451         *type = ACTION;
452         return;
453     }
454
455     // Check for the reservoir magic word.
456     if (strcasecmp(word, game.zzword) == 0) {
457         *id = PART;
458         *type = ACTION;
459         return;
460     }
461
462     // Check words that are actually numbers.
463     if (is_valid_int(word)) {
464         *id = WORD_EMPTY;
465         *type = NUMERIC;
466         return;
467     }
468
469     *id = WORD_NOT_FOUND;
470     *type = NO_WORD_TYPE;
471     return;
472 }
473
474 static void tokenize(char* raw, command_t *cmd)
475 {
476     /*
477      * Be careful about modifying this. We do not want to nuke the
478      * the speech part or ID from the previous turn.
479      */
480     memset(&cmd->word[0].raw, '\0', sizeof(cmd->word[0].raw));
481     memset(&cmd->word[1].raw, '\0', sizeof(cmd->word[1].raw));
482
483     /* Bound prefix on the %s would be needed to prevent buffer
484      * overflow.  but we shortstop this more simply by making each
485      * raw-input buffer as int as the entire input buffer. */
486     sscanf(raw, "%s%s", cmd->word[0].raw, cmd->word[1].raw);
487
488     /* (ESR) In oldstyle mode, simulate the uppercasing and truncating
489      * effect on raw tokens of packing them into sixbit characters, 5
490      * to a 32-bit word.  This is something the FORTRAN version did
491      * because archaic FORTRAN had no string types.  Don Wood's
492      * mechanical translation of 2.5 to C retained the packing and
493      * thus this misfeature.
494      *
495      * It's philosophically questionable whether this is the right
496      * thing to do even in oldstyle mode.  On one hand, the text
497      * mangling was not authorial intent, but a result of limitations
498      * in their tools. On the other, not simulating this misbehavior
499      * goes against the goal of making oldstyle as accurate as
500      * possible an emulation of the original UI.
501      */
502     if (settings.oldstyle) {
503         cmd->word[0].raw[TOKLEN + TOKLEN] = cmd->word[1].raw[TOKLEN + TOKLEN] = '\0';
504         for (size_t i = 0; i < strlen(cmd->word[0].raw); i++)
505             cmd->word[0].raw[i] = toupper(cmd->word[0].raw[i]);
506         for (size_t i = 0; i < strlen(cmd->word[1].raw); i++)
507             cmd->word[1].raw[i] = toupper(cmd->word[1].raw[i]);
508     }
509
510     /* populate command with parsed vocabulary metadata */
511     get_vocab_metadata(cmd->word[0].raw, &(cmd->word[0].id), &(cmd->word[0].type));
512     get_vocab_metadata(cmd->word[1].raw, &(cmd->word[1].id), &(cmd->word[1].type));
513     cmd->state = TOKENIZED;
514 }
515
516 bool get_command_input(command_t *command)
517 /* Get user input on stdin, parse and map to command */
518 {
519     char inputbuf[LINESIZE];
520     char* input;
521
522     for (;;) {
523         input = get_input();
524         if (input == NULL)
525             return false;
526         if (word_count(input) > 2) {
527             rspeak(TWO_WORDS);
528             free(input);
529             continue;
530         }
531         if (strcmp(input, "") != 0)
532             break;
533         free(input);
534     }
535
536     strncpy(inputbuf, input, LINESIZE - 1);
537     free(input);
538
539     tokenize(inputbuf, command);
540
541 #ifdef GDEBUG
542     /* Needs to stay synced with enum word_type_t */
543     const char *types[] = {"NO_WORD_TYPE", "MOTION", "OBJECT", "ACTION", "NUMERIC"};
544     /* needs to stay synced with enum speechpart */
545     const char *roles[] = {"unknown", "intransitive", "transitive"};
546     printf("Command: role = %s type1 = %s, id1 = %d, type2 = %s, id2 = %d\n",
547            roles[command->part],
548            types[command->word[0].type],
549            command->word[0].id,
550            types[command->word[1].type],
551            command->word[1].id);
552 #endif
553
554     command->state = GIVEN;
555     return true;
556 }
557
558 void clear_command(command_t *cmd)
559 /* Resets the state of the command to empty */
560 {
561     cmd->verb = ACT_NULL;
562     cmd->part = unknown;
563     game.oldobj = cmd->obj;
564     cmd->obj = NO_OBJECT;
565     cmd->state = EMPTY;
566 }
567
568 void juggle(obj_t object)
569 /*  Juggle an object by picking it up and putting it down again, the purpose
570  *  being to get the object to the front of the chain of things at its loc. */
571 {
572     loc_t i, j;
573
574     i = game.objects[object].place;
575     j = game.objects[object].fixed;
576     move(object, i);
577     move(object + NOBJECTS, j);
578 }
579
580 void move(obj_t object, loc_t where)
581 /*  Place any object anywhere by picking it up and dropping it.  May
582  *  already be toting, in which case the carry is a no-op.  Mustn't
583  *  pick up objects which are not at any loc, since carry wants to
584  *  remove objects from game atloc chains. */
585 {
586     loc_t from;
587
588     if (object > NOBJECTS)
589         from = game.objects[object - NOBJECTS].fixed;
590     else
591         from = game.objects[object].place;
592     /* (ESR) Used to check for !SPECIAL(from). I *think* that was wrong... */
593     if (from != LOC_NOWHERE && from != CARRIED)
594         carry(object, from);
595     drop(object, where);
596 }
597
598 void put(obj_t object, loc_t where, int pval)
599 /*  put() is the same as move(), except it returns a value used to set up the
600  *  negated game.prop values for the repository objects. */
601 {
602     move(object, where);
603     /* (ESR) Read this in combination with the macro defintions in advebt.h.
604      */
605     game.objects[object].prop = PROP_STASHIFY(pval);
606 #ifdef PROP_SET_SEEN
607     PROP_SET_SEEN(object);
608 #endif
609 }
610
611 void carry(obj_t object, loc_t where)
612 /*  Start toting an object, removing it from the list of things at its former
613  *  location.  Incr holdng unless it was already being toted.  If object>NOBJECTS
614  *  (moving "fixed" second loc), don't change game.place or game.holdng. */
615 {
616     int temp;
617
618     if (object <= NOBJECTS) {
619         if (game.objects[object].place == CARRIED)
620             return;
621         game.objects[object].place = CARRIED;
622
623         /*
624          * Without this conditional your inventory is overcounted
625          * when you pick up the bird while it's caged. This fixes
626          * a cosmetic bug in the original.
627          *
628          * Possibly this check should be skipped whwn oldstyle is on.
629          */
630         if (object != BIRD)
631             ++game.holdng;
632     }
633     if (game.locs[where].atloc == object) {
634         game.locs[where].atloc = game.link[object];
635         return;
636     }
637     temp = game.locs[where].atloc;
638     while (game.link[temp] != object) {
639         temp = game.link[temp];
640     }
641     game.link[temp] = game.link[object];
642 }
643
644 void drop(obj_t object, loc_t where)
645 /*  Place an object at a given loc, prefixing it onto the game atloc list.  Decr
646  *  game.holdng if the object was being toted. No state change on the object. */
647 {
648     if (object > NOBJECTS)
649         game.objects[object - NOBJECTS].fixed = where;
650     else {
651         if (game.objects[object].place == CARRIED)
652             if (object != BIRD)
653                 /* The bird has to be weightless.  This ugly hack (and the
654                  * corresponding code in the carry function) brought to you
655                  * by the fact that when the bird is caged, we need to be able
656                  * to either 'take bird' or 'take cage' and have the right thing
657                  * happen.
658                  */
659                 --game.holdng;
660         game.objects[object].place = where;
661     }
662     if (where == LOC_NOWHERE || where == CARRIED)
663         return;
664     game.link[object] = game.locs[where].atloc;
665     game.locs[where].atloc = object;
666 }
667
668 int atdwrf(loc_t where)
669 /*  Return the index of first dwarf at the given location, zero if no dwarf is
670  *  there (or if dwarves not active yet), -1 if all dwarves are dead.  Ignore
671  *  the pirate (6th dwarf). */
672 {
673     int at;
674
675     at = 0;
676     if (game.dflag < 2)
677         return at;
678     at = -1;
679     for (int i = 1; i <= NDWARVES - 1; i++) {
680         if (game.dwarves[i].loc == where)
681             return i;
682         if (game.dwarves[i].loc != 0)
683             at = 0;
684     }
685     return at;
686 }
687
688 /*  Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
689  *  randrange) */
690
691 int setbit(int bit)
692 /*  Returns 2**bit for use in constructing bit-masks. */
693 {
694     return (1L << bit);
695 }
696
697 bool tstbit(int mask, int bit)
698 /*  Returns true if the specified bit is set in the mask. */
699 {
700     return (mask & (1 << bit)) != 0;
701 }
702
703 void set_seed(int32_t seedval)
704 /* Set the LCG1 seed */
705 {
706     game.lcg_x = seedval % LCG_M;
707     if (game.lcg_x < 0) {
708         game.lcg_x = LCG_M + game.lcg_x;
709     }
710     // once seed is set, we need to generate the Z`ZZZ word
711     for (int i = 0; i < 5; ++i) {
712         game.zzword[i] = 'A' + randrange(26);
713     }
714     game.zzword[1] = '\''; // force second char to apostrophe
715     game.zzword[5] = '\0';
716 }
717
718 static int32_t get_next_lcg_value(void)
719 /* Return the LCG's current value, and then iterate it. */
720 {
721     int32_t old_x = game.lcg_x;
722     game.lcg_x = (LCG_A * game.lcg_x + LCG_C) % LCG_M;
723     if (settings.debug) {
724         printf("# random %d\n", old_x); // LCOV_EXCL_LINE
725     }
726     return old_x;
727 }
728
729 int32_t randrange(int32_t range)
730 /* Return a random integer from [0, range). */
731 {
732     return range * get_next_lcg_value() / LCG_M;
733 }
734
735 // LCOV_EXCL_START
736 void bug(enum bugtype num, const char *error_string)
737 {
738     fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
739     exit(EXIT_FAILURE);
740 }
741 // LCOV_EXCL_STOP
742
743 void state_change(obj_t obj, int state)
744 /* Object must have a change-message list for this to be useful; only some do */
745 {
746     game.objects[obj].prop = state;
747     pspeak(obj, change, true, state);
748 }
749
750 /* end */