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

ChRootFilesystemFactory Class Reference

FIXME: Warning, using this factory in your backend may silently break some features. More...

#include <chroot-fs-factory.h>

Inheritance diagram for ChRootFilesystemFactory:
Collaboration diagram for ChRootFilesystemFactory:

List of all members.

Public Member Functions

 ChRootFilesystemFactory (const Common::String &root)
virtual AbstractFSNodemakeRootFileNode () const
 Returns a special node representing the filesystem root.
virtual AbstractFSNodemakeCurrentDirectoryFileNode () const
 Returns a node representing the "current directory".
virtual AbstractFSNodemakeFileNodePath (const Common::String &path) const
 Construct a node based on a path; the path is in the same format as it would be for calls to fopen().

Private Attributes

const Common::String _root

Detailed Description

FIXME: Warning, using this factory in your backend may silently break some features.

Instances are, for example, the FluidSynth code, and the POSIX plugin code.

Definition at line 34 of file chroot-fs-factory.h.


Constructor & Destructor Documentation

ChRootFilesystemFactory::ChRootFilesystemFactory ( const Common::String root  )  [explicit]

Member Function Documentation

virtual AbstractFSNode* ChRootFilesystemFactory::makeCurrentDirectoryFileNode (  )  const [virtual]

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.

Implements FilesystemFactory.

virtual AbstractFSNode* ChRootFilesystemFactory::makeFileNodePath ( const Common::String path  )  const [virtual]

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.

Parameters:
path The path string to create a FSNode for.

Implements FilesystemFactory.

virtual AbstractFSNode* ChRootFilesystemFactory::makeRootFileNode (  )  const [virtual]

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:).

Implements FilesystemFactory.


Member Data Documentation

Definition at line 43 of file chroot-fs-factory.h.


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


Generated on Sat Jul 20 2019 05:02:13 for ResidualVM by doxygen 1.7.1
curved edge   curved edge