libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-02-23 20:51:14 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Patch #1857121: Refactoring of the getSavePath method

Browse Source 
svn-id: r30032
This commit is contained in:
Eugene Sandulenko 2007-12-28 07:37:04 +00:00
parent 26913c3057
commit d4d072fe04
9 changed files with 136 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
backends/platform/ds/arm9/source/gbampsave.h
View File

@ -24,7 +24,7 @@
#define _GBAMPSAVE_H_
#include "system.h"
#include "common/savefile.h"
#include "saves/default/default-saves.h"
#include "ds-fs.h"
#define SAVE_BUFFER_SIZE 100000
@ -58,9 +58,7 @@ public:
};
class GBAMPSaveFileManager : public Common::SaveFileManager {
class GBAMPSaveFileManager : public DefaultSaveFileManager {
public:
GBAMPSaveFileManager();
~GBAMPSaveFileManager();
@ -81,5 +79,4 @@ public:
void listFiles();
};
#endif

4
backends/platform/ps2/savefile.cpp
View File

@ -484,10 +484,6 @@ void Ps2SaveFileManager::listSavefiles(const char *prefix, bool *marks, int num)
_screen->wantAnim(false);
}
const char *Ps2SaveFileManager::getSavePath(void) const {
return "mc0:";
}
bool Ps2SaveFileManager::setupIcon(const char *dest, const char *ico, const char *descr1, const char *descr2) {
mcIcon icon_sys;
memset(&icon_sys, 0, sizeof(mcIcon));

4
backends/platform/ps2/savefile.h
View File

@ -42,12 +42,10 @@ public:
virtual Common::OutSaveFile *openForSaving(const char *filename);
virtual void listSavefiles(const char *prefix, bool *marks, int num);
/** Get the path to the save game directory. */
virtual const char *getSavePath() const;
void writeSaveNonblocking(char *name, void *buf, uint32 size);
void saveThread(void);
void quit(void);
private:
bool setupIcon(const char *dest, const char *ico, const char *descr1, const char *descr2);

141
backends/saves/default/default-saves.cpp
View File

@ -29,6 +29,7 @@
#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"
@ -128,120 +129,132 @@ Common::StringList DefaultSaveFileManager::listSavefiles(const char *regex) {
return results;
}
Common::InSaveFile *DefaultSaveFileManager::openForLoading(const char *filename) {
char buf[256];
join_paths(filename, getSavePath(), buf, sizeof(buf));
StdioSaveFile *sf = new StdioSaveFile(buf, false);
if (!sf->isOpen()) {
delete sf;
sf = 0;
}
return wrapInSaveFile(sf);
}
Common::OutSaveFile *DefaultSaveFileManager::openForSaving(const char *filename) {
char buf[256];
// Ensure that the savepath exists and is writeable. If not, generate
// an appropriate error
const char *savePath = getSavePath();
void DefaultSaveFileManager::checkPath(const char *path) {
clearError();
Common::String pathStr(path);
#if defined(UNIX) || defined(__SYMBIAN32__)
struct stat sb;
clearError();
// Check whether the dir exists
if (stat(savePath, &sb) == -1) {
if (stat(path, &sb) == -1) {
// The dir does not exist, or stat failed for some other reason.
// If the problem was that the path pointed to nothing, try
// to create the dir (ENOENT case).
switch (errno) {
case EACCES:
setError(SFM_DIR_ACCESS, Common::String("Search or write permission denied"));
setError(SFM_DIR_ACCESS, "Search or write permission denied: "+pathStr);
break;
#if !defined(__SYMBIAN32__)
case ELOOP:
setError(SFM_DIR_LOOP, Common::String("Too many symbolic links encountered while traversing the path"));
setError(SFM_DIR_LOOP, "Too many symbolic links encountered while traversing the path: "+pathStr);
break;
#endif
case ENAMETOOLONG:
setError(SFM_DIR_NAMETOOLONG, Common::String("The path name is too long"));
setError(SFM_DIR_NAMETOOLONG, "The path name is too long: "+pathStr);
break;
case ENOENT:
if (mkdir(savePath, 0755) != 0) {
if (mkdir(path, 0755) != 0) {
// mkdir could fail for various reasons: The parent dir doesn't exist,
// or is not writeable, the path could be completly bogus, etc.
warning("mkdir for '%s' failed!", savePath);
warning("mkdir for '%s' failed!", path);
perror("mkdir");
switch (errno) {
case EACCES:
setError(SFM_DIR_ACCESS, Common::String("Search or write permission denied"));
setError(SFM_DIR_ACCESS, "Search or write permission denied: "+pathStr);
break;
case EMLINK:
setError(SFM_DIR_LINKMAX, Common::String("The link count of the parent directory would exceed {LINK_MAX}"));
setError(SFM_DIR_LINKMAX, "The link count of the parent directory would exceed {LINK_MAX}: "+pathStr);
break;
#if !defined(__SYMBIAN32__)
case ELOOP:
setError(SFM_DIR_LOOP, Common::String("Too many symbolic links encountered while traversing the path"));
setError(SFM_DIR_LOOP, "Too many symbolic links encountered while traversing the path: "+pathStr);
break;
#endif
case ENAMETOOLONG:
setError(SFM_DIR_NAMETOOLONG, Common::String("The path name is too long"));
setError(SFM_DIR_NAMETOOLONG, "The path name is too long: "+pathStr);
break;
case ENOENT:
setError(SFM_DIR_NOENT, Common::String("A component of the path does not exist, or the path is an empty string"));
setError(SFM_DIR_NOENT, "A component of the path does not exist, or the path is an empty string: "+pathStr);
break;
case ENOTDIR:
setError(SFM_DIR_NOTDIR, Common::String("A component of the path prefix is not a directory"));
setError(SFM_DIR_NOTDIR, "A component of the path prefix is not a directory: "+pathStr);
break;
case EROFS:
setError(SFM_DIR_ROFS, Common::String("The parent directory resides on a read-only file system"));
setError(SFM_DIR_ROFS, "The parent directory resides on a read-only file system:"+pathStr);
break;
}
return 0;
}
break;
case ENOTDIR:
setError(SFM_DIR_NOTDIR, Common::String("A component of the path prefix is not a directory"));
setError(SFM_DIR_NOTDIR, "A component of the path prefix is not a directory: "+pathStr);
break;
}
} else {
// So stat() succeeded. But is the path actually pointing to a directory?
if (!S_ISDIR(sb.st_mode)) {
setError(SFM_DIR_NOTDIR, Common::String("The given savepath is not a directory"));
return 0;
setError(SFM_DIR_NOTDIR, "The given savepath is not a directory: "+pathStr);
}
}
#endif
}
join_paths(filename, savePath, buf, sizeof(buf));
StdioSaveFile *sf = new StdioSaveFile(buf, true);
if (!sf->isOpen()) {
delete sf;
sf = 0;
Common::InSaveFile *DefaultSaveFileManager::openForLoading(const char *filename) {
// Ensure that the savepath is valid. If not, generate an appropriate error.
char buf[256];
const char *savePath = getSavePath();
checkPath(savePath);
if (getError() == SFM_NO_ERROR) {
join_paths(filename, savePath, buf, sizeof(buf));
StdioSaveFile *sf = new StdioSaveFile(buf, false);
if (!sf->isOpen()) {
delete sf;
sf = 0;
}
return wrapInSaveFile(sf);
} else {
return 0;
}
}
return wrapOutSaveFile(sf);
Common::OutSaveFile *DefaultSaveFileManager::openForSaving(const char *filename) {
// Ensure that the savepath is valid. If not, generate an appropriate error.
char buf[256];
const char *savePath = getSavePath();
checkPath(savePath);
if (getError() == SFM_NO_ERROR) {
join_paths(filename, savePath, buf, sizeof(buf));
StdioSaveFile *sf = new StdioSaveFile(buf, true);
if (!sf->isOpen()) {
delete sf;
sf = 0;
}
return wrapOutSaveFile(sf);
} else {
return 0;
}
}
bool DefaultSaveFileManager::removeSavefile(const char *filename) {
char buf[256];
clearError();
Common::String filenameStr;
join_paths(filename, getSavePath(), buf, sizeof(buf));
if (remove(buf) != 0) {
#ifndef _WIN32_WCE
if (errno == EACCES)
setError(SFM_DIR_ACCESS, Common::String("Search or write permission denied"));
setError(SFM_DIR_ACCESS, "Search or write permission denied: "+filenameStr);
if (errno == ENOENT)
setError(SFM_DIR_NOENT, Common::String("A component of the path does not exist, or the path is an empty string"));
setError(SFM_DIR_NOENT, "A component of the path does not exist, or the path is an empty string: "+filenameStr);
#endif
return false;
} else {
@ -249,4 +262,34 @@ bool DefaultSaveFileManager::removeSavefile(const char *filename) {
}
}
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)

17
backends/saves/default/default-saves.h
View File

@ -29,12 +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);
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 savegame directory.
* Should only be used internally since some platforms
* might implement savefiles in a completely different way.
*/
virtual const char *getSavePath() const;
/**
* Checks the given path for read access, existence, etc.
* Sets the internal error and error message accordingly.
*/
void checkPath(const char *path);
};
#endif

34
backends/saves/savefile.cpp
View File

@ -24,7 +24,6 @@
*/
#include "common/util.h"
#include "common/config-manager.h"
#include "common/savefile.h"
#include <stdio.h>
@ -72,34 +71,11 @@ bool SaveFileManager::renameSavefile(const char *oldFilename, const char *newFil
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

17
common/savefile.h
View File

@ -109,7 +109,15 @@ public:
* @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,13 +153,6 @@ public:
* 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

8
engines/sky/control.cpp
View File

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

12
engines/sword1/control.cpp
View File

@ -738,7 +738,7 @@ void Control::writeSavegameDescriptions(void) {
if (!outf) {
// Display an error message, and do nothing
displayMessage(0, "Can't create SAVEGAME.INF in directory '%s'", _saveFileMan->getSavePath());
displayMessage(0, "Can't create SAVEGAME.INF. (%s)", _saveFileMan->popErrorDesc().c_str());
return;
}
@ -757,7 +757,7 @@ void Control::writeSavegameDescriptions(void) {
}
outf->finalize();
if (outf->ioFailed())
displayMessage(0, "Can't write to SAVEGAME.INF in directory '%s'. Device full?", _saveFileMan->getSavePath());
displayMessage(0, "Can't write to SAVEGAME.INF. Device full? (%s)", _saveFileMan->popErrorDesc().c_str());
delete outf;
}
@ -928,7 +928,7 @@ void Control::saveGameToFile(uint8 slot) {
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, "Unable to create file '%s'. (%s)", fName, _saveFileMan->popErrorDesc().c_str());
return;
}
@ -952,7 +952,7 @@ void Control::saveGameToFile(uint8 slot) {
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, "Couldn't write to file '%s'. Device full? (%s)", fName, _saveFileMan->popErrorDesc().c_str());
delete outf;
}
@ -964,7 +964,7 @@ bool Control::restoreGameFromFile(uint8 slot) {
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, "Can't open file '%s'. (%s)", fName, _saveFileMan->popErrorDesc().c_str());
return false;
}
@ -988,7 +988,7 @@ bool Control::restoreGameFromFile(uint8 slot) {
playerBuf[cnt2] = inf->readUint32LE();
if (inf->ioFailed()) {
displayMessage(0, "Can't read from file '%s' in directory '%s'", fName, _saveFileMan->getSavePath());
displayMessage(0, "Can't read from file '%s'. (%s)", fName, _saveFileMan->popErrorDesc().c_str());
delete inf;
free(_restoreBuf);
_restoreBuf = NULL;