X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=saveresume.c;h=c53ee4950ff9942868ec2ad4517497739030a421;hb=5929a68b88ee9a244f5b12d08ead6a6692deb32d;hp=7bf0c714c153ba5e0acf70e0b2252df858ddc7ce;hpb=87452af44895728466a9a62de95a0e81863b6cfd;p=open-adventure.git diff --git a/saveresume.c b/saveresume.c index 7bf0c71..c53ee49 100644 --- a/saveresume.c +++ b/saveresume.c @@ -11,19 +11,26 @@ #include #include -#include +#include #include #include #include "advent.h" #include "dungeon.h" -#define VRSION 28 /* bump on save format change */ +/* + * Bump on save format change. + * + * Note: Verify that the tests run clean before bumping this, then rebuild the check + * files afterwards. Otherwise you will get a spurious failure due to the old version + * having been generated into a check file. + */ +#define VRSION 29 /* * If you change the first three members, the resume function may not properly * reject saves from older versions. Yes, this glues us to a hardware- - * dependent length of long. Later members can change, but bump the version + * dependent length of int. Later members can change, but bump the version * when you do that. */ struct save_t { @@ -49,28 +56,51 @@ int savefile(FILE *fp, int32_t version) } /* Suspend and resume */ + +char *strip(char *name) +{ + // Trim leading whitespace + while(isspace((unsigned char)*name)) + name++; // LCOV_EXCL_LINE + if(*name != '\0') { + // Trim trailing whitespace; + // might be left there by autocomplete + char *end = name + strlen(name) - 1; + while(end > name && isspace((unsigned char)*end)) + end--; + // Write new null terminator character + end[1] = '\0'; + } + + return name; +} + int suspend(void) { /* Suspend. Offer to save things in a file, but charging * some points (so can't win by using saved games to retry * battles or to start over after learning zzword). - * If ADVENT_NOSAVE is defined, do nothing instead. */ + * If ADVENT_NOSAVE is defined, gripe instead. */ -#ifdef ADVENT_NOSAVE - return GO_UNKNOWN; +#if defined ADVENT_NOSAVE || defined ADVENT_AUTOSAVE + rspeak(SAVERESUME_DISABLED) + return GO_TOP; #endif FILE *fp = NULL; rspeak(SUSPEND_WARNING); - if (!yes(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN])) + if (!yes_or_no(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN])) return GO_CLEAROBJ; game.saved = game.saved + 5; while (fp == NULL) { - char* name = readline("\nFile name: "); + char* name = myreadline("\nFile name: "); if (name == NULL) return GO_TOP; - fp = fopen(name, WRITE_MODE); + name = strip(name); + if (strlen(name) == 0) + return GO_TOP; // LCOV_EXCL_LINE + fp = fopen(strip(name), WRITE_MODE); if (fp == NULL) printf("Can't open file %s, try again.\n", name); free(name); @@ -85,25 +115,29 @@ int suspend(void) int resume(void) { /* Resume. Read a suspended game back from a file. - * If ADVENT_NOSAVE is defined, do nothing instead. */ + * If ADVENT_NOSAVE is defined, gripe instead. */ -#ifdef ADVENT_NOSAVE - return GO_UNKNOWN; +#if defined ADVENT_NOSAVE || defined ADVENT_AUTOSAVE + rspeak(SAVERESUME_DISABLED) + return GO_TOP; #endif FILE *fp = NULL; if (game.loc != 1 || game.abbrev[1] != 1) { rspeak(RESUME_ABANDON); - if (!yes(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN])) + if (!yes_or_no(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN])) return GO_CLEAROBJ; } while (fp == NULL) { - char* name = readline("\nFile name: "); + char* name = myreadline("\nFile name: "); if (name == NULL) return GO_TOP; - fp = fopen(name, READ_MODE); + name = strip(name); + if (strlen(name) == 0) + return GO_TOP; // LCOV_EXCL_LINE + fp = fopen(name, READ_MODE); if (fp == NULL) printf("Can't open file %s, try again.\n", name); free(name); @@ -116,95 +150,100 @@ int restore(FILE* fp) { /* Read and restore game state from file, assuming * sane initial state. - * If ADVENT_NOSAVE is defined, do nothing instead. */ + * If ADVENT_NOSAVE is defined, gripe instead. */ #ifdef ADVENT_NOSAVE - return GO_UNKNOWN; + rspeak(SAVERESUME_DISABLED) + return GO_TOP; #endif IGNORE(fread(&save, sizeof(struct save_t), 1, fp)); fclose(fp); if (save.version != VRSION) { rspeak(VERSION_SKEW, save.version / 10, MOD(save.version, 10), VRSION / 10, MOD(VRSION, 10)); - } else if (is_valid(&save.game)) { + } else if (!is_valid(save.game)) { + rspeak(SAVE_TAMPERING); + exit(EXIT_SUCCESS); + } else { game = save.game; } return GO_TOP; } -bool is_valid(struct game_t* valgame) +bool is_valid(struct game_t valgame) { /* Save files can be roughly grouped into three groups: - * With valid, reaceable state, with valid, but unreachable - * state and with invaild state. We check that state is + * With valid, reacheable state, with valid, but unreachable + * state and with invalid state. We check that state is * valid: no states are outside minimal or maximal value */ /* Prevent division by zero */ - if (valgame->abbnum == 0) { - return false; + if (valgame.abbnum == 0) { + return false; // LCOV_EXCL_LINE } /* Check for RNG overflow. Truncate */ - if (valgame->lcg_x >= LCG_M) { - valgame->lcg_x %= LCG_M; + if (valgame.lcg_x >= LCG_M) { + valgame.lcg_x %= LCG_M; // LCOV_EXCL_LINE } /* Check for RNG underflow. Transpose */ - if (valgame->lcg_x < LCG_M) { - valgame->lcg_x = LCG_M + (valgame->lcg_x % LCG_M); + if (valgame.lcg_x < LCG_M) { + valgame.lcg_x = LCG_M + (valgame.lcg_x % LCG_M); } /* Bounds check for locations */ - if ( valgame->chloc < -1 || valgame->chloc > NLOCATIONS || - valgame->chloc2 < -1 || valgame->chloc2 > NLOCATIONS || - valgame->loc < 0 || valgame->loc > NLOCATIONS || - valgame->newloc < 0 || valgame->newloc > NLOCATIONS || - valgame->oldloc < 0 || valgame->oldloc > NLOCATIONS || - valgame->oldlc2 < 0 || valgame->oldlc2 > NLOCATIONS) { - return false; + if ( valgame.chloc < -1 || valgame.chloc > NLOCATIONS || + valgame.chloc2 < -1 || valgame.chloc2 > NLOCATIONS || + valgame.loc < 0 || valgame.loc > NLOCATIONS || + valgame.newloc < 0 || valgame.newloc > NLOCATIONS || + valgame.oldloc < 0 || valgame.oldloc > NLOCATIONS || + valgame.oldlc2 < 0 || valgame.oldlc2 > NLOCATIONS) { + return false; // LCOV_EXCL_LINE } /* Bounds check for location arrays */ for (int i = 0; i <= NDWARVES; i++) { - if (valgame->dloc[i] < -1 || valgame->dloc[i] > NLOCATIONS || - valgame->odloc[i] < -1 || valgame->odloc[i] > NLOCATIONS) { - return false; + if (valgame.dloc[i] < -1 || valgame.dloc[i] > NLOCATIONS || + valgame.odloc[i] < -1 || valgame.odloc[i] > NLOCATIONS) { + return false; // LCOV_EXCL_LINE } } for (int i = 0; i <= NOBJECTS; i++) { - if (valgame->place[i] < -1 || valgame->place[i] > NLOCATIONS || - valgame->fixed[i] < -1 || valgame->fixed[i] > NLOCATIONS) { - return false; + if (valgame.place[i] < -1 || valgame.place[i] > NLOCATIONS || + valgame.fixed[i] < -1 || valgame.fixed[i] > NLOCATIONS) { + return false; // LCOV_EXCL_LINE } } /* Bounds check for dwarves */ - if (valgame->dtotal < 0 || valgame->dtotal > NDWARVES || - valgame->dkill < 0 || valgame->dkill > NDWARVES) { - return false; + if (valgame.dtotal < 0 || valgame.dtotal > NDWARVES || + valgame.dkill < 0 || valgame.dkill > NDWARVES) { + return false; // LCOV_EXCL_LINE } /* Validate that we didn't die too many times in save */ - if (valgame->numdie >= NDEATHS) { - return false; + if (valgame.numdie >= NDEATHS) { + return false; // LCOV_EXCL_LINE } /* Recalculate tally, throw the towel if in disagreement */ - long temp_tally = 0; + int temp_tally = 0; for (int treasure = 1; treasure <= NOBJECTS; treasure++) { if (objects[treasure].is_treasure) { - if (valgame->prop[treasure] == STATE_NOTFOUND) { + if (valgame.prop[treasure] == STATE_NOTFOUND) { ++temp_tally; } } } - if (temp_tally != valgame->tally) { - return false; + if (temp_tally != valgame.tally) { + return false; // LCOV_EXCL_LINE } /* Check that properties of objects aren't beyond expected */ for (obj_t obj = 0; obj <= NOBJECTS; obj++) { - if (valgame->prop[obj] < STATE_NOTFOUND || valgame->prop[obj] > 1) { + /* Magic number -2 allows a STASHED version of state 1 */ + if (valgame.prop[obj] < -2 || valgame.prop[obj] > 1) { switch (obj) { case RUG: case DRAGON: @@ -217,28 +256,28 @@ bool is_valid(struct game_t* valgame) case EGGS: case VASE: case CHAIN: - if (valgame->prop[obj] == 2) // There are multiple different states, but it's convenient to clump them together - continue; + if (valgame.prop[obj] == 2) // There are multiple different states, but it's convenient to clump them together + continue; // LCOV_EXCL_LINE /* FALLTHRU */ case BEAR: - if (valgame->prop[BEAR] == CONTENTED_BEAR || valgame->prop[BEAR] == BEAR_DEAD) + if (valgame.prop[BEAR] == CONTENTED_BEAR || valgame.prop[BEAR] == BEAR_DEAD) continue; /* FALLTHRU */ default: - return false; + return false; // LCOV_EXCL_LINE } } } /* Check that values in linked lists for objects in locations are inside bounds */ for (loc_t loc = LOC_NOWHERE; loc <= NLOCATIONS; loc++) { - if (valgame->atloc[loc] < NO_OBJECT || valgame->atloc[loc] > NOBJECTS * 2) { - return false; + if (valgame.atloc[loc] < NO_OBJECT || valgame.atloc[loc] > NOBJECTS * 2) { + return false; // LCOV_EXCL_LINE } } for (obj_t obj = 0; obj <= NOBJECTS * 2; obj++ ) { - if (valgame->link[obj] < NO_OBJECT || valgame->link[obj] > NOBJECTS * 2) { - return false; + if (valgame.link[obj] < NO_OBJECT || valgame.link[obj] > NOBJECTS * 2) { + return false; // LCOV_EXCL_LINE } }