2 * I/O and support routines.
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
16 #include <editline/readline.h>
22 static void* xcalloc(size_t size)
24 void* ptr = calloc(size, 1);
27 // exclude from coverage analysis because we can't simulate an out of memory error in testing
28 fprintf(stderr, "Out of memory!\n");
35 /* I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
37 static void vspeak(const char* msg, bool blank, va_list ap)
38 /* Engine for various speak functions */
40 // Do nothing if we got a null pointer.
44 // Do nothing if we got an empty string.
51 int msglen = strlen(msg);
54 ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
55 char* rendered = xcalloc(size);
56 char* renderp = rendered;
58 // Handle format specifiers (including the custom %S) by
59 // adjusting the parameter accordingly, and replacing the
61 bool pluralize = false;
62 for (int i = 0; i < msglen; 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");
79 int32_t arg = va_arg(ap, int32_t);
80 int ret = snprintf(renderp, size, "%" PRId32, arg);
85 pluralize = (arg != 1);
88 // Unmodified string specifier.
90 char *arg = va_arg(ap, char *);
91 strncat(renderp, arg, size - 1);
92 size_t len = strlen(renderp);
97 // Singular/plural specifier.
99 // look at the *previous* numeric parameter
106 // LCOV_EXCL_START - doesn't occur in test suite.
107 /* Version specifier */
109 strcpy(renderp, VERSION);
110 size_t len = strlen(VERSION);
119 // Print the message.
120 printf("%s\n", rendered);
125 void speak(const char* msg, ...)
126 /* speak a specified string */
130 vspeak(msg, true, ap);
134 void sspeak(const int msg, ...)
135 /* Speak a message from the arbitrary-messages list */
140 vprintf(arbitrary_messages[msg], ap);
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. */
156 vspeak(objects[msg].inventory, blank, ap);
159 vspeak(objects[msg].descriptions[skip], blank, ap);
162 vspeak(objects[msg].sounds[skip], blank, ap);
165 vspeak(objects[msg].texts[skip], blank, ap);
168 vspeak(objects[msg].changes[skip], blank, ap);
174 void rspeak(vocab_t i, ...)
175 /* Print the i-th "random" message (section 6 of database). */
179 vspeak(arbitrary_messages[i], true, ap);
183 void echo_input(FILE* destination, const char* input_prompt, const char* input)
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);
193 static int word_count(char* str)
195 char delims[] = " \t";
199 for (char *s = str; *s; s++)
201 if (strchr(delims, *s) == 0) {
206 if (strchr(delims, *s) != 0) {
214 static char* get_input(void)
217 char input_prompt[] = PROMPT;
218 if (!settings.prompt)
219 input_prompt[0] = '\0';
221 // Print a blank line
226 input = myreadline(input_prompt);
228 if (input == NULL) // Got EOF; return with it.
230 if (input[0] == '#') { // Ignore comments.
234 // We have a 'normal' line; leave the loop.
238 // Strip trailing newlines from the input
239 input[strcspn(input, "\n")] = 0;
244 echo_input(stdout, input_prompt, input);
247 echo_input(settings.logfp, "", input);
252 bool silent_yes_or_no(void)
254 bool outcome = false;
257 char* reply = get_input();
260 // Should be unreachable. Reply should never be NULL
265 if (strlen(reply) == 0) {
267 rspeak(PLEASE_ANSWER);
271 char* firstword = (char*) xcalloc(strlen(reply) + 1);
272 sscanf(reply, "%s", firstword);
276 for (int i = 0; i < (int)strlen(firstword); ++i)
277 firstword[i] = tolower(firstword[i]);
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);
286 if (yes == 0 || y == 0) {
289 } else if (no == 0 || n == 0) {
293 rspeak(PLEASE_ANSWER);
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. */
303 bool outcome = false;
308 char* reply = get_input();
311 // Should be unreachable. Reply should never be NULL
317 if (strlen(reply) == 0) {
319 rspeak(PLEASE_ANSWER);
323 char* firstword = (char*) xcalloc(strlen(reply) + 1);
324 sscanf(reply, "%s", firstword);
328 for (int i = 0; i < (int)strlen(firstword); ++i)
329 firstword[i] = tolower(firstword[i]);
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);
338 if (yes == 0 || y == 0) {
342 } else if (no == 0 || n == 0) {
347 rspeak(PLEASE_ANSWER);
354 /* Data structure routines */
356 static int get_motion_vocab_id(const char* word)
357 // Return the first motion number that has 'word' as one of its words.
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 ||
367 // If execution reaches here, we didn't find the word.
368 return (WORD_NOT_FOUND);
371 static int get_object_vocab_id(const char* word)
372 // Return the first object number that has 'word' as one of its words.
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)
380 // If execution reaches here, we didn't find the word.
381 return (WORD_NOT_FOUND);
384 static int get_action_vocab_id(const char* word)
385 // Return the first motion number that has 'word' as one of its words.
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 ||
395 // If execution reaches here, we didn't find the word.
396 return (WORD_NOT_FOUND);
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() */
403 // Handle negative number
407 // Handle empty string or just "-". Should never reach this
408 // point, because this is only used with transitive verbs.
410 return false; // LCOV_EXCL_LINE
412 // Check for non-digit chars in the rest of the string.
423 static void get_vocab_metadata(const char* word, vocab_t* id, word_type_t* type)
425 /* Check for an empty string */
426 if (strncmp(word, "", sizeof("")) == 0) {
428 *type = NO_WORD_TYPE;
434 ref_num = get_motion_vocab_id(word);
435 if (ref_num != WORD_NOT_FOUND) {
441 ref_num = get_object_vocab_id(word);
442 if (ref_num != WORD_NOT_FOUND) {
448 ref_num = get_action_vocab_id(word);
449 if (ref_num != WORD_NOT_FOUND) {
455 // Check for the reservoir magic word.
456 if (strcasecmp(word, game.zzword) == 0) {
462 // Check words that are actually numbers.
463 if (is_valid_int(word)) {
469 *id = WORD_NOT_FOUND;
470 *type = NO_WORD_TYPE;
474 static void tokenize(char* raw, command_t *cmd)
477 * Be careful about modifying this. We do not want to nuke the
478 * the speech part or ID from the previous turn.
480 memset(&cmd->word[0].raw, '\0', sizeof(cmd->word[0].raw));
481 memset(&cmd->word[1].raw, '\0', sizeof(cmd->word[1].raw));
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);
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.
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.
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]);
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;
516 bool get_command_input(command_t *command)
517 /* Get user input on stdin, parse and map to command */
519 char inputbuf[LINESIZE];
526 if (word_count(input) > 2) {
531 if (strcmp(input, "") != 0)
536 strncpy(inputbuf, input, LINESIZE - 1);
539 tokenize(inputbuf, command);
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],
550 types[command->word[1].type],
551 command->word[1].id);
554 command->state = GIVEN;
558 void clear_command(command_t *cmd)
559 /* Resets the state of the command to empty */
561 cmd->verb = ACT_NULL;
563 game.oldobj = cmd->obj;
564 cmd->obj = NO_OBJECT;
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. */
574 i = game.objects[object].place;
575 j = game.objects[object].fixed;
577 move(object + NOBJECTS, j);
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. */
588 if (object > NOBJECTS)
589 from = game.objects[object - NOBJECTS].fixed;
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)
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. */
603 game.objects[object].prop = (-1) - pval;; // Needs to stay synchronized with PROP_STASHED
606 void carry(obj_t object, loc_t where)
607 /* Start toting an object, removing it from the list of things at its former
608 * location. Incr holdng unless it was already being toted. If object>NOBJECTS
609 * (moving "fixed" second loc), don't change game.place or game.holdng. */
613 if (object <= NOBJECTS) {
614 if (game.objects[object].place == CARRIED)
616 game.objects[object].place = CARRIED;
619 * Without this conditional your inventory is overcounted
620 * when you pick up the bird while it's caged. This fixes
621 * a cosmetic bug in the original.
623 * Possibly this check should be skipped whwn oldstyle is on.
628 if (game.locs[where].atloc == object) {
629 game.locs[where].atloc = game.link[object];
632 temp = game.locs[where].atloc;
633 while (game.link[temp] != object) {
634 temp = game.link[temp];
636 game.link[temp] = game.link[object];
639 void drop(obj_t object, loc_t where)
640 /* Place an object at a given loc, prefixing it onto the game atloc list. Decr
641 * game.holdng if the object was being toted. No state change on the object. */
643 if (object > NOBJECTS)
644 game.objects[object - NOBJECTS].fixed = where;
646 if (game.objects[object].place == CARRIED)
648 /* The bird has to be weightless. This ugly hack (and the
649 * corresponding code in the carry function) brought to you
650 * by the fact that when the bird is caged, we need to be able
651 * to either 'take bird' or 'take cage' and have the right thing
655 game.objects[object].place = where;
657 if (where == LOC_NOWHERE || where == CARRIED)
659 game.link[object] = game.locs[where].atloc;
660 game.locs[where].atloc = object;
663 int atdwrf(loc_t where)
664 /* Return the index of first dwarf at the given location, zero if no dwarf is
665 * there (or if dwarves not active yet), -1 if all dwarves are dead. Ignore
666 * the pirate (6th dwarf). */
674 for (int i = 1; i <= NDWARVES - 1; i++) {
675 if (game.dwarves[i].loc == where)
677 if (game.dwarves[i].loc != 0)
683 /* Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
687 /* Returns 2**bit for use in constructing bit-masks. */
692 bool tstbit(int mask, int bit)
693 /* Returns true if the specified bit is set in the mask. */
695 return (mask & (1 << bit)) != 0;
698 void set_seed(int32_t seedval)
699 /* Set the LCG1 seed */
701 game.lcg_x = seedval % LCG_M;
702 if (game.lcg_x < 0) {
703 game.lcg_x = LCG_M + game.lcg_x;
705 // once seed is set, we need to generate the Z`ZZZ word
706 for (int i = 0; i < 5; ++i) {
707 game.zzword[i] = 'A' + randrange(26);
709 game.zzword[1] = '\''; // force second char to apostrophe
710 game.zzword[5] = '\0';
713 static int32_t get_next_lcg_value(void)
714 /* Return the LCG's current value, and then iterate it. */
716 int32_t old_x = game.lcg_x;
717 game.lcg_x = (LCG_A * game.lcg_x + LCG_C) % LCG_M;
718 if (settings.debug) {
719 printf("# random %d\n", old_x); // LCOV_EXCL_LINE
724 int32_t randrange(int32_t range)
725 /* Return a random integer from [0, range). */
727 return range * get_next_lcg_value() / LCG_M;
731 void bug(enum bugtype num, const char *error_string)
733 fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
738 void state_change(obj_t obj, int state)
739 /* Object must have a change-message list for this to be useful; only some do */
741 game.objects[obj].prop = state;
742 pspeak(obj, change, true, state);