ShuriZma
/
stella
mirror of https://github.com/stella-emu/stella.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleaned up the FilesystemNode API a little, removing some redundant code. 

The debugger 'saverom' command now uses absolute filenames, and by default
will save data in the users home directory if a proper path isn't included
in the filename.  This fixes a major bug where ROMs were being saved to
the current or application directory, which in some cases were invalid
locations.


git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@2250 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba
This commit is contained in:
stephena 2011-06-09 14:00:30 +00:00
parent 4c59d810f1
commit df71aa03d1
16 changed files with 138 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Changes.txt
View File

@ -30,6 +30,10 @@
* Tweaked bankswitch autodetection code for 4A50 bankswitching.
* The 'saverom' debugger command now saves ROMs in your home
directory by default if you don't specify a valid path. This fixes
a bug whereby ROMs were saved and couldn't later be located.
-Have fun!

10
src/debugger/CartDebug.cxx
View File

@ -626,7 +626,7 @@ string CartDebug::loadSymbolFile(string file)
{
ifstream in(node.getPath().c_str());
if(!in.is_open())
return DebuggerParser::red("symbol file '" + node.getRelativePath() + "' not found");
return DebuggerParser::red("symbol file '" + node.getPath(false) + "' not found");
myUserAddresses.clear();
myUserLabels.clear();
@ -645,9 +645,9 @@ string CartDebug::loadSymbolFile(string file)
addLabel(label, value);
}
in.close();
return "loaded " + node.getRelativePath() + " OK";
return "loaded " + node.getPath(false) + " OK";
}
return DebuggerParser::red("symbol file '" + node.getRelativePath() + "' not found");
return DebuggerParser::red("symbol file '" + node.getPath(false) + "' not found");
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -783,7 +783,7 @@ string CartDebug::loadConfigFile(string file)
}
in.close();
return "loaded " + node.getRelativePath() + " OK";
return "loaded " + node.getPath(false) + " OK";
}
else
return DebuggerParser::red("config file not found");
@ -827,7 +827,7 @@ string CartDebug::saveConfigFile(string file)
}
out.close();
return "saved " + node.getRelativePath() + " OK";
return "saved " + node.getPath(false) + " OK";
}
else
return DebuggerParser::red("config file not found");

13
src/debugger/Debugger.cxx
View File

@ -825,13 +825,16 @@ void Debugger::getCompletions(const char* in, StringList& list) const
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bool Debugger::saveROM(const string& filename) const
string Debugger::saveROM(const string& filename) const
{
ofstream out(filename.c_str(), ios::out | ios::binary);
if(out.is_open())
return myConsole->cartridge().save(out);
string path = AbstractFilesystemNode::getAbsolutePath(filename, "~", "a26");
FilesystemNode node(path);
ofstream out(node.getPath(true).c_str(), ios::out | ios::binary);
if(out.is_open() && myConsole->cartridge().save(out))
return node.getPath(false);
else
return false;
return "";
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

2
src/debugger/Debugger.hxx
View File

@ -289,7 +289,7 @@ class Debugger : public DialogContainer
void setBreakPoint(int bp, bool set);
bool saveROM(const string& filename) const;
string saveROM(const string& filename) const;
bool setBank(int bank);
bool patchROM(int addr, int value);

11
src/debugger/DebuggerParser.cxx
View File

@ -135,7 +135,7 @@ string DebuggerParser::exec(const FilesystemNode& file)
{
ifstream in(file.getPath().c_str());
if(!in.is_open())
return red("autoexec file \'" + file.getRelativePath() + "\' not found");
return red("autoexec file \'" + file.getPath(false) + "\' not found");
ostringstream buf;
int count = 0;
@ -148,12 +148,12 @@ string DebuggerParser::exec(const FilesystemNode& file)
count++;
}
buf << "Executed " << debugger->valueToString(count) << " commands from \""
<< file.getRelativePath() << "\"";
<< file.getPath(false) << "\"";
return buf.str();
}
else
return red("autoexec file \'" + file.getRelativePath() + "\' not found");
return red("autoexec file \'" + file.getPath(false) + "\' not found");
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -1419,8 +1419,9 @@ void DebuggerParser::executeSaveconfig()
// "saverom"
void DebuggerParser::executeSaverom()
{
if(debugger->saveROM(argStrings[0]))
commandResult << "saved ROM as " << argStrings[0];
const string& result = debugger->saveROM(argStrings[0]);
if(result != "")
commandResult << "saved ROM as " << result;
else
commandResult << red("failed to save ROM");
}

