saveresume.c

   1 /*
   2  * Saving and resuming.
   3  *
   4  * (ESR) This replaces  a bunch of particularly nasty FORTRAN-derived code;
   5  * see the history.adoc file in the source distribution for discussion.
   6  *
   7  * SPDX-FileCopyrightText: 1977, 2005 by Will Crowther and Don Woods
   8  * SPDX-FileCopyrightText: 2017 by Eric S. Raymond
   9  * SPDX-License-Identifier: BSD-2-Clause
  10  */
  11
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <ctype.h>
  15 #include <time.h>
  16 #include <inttypes.h>
  17
  18 #include "advent.h"
  19 #include "dungeon.h"
  20
  21 struct save_t save;
  22
  23 #define IGNORE(r) do{if (r){}}while(0)
  24
  25 int savefile(FILE *fp, int32_t version)
  26 /* Save game to file. No input or output from user. */
  27 {
  28     memcpy(&save.magic, ADVENT_MAGIC, sizeof(ADVENT_MAGIC));
  29     save.version = (version == 0) ? SAVE_VERSION : version;
  30
  31     save.game = game;
  32     IGNORE(fwrite(&save, sizeof(struct save_t), 1, fp));
  33     return (0);
  34 }
  35
  36 /* Suspend and resume */
  37
  38 static char *strip(char *name)
  39 {
  40     // Trim leading whitespace
  41     while(isspace((unsigned char)*name))
  42         name++; // LCOV_EXCL_LINE
  43     if(*name != '\0') {
  44         // Trim trailing whitespace;
  45         // might be left there by autocomplete
  46         char *end = name + strlen(name) - 1;
  47         while(end > name && isspace((unsigned char)*end))
  48             end--;
  49         // Write new null terminator character
  50         end[1] = '\0';
  51     }
  52
  53     return name;
  54 }
  55
  56 int suspend(void)
  57 {
  58     /*  Suspend.  Offer to save things in a file, but charging
  59      *  some points (so can't win by using saved games to retry
  60      *  battles or to start over after learning zzword).
  61      *  If ADVENT_NOSAVE is defined, gripe instead. */
  62
  63 #if defined ADVENT_NOSAVE || defined ADVENT_AUTOSAVE
  64     rspeak(SAVERESUME_DISABLED);
  65     return GO_TOP;
  66 #endif
  67     FILE *fp = NULL;
  68
  69     rspeak(SUSPEND_WARNING);
  70     if (!yes_or_no(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN]))
  71         return GO_CLEAROBJ;
  72     game.saved = game.saved + 5;
  73
  74     while (fp == NULL) {
  75         char* name = myreadline("\nFile name: ");
  76         if (name == NULL)
  77             return GO_TOP;
  78         name = strip(name);
  79         if (strlen(name) == 0)
  80             return GO_TOP;      // LCOV_EXCL_LINE
  81         fp = fopen(strip(name), WRITE_MODE);
  82         if (fp == NULL)
  83             printf("Can't open file %s, try again.\n", name);
  84         free(name);
  85     }
  86
  87     savefile(fp, SAVE_VERSION);
  88     fclose(fp);
  89     rspeak(RESUME_HELP);
  90     exit(EXIT_SUCCESS);
  91 }
  92
  93 int resume(void)
  94 {
  95     /*  Resume.  Read a suspended game back from a file.
  96      *  If ADVENT_NOSAVE is defined, gripe instead. */
  97
  98 #if defined ADVENT_NOSAVE || defined ADVENT_AUTOSAVE
  99     rspeak(SAVERESUME_DISABLED);
 100     return GO_TOP;
 101 #endif
 102     FILE *fp = NULL;
 103
 104     if (game.loc != LOC_START || game.abbrev[LOC_START] != 1) {
 105         rspeak(RESUME_ABANDON);
 106         if (!yes_or_no(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN]))
 107             return GO_CLEAROBJ;
 108     }
 109
 110     while (fp == NULL) {
 111         char* name = myreadline("\nFile name: ");
 112         if (name == NULL)
 113             return GO_TOP;
 114         name = strip(name);
 115         if (strlen(name) == 0)
 116             return GO_TOP;      // LCOV_EXCL_LINE
 117         fp = fopen(name, READ_MODE);
 118         if (fp == NULL)
 119             printf("Can't open file %s, try again.\n", name);
 120         free(name);
 121     }
 122
 123     return restore(fp);
 124 }
 125
 126 int restore(FILE* fp)
 127 {
 128     /*  Read and restore game state from file, assuming
 129      *  sane initial state.
 130      *  If ADVENT_NOSAVE is defined, gripe instead. */
 131 #ifdef ADVENT_NOSAVE
 132     rspeak(SAVERESUME_DISABLED)
 133     return GO_TOP;
 134 #endif
 135
 136     IGNORE(fread(&save, sizeof(struct save_t), 1, fp));
 137     fclose(fp);
 138     if (memcmp(save.magic, ADVENT_MAGIC, sizeof(ADVENT_MAGIC)) != 0)
 139         rspeak(BAD_SAVE);
 140     else if (save.version != SAVE_VERSION) {
 141         rspeak(VERSION_SKEW, save.version / 10, MOD(save.version, 10), SAVE_VERSION / 10, MOD(SAVE_VERSION, 10));
 142     } else if (!is_valid(save.game)) {
 143         rspeak(SAVE_TAMPERING);
 144         exit(EXIT_SUCCESS);
 145     } else {
 146         game = save.game;
 147     }
 148     return GO_TOP;
 149 }
 150
 151 bool is_valid(struct game_t valgame)
 152 {
 153     /*  Save files can be roughly grouped into three groups:
 154      *  With valid, reachable state, with valid, but unreachable
 155      *  state and with invalid state. We check that state is
 156      *  valid: no states are outside minimal or maximal value
 157      */
 158
 159     /* Prevent division by zero */
 160     if (valgame.abbnum == 0) {
 161         return false;   // LCOV_EXCL_LINE
 162     }
 163
 164     /* Check for RNG overflow. Truncate */
 165     if (valgame.lcg_x >= LCG_M) {
 166         valgame.lcg_x %= LCG_M; // LCOV_EXCL_LINE
 167     }
 168
 169     /* Check for RNG underflow. Transpose */
 170     if (valgame.lcg_x < LCG_M) {
 171         valgame.lcg_x = LCG_M + (valgame.lcg_x % LCG_M);
 172     }
 173
 174     /*  Bounds check for locations */
 175     if ( valgame.chloc  < -1 || valgame.chloc  > NLOCATIONS ||
 176          valgame.chloc2 < -1 || valgame.chloc2 > NLOCATIONS ||
 177          valgame.loc    <  0 || valgame.loc    > NLOCATIONS ||
 178          valgame.newloc <  0 || valgame.newloc > NLOCATIONS ||
 179          valgame.oldloc <  0 || valgame.oldloc > NLOCATIONS ||
 180          valgame.oldlc2 <  0 || valgame.oldlc2 > NLOCATIONS) {
 181         return false;   // LCOV_EXCL_LINE
 182     }
 183     /*  Bounds check for location arrays */
 184     for (int i = 0; i <= NDWARVES; i++) {
 185         if (valgame.dloc[i]  < -1 || valgame.dloc[i]  > NLOCATIONS  ||
 186             valgame.odloc[i] < -1 || valgame.odloc[i] > NLOCATIONS) {
 187             return false;       // LCOV_EXCL_LINE
 188         }
 189     }
 190
 191     for (int i = 0; i <= NOBJECTS; i++) {
 192         if (valgame.place[i] < -1 || valgame.place[i] > NLOCATIONS  ||
 193             valgame.fixed[i] < -1 || valgame.fixed[i] > NLOCATIONS) {
 194             return false;       // LCOV_EXCL_LINE
 195         }
 196     }
 197
 198     /*  Bounds check for dwarves */
 199     if (valgame.dtotal < 0 || valgame.dtotal > NDWARVES ||
 200         valgame.dkill < 0  || valgame.dkill  > NDWARVES) {
 201         return false;   // LCOV_EXCL_LINE
 202     }
 203
 204     /*  Validate that we didn't die too many times in save */
 205     if (valgame.numdie >= NDEATHS) {
 206         return false;   // LCOV_EXCL_LINE
 207     }
 208
 209     /* Recalculate tally, throw the towel if in disagreement */
 210     int temp_tally = 0;
 211     for (int treasure = 1; treasure <= NOBJECTS; treasure++) {
 212         if (objects[treasure].is_treasure) {
 213             if (valgame.prop[treasure] == STATE_NOTFOUND) {
 214                 ++temp_tally;
 215             }
 216         }
 217     }
 218     if (temp_tally != valgame.tally) {
 219         return false;   // LCOV_EXCL_LINE
 220     }
 221
 222     /* Check that properties of objects aren't beyond expected */
 223     for (obj_t obj = 0; obj <= NOBJECTS; obj++) {
 224         /* Magic number -2 allows a STASHED version of state 1 */
 225         if (valgame.prop[obj] < -2 || valgame.prop[obj] > 1) {
 226             switch (obj) {
 227             case RUG:
 228             case DRAGON:
 229             case BIRD:
 230             case BOTTLE:
 231             case PLANT:
 232             case PLANT2:
 233             case TROLL:
 234             case URN:
 235             case EGGS:
 236             case VASE:
 237             case CHAIN:
 238                 if (valgame.prop[obj] == 2) // There are multiple different states, but it's convenient to clump them together
 239                     continue;   // LCOV_EXCL_LINE
 240             /* FALLTHRU */
 241             case BEAR:
 242                 if (valgame.prop[BEAR] == CONTENTED_BEAR || valgame.prop[BEAR] == BEAR_DEAD)
 243                     continue;
 244             /* FALLTHRU */
 245             default:
 246                 return false;   // LCOV_EXCL_LINE
 247             }
 248         }
 249     }
 250
 251     /* Check that values in linked lists for objects in locations are inside bounds */
 252     for (loc_t loc = LOC_NOWHERE; loc <= NLOCATIONS; loc++) {
 253         if (valgame.atloc[loc] < NO_OBJECT || valgame.atloc[loc] > NOBJECTS * 2) {
 254             return false;       // LCOV_EXCL_LINE
 255         }
 256     }
 257     for (obj_t obj = 0; obj <= NOBJECTS * 2; obj++ ) {
 258         if (valgame.link[obj] < NO_OBJECT || valgame.link[obj] > NOBJECTS * 2) {
 259             return false;       // LCOV_EXCL_LINE
 260         }
 261     }
 262
 263     return true;
 264 }
 265
 266 /* end */