Stores files of a directory tree sequentially for convenient access. More...

#include <Urho3D/IO/PackageFile.h>

Inheritance diagram for Urho3D::PackageFile:

Public Member Functions
	PackageFile (Context *context)
	Construct.

	PackageFile (Context *context, const ea::string &fileName, unsigned startOffset=0)
	Construct and open.

	~PackageFile () override
	Destruct.

bool	Open (const ea::string &fileName, unsigned startOffset=0)
	Open the package file. Return true if successful.

bool	Exists (const ea::string &fileName) const
	Check if a file exists within the package file. This will be case-insensitive on Windows and case-sensitive on other platforms.

const PackageEntry *	GetEntry (const ea::string &fileName) const
	Return the file entry corresponding to the name, or null if not found. This will be case-insensitive on Windows and case-sensitive on other platforms.

const ea::unordered_map< ea::string, PackageEntry > &	GetEntries () const
	Return all file entries.

StringHash	GetNameHash () const
	Return hash of the package file name.

unsigned	GetNumFiles () const

unsigned	GetTotalSize () const

unsigned	GetTotalDataSize () const

unsigned	GetChecksum () const

bool	IsCompressed () const

const ea::vector< ea::string >	GetEntryNames () const
	Return list of file names in the package.

const ea::string &	GetEntryName (unsigned index) const
	Return a file name in the package at the specified index.


bool	AcceptsScheme (const ea::string &scheme) const override
	Checks if mount point accepts scheme.

bool	Exists (const FileIdentifier &fileName) const override
	Check if a file exists within the mount point.

AbstractFilePtr	OpenFile (const FileIdentifier &fileName, FileMode mode) override
	Open package file. Returns null if file not found.

ea::optional< FileTime >	GetLastModifiedTime (const FileIdentifier &fileName, bool creationIsModification) const override

const ea::string &	GetName () const override
	Returns human-readable name of the mount point.

void	Scan (ea::vector< ea::string > &result, const ea::string &pathName, const ea::string &filter, ScanFlags flags) const override
	Enumerate objects in the mount point. Only files enumeration is guaranteed to be supported.

Public Member Functions inherited from Urho3D::MountPoint
	MountPoint (Context *context)
	Construct.

	~MountPoint () override
	Destruct.

virtual ea::string	GetAbsoluteNameFromIdentifier (const FileIdentifier &fileName) const
	Return absolute file name for existing identifier in this mount point, if supported.

virtual FileIdentifier	GetIdentifierFromAbsoluteName (const ea::string &absoluteFileName) const

virtual void	SetWatching (bool enable)
	Enable or disable FileChanged events.

virtual bool	IsWatching () const
	Returns true if FileChanged events are enabled.

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
	URHO3D_OBJECT (PackageFile, MountPoint)

Private Attributes
ea::unordered_map< ea::string, PackageEntry >	entries_
	File entries.

ea::string	fileName_
	File name.

StringHash	nameHash_
	Package file name hash.

unsigned	totalSize_
	Package file total size.

unsigned	totalDataSize_
	Total data size in the package using each entry's actual size if it is a compressed package file.

unsigned	checksum_
	Package file checksum.

bool	compressed_
	Compressed flag.

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

Stores files of a directory tree sequentially for convenient access.

Member Function Documentation

◆ AcceptsScheme()

bool Urho3D::PackageFile::AcceptsScheme ( const ea::string & scheme ) const

overridevirtual

Checks if mount point accepts scheme.

Implement MountPoint.

Implements Urho3D::MountPoint.

◆ Exists()

bool Urho3D::PackageFile::Exists ( const FileIdentifier & fileName ) const

overridevirtual

Check if a file exists within the mount point.

Implements Urho3D::MountPoint.

◆ GetChecksum()

unsigned Urho3D::PackageFile::GetChecksum ( ) const

inline

Return checksum of the package file contents.

◆ GetLastModifiedTime()

ea::optional< FileTime > Urho3D::PackageFile::GetLastModifiedTime	(	const FileIdentifier &	fileName,
		bool	creationIsModification
	)		const

overridevirtual

Return modification time, or 0 if not supported. Return nullopt if file does not exist.

Reimplemented from Urho3D::MountPoint.

◆ GetName()

const ea::string & Urho3D::PackageFile::GetName ( ) const

inlineoverridevirtual

Returns human-readable name of the mount point.

Implements Urho3D::MountPoint.

◆ GetNumFiles()

unsigned Urho3D::PackageFile::GetNumFiles ( ) const

inline

Return number of files.

◆ GetTotalDataSize()

unsigned Urho3D::PackageFile::GetTotalDataSize ( ) const

inline

Return total data size from all the file entries in the package file.

◆ GetTotalSize()

unsigned Urho3D::PackageFile::GetTotalSize ( ) const

inline

Return total size of the package file.

◆ IsCompressed()

bool Urho3D::PackageFile::IsCompressed ( ) const

inline

Return whether the files are compressed.

◆ OpenFile()

AbstractFilePtr Urho3D::PackageFile::OpenFile	(	const FileIdentifier &	fileName,
		FileMode	mode
	)

overridevirtual

Open package file. Returns null if file not found.

Implements Urho3D::MountPoint.

◆ Scan()

void Urho3D::PackageFile::Scan	(	ea::vector< ea::string > &	result,
		const ea::string &	pathName,
		const ea::string &	filter,
		ScanFlags	flags
	)		const

overridevirtual

Enumerate objects in the mount point. Only files enumeration is guaranteed to be supported.

Implements Urho3D::MountPoint.

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

Urho3D/IO/PackageFile.h
Urho3D/IO/PackageFile.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AcceptsScheme()

◆ Exists()

◆ GetChecksum()

◆ GetLastModifiedTime()

◆ GetName()

◆ GetNumFiles()

◆ GetTotalDataSize()

◆ GetTotalSize()

◆ IsCompressed()

◆ OpenFile()

◆ Scan()