saveresume.c

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