Patch #1768757: Merge fsnode-gsoc into trunk (MAJOR change, will break compilation on some ports)

svn-id: r28944

3 files changed, 224 insertions, 79 deletions

diff --git a/backends/fs/windows/windows-fs-factory.cpp b/backends/fs/windows/windows-fs-factory.cpp
new file mode 100644
index 0000000000..4a4ef018fb
--- /dev/null
+++ b/backends/fs/windows/windows-fs-factory.cpp
@@ -0,0 +1,40 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#include "backends/fs/windows/windows-fs-factory.h"
+#include "backends/fs/windows/windows-fs.cpp"
+
+DECLARE_SINGLETON(WindowsFilesystemFactory);
+
+AbstractFilesystemNode *WindowsFilesystemFactory::makeRootFileNode() const {
+	return new WindowsFilesystemNode();
+}
+
+AbstractFilesystemNode *WindowsFilesystemFactory::makeCurrentDirectoryFileNode() const {
+	return new WindowsFilesystemNode("", true);
+}
+
+AbstractFilesystemNode *WindowsFilesystemFactory::makeFileNodePath(const String &path) const {
+	return new WindowsFilesystemNode(path, false);
+}
diff --git a/backends/fs/windows/windows-fs-factory.h b/backends/fs/windows/windows-fs-factory.h
new file mode 100644
index 0000000000..eb8ade1a8e
--- /dev/null
+++ b/backends/fs/windows/windows-fs-factory.h
@@ -0,0 +1,51 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef WINDOWS_FILESYSTEM_FACTORY_H
+#define WINDOWS_FILESYSTEM_FACTORY_H
+
+#include "common/singleton.h"
+#include "backends/fs/abstract-fs-factory.h"
+
+/**
+ * Creates WindowsFilesystemNode objects.
+ * 
+ * Parts of this class are documented in the base interface class, AbstractFilesystemFactory.
+ */
+class WindowsFilesystemFactory : public AbstractFilesystemFactory, public Common::Singleton<WindowsFilesystemFactory> {	
+public:
+	typedef Common::String String;
+	
+	virtual AbstractFilesystemNode *makeRootFileNode() const;
+	virtual AbstractFilesystemNode *makeCurrentDirectoryFileNode() const;
+	virtual AbstractFilesystemNode *makeFileNodePath(const String &path) const;
+	
+protected:
+	WindowsFilesystemFactory() {};
+		
+private:
+	friend class Common::Singleton<SingletonBaseType>;
+};
+
+#endif /*WINDOWS_FILESYSTEM_FACTORY_H*/
diff --git a/backends/fs/windows/windows-fs.cpp b/backends/fs/windows/windows-fs.cpp
index 0e12c4a96a..995264f110 100644
--- a/backends/fs/windows/windows-fs.cpp
+++ b/backends/fs/windows/windows-fs.cpp
@@ -29,6 +29,7 @@
 #endif
 #include "common/stdafx.h"
 #include "backends/fs/abstract-fs.h"
+#include <io.h>
 #include <stdio.h>
 #include <stdlib.h>
 #ifndef _WIN32_WCE
@@ -36,39 +37,93 @@
 #endif
 #include <tchar.h>
 
-/*
+/**
  * Implementation of the ScummVM file system API based on Windows API.
+ * 
+ * Parts of this class are documented in the base interface class, AbstractFilesystemNode.
  */
