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

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

#include <windows-fs.h>

Inheritance diagram for WindowsFilesystemNode:
Collaboration diagram for WindowsFilesystemNode:

List of all members.

Public Member Functions

 WindowsFilesystemNode ()
 Creates a WindowsFilesystemNode with the root node as path.
 WindowsFilesystemNode (const Common::String &path, const bool currentDir)
 Creates a WindowsFilesystemNode 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 Attributes

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

Static Private Member Functions

static void addFile (AbstractFSList &list, ListMode mode, const char *base, bool hidden, WIN32_FIND_DATA *find_data)
 Adds a single WindowsFilesystemNode to a given list.
static char * toAscii (TCHAR *str)
 Converts a Unicode string to Ascii format.
static const TCHAR * toUnicode (const char *str)
 Converts an Ascii string to Unicode format.

Detailed Description

Implementation of the ScummVM file system API based on Windows API.

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

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


Constructor & Destructor Documentation

WindowsFilesystemNode::WindowsFilesystemNode (  ) 

Creates a WindowsFilesystemNode with the root node as path.

In regular windows systems, a virtual root path is used "". In windows CE, the "\" root is used instead.

WindowsFilesystemNode::WindowsFilesystemNode ( const Common::String path,
const bool  currentDir 
)

Creates a WindowsFilesystemNode for a given path.

Examples: path=c:.txt, currentDir=false -> c:.txt path=c:.txt, currentDir=true -> current directory path=NULL, currentDir=true -> current directory

Parameters:
path Common::String with the path the new node should point to.
currentDir if true, the path parameter will be ignored and the resulting node will point to the current directory.

Member Function Documentation

static void WindowsFilesystemNode::addFile ( AbstractFSList list,
ListMode  mode,
const char *  base,
bool  hidden,
WIN32_FIND_DATA *  find_data 
) [static, private]

Adds a single WindowsFilesystemNode to a given list.

This method is used by getChildren() to populate the directory entries list.

Parameters:
list List to put the file entry node in.
mode Mode to use while adding the file entry to the list.
base Common::String with the directory being listed.
hidden true if hidden files should be added, false otherwise
find_data Describes a file that the FindFirstFile, FindFirstFileEx, or FindNextFile functions find.
virtual bool WindowsFilesystemNode::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* WindowsFilesystemNode::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* WindowsFilesystemNode::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 WindowsFilesystemNode::exists (  )  const [virtual]

Implements AbstractFSNode.

virtual AbstractFSNode* WindowsFilesystemNode::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 WindowsFilesystemNode::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 WindowsFilesystemNode::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 74 of file windows-fs.h.

virtual Common::String WindowsFilesystemNode::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 75 of file windows-fs.h.

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

The parent node of this directory.

The parent of the root is the root itself.

Implements AbstractFSNode.

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

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

Implements AbstractFSNode.

Definition at line 76 of file windows-fs.h.

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

Indicates whether this path refers to a directory or not.

Implements AbstractFSNode.

Definition at line 77 of file windows-fs.h.

virtual bool WindowsFilesystemNode::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 WindowsFilesystemNode::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.

static char* WindowsFilesystemNode::toAscii ( TCHAR *  str  )  [static, private]

Converts a Unicode string to Ascii format.

Parameters:
str Common::String to convert from Unicode to Ascii.
Returns:
str in Ascii format.
static const TCHAR* WindowsFilesystemNode::toUnicode ( const char *  str  )  [static, private]

Converts an Ascii string to Unicode format.

Parameters:
str Common::String to convert from Ascii to Unicode.
Returns:
str in Unicode format.

Member Data Documentation

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

Definition at line 47 of file windows-fs.h.

Definition at line 48 of file windows-fs.h.

Definition at line 49 of file windows-fs.h.

Definition at line 46 of file windows-fs.h.


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


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