#include <vfs.h>

Inheritance diagram for IVFS:

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

Constructor & Destructor Documentation

◆ ~IVFS()

virtual IVFS::~IVFS ( )

inlinevirtual

Member Function Documentation

◆ Clear()

virtual void IVFS::Clear ( )

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.

◆ CreateFile()

virtual Status IVFS::CreateFile	(	const VfsPath &	pathname,
		const std::shared_ptr< u8 > &	fileContents,
		size_t	size
	)

pure virtual

Create a file with the given contents.

Parameters

pathname
fileContents
size	[bytes] of the contents, will match that of the file.

Returns: Status.

Implemented in VFS.

◆ GetDirectoryEntries()

virtual Status IVFS::GetDirectoryEntries	(	const VfsPath &	path,
		CFileInfos *	fileInfos,
		DirectoryNames *	subdirectoryNames
	)		const

pure virtual

Retrieve lists of all files and subdirectories in a directory.

Returns: Status.

Rationale:

this interface avoids having to lock the directory while an iterator is extant.
we cannot efficiently provide routines for returning files and subdirectories separately due to the underlying POSIX interface.

Implemented in VFS.

◆ GetDirectoryRealPath()

virtual Status IVFS::GetDirectoryRealPath	(	const VfsPath &	pathname,
		OsPath &	realPathname,
		bool	createMissingDirectories = `true`
	)

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.

Parameters

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.

◆ GetFileInfo()

virtual Status IVFS::GetFileInfo	(	const VfsPath &	pathname,
		CFileInfo *	pfileInfo
	)		const

pure virtual

Retrieve information about a file (similar to POSIX stat).

Parameters

pathname
pfileInfo	receives information about the file. Passing NULL suppresses warnings if the file doesn't exist.

Returns: Status.

Implemented in VFS.

◆ GetFilePriority()

virtual Status IVFS::GetFilePriority	(	const VfsPath &	pathname,
		size_t *	ppriority
	)		const

pure virtual

Retrieve mount priority for a file.

Parameters

pathname
ppriority	receives priority value, if the file can be found.

Returns: Status.

Implemented in VFS.

◆ GetOriginalPath()

virtual Status IVFS::GetOriginalPath	(	const VfsPath &	filename,
		OsPath &	loadedPathname
	)

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.

◆ GetRealPath()

virtual Status IVFS::GetRealPath	(	const VfsPath &	pathname,
		OsPath &	realPathname,
		bool	createMissingDirectories = `true`
	)

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.

Parameters

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.

◆ GetVirtualPath()

virtual Status IVFS::GetVirtualPath	(	const OsPath &	realPathname,
		VfsPath &	pathname
	)

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.

◆ LoadFile()

virtual Status IVFS::LoadFile	(	const VfsPath &	pathname,
		std::shared_ptr< u8 > &	fileContents,
		size_t &	size
	)

pure virtual

Read an entire file into memory.

Parameters

pathname
fileContents	receives a smart pointer to the contents.
size	receives the size [bytes] of the file contents.

Returns: Status.

Implemented in VFS.

◆ Mount()

virtual Status IVFS::Mount	(	const VfsPath &	mountPoint,
		const OsPath &	path,
		size_t	flags = `0`,
		size_t	priority = `0`
	)

pure virtual

mount a directory into the VFS.

Parameters

mountPoint	(will be created if it does not already exist)
path	real directory path
flags
priority

Returns: Status.

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.

◆ RemoveFile()

virtual Status IVFS::RemoveFile ( const VfsPath & pathname )

pure virtual

remove file from the virtual directory listing.

Implemented in VFS.

◆ RepopulateDirectory()

virtual Status IVFS::RepopulateDirectory ( const VfsPath & path )

pure virtual

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.

◆ TextRepresentation()

virtual std::wstring IVFS::TextRepresentation ( ) const

pure virtual

Returns: a string representation of all files and directories.

Implemented in VFS.

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

/home/docker/jenkins/workspace/technical-docs/source/lib/file/vfs/vfs.h

Public Member Functions

Constructor & Destructor Documentation

◆ ~IVFS()

Member Function Documentation

◆ Clear()

◆ CreateFile()

◆ GetDirectoryEntries()

◆ GetDirectoryRealPath()

◆ GetFileInfo()

◆ GetFilePriority()

◆ GetOriginalPath()

◆ GetRealPath()

◆ GetVirtualPath()

◆ LoadFile()

◆ Mount()

◆ RemoveFile()

◆ RepopulateDirectory()

◆ TextRepresentation()