From a167945e1963c5fdf4d2ad0283d249cb35d28508 Mon Sep 17 00:00:00 2001 From: Aaron Traas Date: Thu, 20 Jul 2017 16:02:54 -0400 Subject: [PATCH] Information hiding - moved all of command input parsing to misc.c get_command_input() is effectively an I/O function that takes raw input and makes it into a command_t. With other I/O functions, it belongs in misc.c. This alos allowed me to make 4 other functions static, as they were only called by get_command_input(); --- advent.h | 5 +-- main.c | 64 +++++++++----------------------- misc.c | 110 +++++++++++++++++++++++++++++++++++-------------------- 3 files changed, 89 insertions(+), 90 deletions(-) diff --git a/advent.h b/advent.h index 36f0863..3ed084f 100644 --- a/advent.h +++ b/advent.h @@ -200,18 +200,15 @@ struct command_t { extern struct game_t game; extern struct settings_t settings; -extern void tokenize(char*, struct command_t *); +extern bool get_command_input(struct command_t *); extern void wordclear(token_t *); extern void speak(const char*, ...); extern void sspeak(long msg, ...); extern void pspeak(vocab_t, enum speaktype, int, bool, ...); extern void rspeak(vocab_t, ...); extern void echo_input(FILE*, const char*, const char*); -extern int word_count(char*); -extern char* get_input(void); extern bool silent_yes(void); extern bool yes(const char*, const char*, const char*); -extern void get_vocab_metadata(const char*, long*, enum wordtype*); extern void juggle(obj_t); extern void move(obj_t, loc_t); extern long put(obj_t, long, long); diff --git a/main.c b/main.c index ee22912..4d5f6a9 100644 --- a/main.c +++ b/main.c @@ -986,36 +986,6 @@ static void listobjects(void) } } -static bool get_command_input(struct command_t *command) -{ - char inputbuf[LINESIZE]; - char* input; - - for (;;) { - input = get_input(); - if (input == NULL) - return false; - if (word_count(input) > 2) { - rspeak(TWO_WORDS); - free(input); - continue; - } - if (strcmp(input, "") != 0) - break; - free(input); - } - - strncpy(inputbuf, input, LINESIZE - 1); - free(input); - - tokenize(inputbuf, command); - - get_vocab_metadata(command->raw1, &(command->id1), &(command->type1)); - get_vocab_metadata(command->raw2, &(command->id2), &(command->type2)); - - return true; -} - static bool do_command() /* Get and execute a command */ { @@ -1116,7 +1086,7 @@ Lclearobj: lampcheck(); if (command.type1 == MOTION && command.id1 == ENTER - && (command.id2 == STREAM || command.id2 == WATER)) { + && (command.id2 == STREAM || command.id2 == WATER)) { if (LIQLOC(game.loc) == WATER) rspeak(FEET_WET); else @@ -1126,22 +1096,22 @@ Lclearobj: } if (command.type1 == OBJECT) { - if (command.id1 == GRATE) { - command.type1 = MOTION; - if (game.loc == LOC_START || - game.loc == LOC_VALLEY || - game.loc == LOC_SLIT) { - command.id1 = DEPRESSION; - } - if (game.loc == LOC_COBBLE || - game.loc == LOC_DEBRIS || - game.loc == LOC_AWKWARD || - game.loc == LOC_BIRD || - game.loc == LOC_PITTOP) { - command.id1 = ENTRANCE; - } - } - if (!((command.id1 != WATER && command.id1 != OIL) || (command.id2 != PLANT && command.id2 != DOOR))) { + if (command.id1 == GRATE) { + command.type1 = MOTION; + if (game.loc == LOC_START || + game.loc == LOC_VALLEY || + game.loc == LOC_SLIT) { + command.id1 = DEPRESSION; + } + if (game.loc == LOC_COBBLE || + game.loc == LOC_DEBRIS || + game.loc == LOC_AWKWARD || + game.loc == LOC_BIRD || + game.loc == LOC_PITTOP) { + command.id1 = ENTRANCE; + } + } + if (!((command.id1 != WATER && command.id1 != OIL) || (command.id2 != PLANT && command.id2 != DOOR))) { if (AT(command.id2)) { command.id2 = POUR; command.type2 = ACTION; diff --git a/misc.c b/misc.c index d5b7f65..6f4aa49 100644 --- a/misc.c +++ b/misc.c @@ -23,38 +23,6 @@ static void* xcalloc(size_t size) return (ptr); } -void tokenize(char* raw, struct command_t *cmd) -{ - memset(cmd, '\0', sizeof(struct command_t)); - - /* 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 enrire inout buffer. */ - sscanf(raw, "%s%s", cmd->raw1, cmd->raw2); - - /* (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 - * mechanical translation of 2.5 to C retained the packing and - * thus this misfeature. - * - * It's philosophically questionable whether this is the right - * thing to do even in oldstyle mode. On one hand, the text - * mangling was not authorial intent, but a result of limitations - * in their tools. On the other, not simulating this misbehavior - * goes against the goal of making oldstyle as accurate as - * 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]); - } -} - /* I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */ static void vspeak(const char* msg, bool blank, va_list ap) @@ -101,18 +69,18 @@ static void vspeak(const char* msg, bool blank, va_list ap) // packed tokens, stringify everything. Future work may // eliminate the need for this. if (msg[i] == 'd') { - long arg = va_arg(ap, long); + long arg = va_arg(ap, long); int ret = snprintf(renderp, size, "%ld", arg); if (ret < size) { renderp += ret; size -= ret; } - pluralize = (arg != 1); + pluralize = (arg != 1); } // Unmodified string specifier. if (msg[i] == 's') { - char *arg = va_arg(ap, char *); + char *arg = va_arg(ap, char *); strncat(renderp, arg, size - 1); size_t len = strlen(renderp); renderp += len; @@ -121,7 +89,7 @@ static void vspeak(const char* msg, bool blank, va_list ap) // Singular/plural specifier. if (msg[i] == 'S') { - // look at the *previous* numeric parameter + // look at the *previous* numeric parameter if (pluralize) { *renderp++ = 's'; size--; @@ -211,7 +179,7 @@ void echo_input(FILE* destination, const char* input_prompt, const char* input) free(prompt_and_input); } -int word_count(char* str) +static int word_count(char* str) { char delims[] = " \t"; int count = 0; @@ -232,7 +200,7 @@ int word_count(char* str) return (count); } -char* get_input() +static char* get_input() { // Set up the prompt char input_prompt[] = "> "; @@ -434,7 +402,7 @@ static int get_special_vocab_id(const char* word) return (WORD_NOT_FOUND); } -void get_vocab_metadata(const char* word, long* id, enum wordtype* type) +static void get_vocab_metadata(const char* word, long* id, enum wordtype* type) { /* Check for an empty string */ if (strncmp(word, "", sizeof("")) == 0) { @@ -485,6 +453,70 @@ void get_vocab_metadata(const char* word, long* id, enum wordtype* type) return; } +static void tokenize(char* raw, struct command_t *cmd) +{ + memset(cmd, '\0', sizeof(struct command_t)); + + /* 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 enrire inout buffer. */ + sscanf(raw, "%s%s", cmd->raw1, cmd->raw2); + + /* (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 + * mechanical translation of 2.5 to C retained the packing and + * thus this misfeature. + * + * It's philosophically questionable whether this is the right + * thing to do even in oldstyle mode. On one hand, the text + * mangling was not authorial intent, but a result of limitations + * in their tools. On the other, not simulating this misbehavior + * goes against the goal of making oldstyle as accurate as + * 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]); + } + + /* populate command with parsed vocab metadata */ + get_vocab_metadata(cmd->raw1, &(cmd->id1), &(cmd->type1)); + get_vocab_metadata(cmd->raw2, &(cmd->id2), &(cmd->type2)); +} + +bool get_command_input(struct command_t *command) +/* Get user input on stdin, parse and map to command */ +{ + char inputbuf[LINESIZE]; + char* input; + + for (;;) { + input = get_input(); + if (input == NULL) + return false; + if (word_count(input) > 2) { + rspeak(TWO_WORDS); + free(input); + continue; + } + if (strcmp(input, "") != 0) + break; + free(input); + } + + strncpy(inputbuf, input, LINESIZE - 1); + free(input); + + tokenize(inputbuf, command); + + return true; +} + 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. */ -- 2.31.1