aboutsummaryrefslogtreecommitdiff
path: root/backends/fs/abstract-fs.h
diff options
context:
space:
mode:
Diffstat (limited to 'backends/fs/abstract-fs.h')
-rw-r--r--backends/fs/abstract-fs.h46
1 files changed, 23 insertions, 23 deletions
diff --git a/backends/fs/abstract-fs.h b/backends/fs/abstract-fs.h
index 611948691e..f593023d24 100644
--- a/backends/fs/abstract-fs.h
+++ b/backends/fs/abstract-fs.h
@@ -46,7 +46,7 @@ protected:
friend class FilesystemNode;
typedef Common::String String;
typedef FilesystemNode::ListMode ListMode;
-
+
/**
* Returns the child node with the given name. If no child with this name
* exists, returns 0. When called on a non-directory node, it should
@@ -55,13 +55,13 @@ protected:
* Example:
* Calling getChild() for a node with path "/foo/bar" using name="file.txt",
* would produce a new node with "/foo/bar/file.txt" as path.
- *
+ *
* @note This function will append a separator char (\ or /) to the end of the
* path if needed.
- *
+ *
* @note Handling calls on non-dir nodes gracefully makes it possible to
* switch to a lazy type detection scheme in the future.
- *
+ *
* @param name String containing the name of the child to create a new node.
*/
virtual AbstractFilesystemNode *getChild(const String &name) const = 0;
@@ -77,7 +77,7 @@ public:
* Destructor.
*/
virtual ~AbstractFilesystemNode() {}
-
+
/*
* Indicates whether the object referred by this path exists in the filesystem or not.
*/
@@ -86,65 +86,65 @@ public:
/**
* Return a list of child nodes of this directory node. If called on a node
* that does not represent a directory, false is returned.
- *
+ *
* @param list List to put the contents of the directory in.
* @param mode Mode to use while listing the directory.
* @param hidden Whether to include hidden files or not in the results.
- *
+ *
* @return true if succesful, false otherwise (e.g. when the directory does not exist).
*/
virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const = 0;
/**
* Returns a human readable path string.
- *
+ *
* @note By default, this method returns the value of getName().
*/
virtual String getDisplayName() const { return getName(); }
-
+
/**
* Returns the last component of the path pointed by this FilesystemNode.
- *
+ *
* Examples (POSIX):
* /foo/bar.txt would return /bar.txt
* /foo/bar/ would return /bar/
- *
+ *
* @note This method is very architecture dependent, please check the concrete implementation for more information.
*/
virtual String getName() const = 0;
-
+
/**
* Returns the 'path' of the current node, usable in fopen().
*/
virtual String getPath() const = 0;
-
+
/**
* Indicates whether this path refers to a directory or not.
*/
virtual bool isDirectory() const = 0;
-
+
/**
* Indicates whether the object referred by this path can be read from or not.
- *
- * If the path refers to a directory, readability implies being able to read
+ *
+ * If the path refers to a directory, readability implies being able to read
* and list the directory entries.
- *
- * If the path refers to a file, readability implies being able to read the
+ *
+ * If the path refers to a file, readability implies being able to read the
* contents of the file.
- *
+ *
* @return bool true if the object can be read, false otherwise.
*/
virtual bool isReadable() const = 0;
-
+
/**
* Indicates whether the object referred by this path can be written to or not.
- *
+ *
* If the path refers to a directory, writability implies being able to modify
* the directory entry (i.e. rename the directory, remove it or write files inside of it).
- *
+ *
* If the path refers to a file, writability implies being able to write data
* to the file.
- *
+ *
* @return bool true if the object can be written to, false otherwise.
*/
virtual bool isWritable() const = 0;