Pyrogenesis trunk
|
#include <vfs.h>
Public Member Functions | |
virtual | ~IVFS () |
virtual Status | Mount (const VfsPath &mountPoint, const OsPath &path, size_t flags=0, size_t priority=0)=0 |
mount a directory into the VFS. More... | |
virtual Status | GetFileInfo (const VfsPath &pathname, CFileInfo *pfileInfo) const =0 |
Retrieve information about a file (similar to POSIX stat). More... | |
virtual Status | GetFilePriority (const VfsPath &pathname, size_t *ppriority) const =0 |
Retrieve mount priority for a file. More... | |
virtual Status | GetDirectoryEntries (const VfsPath &path, CFileInfos *fileInfos, DirectoryNames *subdirectoryNames) const =0 |
Retrieve lists of all files and subdirectories in a directory. More... | |
virtual Status | CreateFile (const VfsPath &pathname, const std::shared_ptr< u8 > &fileContents, size_t size)=0 |
Create a file with the given contents. More... | |
virtual Status | LoadFile (const VfsPath &pathname, std::shared_ptr< u8 > &fileContents, size_t &size)=0 |
Read an entire file into memory. More... | |
virtual std::wstring | TextRepresentation () const =0 |
virtual Status | GetOriginalPath (const VfsPath &filename, OsPath &loadedPathname)=0 |
Retrieve the POSIX pathname a VFS file was loaded from. More... | |
virtual Status | GetRealPath (const VfsPath &pathname, OsPath &realPathname, bool createMissingDirectories=true)=0 |
Retrieve the real (POSIX) pathname underlying a VFS file. More... | |
virtual Status | GetDirectoryRealPath (const VfsPath &pathname, OsPath &realPathname, bool createMissingDirectories=true)=0 |
Retrieve the real (POSIX) pathname underlying a VFS directory. More... | |
virtual Status | GetVirtualPath (const OsPath &realPathname, VfsPath &pathname)=0 |
retrieve the VFS pathname that corresponds to a real file. More... | |
virtual Status | RemoveFile (const VfsPath &pathname)=0 |
remove file from the virtual directory listing. More... | |
virtual Status | RepopulateDirectory (const VfsPath &path)=0 |
request the directory be re-populated when it is next accessed. More... | |
virtual void | Clear ()=0 |
empty the contents of the filesystem. More... | |
|
inlinevirtual |
|
pure virtual |
empty the contents of the filesystem.
this is typically only necessary when changing the set of mounted directories, e.g. when switching mods. NB: open files are not affected.
Implemented in VFS.
|
pure virtual |
Create a file with the given contents.
pathname | |
fileContents | |
size | [bytes] of the contents, will match that of the file. |
Implemented in VFS.
|
pure virtual |
Retrieve lists of all files and subdirectories in a directory.
Rationale:
Implemented in VFS.
|
pure virtual |
Retrieve the real (POSIX) pathname underlying a VFS directory.
This is useful for passing paths to external libraries. Note that this returns the real path relative to the highest priority VFS subpath.
createMissingDirectories | - if true, create subdirectories on the file system as required. (this defaults to true because, in general, this function is then used to create new files). |
Implemented in VFS.
|
pure virtual |
Retrieve information about a file (similar to POSIX stat).
pathname | |
pfileInfo | receives information about the file. Passing NULL suppresses warnings if the file doesn't exist. |
Implemented in VFS.
|
pure virtual |
Retrieve mount priority for a file.
pathname | |
ppriority | receives priority value, if the file can be found. |
Implemented in VFS.
|
pure virtual |
Retrieve the POSIX pathname a VFS file was loaded from.
This is distinct from the current 'real' path, since that depends on the parent directory's real path, which may have been overwritten by a mod or another call to Mount().
This is used by the caching to split by mod, and you also ought to call this to delete a file. (note that deleting has other issues, see below).
Implemented in VFS.
|
pure virtual |
Retrieve the real (POSIX) pathname underlying a VFS file.
This is useful for passing paths to external libraries. Note that this returns the real path relative to the highest priority VFS subpath.
createMissingDirectories | - if true, create subdirectories on the file system as required. (this defaults to true because, in general, this function is then used to create new files). |
Implemented in VFS.
|
pure virtual |
retrieve the VFS pathname that corresponds to a real file.
this is useful for reacting to file change notifications.
the current implementation requires time proportional to the number of directories; this could be accelerated by only checking directories below a mount point with a matching real path.
Implemented in VFS.
|
pure virtual |
Read an entire file into memory.
pathname | |
fileContents | receives a smart pointer to the contents. |
size | receives the size [bytes] of the file contents. |
Implemented in VFS.
|
pure virtual |
mount a directory into the VFS.
mountPoint | (will be created if it does not already exist) |
path | real directory path |
flags | |
priority |
if files are encountered that already exist in the VFS (sub)directories, the most recent / highest priority/precedence version is preferred.
Note that the 'real directory' associated with a VFS Path will be relative to the highest priority subdirectory in the path, and that in case of equal priority, the order is undefined, and will depend on the exact order of populate() calls.
if files with archive extensions are seen, their contents are added as well.
Implemented in VFS.
remove file from the virtual directory listing.
Implemented in VFS.
request the directory be re-populated when it is next accessed.
useful for synchronizing with the underlying filesystem after files have been created or their metadata changed.
Implemented in VFS.
|
pure virtual |
Implemented in VFS.