ScummVM API documentation
Public Member Functions | List of all members
ChRootFilesystemNode Class Referencefinal
Inheritance diagram for ChRootFilesystemNode:
AbstractFSNode

Public Member Functions

 ChRootFilesystemNode (const Common::String &root, const Common::String &path, const Common::String &drive=Common::String())
 
bool exists () const override
 
Common::U32String getDisplayName () const override
 
Common::String getName () const override
 
Common::String getPath () const override
 
bool isDirectory () const override
 
bool isReadable () const override
 
bool isWritable () const override
 
AbstractFSNode * getChild (const Common::String &n) const override
 
bool getChildren (AbstractFSList &list, ListMode mode, bool hidden) const override
 
AbstractFSNode * getParent () const override
 
Common::SeekableReadStream * createReadStream () override
 
Common::SeekableWriteStream * createWriteStream (bool atomic) override
 
bool createDirectory () override
 
- Public Member Functions inherited from AbstractFSNode
virtual ~AbstractFSNode ()
 
virtual Common::SeekableReadStream * createReadStreamForAltStream (Common::AltStreamType altStreamType)
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractFSNode
static Common::FSNode makeFSNode (AbstractFSNode *realNode)
 
- Protected Types inherited from AbstractFSNode
typedef Common::FSNode::ListMode ListMode
 
- Static Protected Member Functions inherited from AbstractFSNode
static const char * lastPathComponent (const Common::String &str, const char sep)
 

Member Function Documentation

◆ getDisplayName()

Common::U32String ChRootFilesystemNode::getDisplayName ( ) const
overridevirtual

Returns a human readable path string.

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

Implements AbstractFSNode.

◆ getName()

Common::String ChRootFilesystemNode::getName ( ) const
overridevirtual

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.

◆ getPath()

Common::String ChRootFilesystemNode::getPath ( ) const
overridevirtual

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

Implements AbstractFSNode.

◆ isDirectory()

bool ChRootFilesystemNode::isDirectory ( ) const
overridevirtual

Indicates whether this path refers to a directory or not.

Implements AbstractFSNode.

◆ isReadable()

bool ChRootFilesystemNode::isReadable ( ) const
overridevirtual

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.

◆ isWritable()

bool ChRootFilesystemNode::isWritable ( ) const
overridevirtual

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.

◆ getChild()

AbstractFSNode* ChRootFilesystemNode::getChild ( const Common::String &  name) const
overridevirtual

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
nameString containing the name of the child to create a new node.

Implements AbstractFSNode.

◆ getChildren()

bool ChRootFilesystemNode::getChildren ( AbstractFSList &  list,
ListMode  mode,
bool  hidden 
) const
overridevirtual

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
listList to put the contents of the directory in.
modeMode to use while listing the directory.
hiddenWhether 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.

◆ getParent()

AbstractFSNode* ChRootFilesystemNode::getParent ( ) const
overridevirtual

The parent node of this directory. The parent of the root is the root itself.

Implements AbstractFSNode.

◆ createReadStream()

Common::SeekableReadStream* ChRootFilesystemNode::createReadStream ( )
overridevirtual

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.

◆ createWriteStream()

Common::SeekableWriteStream* ChRootFilesystemNode::createWriteStream ( bool  atomic)
overridevirtual

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.

When an atomic write stream is requested, the backend will write the data in a temporary file before moving it to its final destination.

Parameters
atomicRequest for an atomic file write when closing.
Returns
pointer to the stream object, 0 in case of a failure

Implements AbstractFSNode.

◆ createDirectory()

bool ChRootFilesystemNode::createDirectory ( )
overridevirtual

Creates a directory referred by this node.

Returns
true if the directory is created successfully

Implements AbstractFSNode.

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