-
 class WindowsFilesystemNode : public AbstractFilesystemNode {
 protected:
 	String _displayName;
+	String _path;
 	bool _isDirectory;
-	bool _isValid;
 	bool _isPseudoRoot;
-	String _path;
+	bool _isValid;
 
 public:
+	/**
+	 * Creates a WindowsFilesystemNode with the root node as path.
+	 * 
+	 * In regular windows systems, a virtual root path is used "".
+	 * In windows CE, the "\" root is used instead.
+	 */
 	WindowsFilesystemNode();
-	WindowsFilesystemNode(const String &path);
-
-	virtual String displayName() const { return _displayName; }
-	virtual String name() const { return _displayName; }
-	virtual bool isValid() const { return _isValid; }
+	
+	/**
+	 * Creates a WindowsFilesystemNode for a given path.
+	 * 
+	 * Examples:
+	 *			path=c:\foo\bar.txt, currentDir=false -> c:\foo\bar.txt
+	 * 			path=c:\foo\bar.txt, currentDir=true -> current directory
+	 * 			path=NULL, currentDir=true -> current directory
+	 * 
+	 * @param path String with the path the new node should point to.
+	 * @param currentDir if true, the path parameter will be ignored and the resulting node will point to the current directory.
+	 */
+	WindowsFilesystemNode(const String &path, const bool currentDir);
+	
+	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 bool isDirectory() const { return _isDirectory; }
-	virtual String path() const { return _path; }
+	virtual bool isReadable() const { return _access(_path.c_str(), R_OK) == 0; }
+	virtual bool isValid() const { return _isValid; }
+	virtual bool isWritable() const { return _access(_path.c_str(), W_OK) == 0; }
 
-	virtual bool listDir(AbstractFSList &list, ListMode mode) const;
-	virtual AbstractFilesystemNode *parent() const;
-	virtual AbstractFilesystemNode *child(const String &n) const;
+	virtual AbstractFilesystemNode *getChild(const String &n) const;
+	virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
+	virtual AbstractFilesystemNode *getParent() const;
 
 private:
-	static char *toAscii(TCHAR *x);
-	static const TCHAR* toUnicode(const char *x);
-	static void addFile (AbstractFSList &list, ListMode mode, const char *base, WIN32_FIND_DATA* find_data);
+	/**
+	 * Adds a single WindowsFilesystemNode to a given list.
+	 * This method is used by getChildren() to populate the directory entries list. 
+	 * 
+	 * @param list List to put the file entry node in.
+	 * @param mode Mode to use while adding the file entry to the list.
+	 * @param base String with the directory being listed.
+	 * @param find_data Describes a file that the FindFirstFile, FindFirstFileEx, or FindNextFile functions find.
+ 	 */
+	static void addFile(AbstractFSList &list, ListMode mode, const char *base, WIN32_FIND_DATA* find_data);
+	
+	/**
+	 * Converts a Unicode string to Ascii format.
+	 * 
+	 * @param str String to convert from Unicode to Ascii.
+	 * @return str in Ascii format.
+ 	 */
+	static char *toAscii(TCHAR *str);
+	
+	/**
+	 * Converts an Ascii string to Unicode format.
+	 * 
+	 * @param str String to convert from Ascii to Unicode.
+	 * @return str in Unicode format.
+ 	 */
+	static const TCHAR* toUnicode(const char *str);
 };
 
