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

FilesystemFactory Class Reference

Creates concrete FSNode objects depending on the current architecture. More...

#include <fs-factory.h>

Inheritance diagram for FilesystemFactory:

List of all members.

Public Member Functions

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

Detailed Description

Creates concrete FSNode objects depending on the current architecture.

Definition at line 32 of file fs-factory.h.


Constructor & Destructor Documentation

virtual FilesystemFactory::~FilesystemFactory (  )  [inline, virtual]

Destructor.

Definition at line 37 of file fs-factory.h.


Member Function Documentation

virtual AbstractFSNode* FilesystemFactory::makeCurrentDirectoryFileNode (  )  const [pure 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.

Implemented in AmigaOSFilesystemFactory, ChRootFilesystemFactory, POSIXFilesystemFactory, PS3FilesystemFactory, RISCOSFilesystemFactory, and WindowsFilesystemFactory.

virtual AbstractFSNode* FilesystemFactory::makeFileNodePath ( const Common::String path  )  const [pure 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.

Implemented in AmigaOSFilesystemFactory, ChRootFilesystemFactory, POSIXFilesystemFactory, RISCOSFilesystemFactory, and WindowsFilesystemFactory.

virtual AbstractFSNode* FilesystemFactory::makeRootFileNode (  )  const [pure 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:).

Implemented in AmigaOSFilesystemFactory, ChRootFilesystemFactory, POSIXFilesystemFactory, RISCOSFilesystemFactory, and WindowsFilesystemFactory.


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


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