8 #include <editline/readline.h>
13 static void* xmalloc(size_t size)
15 void* ptr = malloc(size);
18 // exclude from coverage analysis because we can't simulate an out of memory error in testing
19 fprintf(stderr, "Out of memory!\n");
26 void packed_to_token(long packed, char token[TOKLEN + 1])
28 // The advent->ascii mapping.
29 const char advent_to_ascii[] = {
30 ' ', '!', '"', '#', '$', '%', '&', '\'',
31 '(', ')', '*', '+', ',', '-', '.', '/',
32 '0', '1', '2', '3', '4', '5', '6', '7',
33 '8', '9', ':', ';', '<', '=', '>', '?',
34 '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
35 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
36 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
37 'X', 'Y', 'Z', '\0', '\0', '\0', '\0', '\0',
40 // Unpack and map back to ASCII.
41 for (int i = 0; i < 5; ++i) {
42 char advent = (packed >> i * 6) & 63;
43 token[i] = advent_to_ascii[(int) advent];
46 // Ensure the last character is \0.
49 // Replace trailing whitespace with \0.
50 for (int i = 4; i >= 0; --i) {
51 if (token[i] == ' ' ||
59 long token_to_packed(const char token[])
61 const char ascii_to_advent[] = {
62 63, 63, 63, 63, 63, 63, 63, 63,
63 63, 63, 63, 63, 63, 63, 63, 63,
64 63, 63, 63, 63, 63, 63, 63, 63,
65 63, 63, 63, 63, 63, 63, 63, 63,
67 0, 1, 2, 3, 4, 5, 6, 7,
68 8, 9, 10, 11, 12, 13, 14, 15,
69 16, 17, 18, 19, 20, 21, 22, 23,
70 24, 25, 26, 27, 28, 29, 30, 31,
71 32, 33, 34, 35, 36, 37, 38, 39,
72 40, 41, 42, 43, 44, 45, 46, 47,
73 48, 49, 50, 51, 52, 53, 54, 55,
74 56, 57, 58, 59, 60, 61, 62, 63,
76 63, 63, 63, 63, 63, 63, 63, 63,
77 63, 63, 63, 63, 63, 63, 63, 63,
78 63, 63, 63, 63, 63, 63, 63, 63,
79 63, 63, 63, 63, 63, 63, 63, 63,
82 size_t t_len = strlen(token);
86 for (size_t i = 0; i < t_len; ++i) {
87 char mapped = ascii_to_advent[(int) toupper(token[i])];
88 packed |= (mapped << (6 * i));
93 void tokenize(char* raw, struct command_t *cmd)
95 memset(cmd, '\0', sizeof(struct command_t));
97 /* Bound prefix on the %s would be needed to prevent buffer
98 * overflow. but we shortstop this more simply by making each
99 * raw-input buffer as long as the enrire inout buffer. */
100 sscanf(raw, "%s%s", cmd->raw1, cmd->raw2);
102 // pack the substrings
103 cmd->wd1 = token_to_packed(cmd->raw1);
104 cmd->wd2 = token_to_packed(cmd->raw2);
106 /* (ESR) In oldstyle mode, simulate the uppercasing and truncating
107 * effect on raw tokens of packing them into sixbit characters, 5
108 * to a 32-bit word. This is something the FORTRAN version did
109 * becuse archaic FORTRAN had no string types. Don Wood's
110 * mechanical translation of 2.5 to C retained the packing and
111 * thus this misfeature.
113 * It's philosophically questionable whether this is the right
114 * thing to do even in oldstyle mode. On one hand, the text
115 * mangling was not authorial intent, but a result of limitations
116 * in their tools. On the other, not simulating this misbehavior
117 * goes against the goal of making oldstyle as accurate as
118 * possible an emulation of the original UI.
120 if (settings.oldstyle) {
121 cmd->raw1[TOKLEN + TOKLEN] = cmd->raw2[TOKLEN + TOKLEN] = '\0';
122 for (size_t i = 0; i < strlen(cmd->raw1); i++)
123 cmd->raw1[i] = toupper(cmd->raw1[i]);
124 for (size_t i = 0; i < strlen(cmd->raw2); i++)
125 cmd->raw2[i] = toupper(cmd->raw2[i]);
129 /* Hide the fact that wods are corrently packed longs */
131 bool wordeq(token_t a, token_t b)
136 bool wordempty(token_t a)
141 void wordclear(token_t *v)
146 /* I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
148 void vspeak(const char* msg, bool blank, va_list ap)
150 // Do nothing if we got a null pointer.
154 // Do nothing if we got an empty string.
155 if (strlen(msg) == 0)
161 int msglen = strlen(msg);
164 ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
165 char* rendered = xmalloc(size);
166 char* renderp = rendered;
168 // Handle format specifiers (including the custom %C, %L, %S) by
169 // adjusting the parameter accordingly, and replacing the
170 // specifier with %s.
171 long previous_arg = 0;
172 for (int i = 0; i < msglen; i++) {
177 long arg = va_arg(ap, long);
179 arg = 0; // LCOV_EXCL_LINE - don't think we can get here.
181 // Integer specifier. In order to accommodate the fact
182 // that PARMS can have both legitimate integers *and*
183 // packed tokens, stringify everything. Future work may
184 // eliminate the need for this.
186 int ret = snprintf(renderp, size, "%ld", arg);
193 // Unmodified string specifier.
195 packed_to_token(arg, renderp); /* unpack directly to destination */
196 size_t len = strlen(renderp);
201 // Singular/plural specifier.
203 if (previous_arg > 1) { // look at the *previous* parameter (which by necessity must be numeric)
209 /* Version specifier */
211 strcpy(renderp, VERSION);
212 size_t len = strlen(VERSION);
222 // Print the message.
223 printf("%s\n", rendered);
228 void speak(const char* msg, ...)
232 vspeak(msg, true, ap);
236 void sspeak(const long msg, ...)
241 vprintf(arbitrary_messages[msg], ap);
246 void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...)
247 /* Find the skip+1st message from msg and print it. Modes are:
248 * feel = for inventory, what you can touch
249 * look = the long description for the state the object is in
250 * listen = the sound for the state the object is in
251 * study = text on the object. */
257 vspeak(objects[msg].inventory, blank, ap);
260 vspeak(objects[msg].descriptions[skip], blank, ap);
263 vspeak(objects[msg].sounds[skip], blank, ap);
266 vspeak(objects[msg].texts[skip], blank, ap);
269 vspeak(objects[msg].changes[skip], blank, ap);
275 void rspeak(vocab_t i, ...)
276 /* Print the i-th "random" message (section 6 of database). */
280 vspeak(arbitrary_messages[i], true, ap);
284 void echo_input(FILE* destination, const char* input_prompt, const char* input)
286 size_t len = strlen(input_prompt) + strlen(input) + 1;
287 char* prompt_and_input = (char*) xmalloc(len);
288 strcpy(prompt_and_input, input_prompt);
289 strcat(prompt_and_input, input);
290 fprintf(destination, "%s\n", prompt_and_input);
291 free(prompt_and_input);
294 int word_count(char* str)
296 char delims[] = " \t";
300 for (char *s = str; *s; s++)
302 if (strchr(delims, *s) == 0) {
307 if (strchr(delims, *s) != 0) {
318 char input_prompt[] = "> ";
319 if (!settings.prompt)
320 input_prompt[0] = '\0';
322 // Print a blank line
327 input = readline(input_prompt);
329 if (input == NULL) // Got EOF; return with it.
331 if (input[0] == '#') { // Ignore comments.
335 // We have a 'normal' line; leave the loop.
339 // Strip trailing newlines from the input
340 input[strcspn(input, "\n")] = 0;
345 echo_input(stdout, input_prompt, input);
348 echo_input(settings.logfp, "", input);
355 bool outcome = false;
358 char* reply = get_input();
361 // Should be unreachable. Reply should never be NULL
366 if (strlen(reply) == 0) {
368 rspeak(PLEASE_ANSWER);
372 char* firstword = (char*) xmalloc(strlen(reply) + 1);
373 sscanf(reply, "%s", firstword);
377 for (int i = 0; i < (int)strlen(firstword); ++i)
378 firstword[i] = tolower(firstword[i]);
380 int yes = strncmp("yes", firstword, sizeof("yes") - 1);
381 int y = strncmp("y", firstword, sizeof("y") - 1);
382 int no = strncmp("no", firstword, sizeof("no") - 1);
383 int n = strncmp("n", firstword, sizeof("n") - 1);
391 } else if (no == 0 ||
396 rspeak(PLEASE_ANSWER);
402 bool yes(const char* question, const char* yes_response, const char* no_response)
403 /* Print message X, wait for yes/no answer. If yes, print Y and return true;
404 * if no, print Z and return false. */
406 bool outcome = false;
411 char* reply = get_input();
414 // Should be unreachable. Reply should never be NULL
420 if (strlen(reply) == 0) {
422 rspeak(PLEASE_ANSWER);
426 char* firstword = (char*) xmalloc(strlen(reply) + 1);
427 sscanf(reply, "%s", firstword);
431 for (int i = 0; i < (int)strlen(firstword); ++i)
432 firstword[i] = tolower(firstword[i]);
434 int yes = strncmp("yes", firstword, sizeof("yes") - 1);
435 int y = strncmp("y", firstword, sizeof("y") - 1);
436 int no = strncmp("no", firstword, sizeof("no") - 1);
437 int n = strncmp("n", firstword, sizeof("n") - 1);
446 } else if (no == 0 ||
452 rspeak(PLEASE_ANSWER);
459 /* Data structure routines */
461 int get_motion_vocab_id(const char* word)
462 // Return the first motion number that has 'word' as one of its words.
464 for (int i = 0; i < NMOTIONS; ++i) {
465 for (int j = 0; j < motions[i].words.n; ++j) {
466 if (strcasecmp(word, motions[i].words.strs[j]) == 0 && (strlen(word) > 1 ||
467 strchr(ignore, word[0]) == NULL ||
472 // If execution reaches here, we didn't find the word.
473 return (WORD_NOT_FOUND);
476 int get_object_vocab_id(const char* word)
477 // Return the first object number that has 'word' as one of its words.
479 for (int i = 0; i < NOBJECTS + 1; ++i) { // FIXME: the + 1 should go when 1-indexing for objects is removed
480 for (int j = 0; j < objects[i].words.n; ++j) {
481 if (strcasecmp(word, objects[i].words.strs[j]) == 0)
485 // If execution reaches here, we didn't find the word.
486 return (WORD_NOT_FOUND);
489 int get_action_vocab_id(const char* word)
490 // Return the first motion number that has 'word' as one of its words.
492 for (int i = 0; i < NACTIONS; ++i) {
493 for (int j = 0; j < actions[i].words.n; ++j) {
494 if (strcasecmp(word, actions[i].words.strs[j]) == 0 && (strlen(word) > 1 ||
495 strchr(ignore, word[0]) == NULL ||
500 // If execution reaches here, we didn't find the word.
501 return (WORD_NOT_FOUND);
504 int get_special_vocab_id(const char* word)
505 // Return the first special number that has 'word' as one of its words.
507 for (int i = 0; i < NSPECIALS; ++i) {
508 for (int j = 0; j < specials[i].words.n; ++j) {
509 if (strcasecmp(word, specials[i].words.strs[j]) == 0)
513 // If execution reaches here, we didn't find the word.
514 return (WORD_NOT_FOUND);
517 long get_vocab_id(const char* word)
518 // Search the vocab categories in order for the supplied word.
520 /* Check for an empty string */
521 if (strncmp(word, "", sizeof("")) == 0)
526 /* FIXME: Magic numbers related to vocabulary */
527 ref_num = get_motion_vocab_id(word);
528 if (ref_num != WORD_NOT_FOUND)
529 return MOTION_WORD(ref_num);
531 ref_num = get_object_vocab_id(word);
532 if (ref_num != WORD_NOT_FOUND)
533 return OBJECT_WORD(ref_num);
535 ref_num = get_action_vocab_id(word);
536 if (ref_num != WORD_NOT_FOUND)
537 return ACTION_WORD(ref_num);
539 ref_num = get_special_vocab_id(word);
540 if (ref_num != WORD_NOT_FOUND)
541 return SPECIAL_WORD(ref_num);
543 // Check for the reservoir magic word.
544 if (strcasecmp(word, game.zzword) == 0)
545 return ACTION_WORD(PART);
547 return (WORD_NOT_FOUND);
550 void juggle(obj_t object)
551 /* Juggle an object by picking it up and putting it down again, the purpose
552 * being to get the object to the front of the chain of things at its loc. */
556 i = game.place[object];
557 j = game.fixed[object];
559 move(object + NOBJECTS, j);
562 void move(obj_t object, loc_t where)
563 /* Place any object anywhere by picking it up and dropping it. May
564 * already be toting, in which case the carry is a no-op. Mustn't
565 * pick up objects which are not at any loc, since carry wants to
566 * remove objects from game.atloc chains. */
570 if (object > NOBJECTS)
571 from = game.fixed[object - NOBJECTS];
573 from = game.place[object];
574 if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
579 long put(obj_t object, loc_t where, long pval)
580 /* put() is the same as move(), except it returns a value used to set up the
581 * negated game.prop values for the repository objects. */
584 return STASHED(pval);
587 void carry(obj_t object, loc_t where)
588 /* Start toting an object, removing it from the list of things at its former
589 * location. Incr holdng unless it was already being toted. If object>NOBJECTS
590 * (moving "fixed" second loc), don't change game.place or game.holdng. */
594 if (object <= NOBJECTS) {
595 if (game.place[object] == CARRIED)
597 game.place[object] = CARRIED;
600 if (game.atloc[where] == object) {
601 game.atloc[where] = game.link[object];
604 temp = game.atloc[where];
605 while (game.link[temp] != object) {
606 temp = game.link[temp];
608 game.link[temp] = game.link[object];
611 void drop(obj_t object, loc_t where)
612 /* Place an object at a given loc, prefixing it onto the game.atloc list. Decr
613 * game.holdng if the object was being toted. */
615 if (object > NOBJECTS)
616 game.fixed[object - NOBJECTS] = where;
618 if (game.place[object] == CARRIED)
620 game.place[object] = where;
622 if (where == LOC_NOWHERE ||
625 game.link[object] = game.atloc[where];
626 game.atloc[where] = object;
629 long atdwrf(loc_t where)
630 /* Return the index of first dwarf at the given location, zero if no dwarf is
631 * there (or if dwarves not active yet), -1 if all dwarves are dead. Ignore
632 * the pirate (6th dwarf). */
640 for (long i = 1; i <= NDWARVES - 1; i++) {
641 if (game.dloc[i] == where)
643 if (game.dloc[i] != 0)
649 /* Utility routines (setbit, tstbit, set_seed, get_next_lcg_value,
652 long setbit(long bit)
653 /* Returns 2**bit for use in constructing bit-masks. */
658 bool tstbit(long mask, int bit)
659 /* Returns true if the specified bit is set in the mask. */
661 return (mask & (1 << bit)) != 0;
664 void set_seed(long seedval)
665 /* Set the LCG seed */
667 game.lcg_x = (unsigned long) seedval % game.lcg_m;
669 // once seed is set, we need to generate the Z`ZZZ word
670 make_zzword(game.zzword);
673 unsigned long get_next_lcg_value(void)
674 /* Return the LCG's current value, and then iterate it. */
676 unsigned long old_x = game.lcg_x;
677 game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m;
681 long randrange(long range)
682 /* Return a random integer from [0, range). */
684 return range * get_next_lcg_value() / game.lcg_m;
687 void make_zzword(char zzword[TOKLEN + 1])
689 for (int i = 0; i < 5; ++i) {
690 zzword[i] = 'A' + randrange(26);
692 zzword[1] = '\''; // force second char to apostrophe
697 void bug(enum bugtype num, const char *error_string)
699 fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
706 void state_change(obj_t obj, long state)
707 /* Object must have a change-message list for this to be useful; only some do */
709 game.prop[obj] = state;
710 pspeak(obj, change, state, true);