Ticket #8762: getsavepath.patch

home/david/Projects/scummvm/backends/saves/default/default-saves.cpp

@@ -29 +29 @@
 #include "common/util.h"
 #include "common/fs.h"
 #include "common/file.h"
+#include "common/config-manager.h"
 #include "backends/saves/default/default-saves.h"
 #include "backends/saves/compressed/compressed-saves.h"
 
@@ -249 +250 @@
         }
 }
 
+const char *DefaultSaveFileManager::getSavePath() const {
+
+#if defined(PALMOS_MODE) || defined(__PSP__)
+        return SCUMMVM_SAVEPATH;
+#else
+
+        const char *dir = NULL;
+
+        // Try to use game specific savepath from config
+        dir = ConfMan.get("savepath").c_str();
+
+        // Work around a bug (#999122) in the original 0.6.1 release of
+        // ScummVM, which would insert a bad savepath value into config files.
+        if (0 == strcmp(dir, "None")) {
+                ConfMan.removeKey("savepath", ConfMan.getActiveDomainName());
+                ConfMan.flushToDisk();
+                dir = ConfMan.get("savepath").c_str();
+        }
+
+#ifdef _WIN32_WCE
+        if (dir[0] == 0)
+                dir = ConfMan.get("path").c_str();
+#endif
+
+        assert(dir);
+
+        return dir;
+#endif
+}
+
 #endif // !defined(DISABLE_DEFAULT_SAVEFILEMANAGER)

home/david/Projects/scummvm/backends/saves/default/default-saves.h

@@ -29 +29 @@
 #include "common/savefile.h"
 #include "common/str.h"
 
+/**
+ * Provides a default savefile manager implementation for common platforms.
+ */
 class DefaultSaveFileManager : public Common::SaveFileManager {
 public:
         virtual Common::StringList listSavefiles(const char *regex);
@@ -35 +38 @@
         virtual Common::InSaveFile *openForLoading(const char *filename);
         virtual Common::OutSaveFile *openForSaving(const char *filename);
         virtual bool removeSavefile(const char *filename);
+
+protected:
+        /**
+         * Get the path to the save game directory.
+         * Should only be used internally since some platforms
+         * might implement savefiles in a completely different way.
+         */
+        virtual const char *getSavePath() const;
 };
 
 #endif

home/david/Projects/scummvm/backends/saves/savefile.cpp

@@ -24 +24 @@
  */
 
 #include "common/util.h"
-#include "common/config-manager.h"
 #include "common/savefile.h"
 
 #include <stdio.h>
@@ -72 +71 @@
         return success;
 }
 
-const char *SaveFileManager::getSavePath() const {
-
-#if defined(PALMOS_MODE) || defined(__PSP__)
-        return SCUMMVM_SAVEPATH;
-#else
-
-        const char *dir = NULL;
-
-        // Try to use game specific savepath from config
-        dir = ConfMan.get("savepath").c_str();
-
-        // Work around a bug (#999122) in the original 0.6.1 release of
-        // ScummVM, which would insert a bad savepath value into config files.
-        if (0 == strcmp(dir, "None")) {
-                ConfMan.removeKey("savepath", ConfMan.getActiveDomainName());
-                ConfMan.flushToDisk();
-                dir = ConfMan.get("savepath").c_str();
-        }
-
-#ifdef _WIN32_WCE
-        if (dir[0] == 0)
-                dir = ConfMan.get("path").c_str();
-#endif
-
-        assert(dir);
-
-        return dir;
-#endif
+String SaveFileManager::popErrorDesc() {
+        String err = _errorDesc;
+        clearError();
+        
+        return err;
 }
 
 } // End of namespace Common

home/david/Projects/scummvm/common/savefile.h

@@ -109 +109 @@
          * @return A string describing the last error.
          */
         virtual String getErrorDesc() { return _errorDesc; }
-
+        
+        /**
+         * Returns the last ocurred error description. If none ocurred, returns 0.
+         * Also clears the last error state and description.
+         * 
+         * @return A string describing the last error.
+         */
+        virtual String popErrorDesc();
+        
         /**
          * Open the file with name filename in the given directory for saving.
          * @param filename      the filename
@@ -145 +153 @@
          * returns a list of strings for all present file names.
          */
         virtual Common::StringList listSavefiles(const char *regex) = 0;
-
-        /**
-         * Get the path to the save game directory.
-         * Should only be used for error messages, *never* to construct file paths
-         * from it, since that is highly unportable!
-         */
-        virtual const char *getSavePath() const;
 };
 
 } // End of namespace Common

home/david/Projects/scummvm/engines/sky/control.cpp

@@ -944 +944 @@
                                                 refreshNames = true;
                                         }
                                         if (clickRes == NO_DISK_SPACE) {
-                                                displayMessage(0, "Could not save game in directory '%s'", _saveFileMan->getSavePath());
+                                                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
                                                 quitPanel = true;
                                         }
                                         if ((clickRes == CANCEL_PRESSED) || (clickRes == GAME_RESTORED))
@@ -1153 +1153 @@
                 delete outf;
         }
         if (ioFailed)
-                displayMessage(NULL, "Unable to store Savegame names to file SKY-VM.SAV in directory %s", _saveFileMan->getSavePath());
+                displayMessage(NULL, _saveFileMan->popErrorDesc().c_str());
         free(tmpBuf);
 }
 
@@ -1167 +1167 @@
 
         outf = _saveFileMan->openForSaving(fName);
         if (outf == NULL) {
-                displayMessage(0, "Unable to create autosave file '%s' in directory '%s'", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
                 return;
         }
         uint8 *saveData = (uint8 *)malloc(0x20000);
@@ -1177 +1177 @@
         outf->finalize();
 
         if (outf->ioFailed())
-                displayMessage(0, "Unable to write autosave file '%s' in directory '%s'. Disk full?", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
 
         delete outf;
         free(saveData);

home/david/Projects/scummvm/engines/sword1/control.cpp

@@ -738 +738 @@
 
         if (!outf) {
                 // Display an error message, and do nothing
-                displayMessage(0, "Can't create SAVEGAME.INF in directory '%s'", _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
                 return;
         }
 
@@ -757 +757 @@
         }
         outf->finalize();
         if (outf->ioFailed())
-                displayMessage(0, "Can't write to SAVEGAME.INF in directory '%s'. Device full?", _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
         delete outf;
 }
 
@@ -928 +928 @@
         outf = _saveFileMan->openForSaving(fName);
         if (!outf) {
                 // Display an error message and do nothing
-                displayMessage(0, "Unable to create file '%s' in directory '%s'", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->getErrorDesc().c_str());
                 return;
         }
 
@@ -952 +952 @@
                 outf->writeUint32LE(playerRaw[cnt2]);
         outf->finalize();
         if (outf->ioFailed())
-                displayMessage(0, "Couldn't write to file '%s' in directory '%s'. Device full?", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
         delete outf;
 }
 
@@ -964 +964 @@
         inf = _saveFileMan->openForLoading(fName);
         if (!inf) {
                 // Display an error message, and do nothing
-                displayMessage(0, "Can't open file '%s' in directory '%s'", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
                 return false;
         }
 
@@ -988 +988 @@
                 playerBuf[cnt2] = inf->readUint32LE();
 
         if (inf->ioFailed()) {
-                displayMessage(0, "Can't read from file '%s' in directory '%s'", fName, _saveFileMan->getSavePath());
+                displayMessage(0, _saveFileMan->popErrorDesc().c_str());
                 delete inf;
                 free(_restoreBuf);
                 _restoreBuf = NULL;