-
+/**
+ * Returns the last component of a given path.
+ * 
+ * Examples:
+ * 			c:\foo\bar.txt would return "\bar.txt"
+ * 			c:\foo\bar\    would return "\bar\"
+ *  
+ * @param str Path to obtain the last component from.
+ * @return Pointer to the first char of the last component inside str.
+ */
 static const char *lastPathComponent(const Common::String &str) {
 	const char *start = str.c_str();
 	const char *cur = start + str.size() - 2;
@@ -80,27 +135,6 @@ static const char *lastPathComponent(const Common::String &str) {
 	return cur + 1;
 }
 
-char* WindowsFilesystemNode::toAscii(TCHAR *x) {
-
-#ifndef UNICODE
-	return (char*)x;
-#else
-	static char asciiString[MAX_PATH];
-	WideCharToMultiByte(CP_ACP, 0, x, _tcslen(x) + 1, asciiString, sizeof(asciiString), NULL, NULL);
-	return asciiString;
-#endif
-}
-
-const TCHAR* WindowsFilesystemNode::toUnicode(const char *x) {
-#ifndef UNICODE
-	return (const TCHAR *)x;
-#else
-	static TCHAR unicodeString[MAX_PATH];
-	MultiByteToWideChar(CP_ACP, 0, x, strlen(x) + 1, unicodeString, sizeof(unicodeString) / sizeof(TCHAR));
-	return unicodeString;
-#endif
-}
-
 void WindowsFilesystemNode::addFile(AbstractFSList &list, ListMode mode, const char *base, WIN32_FIND_DATA* find_data) {
 	WindowsFilesystemNode entry;
 	char *asciiName = toAscii(find_data->cFileName);
@@ -128,25 +162,24 @@ void WindowsFilesystemNode::addFile(AbstractFSList &list, ListMode mode, const c
 	list.push_back(new WindowsFilesystemNode(entry));
 }
 
-AbstractFilesystemNode *AbstractFilesystemNode::getCurrentDirectory() {
-	char path[MAX_PATH];
-	GetCurrentDirectory(MAX_PATH, path);
-
-	// Add a trailing slash, if necessary.
-	if (path[0] != 0) {
-		if (path[strlen(path) - 1] != '\\')
-			strcat(path, "\\");
-	}
-
-	return new WindowsFilesystemNode(path);
-}
-
-AbstractFilesystemNode *AbstractFilesystemNode::getRoot() {
-	return new WindowsFilesystemNode();
+char* WindowsFilesystemNode::toAscii(TCHAR *str) {
+#ifndef UNICODE
+	return (char*)str;
+#else
+	static char asciiString[MAX_PATH];
+	WideCharToMultiByte(CP_ACP, 0, str, _tcslen(str) + 1, asciiString, sizeof(asciiString), NULL, NULL);
+	return asciiString;
+#endif
 }
 
-AbstractFilesystemNode *AbstractFilesystemNode::getNodeForPath(const String &path) {
-	return new WindowsFilesystemNode(path);
+const TCHAR* WindowsFilesystemNode::toUnicode(const char *str) {
+#ifndef UNICODE
+	return (const TCHAR *)str;
+#else
+	static TCHAR unicodeString[MAX_PATH];
+	MultiByteToWideChar(CP_ACP, 0, str, strlen(str) + 1, unicodeString, sizeof(unicodeString) / sizeof(TCHAR));
+	return unicodeString;
+#endif
 }
 
 WindowsFilesystemNode::WindowsFilesystemNode() {
@@ -165,28 +198,59 @@ WindowsFilesystemNode::WindowsFilesystemNode() {
 #endif
 }
 
-WindowsFilesystemNode::WindowsFilesystemNode(const String &p) {
-	assert(p.size() > 0);
+WindowsFilesystemNode::WindowsFilesystemNode(const String &p, const bool currentDir) {
+	if (currentDir) {
+		char path[MAX_PATH];
+		GetCurrentDirectory(MAX_PATH, path);
 
-	_path = p;
+		// Add a trailing slash, if necessary.
+		if (path[0] != 0) {
+			if (path[strlen(path) - 1] != '\\')
+				strcat(path, "\\");
+		}
+		_path = path;
+	}
+	else {
+		assert(p.size() > 0);
+		_path = p;
+	}
+	
 	_displayName = lastPathComponent(_path);
 
 	// Check whether it is a directory, and whether the file actually exists
 	DWORD fileAttribs = GetFileAttributes(toUnicode(_path.c_str()));
 
 	if (fileAttribs == INVALID_FILE_ATTRIBUTES) {
-		_isValid = false;
 		_isDirectory = false;
+		_isValid = false;
 	} else {
-		_isValid = true;
 		_isDirectory = ((fileAttribs & FILE_ATTRIBUTE_DIRECTORY) != 0);
+		_isValid = true;
 	}
 	_isPseudoRoot = false;
 }
 
-bool WindowsFilesystemNode::listDir(AbstractFSList &myList, ListMode mode) const {
+AbstractFilesystemNode *WindowsFilesystemNode::getChild(const String &n) const {
+	assert(_isDirectory);
+	
+	String newPath(_path);
+	if (_path.lastChar() != '\\')
+		newPath += '\\';
+	newPath += n;
+
+	// Check whether the directory actually exists
+	DWORD fileAttribs = GetFileAttributes(toUnicode(newPath.c_str()));
+	if (fileAttribs == INVALID_FILE_ATTRIBUTES)
+		return 0;
+
+	return new WindowsFilesystemNode(newPath, false);
+}
+
+bool WindowsFilesystemNode::getChildren(AbstractFSList &myList, ListMode mode, bool hidden) const {
 	assert(_isDirectory);
 
+	//TODO: honor the hidden flag
+
 	if (_isPseudoRoot) {
 #ifndef _WIN32_WCE
 		// Drives enumeration
@@ -218,9 +282,12 @@ bool WindowsFilesystemNode::listDir(AbstractFSList &myList, ListMode mode) const
 		sprintf(searchPath, "%s*", _path.c_str());
 
 		handle = FindFirstFile(toUnicode(searchPath), &desc);
+		
 		if (handle == INVALID_HANDLE_VALUE)
 			return false;
+			
 		addFile(myList, mode, _path.c_str(), &desc);
+		
 		while (FindNextFile(handle, &desc))
 			addFile(myList, mode, _path.c_str(), &desc);
 
@@ -230,10 +297,12 @@ bool WindowsFilesystemNode::listDir(AbstractFSList &myList, ListMode mode) const
 	return true;
 }
 
-AbstractFilesystemNode *WindowsFilesystemNode::parent() const {
+AbstractFilesystemNode *WindowsFilesystemNode::getParent() const {
 	assert(_isValid || _isPseudoRoot);
+	
 	if (_isPseudoRoot)
 		return 0;
+		
 	WindowsFilesystemNode *p = new WindowsFilesystemNode();
 	if (_path.size() > 3) {
 		const char *start = _path.c_str();
@@ -246,23 +315,8 @@ AbstractFilesystemNode *WindowsFilesystemNode::parent() const {
 		p->_displayName = lastPathComponent(p->_path);
 		p->_isPseudoRoot = false;
 	}
+	
 	return p;
 }
 
-AbstractFilesystemNode *WindowsFilesystemNode::child(const String &n) const {
-	assert(_isDirectory);
-	String newPath(_path);
-	if (_path.lastChar() != '\\')
-		newPath += '\\';
-	newPath += n;
-
-	// Check whether the directory actually exists
-	DWORD fileAttribs = GetFileAttributes(toUnicode(newPath.c_str()));
-	if (fileAttribs == INVALID_FILE_ATTRIBUTES)
-		return 0;
-
-	WindowsFilesystemNode *p = new WindowsFilesystemNode(newPath);
-	return p;
-}
-
-#endif // WIN32
+#endif //#ifdef WIN32