3
src/emucore/EventHandler.cxx
View File

@ -2182,7 +2182,6 @@ void EventHandler::leaveDebugMode()
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void EventHandler::setEventState(State state)
{
cerr << "setEventState:" << state << endl;
myState = state;
switch(myState)
@ -2231,7 +2230,7 @@ cerr << "setEventState:" << state << endl;
myEvent->clear();
// Sometimes an extraneous mouse motion event is generated
// after a state change, which should be surpressed
// after a state change, which should be supressed
mySkipMouseMotion = true;
}

15
src/emucore/FSNode.cxx
View File

@ -39,9 +39,7 @@ FilesystemNode::FilesystemNode(AbstractFilesystemNode *realNode)
FilesystemNode::FilesystemNode(const string& p)
{
AbstractFilesystemNode* tmp = 0;
if (p.empty() || p == ".")
tmp = AbstractFilesystemNode::makeCurrentDirectoryFileNode();
else if (p == "~")
if (p.empty() || p == "." || p == "~")
tmp = AbstractFilesystemNode::makeHomeDirectoryFileNode();
else
tmp = AbstractFilesystemNode::makeFileNodePath(p);
@ -124,17 +122,10 @@ FilesystemNode FilesystemNode::getParent() const
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string FilesystemNode::getPath() const
string FilesystemNode::getPath(bool fqn) const
{
assert(_realNode);
return _realNode->getPath();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string FilesystemNode::getRelativePath() const
{
assert(_realNode);
return _realNode->getRelativePath();
return _realNode->getPath(fqn);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

50
src/emucore/FSNode.hxx
View File

@ -116,8 +116,8 @@ class FilesystemNode
* Create a new FilesystemNode referring to the specified path. This is
* the counterpart to the path() method.
*
* If path is empty or equals ".", then a node representing the "current
* directory" will be created. If that is not possible (since e.g. the
* If path is empty or equals "." or "~", then a node representing the
* "home directory" will be created. If that is not possible (since e.g. the
* operating system doesn't support the concept), some other directory is
* used (usually the root directory).
*/
@ -166,7 +166,11 @@ class FilesystemNode
virtual string getName() const;
/**
* Return a string representation of the file which can be passed to fopen().
* Return a string representation of the file with the following properties:
* 1) can be passed to fopen() if fqn is true
* 2) contains the '~' symbol (if applicable), and is suitable for archiving
* (i.e. writing to the config file) if fqn is false
*
* This will usually be a 'path' (hence the name of the method), but can
* be anything that fulfills the above criterions.
*
@ -175,19 +179,7 @@ class FilesystemNode
*
* @return the 'path' represented by this filesystem node
*/
virtual string getPath() const;
/**
* Return a string representation of the file which contains the '~'
* symbol (if applicable), and is suitable for archiving (i.e. writing
* to the config file).
*
* @note Do not assume that this string contains (back)slashes or any
* other kind of 'path separators'.
*
* @return the 'path' represented by this filesystem node
*/
virtual string getRelativePath() const;
virtual string getPath(bool fqn = true) const;
/**
* Determine whether this node has a parent.
@ -302,14 +294,10 @@ class AbstractFilesystemNode
virtual string getName() const = 0;
/**
* Returns the 'path' of the current node, usable in fopen().
* Returns the 'path' of the current node, usable in fopen() or
containing '~' and for archiving.
*/
virtual string getPath() const = 0;
/**
* Returns the 'path' of the current node, containing '~' and for archiving.
*/
virtual string getRelativePath() const = 0;
virtual string getPath(bool fqn = true) const = 0;
/**
* Indicates whether this path refers to a directory or not.
@ -356,6 +344,14 @@ class AbstractFilesystemNode
*/
static bool renameFile(const string& oldfile, const string& newfile);
/**
Create an absolute pathname from the given path (if it isn't already
absolute), pre-pending 'startpath' when necessary. If the path doesn't
have an extension matching 'ext', append it to the path.
*/
static string getAbsolutePath(const string& p, const string& startpath,
const string& ext);
protected:
/**
* The parent node of this directory.
@ -363,14 +359,6 @@ class AbstractFilesystemNode
*/
virtual AbstractFilesystemNode* getParent() const = 0;
/**
* Returns a node representing the "current directory".
* If your system does not support this concept, you can either try to
* emulate it or simply return some "sensible" default directory node,
* e.g. the same value as getRoot() returns.
*/
static AbstractFilesystemNode* makeCurrentDirectoryFileNode();
/**
* Returns a node representing the "home directory".
*

8
src/emucore/OSystem.cxx
View File

@ -325,19 +325,19 @@ void OSystem::setConfigPaths()
if(s == "") s = myBaseDir + "stella.cht";
node = FilesystemNode(s);
myCheatFile = node.getPath();
mySettings->setString("cheatfile", node.getRelativePath());
mySettings->setString("cheatfile", node.getPath(false));
s = mySettings->getString("palettefile");
if(s == "") s = myBaseDir + "stella.pal";
node = FilesystemNode(s);
myPaletteFile = node.getPath();
mySettings->setString("palettefile", node.getRelativePath());
mySettings->setString("palettefile", node.getPath(false));
s = mySettings->getString("propsfile");
if(s == "") s = myBaseDir + "stella.pro";
node = FilesystemNode(s);
myPropertiesFile = node.getPath();
mySettings->setString("propsfile", node.getRelativePath());
mySettings->setString("propsfile", node.getPath(false));
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -875,7 +875,7 @@ void OSystem::validatePath(const string& setting, const string& partialpath,
node = FilesystemNode(node.getPath());
}
fullpath = node.getPath();
mySettings->setString(setting, node.getRelativePath());
mySettings->setString(setting, node.getPath(false));
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

2
src/gui/BrowserDialog.cxx
View File

@ -164,7 +164,7 @@ void BrowserDialog::updateListing()
_nodeList->clear();
// Update the path display
_currentPath->setLabel(_node.getRelativePath());
_currentPath->setLabel(_node.getPath(false));
// Read in the data from the file system
FSList content;

28
src/gui/FileSnapDialog.cxx
View File

@ -225,31 +225,31 @@ void FileSnapDialog::setDefaults()
const string& basedir = instance().baseDir();
node = FilesystemNode("~");
myRomPath->setEditString(node.getRelativePath());
myRomPath->setEditString(node.getPath(false));
const string& statedir = basedir + "state";
node = FilesystemNode(statedir);
myStatePath->setEditString(node.getRelativePath());
myStatePath->setEditString(node.getPath(false));
const string& cheatfile = basedir + "stella.cht";
node = FilesystemNode(cheatfile);
myCheatFile->setEditString(node.getRelativePath());
myCheatFile->setEditString(node.getPath(false));
const string& palettefile = basedir + "stella.pal";
node = FilesystemNode(palettefile);
myPaletteFile->setEditString(node.getRelativePath());
myPaletteFile->setEditString(node.getPath(false));
const string& propsfile = basedir + "stella.pro";
node = FilesystemNode(propsfile);
myPropsFile->setEditString(node.getRelativePath());
myPropsFile->setEditString(node.getPath(false));
const string& eepromdir = basedir;
node = FilesystemNode(eepromdir);
myEEPROMPath->setEditString(node.getRelativePath());
myEEPROMPath->setEditString(node.getPath(false));
const string& ssdir = basedir + "snapshots";
node = FilesystemNode(ssdir);
mySnapPath->setEditString(node.getRelativePath());
mySnapPath->setEditString(node.getPath(false));
mySnapSingle->setState(false);
mySnap1x->setState(false);
@ -311,49 +311,49 @@ void FileSnapDialog::handleCommand(CommandSender* sender, int cmd,
case kRomDirChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myRomPath->setEditString(dir.getRelativePath());
myRomPath->setEditString(dir.getPath(false));
break;
}
case kStateDirChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myStatePath->setEditString(dir.getRelativePath());
myStatePath->setEditString(dir.getPath(false));
break;
}
case kCheatFileChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myCheatFile->setEditString(dir.getRelativePath());
myCheatFile->setEditString(dir.getPath(false));
break;
}
case kPaletteFileChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myPaletteFile->setEditString(dir.getRelativePath());
myPaletteFile->setEditString(dir.getPath(false));
break;
}
case kPropsFileChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myPropsFile->setEditString(dir.getRelativePath());
myPropsFile->setEditString(dir.getPath(false));
break;
}
case kSnapDirChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
mySnapPath->setEditString(dir.getRelativePath());
mySnapPath->setEditString(dir.getPath(false));
break;
}
case kEEPROMDirChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myEEPROMPath->setEditString(dir.getRelativePath());
myEEPROMPath->setEditString(dir.getPath(false));
break;
}

4
src/gui/LauncherDialog.cxx
View File

@ -293,7 +293,7 @@ void LauncherDialog::updateListing(const string& nameToSelect)
myPrevDirButton->setEnabled(myCurrentNode.hasParent());
// Show current directory
myDir->setLabel(myCurrentNode.getRelativePath());
myDir->setLabel(myCurrentNode.getPath(false));
// Now fill the list widget with the contents of the GameList
StringList l;
@ -586,7 +586,7 @@ void LauncherDialog::handleCommand(CommandSender* sender, int cmd,
case kStartupRomDirChosenCmd:
{
FilesystemNode dir(myRomDir->getResult());
instance().settings().setString("romdir", dir.getRelativePath());
instance().settings().setString("romdir", dir.getPath(false));
// fall through to the next case
}
case kRomDirChosenCmd:

4
src/gui/RomAuditDialog.cxx
View File

@ -109,7 +109,7 @@ RomAuditDialog::~RomAuditDialog()
void RomAuditDialog::loadConfig()
{
const string& currentdir =
instance().launcher().currentNode().getRelativePath();
instance().launcher().currentNode().getPath(false);
const string& path = currentdir == "" ?
instance().settings().getString("romdir") : currentdir;
@ -209,7 +209,7 @@ void RomAuditDialog::handleCommand(CommandSender* sender, int cmd,
case kAuditDirChosenCmd:
{
FilesystemNode dir(myBrowser->getResult());
myRomPath->setEditString(dir.getRelativePath());
myRomPath->setEditString(dir.getPath(false));
myResults1->setLabel("");
myResults2->setLabel("");
break;

2
src/macosx/stella_intel.xcodeproj/project.pbxproj
View File

@ -1920,7 +1920,7 @@
2D91752309BA903B0026E9FF /* Deployment */ = {
isa = XCBuildConfiguration;
buildSettings = {
ARCHS = "$(ARCHS_STANDARD_32_64_BIT)";
ARCHS = "$(ARCHS_STANDARD_64_BIT)";
FRAMEWORK_SEARCH_PATHS = (
.,
"$(HOME)/Library/Frameworks",

69
src/unix/FSNodePOSIX.cxx
View File

@ -58,17 +58,16 @@ class POSIXFilesystemNode : public AbstractFilesystemNode
*/
POSIXFilesystemNode(const string& path, bool verify);
virtual bool exists() const { return access(_path.c_str(), F_OK) == 0; }
virtual string getDisplayName() const { return _displayName; }
virtual string getName() const { return _displayName; }
virtual string getPath() const { return _path; }
virtual string getRelativePath() const;
virtual bool isDirectory() const { return _isDirectory; }
virtual bool isReadable() const { return access(_path.c_str(), R_OK) == 0; }
virtual bool isWritable() const { return access(_path.c_str(), W_OK) == 0; }
bool exists() const { return access(_path.c_str(), F_OK) == 0; }
string getDisplayName() const { return _displayName; }
string getName() const { return _displayName; }
string getPath(bool fqn) const;
bool isDirectory() const { return _isDirectory; }
bool isReadable() const { return access(_path.c_str(), R_OK) == 0; }
bool isWritable() const { return access(_path.c_str(), W_OK) == 0; }
virtual bool getChildren(AbstractFSList& list, ListMode mode, bool hidden) const;
virtual AbstractFilesystemNode* getParent() const;
bool getChildren(AbstractFSList& list, ListMode mode, bool hidden) const;
AbstractFilesystemNode* getParent() const;
protected:
string _displayName;
@ -183,21 +182,17 @@ POSIXFilesystemNode::POSIXFilesystemNode(const string& p, bool verify)
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string POSIXFilesystemNode::getRelativePath() const
string POSIXFilesystemNode::getPath(bool fqn) const
{
// If the path starts with the home directory, replace it with '~'
const char* home = getenv("HOME");
if(home != NULL)
if(!fqn && home != NULL && BSPF_startsWithIgnoreCase(_path, home))
{
int len = strlen(home);
if(strncmp(_path.c_str(), home, len) == 0)
{
string path = "~";
const char* offset = _path.c_str() + len;
if(*offset != '/') path += "/";
path += offset;
return path;
}
string path = "~";
const char* offset = _path.c_str() + strlen(home);
if(*offset != '/') path += "/";
path += offset;
return path;
}
return _path;
}
@ -301,12 +296,6 @@ AbstractFilesystemNode* AbstractFilesystemNode::makeRootFileNode()
return new POSIXFilesystemNode();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AbstractFilesystemNode* AbstractFilesystemNode::makeCurrentDirectoryFileNode()
{
return new POSIXFilesystemNode("./", true);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AbstractFilesystemNode* AbstractFilesystemNode::makeHomeDirectoryFileNode()
{
@ -331,3 +320,29 @@ bool AbstractFilesystemNode::renameFile(const string& oldfile,
{
return rename(oldfile.c_str(), newfile.c_str()) == 0;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string AbstractFilesystemNode::getAbsolutePath(const string& p,
const string& startpath,
const string& ext)
{
// Does p start with the root directory or the given startpath?
// If not, it isn't an absolute path
string path = FilesystemNode(p).getPath(false);
if(!BSPF_startsWithIgnoreCase(p, startpath+"/") &&
!BSPF_startsWithIgnoreCase(p, "/"))
path = startpath + "/" + p;
// Does the path have a valid extension?
// If not, we add the given one
string::size_type idx = path.find_last_of('.');
if(idx != string::npos)
{
if(!BSPF_equalsIgnoreCase(path.c_str() + idx + 1, ext))
path = path.replace(idx+1, ext.length(), ext);
}
else
path += "." + ext;
return path;
}

48
src/win32/FSNodeWin32.cxx
View File

@ -91,17 +91,16 @@ class WindowsFilesystemNode : public AbstractFilesystemNode
*/
WindowsFilesystemNode(const string& path);
virtual bool exists() const { return _access(_path.c_str(), F_OK) == 0; }
virtual string getDisplayName() const { return _displayName; }
virtual string getName() const { return _displayName; }
virtual string getPath() const { return _path; }
virtual string getRelativePath() const;
virtual bool isDirectory() const { return _isDirectory; }
virtual bool isReadable() const { return _access(_path.c_str(), R_OK) == 0; }
virtual bool isWritable() const { return _access(_path.c_str(), W_OK) == 0; }
bool exists() const { return _access(_path.c_str(), F_OK) == 0; }
string getDisplayName() const { return _displayName; }
string getName() const { return _displayName; }
string getPath(bool fqn) const;
bool isDirectory() const { return _isDirectory; }
bool isReadable() const { return _access(_path.c_str(), R_OK) == 0; }
bool isWritable() const { return _access(_path.c_str(), W_OK) == 0; }
virtual bool getChildren(AbstractFSList& list, ListMode mode, bool hidden) const;
virtual AbstractFilesystemNode* getParent() const;
bool getChildren(AbstractFSList& list, ListMode mode, bool hidden) const;
AbstractFilesystemNode* getParent() const;
protected:
string _displayName;
@ -286,22 +285,16 @@ WindowsFilesystemNode::WindowsFilesystemNode(const string& p)
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string WindowsFilesystemNode::getRelativePath() const
string WindowsFilesystemNode::getPath(bool fqn) const
{
// If the path starts with the home directory, replace it with '~'
const string& home = myHomeFinder.getHomePath();
if(home != "")
{
// Windows file system not case sensitive
int len = home.length();
if(BSPF_strncasecmp(home.c_str(), _path.substr(0, len).c_str(), len) == 0)
{
string path = "~";
const char* offset = _path.c_str() + len;
if(*offset != '\\') path += '\\';
path += offset;
return path;
}
if(!fqn && home != "" && BSPF_startsWithIgnoreCase(_path, home))
string path = "~";
const char* offset = _path.c_str() + home.length();
if(*offset != '\\') path += '\\';
path += offset;
return path;
}
return _path;
}
@ -423,3 +416,12 @@ bool AbstractFilesystemNode::renameFile(const string& oldfile,
{
return MoveFile(oldfile.c_str(), newfile.c_str()) != 0;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string AbstractFilesystemNode::getAbsolutePath(const string& p,
const string& startpath,
const string& ext)
{
assert(false);
return "";
}