11 #include "linenoise/linenoise.h"
14 char* xstrdup(const char* s)
16 char* ptr = strdup(s);
19 // exclude from coverage analysis because we can't simulate an out of memory error in testing
20 fprintf(stderr, "Out of memory!\n");
26 void* xmalloc(size_t size)
28 void* ptr = malloc(size);
31 // exclude from coverage analysis because we can't simulate an out of memory error in testing
32 fprintf(stderr, "Out of memory!\n");
39 void packed_to_token(long packed, char token[6])
41 // Unpack and map back to ASCII.
42 for (int i = 0; i < 5; ++i) {
43 char advent = (packed >> i * 6) & 63;
44 token[i] = new_advent_to_ascii[(int) advent];
47 // Ensure the last character is \0.
50 // Replace trailing whitespace with \0.
51 for (int i = 4; i >= 0; --i) {
52 if (token[i] == ' ' || token[i] == '\t')
59 long token_to_packed(const char token[6])
61 size_t t_len = strlen(token);
63 for (size_t i = 0; i < t_len; ++i)
65 char mapped = new_ascii_to_advent[(int) token[i]];
66 packed |= (mapped << (6 * i));
71 void tokenize(char* raw, long tokens[4])
73 // set each token to 0
74 for (int i = 0; i < 4; ++i)
77 // grab the first two words
79 words[0] = (char*) xmalloc(strlen(raw));
80 words[1] = (char*) xmalloc(strlen(raw));
81 int word_count = sscanf(raw, "%s%s", words[0], words[1]);
83 // make space for substrings and zero it out
84 char chunk_data[][6] = {
91 // break the words into up to 4 5-char substrings
92 sscanf(words[0], "%5s%5s", chunk_data[0], chunk_data[1]);
94 sscanf(words[1], "%5s%5s", chunk_data[2], chunk_data[3]);
98 // uppercase all the substrings
99 for (int i = 0; i < 4; ++i)
100 for (unsigned int j = 0; j < strlen(chunk_data[i]); ++j)
101 chunk_data[i][j] = (char) toupper(chunk_data[i][j]);
103 // pack the substrings
104 for (int i = 0; i < 4; ++i)
105 tokens[i] = token_to_packed(chunk_data[i]);
108 /* Hide the fact that wods are corrently packed longs */
110 bool wordeq(token_t a, token_t b)
115 bool wordempty(token_t a)
120 void wordclear(token_t *v)
125 /* I/O routines (speak, pspeak, rspeak, GETIN, YES) */
127 void vspeak(const char* msg, va_list ap)
129 // Do nothing if we got a null pointer.
133 // Do nothing if we got an empty string.
134 if (strlen(msg) == 0)
137 // Print a newline if the global game.blklin says to.
138 if (game.blklin == true)
141 int msglen = strlen(msg);
144 ssize_t size = 2000; /* msglen > 50 ? msglen*2 : 100; */
145 char* rendered = xmalloc(size);
146 char* renderp = rendered;
148 // Handle format specifiers (including the custom %C, %L, %S) by adjusting the parameter accordingly, and replacing the specifier with %s.
149 long previous_arg = 0;
150 for (int i = 0; i < msglen; i++) {
155 long arg = va_arg(ap, long);
159 // 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.
161 int ret = snprintf(renderp, size, "%ld", arg);
168 // Unmodified string specifier.
170 packed_to_token(arg, renderp); /* unpack directly to destination */
171 size_t len = strlen(renderp);
176 // Singular/plural specifier.
178 if (previous_arg > 1) { // look at the *previous* parameter (which by necessity must be numeric)
184 // All-lowercase specifier.
185 if (msg[i] == 'L' || msg[i] == 'C') {
186 packed_to_token(arg, renderp); /* unpack directly to destination */
187 int len = strlen(renderp);
188 for (int j = 0; j < len; ++j) {
189 renderp[j] = tolower(renderp[j]);
191 if (msg[i] == 'C') // First char uppercase, rest lowercase.
192 renderp[0] = toupper(renderp[0]);
202 // Print the message.
203 printf("%s\n", rendered);
208 void speak(const char* msg, ...)
216 void pspeak(vocab_t msg, enum speaktype mode, int skip, ...)
217 /* Find the skip+1st message from msg and print it. Modes are:
218 * feel = for inventory, what you can touch
219 * look = the long description for the state the object is in
220 * listen = the sound for the state the object is in
221 * study = text on the object. */
227 vspeak(objects[msg].inventory, ap);
230 vspeak(objects[msg].descriptions[skip], ap);
233 vspeak(objects[msg].sounds[skip], ap);
236 vspeak(objects[msg].texts[skip], ap);
239 vspeak(objects[msg].changes[skip], ap);
245 void rspeak(vocab_t i, ...)
246 /* Print the i-th "random" message (section 6 of database). */
250 vspeak(arbitrary_messages[i], ap);
254 bool GETIN(FILE *input,
255 long *pword1, long *pword1x,
256 long *pword2, long *pword2x)
257 /* Get a command from the adventurer. Snarf out the first word, pad it with
258 * blanks, and return it in WORD1. Chars 6 thru 10 are returned in WORD1X, in
259 * case we need to print out the whole word in an error message. Any number of
260 * blanks may follow the word. If a second word appears, it is returned in
261 * WORD2 (chars 6 thru 10 in WORD2X), else WORD2 is -1. */
267 fputc('\n', stdout);;
270 *pword1 = GETTXT(true, true, true);
271 if (game.blklin && *pword1 < 0)
273 *pword1x = GETTXT(false, true, true);
275 junk = GETTXT(false, true, true);
278 *pword2 = GETTXT(true, true, true);
279 *pword2x = GETTXT(false, true, true);
281 junk = GETTXT(false, true, true);
284 if (GETTXT(true, true, true) <= 0)
290 void echo_input(FILE* destination, char* input_prompt, char* input)
292 size_t len = strlen(input_prompt) + strlen(input) + 1;
293 char* prompt_and_input = (char*) xmalloc(len);
294 strcpy(prompt_and_input, input_prompt);
295 strcat(prompt_and_input, input);
296 fprintf(destination, "%s\n", prompt_and_input);
297 free(prompt_and_input);
300 int word_count(char* s)
302 char* copy = xstrdup(s);
303 char delims[] = " \t";
307 word = strtok(copy, delims);
310 word = strtok(NULL, delims);
320 char input_prompt[] = "> ";
322 input_prompt[0] = '\0';
324 // Print a blank line if game.blklin tells us to.
325 if (game.blklin == true)
331 input = linenoise(input_prompt);
337 // Should be unreachable in tests, as they will use a non-interactive shell.
338 printf("%s", input_prompt);
340 ssize_t numread = getline(&input, &n, stdin);
341 if (numread == -1) // Got EOF; return with it.
345 if (input == NULL) // Got EOF; return with it.
347 else if (input[0] == '#') // Ignore comments.
349 else // We have a 'normal' line; leave the loop.
353 // Strip trailing newlines from the input
354 input[strcspn(input, "\n")] = 0;
356 linenoiseHistoryAdd(input);
359 echo_input(stdout, input_prompt, input);
362 echo_input(logfp, input_prompt, input);
376 // Should be unreachable. Reply should never be NULL
377 linenoiseFree(reply);
382 char* firstword = (char*) xmalloc(strlen(reply)+1);
383 sscanf(reply, "%s", firstword);
385 for (int i = 0; i < (int)strlen(firstword); ++i)
386 firstword[i] = tolower(firstword[i]);
388 int yes = strncmp("yes", firstword, sizeof("yes") - 1);
389 int y = strncmp("y", firstword, sizeof("y") - 1);
390 int no = strncmp("no", firstword, sizeof("no") - 1);
391 int n = strncmp("n", firstword, sizeof("n") - 1);
395 if (yes == 0 || y == 0) {
398 } else if (no == 0 || n == 0) {
402 rspeak(PLEASE_ANSWER);
404 linenoiseFree(reply);
409 bool yes(const char* question, const char* yes_response, const char* no_response)
410 /* Print message X, wait for yes/no answer. If yes, print Y and return true;
411 * if no, print Z and return false. */
422 // Should be unreachable. Reply should never be NULL
423 linenoiseFree(reply);
428 char* firstword = (char*) xmalloc(strlen(reply)+1);
429 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);
441 if (yes == 0 || y == 0) {
445 } else if (no == 0 || n == 0) {
450 rspeak(PLEASE_ANSWER);
452 linenoiseFree(reply);
456 /* Line-parsing routines (GETTXT, MAKEWD, PUTTXT, SHFTXT) */
458 long GETTXT(bool skip, bool onewrd, bool upper)
459 /* Take characters from an input line and pack them into 30-bit words.
460 * Skip says to skip leading blanks. ONEWRD says stop if we come to a
461 * blank. UPPER says to map all letters to uppercase. If we reach the
462 * end of the line, the word is filled up with blanks (which encode as 0's).
463 * If we're already at end of line when TEXT is called, we return -1. */
466 static long splitting = -1;
468 if (LNPOSN != splitting)
474 if ((!skip) || INLINE[LNPOSN] != 0)
480 for (int I = 1; I <= TOKLEN; I++) {
482 if (LNPOSN > LNLENG || (onewrd && INLINE[LNPOSN] == 0))
484 char current = INLINE[LNPOSN];
485 if (current < ascii_to_advent['%']) {
487 if (upper && current >= ascii_to_advent['a'])
488 current = current - 26;
489 text = text + current;
493 if (splitting != LNPOSN) {
494 text = text + ascii_to_advent['%'];
499 text = text + current - ascii_to_advent['%'];
507 token_t MAKEWD(long letters)
508 /* Combine TOKLEN (currently 5) uppercase letters (represented by
509 * pairs of decimal digits in lettrs) to form a 30-bit value matching
510 * the one that GETTXT would return given those characters plus
511 * trailing blanks. Caution: lettrs will overflow 31 bits if
512 * 5-letter word starts with V-Z. As a kludgey workaround, you can
513 * increment a letter by 5 by adding 50 to the next pair of
516 long i = 1, word = 0;
518 for (long k = letters; k != 0; k = k / 100) {
519 word = word + i * (MOD(k, 50) + 10);
521 if (MOD(k, 100) > 50)word = word + i * 5;
523 i = 64L * 64L * 64L * 64L * 64L / i;
528 /* Data structure routines */
530 long vocab(long id, long init)
531 /* Look up ID in the vocabulary (ATAB) and return its "definition" (KTAB), or
532 * -1 if not found. If INIT is positive, this is an initialisation call setting
533 * up a keyword variable, and not finding it constitutes a bug. It also means
534 * that only KTAB values which taken over 1000 equal INIT may be considered.
535 * (Thus "STEPS", which is a motion verb as well as an object, may be located
536 * as an object.) And it also means the KTAB value is taken modulo 1000. */
540 for (long i = 1; i <= TABSIZ; i++) {
545 BUG(REQUIRED_VOCABULARY_WORD_NOT_FOUND); // LCOV_EXCL_LINE
547 if (init >= 0 && KTAB[i] / 1000 != init)
552 lexeme = MOD(lexeme, 1000);
556 BUG(RAN_OFF_END_OF_VOCABULARY_TABLE); // LCOV_EXCL_LINE
559 int get_motion_vocab_id(const char* word)
560 // Return the first motion number that has 'word' as one of its words.
562 for (int i = 0; i < NMOTIONS; ++i)
564 for (int j = 0; j < motions[i].words.n; ++j)
566 if (strcasecmp(word, motions[i].words.strs[j]) == 0)
570 // If execution reaches here, we didn't find the word.
571 return(WORD_NOT_FOUND);
574 int get_object_vocab_id(const char* word)
575 // Return the first object number that has 'word' as one of its words.
577 for (int i = 0; i < NOBJECTS + 1; ++i) // FIXME: the + 1 should go when 1-indexing for objects is removed
579 for (int j = 0; j < objects[i].words.n; ++j)
581 if (strcasecmp(word, objects[i].words.strs[j]) == 0)
585 // If execution reaches here, we didn't find the word.
586 return(WORD_NOT_FOUND);
589 int get_action_vocab_id(const char* word)
590 // Return the first motion number that has 'word' as one of its words.
592 for (int i = 0; i < NACTIONS; ++i)
594 for (int j = 0; j < actions[i].words.n; ++j)
596 if (strcasecmp(word, actions[i].words.strs[j]) == 0)
600 // If execution reaches here, we didn't find the word.
601 return(WORD_NOT_FOUND);
604 int get_special_vocab_id(const char* word)
605 // Return the first special number that has 'word' as one of its words.
607 for (int i = 0; i < NSPECIALS; ++i)
609 for (int j = 0; j < specials[i].words.n; ++j)
611 if (strcasecmp(word, specials[i].words.strs[j]) == 0)
615 // If execution reaches here, we didn't find the word.
616 return(WORD_NOT_FOUND);
619 long get_vocab_id(const char* word)
620 // Search the vocab categories in order for the supplied word.
624 ref_num = get_motion_vocab_id(word);
625 if (ref_num != WORD_NOT_FOUND)
626 return(ref_num + 0); // FIXME: replace with a proper hash
628 ref_num = get_object_vocab_id(word);
629 if (ref_num != WORD_NOT_FOUND)
630 return(ref_num + 1000); // FIXME: replace with a proper hash
632 ref_num = get_action_vocab_id(word);
633 if (ref_num != WORD_NOT_FOUND)
634 return(ref_num + 2000); // FIXME: replace with a proper hash
636 ref_num = get_special_vocab_id(word);
637 if (ref_num != WORD_NOT_FOUND)
638 return(ref_num + 3000); // FIXME: replace with a proper hash
640 // Check for the reservoir magic word.
641 if (strcasecmp(word, game.zzword) == 0)
642 return(PART + 2000); // FIXME: replace with a proper hash
644 return(WORD_NOT_FOUND);
647 void juggle(long object)
648 /* Juggle an object by picking it up and putting it down again, the purpose
649 * being to get the object to the front of the chain of things at its loc. */
653 i = game.place[object];
654 j = game.fixed[object];
656 move(object + NOBJECTS, j);
659 void move(long object, long where)
660 /* Place any object anywhere by picking it up and dropping it. May
661 * already be toting, in which case the carry is a no-op. Mustn't
662 * pick up objects which are not at any loc, since carry wants to
663 * remove objects from game.atloc chains. */
667 if (object > NOBJECTS)
668 from = game.fixed[object - NOBJECTS];
670 from = game.place[object];
671 if (from != LOC_NOWHERE && from != CARRIED && !SPECIAL(from))
676 long put(long object, long where, long pval)
677 /* PUT is the same as MOVE, except it returns a value used to set up the
678 * negated game.prop values for the repository objects. */
684 void carry(long object, long where)
685 /* Start toting an object, removing it from the list of things at its former
686 * location. Incr holdng unless it was already being toted. If object>NOBJECTS
687 * (moving "fixed" second loc), don't change game.place or game.holdng. */
691 if (object <= NOBJECTS) {
692 if (game.place[object] == CARRIED)
694 game.place[object] = CARRIED;
697 if (game.atloc[where] == object) {
698 game.atloc[where] = game.link[object];
701 temp = game.atloc[where];
702 while (game.link[temp] != object) {
703 temp = game.link[temp];
705 game.link[temp] = game.link[object];
708 void drop(long object, long where)
709 /* Place an object at a given loc, prefixing it onto the game.atloc list. Decr
710 * game.holdng if the object was being toted. */
712 if (object > NOBJECTS)
713 game.fixed[object - NOBJECTS] = where;
715 if (game.place[object] == CARRIED)
717 game.place[object] = where;
721 game.link[object] = game.atloc[where];
722 game.atloc[where] = object;
725 long atdwrf(long where)
726 /* Return the index of first dwarf at the given location, zero if no dwarf is
727 * there (or if dwarves not active yet), -1 if all dwarves are dead. Ignore
728 * the pirate (6th dwarf). */
736 for (long i = 1; i <= NDWARVES - 1; i++) {
737 if (game.dloc[i] == where)
739 if (game.dloc[i] != 0)
745 /* Utility routines (SETBIT, TSTBIT, set_seed, get_next_lcg_value,
746 * randrange, RNDVOC) */
748 long setbit(long bit)
749 /* Returns 2**bit for use in constructing bit-masks. */
754 bool tstbit(long mask, int bit)
755 /* Returns true if the specified bit is set in the mask. */
757 return (mask & (1 << bit)) != 0;
760 void set_seed(long seedval)
761 /* Set the LCG seed */
763 game.lcg_x = (unsigned long) seedval % game.lcg_m;
766 unsigned long get_next_lcg_value(void)
767 /* Return the LCG's current value, and then iterate it. */
769 unsigned long old_x = game.lcg_x;
770 game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m;
774 long randrange(long range)
775 /* Return a random integer from [0, range). */
777 return range * get_next_lcg_value() / game.lcg_m;
780 long rndvoc(long second, long force)
781 /* Searches the vocabulary ATAB for a word whose second character is
782 * char, and changes that word such that each of the other four
783 * characters is a random letter. If force is non-zero, it is used
784 * as the new word. Returns the new word. */
789 for (int i = 1; i <= 5; i++) {
790 long j = 11 + randrange(26);
797 long div = 64L * 64L * 64L;
798 for (int i = 1; i <= TABSIZ; i++) {
799 if (MOD(ATAB[i] / div, 64L) == second) {
808 void make_zzword(char zzword[6])
810 for (int i = 0; i < 5; ++i)
812 zzword[i] = 'A' + randrange(26);
814 zzword[1] = '\''; // force second char to apostrophe
818 /* Machine dependent routines (MAPLIN, SAVEIO) */
820 bool MAPLIN(FILE *fp)
824 /* Read a line of input, from the specified input source.
825 * This logic is complicated partly because it has to serve
826 * several cases with different requirements and partly because
827 * of a quirk in linenoise().
829 * The quirk shows up when you paste a test log from the clipboard
830 * to the program's command prompt. While fgets (as expected)
831 * consumes it a line at a time, linenoise() returns the first
832 * line and discards the rest. Thus, there needs to be an
833 * editline (-s) option to fall back to fgets while still
834 * prompting. Note that linenoise does behave properly when
835 * fed redirected stdin.
837 * The logging is a bit of a mess because there are two distinct cases
838 * in which you want to echo commands. One is when shipping them to
839 * a log under the -l option, in which case you want to suppress
840 * prompt generation (so test logs are unadorned command sequences).
841 * On the other hand, if you redirected stdin and are feeding the program
842 * a logfile, you *do* want prompt generation - it makes checkfiles
843 * easier to read when the commands are marked by a preceding prompt.
849 IGNORE(fgets(rawbuf, sizeof(rawbuf) - 1, fp));
852 char *cp = linenoise("> ");
855 strncpy(rawbuf, cp, sizeof(rawbuf) - 1);
856 linenoiseHistoryAdd(rawbuf);
857 strncat(rawbuf, "\n", sizeof(rawbuf) - strlen(rawbuf) - 1);
862 (!eof && rawbuf[0] == '#');
864 if (logfp && fp == stdin)
869 if (logfp && fp == stdin)
874 if (prompt && efp == stdout)
876 IGNORE(fputs(rawbuf, efp));
878 strcpy(INLINE + 1, rawbuf);
879 /* translate the chars to integers in the range 0-126 and store
880 * them in the common array "INLINE". Integer values are as follows:
881 * 0 = space [ASCII CODE 40 octal, 32 decimal]
882 * 1-2 = !" [ASCII 41-42 octal, 33-34 decimal]
883 * 3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
884 * 11-36 = upper-case letters
885 * 37-62 = lower-case letters
886 * 63 = percent (%) [ASCII 45 octal, 37 decimal]
887 * 64-73 = digits, 0 through 9
888 * Remaining characters can be translated any way that is convenient;
889 * The above mappings are required so that certain special
890 * characters are known to fit in 6 bits and/or can be easily spotted.
891 * Array elements beyond the end of the line should be filled with 0,
892 * and LNLENG should be set to the index of the last character.
894 * If the data file uses a character other than space (e.g., tab) to
895 * separate numbers, that character should also translate to 0.
897 * This procedure may use the map1,map2 arrays to maintain
898 * static data for he mapping. MAP2(1) is set to 0 when the
899 * program starts and is not changed thereafter unless the
900 * routines in this module choose to do so. */
902 for (long i = 1; i <= (long)sizeof(INLINE) && INLINE[i] != 0; i++) {
903 long val = INLINE[i];
904 INLINE[i] = ascii_to_advent[val];
913 void datime(long* d, long* t)
916 gettimeofday(&tv, NULL);
917 *d = (long) tv.tv_sec;
918 *t = (long) tv.tv_usec;
922 void bug(enum bugtype num, const char *error_string)
924 fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);