X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=misc.c;h=c853237f742195bd1a837f8779737cac5de7df64;hb=258b7703f22045be1b6e9fb74bd3391ed94ed86b;hp=e6d31bf232b18b64d69272bbb5c2b5d68a7a5f4f;hpb=30f13c6c25be8d0fb5b0e6d819685b4e6f45829c;p=open-adventure.git diff --git a/misc.c b/misc.c index e6d31bf..c853237 100644 --- a/misc.c +++ b/misc.c @@ -1,3 +1,10 @@ +/* + * I/O and support routines. + * + * SPDX-FileCopyrightText: (C) 1977, 2005 by Will Crowther and Don Woods + * SPDX-License-Identifier: BSD-2-Clause + */ + #include #include #include @@ -6,6 +13,7 @@ #include #include #include +#include #include "advent.h" #include "dungeon.h" @@ -26,6 +34,7 @@ static void* xcalloc(size_t size) /* I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */ static void vspeak(const char* msg, bool blank, va_list ap) +/* Engine for various speak functions */ { // Do nothing if we got a null pointer. if (msg == NULL) @@ -66,8 +75,8 @@ static void vspeak(const char* msg, bool blank, va_list ap) i++; // Integer specifier. if (msg[i] == 'd') { - long arg = va_arg(ap, long); - int ret = snprintf(renderp, size, "%ld", arg); + int32_t arg = va_arg(ap, int32_t); + int ret = snprintf(renderp, size, "%" PRId32, arg); if (ret < size) { renderp += ret; size -= ret; @@ -93,6 +102,7 @@ static void vspeak(const char* msg, bool blank, va_list ap) } } + // LCOV_EXCL_START - doesn't occur in test suite. /* Version specifier */ if (msg[i] == 'V') { strcpy(renderp, VERSION); @@ -100,6 +110,7 @@ static void vspeak(const char* msg, bool blank, va_list ap) renderp += len; size -= len; } + // LCOV_EXCL_STOP } } *renderp = 0; @@ -111,6 +122,7 @@ static void vspeak(const char* msg, bool blank, va_list ap) } void speak(const char* msg, ...) +/* speak a specified string */ { va_list ap; va_start(ap, msg); @@ -119,6 +131,7 @@ void speak(const char* msg, ...) } void sspeak(const int msg, ...) +/* Speak a message from the arbitrary-messages list */ { va_list ap; va_start(ap, msg); @@ -128,7 +141,7 @@ void sspeak(const int msg, ...) va_end(ap); } -void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...) +void pspeak(vocab_t msg, enum speaktype mode, bool blank, int skip, ...) /* Find the skip+1st message from msg and print it. Modes are: * feel = for inventory, what you can touch * look = the full description for the state the object is in @@ -136,7 +149,7 @@ void pspeak(vocab_t msg, enum speaktype mode, int skip, bool blank, ...) * study = text on the object. */ { va_list ap; - va_start(ap, blank); + va_start(ap, skip); switch (mode) { case touch: vspeak(objects[msg].inventory, blank, ap); @@ -200,7 +213,7 @@ static int word_count(char* str) static char* get_input(void) { // Set up the prompt - char input_prompt[] = "> "; + char input_prompt[] = PROMPT; if (!settings.prompt) input_prompt[0] = '\0'; @@ -208,8 +221,8 @@ static char* get_input(void) printf("\n"); char* input; - while (true) { - input = readline(input_prompt); + for (;;) { + input = myreadline(input_prompt); if (input == NULL) // Got EOF; return with it. return (input); @@ -235,7 +248,7 @@ static char* get_input(void) return (input); } -bool silent_yes(void) +bool silent_yes_or_no(void) { bool outcome = false; @@ -269,12 +282,10 @@ bool silent_yes(void) free(firstword); - if (yes == 0 || - y == 0) { + if (yes == 0 || y == 0) { outcome = true; break; - } else if (no == 0 || - n == 0) { + } else if (no == 0 || n == 0) { outcome = false; break; } else @@ -284,7 +295,7 @@ bool silent_yes(void) } -bool yes(const char* question, const char* yes_response, const char* no_response) +bool yes_or_no(const char* question, const char* yes_response, const char* no_response) /* Print message X, wait for yes/no answer. If yes, print Y and return true; * if no, print Z and return false. */ { @@ -323,13 +334,11 @@ bool yes(const char* question, const char* yes_response, const char* no_response free(firstword); - if (yes == 0 || - y == 0) { + if (yes == 0 || y == 0) { speak(yes_response); outcome = true; break; - } else if (no == 0 || - n == 0) { + } else if (no == 0 || n == 0) { speak(no_response); outcome = false; break; @@ -386,22 +395,21 @@ static int get_action_vocab_id(const char* word) return (WORD_NOT_FOUND); } -static bool is_valid_int(const char *str) -/* Returns true if the string passed in is represents a valid integer, +static bool is_valid_int(const char *str) +/* Returns true if the string passed in is represents a valid integer, * that could then be parsed by atoi() */ { // Handle negative number if (*str == '-') ++str; - // Handle empty string or just "-". Should never reach this + // Handle empty string or just "-". Should never reach this // point, because this is only used with transitive verbs. if (!*str) return false; // LCOV_EXCL_LINE - // Check for non-digit chars in the rest of the stirng. - while (*str) - { + // Check for non-digit chars in the rest of the string. + while (*str) { if (!isdigit(*str)) return false; else @@ -411,7 +419,7 @@ static bool is_valid_int(const char *str) return true; } -static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* type) +static void get_vocab_metadata(const char* word, vocab_t* id, word_type_t* type) { /* Check for an empty string */ if (strncmp(word, "", sizeof("")) == 0) { @@ -423,6 +431,7 @@ static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* typ vocab_t ref_num; ref_num = get_motion_vocab_id(word); + // Second conjunct is because the magic-word placeholder is a bit special if (ref_num != WORD_NOT_FOUND) { *id = ref_num; *type = MOTION; @@ -437,7 +446,7 @@ static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* typ } ref_num = get_action_vocab_id(word); - if (ref_num != WORD_NOT_FOUND) { + if (ref_num != WORD_NOT_FOUND && ref_num != PART) { *id = ref_num; *type = ACTION; return; @@ -462,19 +471,24 @@ static void get_vocab_metadata(const char* word, vocab_t* id, enum wordtype* typ return; } -static void tokenize(char* raw, struct command_t *cmd) +static void tokenize(char* raw, command_t *cmd) { - memset(cmd, '\0', sizeof(struct command_t)); + /* + * Be careful about modifying this. We do not want to nuke the + * the speech part or ID from the previous turn. + */ + memset(&cmd->word[0].raw, '\0', sizeof(cmd->word[0].raw)); + memset(&cmd->word[1].raw, '\0', sizeof(cmd->word[1].raw)); /* Bound prefix on the %s would be needed to prevent buffer * overflow. but we shortstop this more simply by making each - * raw-input buffer as long as the entire input buffer. */ - sscanf(raw, "%s%s", cmd->raw1, cmd->raw2); + * raw-input buffer as int as the entire input buffer. */ + sscanf(raw, "%s%s", cmd->word[0].raw, cmd->word[1].raw); /* (ESR) In oldstyle mode, simulate the uppercasing and truncating * effect on raw tokens of packing them into sixbit characters, 5 * to a 32-bit word. This is something the FORTRAN version did - * becuse archaic FORTRAN had no string types. Don Wood's + * because archaic FORTRAN had no string types. Don Wood's * mechanical translation of 2.5 to C retained the packing and * thus this misfeature. * @@ -486,19 +500,20 @@ static void tokenize(char* raw, struct command_t *cmd) * possible an emulation of the original UI. */ if (settings.oldstyle) { - cmd->raw1[TOKLEN + TOKLEN] = cmd->raw2[TOKLEN + TOKLEN] = '\0'; - for (size_t i = 0; i < strlen(cmd->raw1); i++) - cmd->raw1[i] = toupper(cmd->raw1[i]); - for (size_t i = 0; i < strlen(cmd->raw2); i++) - cmd->raw2[i] = toupper(cmd->raw2[i]); + cmd->word[0].raw[TOKLEN + TOKLEN] = cmd->word[1].raw[TOKLEN + TOKLEN] = '\0'; + for (size_t i = 0; i < strlen(cmd->word[0].raw); i++) + cmd->word[0].raw[i] = toupper(cmd->word[0].raw[i]); + for (size_t i = 0; i < strlen(cmd->word[1].raw); i++) + cmd->word[1].raw[i] = toupper(cmd->word[1].raw[i]); } /* populate command with parsed vocabulary metadata */ - get_vocab_metadata(cmd->raw1, &(cmd->id1), &(cmd->type1)); - get_vocab_metadata(cmd->raw2, &(cmd->id2), &(cmd->type2)); + get_vocab_metadata(cmd->word[0].raw, &(cmd->word[0].id), &(cmd->word[0].type)); + get_vocab_metadata(cmd->word[1].raw, &(cmd->word[1].id), &(cmd->word[1].type)); + cmd->state = TOKENIZED; } -bool get_command_input(struct command_t *command) +bool get_command_input(command_t *command) /* Get user input on stdin, parse and map to command */ { char inputbuf[LINESIZE]; @@ -523,17 +538,41 @@ bool get_command_input(struct command_t *command) tokenize(inputbuf, command); +#ifdef GDEBUG + /* Needs to stay synced with enum word_type_t */ + const char *types[] = {"NO_WORD_TYPE", "MOTION", "OBJECT", "ACTION", "NUMERIC"}; + /* needs to stay synced with enum speechpart */ + const char *roles[] = {"unknown", "intransitive", "transitive"}; + printf("Command: role = %s type1 = %s, id1 = %d, type2 = %s, id2 = %d\n", + roles[command->part], + types[command->word[0].type], + command->word[0].id, + types[command->word[1].type], + command->word[1].id); +#endif + + command->state = GIVEN; return true; } +void clear_command(command_t *cmd) +/* Resets the state of the command to empty */ +{ + cmd->verb = ACT_NULL; + cmd->part = unknown; + game.oldobj = cmd->obj; + cmd->obj = NO_OBJECT; + cmd->state = EMPTY; +} + void juggle(obj_t object) /* Juggle an object by picking it up and putting it down again, the purpose * being to get the object to the front of the chain of things at its loc. */ { loc_t i, j; - i = game.place[object]; - j = game.fixed[object]; + i = game.objects[object].place; + j = game.objects[object].fixed; move(object, i); move(object + NOBJECTS, j); } @@ -542,26 +581,31 @@ void move(obj_t object, loc_t where) /* Place any object anywhere by picking it up and dropping it. May * already be toting, in which case the carry is a no-op. Mustn't * pick up objects which are not at any loc, since carry wants to - * remove objects from game.atloc chains. */ + * remove objects from game atloc chains. */ { loc_t from; if (object > NOBJECTS) - from = game.fixed[object - NOBJECTS]; + from = game.objects[object - NOBJECTS].fixed; else - from = game.place[object]; + from = game.objects[object].place; /* (ESR) Used to check for !SPECIAL(from). I *think* that was wrong... */ if (from != LOC_NOWHERE && from != CARRIED) carry(object, from); drop(object, where); } -loc_t put(obj_t object, loc_t where, long pval) +void put(obj_t object, loc_t where, int pval) /* put() is the same as move(), except it returns a value used to set up the * negated game.prop values for the repository objects. */ { move(object, where); - return STASHED(pval); + /* (ESR) Read this in combination with the macro defintions in advebt.h. + */ + game.objects[object].prop = PROP_STASHIFY(pval); +#ifdef PROP_SET_SEEN + PROP_SET_SEEN(object); +#endif } void carry(obj_t object, loc_t where) @@ -569,19 +613,28 @@ void carry(obj_t object, loc_t where) * location. Incr holdng unless it was already being toted. If object>NOBJECTS * (moving "fixed" second loc), don't change game.place or game.holdng. */ { - long temp; + int temp; if (object <= NOBJECTS) { - if (game.place[object] == CARRIED) + if (game.objects[object].place == CARRIED) return; - game.place[object] = CARRIED; - ++game.holdng; + game.objects[object].place = CARRIED; + + /* + * Without this conditional your inventory is overcounted + * when you pick up the bird while it's caged. This fixes + * a cosmetic bug in the original. + * + * Possibly this check should be skipped whwn oldstyle is on. + */ + if (object != BIRD) + ++game.holdng; } - if (game.atloc[where] == object) { - game.atloc[where] = game.link[object]; + if (game.locs[where].atloc == object) { + game.locs[where].atloc = game.link[object]; return; } - temp = game.atloc[where]; + temp = game.locs[where].atloc; while (game.link[temp] != object) { temp = game.link[temp]; } @@ -589,21 +642,27 @@ void carry(obj_t object, loc_t where) } void drop(obj_t object, loc_t where) -/* Place an object at a given loc, prefixing it onto the game.atloc list. Decr - * game.holdng if the object was being toted. */ +/* Place an object at a given loc, prefixing it onto the game atloc list. Decr + * game.holdng if the object was being toted. No state change on the object. */ { if (object > NOBJECTS) - game.fixed[object - NOBJECTS] = where; + game.objects[object - NOBJECTS].fixed = where; else { - if (game.place[object] == CARRIED) - --game.holdng; - game.place[object] = where; + if (game.objects[object].place == CARRIED) + if (object != BIRD) + /* The bird has to be weightless. This ugly hack (and the + * corresponding code in the carry function) brought to you + * by the fact that when the bird is caged, we need to be able + * to either 'take bird' or 'take cage' and have the right thing + * happen. + */ + --game.holdng; + game.objects[object].place = where; } - if (where == LOC_NOWHERE || - where == CARRIED) + if (where == LOC_NOWHERE || where == CARRIED) return; - game.link[object] = game.atloc[where]; - game.atloc[where] = object; + game.link[object] = game.locs[where].atloc; + game.locs[where].atloc = object; } int atdwrf(loc_t where) @@ -617,10 +676,10 @@ int atdwrf(loc_t where) if (game.dflag < 2) return at; at = -1; - for (long i = 1; i <= NDWARVES - 1; i++) { - if (game.dloc[i] == where) + for (int i = 1; i <= NDWARVES - 1; i++) { + if (game.dwarves[i].loc == where) return i; - if (game.dloc[i] != 0) + if (game.dwarves[i].loc != 0) at = 0; } return at; @@ -629,23 +688,25 @@ int atdwrf(loc_t where) /* Utility routines (setbit, tstbit, set_seed, get_next_lcg_value, * randrange) */ -long setbit(int bit) +int setbit(int bit) /* Returns 2**bit for use in constructing bit-masks. */ { return (1L << bit); } -bool tstbit(long mask, int bit) +bool tstbit(int mask, int bit) /* Returns true if the specified bit is set in the mask. */ { return (mask & (1 << bit)) != 0; } -void set_seed(long seedval) -/* Set the LCG seed */ +void set_seed(int32_t seedval) +/* Set the LCG1 seed */ { - game.lcg_x = (unsigned long) seedval % game.lcg_m; - + game.lcg_x = seedval % LCG_M; + if (game.lcg_x < 0) { + game.lcg_x = LCG_M + game.lcg_x; + } // once seed is set, we need to generate the Z`ZZZ word for (int i = 0; i < 5; ++i) { game.zzword[i] = 'A' + randrange(26); @@ -654,18 +715,21 @@ void set_seed(long seedval) game.zzword[5] = '\0'; } -unsigned long get_next_lcg_value(void) +static int32_t get_next_lcg_value(void) /* Return the LCG's current value, and then iterate it. */ { - unsigned long old_x = game.lcg_x; - game.lcg_x = (game.lcg_a * game.lcg_x + game.lcg_c) % game.lcg_m; + int32_t old_x = game.lcg_x; + game.lcg_x = (LCG_A * game.lcg_x + LCG_C) % LCG_M; + if (settings.debug) { + printf("# random %d\n", old_x); // LCOV_EXCL_LINE + } return old_x; } -long randrange(long range) +int32_t randrange(int32_t range) /* Return a random integer from [0, range). */ { - return range * get_next_lcg_value() / game.lcg_m; + return range * get_next_lcg_value() / LCG_M; } // LCOV_EXCL_START @@ -676,13 +740,11 @@ void bug(enum bugtype num, const char *error_string) } // LCOV_EXCL_STOP -/* end */ - void state_change(obj_t obj, int state) /* Object must have a change-message list for this to be useful; only some do */ { - game.prop[obj] = state; - pspeak(obj, change, state, true); + game.objects[obj].prop = state; + pspeak(obj, change, true, state); } /* end */