Provider for OS directories. More...
#include <directoryprovider.h>
Inheritance diagram for FIFE::DirectoryProvider:
Collaboration diagram for FIFE::DirectoryProvider:
Public Member Functions | |
| DirectoryProvider () | |
| virtual bool | isReadable (const std::string &path) const |
| Check if a given directory is readable. More... | |
| virtual VFSSource * | createSource (const std::string &path) |
| Create a new instance of a VFSSource initialized with the given directory This will only pass if the path is readable and recognized as a directory as per the description of isReadable. More... | |
| virtual VFSSource * | getSource (const std::string &path) const |
| Get the source instance of the path. More... | |
| virtual bool | hasSource (const std::string &path) const |
| Check whether the provider already has created a source with that path. More... | |
| Public Member Functions inherited from FIFE::VFSSourceProvider | |
| VFSSourceProvider (const std::string &name) | |
| virtual | ~VFSSourceProvider () |
| const std::string & | getName () const |
| Returns the name of this VFSSourceProvider. More... | |
| void | setVFS (VFS *vfs) |
| Get the VFS this provider is using. More... | |
| VFS * | getVFS () const |
Private Attributes | |
| std::string | m_name |
| std::map< std::string, VFSSource *> | m_sources |
Detailed Description
Provider for OS directories.
Definition at line 43 of file directoryprovider.h.
Constructor & Destructor Documentation
◆ DirectoryProvider()
|
inline |
Definition at line 45 of file directoryprovider.h.
References createSource(), getSource(), hasSource(), and isReadable().
Member Function Documentation
◆ createSource()
|
virtual |
Create a new instance of a VFSSource initialized with the given directory This will only pass if the path is readable and recognized as a directory as per the description of isReadable.
- Parameters
-
path the directory to open
- Returns
- the new VFSSource
Implements FIFE::VFSSourceProvider.
Definition at line 42 of file directoryprovider.cpp.
References FIFE::VFSSourceProvider::getVFS(), hasSource(), isReadable(), and m_sources.
Referenced by DirectoryProvider().
Here is the caller graph for this function:
◆ getSource()
|
virtual |
Get the source instance of the path.
- Parameters
-
path The source path
- Returns
- A VFSSource or NULL of none is present
Implements FIFE::VFSSourceProvider.
Definition at line 57 of file directoryprovider.cpp.
References hasSource(), and m_sources.
Referenced by DirectoryProvider().
Here is the caller graph for this function:
◆ hasSource()
|
virtual |
Check whether the provider already has created a source with that path.
- Parameters
-
path The path to the source
- Returns
- true if the provider has already created a source with that path, false if not
Implements FIFE::VFSSourceProvider.
Definition at line 65 of file directoryprovider.cpp.
References m_sources.
Referenced by createSource(), DirectoryProvider(), and getSource().
Here is the caller graph for this function:
◆ isReadable()
|
virtual |
Check if a given directory is readable.
The path must either be an absolute path or relative to the current working directory where the client was launched
- Parameters
-
path the filename to check
- Returns
- true if readable, false otherwise
Implements FIFE::VFSSourceProvider.
Definition at line 38 of file directoryprovider.cpp.
Referenced by createSource(), and DirectoryProvider().
Here is the caller graph for this function:
Member Data Documentation
◆ m_name
|
private |
Definition at line 79 of file directoryprovider.h.
◆ m_sources
|
private |
Definition at line 80 of file directoryprovider.h.
Referenced by createSource(), getSource(), and hasSource().
The documentation for this class was generated from the following files:
- engine/core/vfs/directoryprovider.h
- engine/core/vfs/directoryprovider.cpp
