ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Implementation of the ScummVM file system API based on POSIX. More...

#include <posix-fs.h>

Inheritance diagram for POSIXFilesystemNode:
Collaboration diagram for POSIXFilesystemNode:

List of all members.

Public Member Functions

 POSIXFilesystemNode (const Common::String &path)
 Creates a POSIXFilesystemNode for a given path.
virtual bool exists () const
virtual Common::String getDisplayName () const
 Returns a human readable path string.
virtual Common::String getName () const
 Returns the last component of the path pointed by this FSNode.
virtual Common::String getPath () const
 Returns the 'path' of the current node, usable in fopen().
virtual bool isDirectory () const
 Indicates whether this path refers to a directory or not.
virtual bool isReadable () const
 Indicates whether the object referred by this path can be read from or not.
virtual bool isWritable () const
 Indicates whether the object referred by this path can be written to or not.
virtual AbstractFSNodegetChild (const Common::String &n) const
 Returns the child node with the given name.
virtual bool getChildren (AbstractFSList &list, ListMode mode, bool hidden) const
 Return a list of child nodes of this directory node.
virtual AbstractFSNodegetParent () const
 The parent node of this directory.
virtual
Common::SeekableReadStream
createReadStream ()
 Creates a SeekableReadStream instance corresponding to the file referred by this node.
virtual Common::WriteStreamcreateWriteStream ()
 Creates a WriteStream instance corresponding to the file referred by this node.
virtual bool create (bool isDirectoryFlag)
 Creates a file referred by this node.

Protected Member Functions

virtual AbstractFSNodemakeNode (const Common::String &path) const
 POSIXFilesystemNode ()
 Plain constructor, for internal use only (hence protected).

Protected Attributes

Common::String _displayName
Common::String _path
bool _isDirectory
bool _isValid

Private Member Functions

virtual void setFlags ()
 Tests and sets the _isValid and _isDirectory flags, using the stat() function.

Detailed Description

Implementation of the ScummVM file system API based on POSIX.

Parts of this class are documented in the base interface class, AbstractFSNode.

Definition at line 38 of file posix-fs.h.


Constructor & Destructor Documentation

POSIXFilesystemNode::POSIXFilesystemNode (  )  [inline, protected]

Plain constructor, for internal use only (hence protected).

Definition at line 52 of file posix-fs.h.

POSIXFilesystemNode::POSIXFilesystemNode ( const Common::String path  ) 

Creates a POSIXFilesystemNode for a given path.

Parameters:
path the path the new node should point to.

Member Function Documentation

virtual bool POSIXFilesystemNode::create ( bool  isDirectoryFlag  )  [virtual]

Creates a file referred by this node.

Parameters:
isDirectoryFlag true if created file must be a directory
Returns:
true if file is created successfully

Implements AbstractFSNode.

virtual Common::SeekableReadStream* POSIXFilesystemNode::createReadStream (  )  [virtual]

Creates a SeekableReadStream instance corresponding to the file referred by this node.

This assumes that the node actually refers to a readable file. If this is not the case, 0 is returned.

Returns:
pointer to the stream object, 0 in case of a failure

Implements AbstractFSNode.

virtual Common::WriteStream* POSIXFilesystemNode::createWriteStream (  )  [virtual]

Creates a WriteStream instance corresponding to the file referred by this node.

This assumes that the node actually refers to a readable file. If this is not the case, 0 is returned.

Returns:
pointer to the stream object, 0 in case of a failure

Implements AbstractFSNode.

virtual bool POSIXFilesystemNode::exists (  )  const [inline, virtual]

Implements AbstractFSNode.

Definition at line 62 of file posix-fs.h.

virtual AbstractFSNode* POSIXFilesystemNode::getChild ( const Common::String name  )  const [virtual]

Returns the child node with the given name.

When called on a non-directory node, it should handle this gracefully by returning 0. When called with a name not matching any of the files/dirs contained in this directory, a valid node should be returned, which returns 'false' upon calling the exists() method. The idea is that this node can then still can be used to create a new file via the createWriteStream() method.

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:
Handling calls on non-dir nodes gracefully makes it possible to switch to a lazy type detection scheme in the future.
Parameters:
name String containing the name of the child to create a new node.

Implements AbstractFSNode.

virtual bool POSIXFilesystemNode::getChildren ( AbstractFSList list,
ListMode  mode,
bool  hidden 
) const [virtual]

Return a list of child nodes of this directory node.

If called on a node that does not represent a directory, false is returned.

Parameters:
list List to put the contents of the directory in.
mode Mode to use while listing the directory.
hidden Whether to include hidden files or not in the results.
Returns:
true if successful, false otherwise (e.g. when the directory does not exist).

Implements AbstractFSNode.

virtual Common::String POSIXFilesystemNode::getDisplayName (  )  const [inline, virtual]

Returns a human readable path string.

Note:
By default, this method returns the value of getName().

Reimplemented from AbstractFSNode.

Definition at line 63 of file posix-fs.h.

virtual Common::String POSIXFilesystemNode::getName (  )  const [inline, virtual]

Returns the last component of the path pointed by this FSNode.

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.

Implements AbstractFSNode.

Definition at line 64 of file posix-fs.h.

virtual AbstractFSNode* POSIXFilesystemNode::getParent (  )  const [virtual]

The parent node of this directory.

The parent of the root is the root itself.

Implements AbstractFSNode.

virtual Common::String POSIXFilesystemNode::getPath (  )  const [inline, virtual]

Returns the 'path' of the current node, usable in fopen().

Implements AbstractFSNode.

Definition at line 65 of file posix-fs.h.

virtual bool POSIXFilesystemNode::isDirectory (  )  const [inline, virtual]

Indicates whether this path refers to a directory or not.

Implements AbstractFSNode.

Definition at line 66 of file posix-fs.h.

virtual bool POSIXFilesystemNode::isReadable (  )  const [inline, virtual]

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 and list the directory entries.

If the path refers to a file, readability implies being able to read the contents of the file.

Returns:
bool true if the object can be read, false otherwise.

Implements AbstractFSNode.

Definition at line 67 of file posix-fs.h.

virtual bool POSIXFilesystemNode::isWritable (  )  const [inline, virtual]

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.

Returns:
bool true if the object can be written to, false otherwise.

Implements AbstractFSNode.

Definition at line 68 of file posix-fs.h.

virtual AbstractFSNode* POSIXFilesystemNode::makeNode ( const Common::String path  )  const [inline, protected, virtual]

Definition at line 45 of file posix-fs.h.

virtual void POSIXFilesystemNode::setFlags (  )  [private, virtual]

Tests and sets the _isValid and _isDirectory flags, using the stat() function.


Member Data Documentation

Definition at line 40 of file posix-fs.h.

Definition at line 42 of file posix-fs.h.

Definition at line 43 of file posix-fs.h.

Definition at line 41 of file posix-fs.h.


The documentation for this class was generated from the following file:


Generated on Sat Mar 16 2019 05:04:40 for ResidualVM by doxygen 1.7.1
curved edge   curved edge