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  * Copyright (c) 1977, 2005 by Will Crowther and Don Woods
   8  * Copyright (c) 2017 by Eric S. Raymond
   9  * SPDX-License-Identifier: BSD-2-clause
  10  */
  11
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <editline/readline.h>
  15 #include <time.h>
  16 #include <inttypes.h>
  17
  18 #include "advent.h"
  19 #include "dungeon.h"
  20
  21 /*
  22  * Bump on save format change.
  23  *
  24  * Note: Verify that the tests run clean before bumping this, then rebuild the check
  25  * files afterwards.  Otherwise you will get a spurious failure due to the old version
  26  * having been generated into a check file.
  27  */
  28 #define VRSION  29
  29
  30 /*
  31  * If you change the first three members, the resume function may not properly
  32  * reject saves from older versions.  Yes, this glues us to a hardware-
  33  * dependent length of int.  Later members can change, but bump the version
  34  * when you do that.
  35  */
  36 struct save_t {
  37     int64_t savetime;
  38     int32_t mode;               /* not used, must be present for version detection */
  39     int32_t version;
  40     struct game_t game;
  41 };
  42 struct save_t save;
  43
  44 #define IGNORE(r) do{if (r){}}while(0)
  45
  46 int savefile(FILE *fp, int32_t version)
  47 /* Save game to file. No input or output from user. */
  48 {
  49     save.savetime = time(NULL);
  50     save.mode = -1;
  51     save.version = (version == 0) ? VRSION : version;
  52
  53     save.game = game;
  54     IGNORE(fwrite(&save, sizeof(struct save_t), 1, fp));
  55     return (0);
  56 }
  57
  58 /* Suspend and resume */
  59 int suspend(void)
  60 {
  61     /*  Suspend.  Offer to save things in a file, but charging
  62      *  some points (so can't win by using saved games to retry
  63      *  battles or to start over after learning zzword).
  64      *  If ADVENT_NOSAVE is defined, do nothing instead. */
  65
  66 #ifdef ADVENT_NOSAVE
  67     return GO_UNKNOWN;
  68 #endif
  69     FILE *fp = NULL;
  70
  71     rspeak(SUSPEND_WARNING);
  72     if (!yes(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN]))
  73         return GO_CLEAROBJ;
  74     game.saved = game.saved + 5;
  75
  76     while (fp == NULL) {
  77         char* name = readline("\nFile name: ");
  78         if (name == NULL)
  79             return GO_TOP;
  80         fp = fopen(name, WRITE_MODE);
  81         if (fp == NULL)
  82             printf("Can't open file %s, try again.\n", name);
  83         free(name);
  84     }
  85
  86     savefile(fp, VRSION);
  87     fclose(fp);
  88     rspeak(RESUME_HELP);
  89     exit(EXIT_SUCCESS);
  90 }
  91
  92 int resume(void)
  93 {
  94     /*  Resume.  Read a suspended game back from a file.
  95      *  If ADVENT_NOSAVE is defined, do nothing instead. */
  96
  97 #ifdef ADVENT_NOSAVE
  98     return GO_UNKNOWN;
  99 #endif
 100     FILE *fp = NULL;
 101
 102     if (game.loc != 1 ||
 103         game.abbrev[1] != 1) {
 104         rspeak(RESUME_ABANDON);
 105         if (!yes(arbitrary_messages[THIS_ACCEPTABLE], arbitrary_messages[OK_MAN], arbitrary_messages[OK_MAN]))
 106             return GO_CLEAROBJ;
 107     }
 108
 109     while (fp == NULL) {
 110         char* name = readline("\nFile name: ");
 111         // Autocomplete can leave the input with an extra traoling space.
 112         if (name != NULL && strlen(name) > 0 && name[strlen(name) - 1] == ' ')
 113             name[strlen(name) - 1] = '\0';
 114         if (name == NULL)
 115             return GO_TOP;
 116         fp = fopen(name, READ_MODE);
 117         if (fp == NULL)
 118             printf("Can't open file %s, try again.\n", name);
 119         free(name);
 120     }
 121
 122     return restore(fp);
 123 }
 124
 125 int restore(FILE* fp)
 126 {
 127     /*  Read and restore game state from file, assuming
 128      *  sane initial state.
 129      *  If ADVENT_NOSAVE is defined, do nothing instead. */
 130 #ifdef ADVENT_NOSAVE
 131     return GO_UNKNOWN;
 132 #endif
 133
 134     IGNORE(fread(&save, sizeof(struct save_t), 1, fp));
 135     fclose(fp);
 136     if (save.version != VRSION) {
 137         rspeak(VERSION_SKEW, save.version / 10, MOD(save.version, 10), VRSION / 10, MOD(VRSION, 10));
 138     } else if (is_valid(save.game)) {
 139         game = save.game;
 140     }
 141     return GO_TOP;
 142 }
 143
 144 bool is_valid(struct game_t valgame)
 145 {
 146     /*  Save files can be roughly grouped into three groups:
 147      *  With valid, reaceable state, with valid, but unreachable
 148      *  state and with invaild state. We check that state is
 149      *  valid: no states are outside minimal or maximal value
 150      */
 151
 152     /* Prevent division by zero */
 153     if (valgame.abbnum == 0) {
 154         return false;   // LCOV_EXCL_LINE
 155     }
 156
 157     /* Check for RNG overflow. Truncate */
 158     if (valgame.lcg_x >= LCG_M) {
 159         valgame.lcg_x %= LCG_M; // LCOV_EXCL_LINE
 160     }
 161
 162     /* Check for RNG underflow. Transpose */
 163     if (valgame.lcg_x < LCG_M) {
 164         valgame.lcg_x = LCG_M + (valgame.lcg_x % LCG_M);
 165     }
 166
 167     /*  Bounds check for locations */
 168     if ( valgame.chloc  < -1 || valgame.chloc  > NLOCATIONS ||
 169          valgame.chloc2 < -1 || valgame.chloc2 > NLOCATIONS ||
 170          valgame.loc    <  0 || valgame.loc    > NLOCATIONS ||
 171          valgame.newloc <  0 || valgame.newloc > NLOCATIONS ||
 172          valgame.oldloc <  0 || valgame.oldloc > NLOCATIONS ||
 173          valgame.oldlc2 <  0 || valgame.oldlc2 > NLOCATIONS) {
 174         return false;   // LCOV_EXCL_LINE
 175     }
 176     /*  Bounds check for location arrays */
 177     for (int i = 0; i <= NDWARVES; i++) {
 178         if (valgame.dloc[i]  < -1 || valgame.dloc[i]  > NLOCATIONS  ||
 179             valgame.odloc[i] < -1 || valgame.odloc[i] > NLOCATIONS) {
 180             return false;       // LCOV_EXCL_LINE
 181         }
 182     }
 183
 184     for (int i = 0; i <= NOBJECTS; i++) {
 185         if (valgame.place[i] < -1 || valgame.place[i] > NLOCATIONS  ||
 186             valgame.fixed[i] < -1 || valgame.fixed[i] > NLOCATIONS) {
 187             return false;       // LCOV_EXCL_LINE
 188         }
 189     }
 190
 191     /*  Bounds check for dwarves */
 192     if (valgame.dtotal < 0 || valgame.dtotal > NDWARVES ||
 193         valgame.dkill < 0  || valgame.dkill  > NDWARVES) {
 194         return false;   // LCOV_EXCL_LINE
 195     }
 196
 197     /*  Validate that we didn't die too many times in save */
 198     if (valgame.numdie >= NDEATHS) {
 199         return false;   // LCOV_EXCL_LINE
 200     }
 201
 202     /* Recalculate tally, throw the towel if in disagreement */
 203     int temp_tally = 0;
 204     for (int treasure = 1; treasure <= NOBJECTS; treasure++) {
 205         if (objects[treasure].is_treasure) {
 206             if (valgame.prop[treasure] == STATE_NOTFOUND) {
 207                 ++temp_tally;
 208             }
 209         }
 210     }
 211     if (temp_tally != valgame.tally) {
 212         return false;   // LCOV_EXCL_LINE
 213     }
 214
 215     /* Check that properties of objects aren't beyond expected */
 216     for (obj_t obj = 0; obj <= NOBJECTS; obj++) {
 217         if (valgame.prop[obj] < STATE_NOTFOUND || valgame.prop[obj] > 1) {
 218             switch (obj) {
 219             case RUG:
 220             case DRAGON:
 221             case BIRD:
 222             case BOTTLE:
 223             case PLANT:
 224             case PLANT2:
 225             case TROLL:
 226             case URN:
 227             case EGGS:
 228             case VASE:
 229             case CHAIN:
 230                 if (valgame.prop[obj] == 2) // There are multiple different states, but it's convenient to clump them together
 231                     continue;
 232             /* FALLTHRU */
 233             case BEAR:
 234                 if (valgame.prop[BEAR] == CONTENTED_BEAR || valgame.prop[BEAR] == BEAR_DEAD)
 235                     continue;
 236             /* FALLTHRU */
 237             default:
 238                 return false;   // LCOV_EXCL_LINE
 239             }
 240         }
 241     }
 242
 243     /* Check that values in linked lists for objects in locations are inside bounds */
 244     for (loc_t loc = LOC_NOWHERE; loc <= NLOCATIONS; loc++) {
 245         if (valgame.atloc[loc] < NO_OBJECT || valgame.atloc[loc] > NOBJECTS * 2) {
 246             return false;       // LCOV_EXCL_LINE
 247         }
 248     }
 249     for (obj_t obj = 0; obj <= NOBJECTS * 2; obj++ ) {
 250         if (valgame.link[obj] < NO_OBJECT || valgame.link[obj] > NOBJECTS * 2) {
 251             return false;       // LCOV_EXCL_LINE
 252         }
 253     }
 254
 255     return true;
 256 }
 257
 258 /* end */