Urho3D::VirtualFileSystem Class Reference

Subsystem for virtual file system. More...

#include <Urho3D/IO/VirtualFileSystem.h>

Inheritance diagram for Urho3D::VirtualFileSystem:

Public Member Functions
	VirtualFileSystem (Context *context)
	Construct.
	~VirtualFileSystem () override
	Destruct.
MountPoint *	MountAliasRoot ()
	Mount alias root as alias:// scheme. Alias root will be mounted automatically if alias is created.
MountPoint *	MountRoot ()
	Mount file system root as file:// scheme.
MountPoint *	MountDir (const ea::string &path)
	Mount real folder into virtual file system.
MountPoint *	MountDir (const ea::string &scheme, const ea::string &path)
	Mount real folder into virtual file system under the scheme.
void	AutomountDir (const ea::string &path)
	Mount subfolders and pak files from real folder into virtual file system.
void	AutomountDir (const ea::string &scheme, const ea::string &path)
	Mount subfolders and pak files from real folder into virtual file system under the scheme.
MountPoint *	MountPackageFile (const ea::string &path)
	Mount package file into virtual file system.
void	Mount (MountPoint *mountPoint)
	Mount virtual or real folder into virtual file system.
void	MountAlias (const ea::string &alias, MountPoint *mountPoint, const ea::string &scheme=EMPTY_STRING)
	Mount alias to another mount point.
void	Unmount (MountPoint *mountPoint)
	Remove mount point from the virtual file system.
void	UnmountAll ()
	Remove all mount points.
unsigned	NumMountPoints () const
	Get number of mount points.
MountPoint *	GetMountPoint (unsigned index) const
	Get mount point by index.
void	MountExistingPackages (const StringVector &prefixPaths, const StringVector &relativePaths)
	Mount all existing packages for each combination of prefix path and relative path.
void	MountExistingDirectoriesOrPackages (const StringVector &prefixPaths, const StringVector &relativePaths)
bool	Exists (const FileIdentifier &fileName) const
	Check if a file exists in the virtual file system.
AbstractFilePtr	OpenFile (const FileIdentifier &fileName, FileMode mode) const
	Open file in the virtual file system. Returns null if file not found.
ea::string	ReadAllText (const FileIdentifier &fileName) const
	Read text file from the virtual file system. Returns empty string if file not found.
bool	WriteAllText (const FileIdentifier &fileName, const ea::string &text) const
	Write text file to the virtual file system. Returns true if file is written successfully.
FileTime	GetLastModifiedTime (const FileIdentifier &fileName, bool creationIsModification) const
	Return modification time. Return 0 if not supported or file doesn't exist.
ea::string	GetAbsoluteNameFromIdentifier (const FileIdentifier &fileName) const
	Return absolute file name for existing identifier in this mount point, if supported.
FileIdentifier	GetCanonicalIdentifier (const FileIdentifier &fileName) const
	Return canonical file identifier, if possible.
FileIdentifier	GetIdentifierFromAbsoluteName (const ea::string &absoluteFileName) const
	Works even if the file does not exist.
FileIdentifier	GetIdentifierFromAbsoluteName (const ea::string &scheme, const ea::string &absoluteFileName) const
	Return relative file name of the file, or empty if not found.
void	SetWatching (bool enable)
	Enable or disable file watchers.
bool	IsWatching () const
	Returns true if the file watchers are enabled.
void	Scan (ea::vector< ea::string > &result, const ea::string &scheme, const ea::string &pathName, const ea::string &filter, ScanFlags flags) const
	Scan for specified files.
void	Scan (ea::vector< ea::string > &result, const FileIdentifier &pathName, const ea::string &filter, ScanFlags flags) const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Member Functions
MountedAliasRoot *	GetOrCreateAliasRoot ()
	Return or create internal alias:// mount point.

Private Attributes
Mutex	mountMutex_
	Mutex for thread-safe access to the mount points.
ea::vector< SharedPtr< MountPoint > >	mountPoints_
	File system mount points. It is expected to have small number of mount points.
SharedPtr< MountedAliasRoot >	aliasMountPoint_
	Alias mount point.
bool	isWatching_ {}
	Are file watchers enabled.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Subsystem for virtual file system.

Member Function Documentation

MountExistingDirectoriesOrPackages()

void Urho3D::VirtualFileSystem::MountExistingDirectoriesOrPackages	(	const StringVector &	prefixPaths,
		const StringVector &	relativePaths
	)

Mount all existing directories and packages for each combination of prefix path and relative path. Package is preferred over directory if both exist.

---

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

• Urho3D/IO/VirtualFileSystem.h
• Urho3D/IO/VirtualFileSystem.cpp