aboutsummaryrefslogtreecommitdiff
path: root/backends/fs/abstract-fs-factory.h
diff options
context:
space:
mode:
authorDavid Corrales2007-05-12 18:17:40 +0000
committerDavid Corrales2007-05-12 18:17:40 +0000
commit86324f00bc561c03b281170125ef2fde14cae132 (patch)
treeae825cd2ad0501f869581e8ac0d71bc7d32433d6 /backends/fs/abstract-fs-factory.h
parentc459f054b46b8791ce206c2ee13d455a9c10fe4d (diff)
downloadscummvm-rg350-86324f00bc561c03b281170125ef2fde14cae132.tar.gz
scummvm-rg350-86324f00bc561c03b281170125ef2fde14cae132.tar.bz2
scummvm-rg350-86324f00bc561c03b281170125ef2fde14cae132.zip
Renamed files and minor tweaks. Thanks LordHoto :)
svn-id: r26810
Diffstat (limited to 'backends/fs/abstract-fs-factory.h')
-rw-r--r--backends/fs/abstract-fs-factory.h48
1 files changed, 48 insertions, 0 deletions
diff --git a/backends/fs/abstract-fs-factory.h b/backends/fs/abstract-fs-factory.h
new file mode 100644
index 0000000000..41bfaaa34b
--- /dev/null
+++ b/backends/fs/abstract-fs-factory.h
@@ -0,0 +1,48 @@
+#ifndef ABSTRACT_FILESYSTEM_FACTORY_H
+#define ABSTRACT_FILESYSTEM_FACTORY_H
+
+#include "common/str.h"
+
+/**
+ * Creates concrete FilesystemNode objects depending on the current architecture.
+ */
+class AbstractFilesystemFactory {
+public:
+ typedef Common::String String;
+
+ /**
+ * Destructor.
+ */
+ virtual ~AbstractFilesystemFactory() {};
+
+ /**
+ * 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.
+ */
+ virtual AbstractFilesystemNode *makeCurrentDirectoryFileNode() const = 0;
+
+ /**
+ * Construct a node based on a path; the path is in the same format as it
+ * would be for calls to fopen().
+ *
+ * Furthermore getNodeForPath(oldNode.path()) should create a new node
+ * identical to oldNode. Hence, we can use the "path" value for persistent
+ * storage e.g. in the config file.
+ *
+ * @param path The path string to create a FilesystemNode for.
+ */
+ virtual AbstractFilesystemNode *makeFileNodePath(const String &path) const = 0;
+
+ /**
+ * Returns a special node representing the filesystem root.
+ * The starting point for any file system browsing.
+ *
+ * On Unix, this will be simply the node for / (the root directory).
+ * On Windows, it will be a special node which "contains" all drives (C:, D:, E:).
+ */
+ virtual AbstractFilesystemNode *makeRootFileNode() const = 0;
+};
+
+#endif /*ABSTRACT_FILESYSTEM_FACTORY_H*/