Partial REUSE cmpliance.
[open-adventure.git] / saveresume.c
index 6e73017e48a32ff2cb4ee5eb89c37279ab7a8fc6..db1153b3c793bef7bb8bddc35ba55c236c98c5bb 100644 (file)
@@ -4,26 +4,33 @@
  * (ESR) This replaces  a bunch of particularly nasty FORTRAN-derived code;
  * see the history.adoc file in the source distribution for discussion.
  *
- * Copyright (c) 1977, 2005 by Will Crowther and Don Woods
- * Copyright (c) 2017 by Eric S. Raymond
- * SPDX-License-Identifier: BSD-2-clause
+ * SPDX-FileCopyrightText: 1977, 2005 by Will Crowther and Don Woods
+ * SPDX-FileCopyrightText: 2017 by Eric S. Raymond
+ * SPDX-License-Identifier: BSD-2-Clause
  */
 
 #include <stdlib.h>
 #include <string.h>
-#include <editline/readline.h>
+#include <ctype.h>
 #include <time.h>
 #include <inttypes.h>
 
 #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 */
+
+static 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,16 +150,20 @@ 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;
@@ -134,8 +172,8 @@ int restore(FILE* fp)
 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, reachable state, with valid, but unreachable
+     *  state and with invalid state. We check that state is
      *  valid: no states are outside minimal or maximal value
      */
 
@@ -190,7 +228,7 @@ bool is_valid(struct game_t valgame)
     }
 
     /* 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) {
@@ -204,7 +242,8 @@ bool is_valid(struct game_t valgame)
 
     /* 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:
@@ -218,7 +257,7 @@ bool is_valid(struct game_t valgame)
             case VASE:
             case CHAIN:
                 if (valgame.prop[obj] == 2) // There are multiple different states, but it's convenient to clump them together
-                    continue;
+                    continue;  // LCOV_EXCL_LINE
             /* FALLTHRU */
             case BEAR:
                 if (valgame.prop[BEAR] == CONTENTED_BEAR || valgame.prop[BEAR] == BEAR_DEAD)