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

#include <chroot-fs.h>

Inheritance diagram for ChRootFilesystemNode:
Collaboration diagram for ChRootFilesystemNode:

List of all members.

Public Member Functions

 ChRootFilesystemNode (const Common::String &root, const Common::String &path)
virtual ~ChRootFilesystemNode ()
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.

Private Member Functions

 ChRootFilesystemNode (const Common::String &root, POSIXFilesystemNode *)

Static Private Member Functions

static Common::String addPathComponent (const Common::String &path, const Common::String &component)

Private Attributes

Common::String _root
POSIXFilesystemNode_realNode

Detailed Description

Definition at line 28 of file chroot-fs.h.


Constructor & Destructor Documentation

ChRootFilesystemNode::ChRootFilesystemNode ( const Common::String root,
POSIXFilesystemNode  
) [private]
ChRootFilesystemNode::ChRootFilesystemNode ( const Common::String root,
const Common::String path 
)
virtual ChRootFilesystemNode::~ChRootFilesystemNode (  )  [virtual]

Member Function Documentation

static Common::String ChRootFilesystemNode::addPathComponent ( const Common::String path,
const Common::String component 
) [static, private]
virtual bool ChRootFilesystemNode::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* ChRootFilesystemNode::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* ChRootFilesystemNode::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 ChRootFilesystemNode::exists (  )  const [virtual]

Implements AbstractFSNode.

virtual AbstractFSNode* ChRootFilesystemNode::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 ChRootFilesystemNode::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 ChRootFilesystemNode::getDisplayName (  )  const [virtual]

Returns a human readable path string.

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

Reimplemented from AbstractFSNode.

virtual Common::String ChRootFilesystemNode::getName (  )  const [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.

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

The parent node of this directory.

The parent of the root is the root itself.

Implements AbstractFSNode.

virtual Common::String ChRootFilesystemNode::getPath (  )  const [virtual]

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

Implements AbstractFSNode.

virtual bool ChRootFilesystemNode::isDirectory (  )  const [virtual]

Indicates whether this path refers to a directory or not.

Implements AbstractFSNode.

virtual bool ChRootFilesystemNode::isReadable (  )  const [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.

virtual bool ChRootFilesystemNode::isWritable (  )  const [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.


Member Data Documentation

Definition at line 30 of file chroot-fs.h.

Definition at line 29 of file chroot-fs.h.


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


Generated on Sat Nov 16 2019 05:02:00 for ResidualVM by doxygen 1.7.1
curved edge   curved edge