#include <seadArchiveFileDevice.h>

Inherits sead::FileDevice.

Classes
struct	ArchiveFileHandle

Public Member Functions
	ArchiveFileDevice (ArchiveRes *archive=nullptr)
virtual	~ArchiveFileDevice ()
void	setArchive (ArchiveRes *archive)
ArchiveRes *	getArchive () const
FileDevice *	tryOpenWithEntryID (FileHandle *handle, s32 entry_id, FileOpenFlag flag, u32 div_size)
u8 *	tryLoadWithEntryID (s32 entry_id, LoadArg &arg)
s32	tryConvertPathToEntryID (const SafeString &filename)
bool	setCurrentDirectory (const SafeString &path)
Public Member Functions inherited from sead::FileDevice
	FileDevice (const SafeString &default_drive_name)
	~FileDevice () override
const SafeString &	getDriveName () const
void	setDriveName (const SafeString &drive_name)
void	setPermission (bool permission)
bool	hasPermission () const
bool	isAvailable () const
u8 *	load (LoadArg &arg)
u8 *	tryLoad (LoadArg &arg)
void	unload (u8 *data)
FileDevice *	open (FileHandle *handle, const SafeString &filename, FileOpenFlag flag, u32 div_size)
FileDevice *	tryOpen (FileHandle *handle, const SafeString &filename, FileOpenFlag flag, u32 div_size)
bool	close (FileHandle *handle)
bool	tryClose (FileHandle *handle)
u32	read (FileHandle handle, u8 buf, u32 size)
bool	tryRead (u32 read_size, FileHandle handle, u8 *buf, u32 size)
u32	write (FileHandle handle, const u8 buf, u32 size)
bool	tryWrite (u32 write_size, FileHandle handle, const u8 *buf, u32 size)
bool	seek (FileHandle *handle, s32 offset, SeekOrigin origin)
bool	trySeek (FileHandle *handle, s32 offset, SeekOrigin origin)
u32	getCurrentSeekPos (FileHandle *handle)
bool	tryGetCurrentSeekPos (u32 pos, FileHandle handle)
u32	getFileSize (const SafeString &path)
u32	getFileSize (FileHandle *handle)
bool	tryGetFileSize (u32 *size, const SafeString &path)
bool	tryGetFileSize (u32 size, FileHandle handle)
bool	isExistFile (const SafeString &path)
bool	tryIsExistFile (bool *is_exist, const SafeString &path)
bool	isExistDirectory (const SafeString &path)
bool	tryIsExistDirectory (bool *is_exist, const SafeString &path)
FileDevice *	openDirectory (DirectoryHandle *handle, const SafeString &dirname)
FileDevice *	tryOpenDirectory (DirectoryHandle *handle, const SafeString &dirname)
bool	closeDirectory (DirectoryHandle *handle)
bool	tryCloseDirectory (DirectoryHandle *handle)
u32	readDirectory (DirectoryHandle handle, DirectoryEntry entry, u32 num)
bool	tryReadDirectory (u32 read_num, DirectoryHandle handle, DirectoryEntry *entry, u32 num)
bool	makeDirectory (const SafeString &path, u32 permission)
bool	tryMakeDirectory (const SafeString &path, u32 permission)
bool	makeDirectoryWithParent (const SafeString &path, u32 permission)
bool	tryMakeDirectoryWithParent (const SafeString &path, u32 permission)
RawErrorCode	getLastRawError () const
virtual void	traceFilePath (const SafeString &path) const
virtual void	traceDirectoryPath (const SafeString &path) const
virtual void	resolveFilePath (BufferedSafeString *out, const SafeString &path) const
virtual void	resolveDirectoryPath (BufferedSafeString *out, const SafeString &path) const
virtual bool	isMatchDevice_ (const HandleBase *handle) const
Public Member Functions inherited from sead::TListNode< FileDevice * >
	TListNode ()
void	insertBack (TListNode< FileDevice * > *n)
void	insertFront (TListNode< FileDevice * > *n)
void	erase ()
Public Member Functions inherited from sead::ListNode
	ListNode ()
ListNode *	next () const
ListNode *	prev () const
bool	isLinked () const
Public Member Functions inherited from sead::IDisposer
	IDisposer ()
virtual	~IDisposer ()

Protected Member Functions
virtual bool	doIsAvailable_ () const
virtual u8 *	doLoad_ (LoadArg &arg)
virtual u8 *	doLoadWithEntryID_ (s32 entry_id, LoadArg &arg)
virtual FileDevice *	doOpen_ (FileHandle *handle, const SafeString &filename, FileOpenFlag flag)
virtual FileDevice *	doOpenWithEntryID_ (FileHandle *handle, s32 entry_id, FileOpenFlag flag)
virtual s32	doConvertPathToEntryID_ (const SafeString &filename)
virtual bool	doClose_ (FileHandle *handle)
virtual bool	doRead_ (u32 read_size, FileHandle handle, u8 *buf, u32 size)
virtual bool	doWrite_ (u32 write_size, FileHandle handle, const u8 *buf, u32 size)
virtual bool	doSeek_ (FileHandle *handle, s32 offset, SeekOrigin origin)
virtual bool	doGetCurrentSeekPos_ (u32 pos, FileHandle handle)
virtual bool	doGetFileSize_ (u32 *size, const SafeString &path)
virtual bool	doGetFileSize_ (u32 size, FileHandle handle)
virtual bool	doIsExistFile_ (bool *is_exist, const SafeString &path)
virtual bool	doIsExistDirectory_ (bool *is_exist, const SafeString &path)
virtual FileDevice *	doOpenDirectory_ (DirectoryHandle *handle, const SafeString &dirname)
virtual bool	doCloseDirectory_ (DirectoryHandle *handle)
virtual bool	doReadDirectory_ (u32 read_num, DirectoryHandle handle, DirectoryEntry *entry, u32 num)
virtual bool	doMakeDirectory_ (const SafeString &path, u32 permission)
virtual RawErrorCode	doGetLastRawError_ () const
virtual bool	doSetCurrentDirectory_ (const SafeString &path)
ArchiveFileHandle *	getArchiveFileHandle_ (FileHandle *handle)
Protected Member Functions inherited from sead::FileDevice
virtual void	doTracePath_ (const SafeString &path) const
virtual void	doResolvePath_ (BufferedSafeString *out, const SafeString &path) const
HandleBuffer &	getHandleBaseHandleBuffer_ (HandleBase *handle) const
void	setHandleBaseFileDevice_ (HandleBase handle, FileDevice device) const
void	setHandleBaseOriginalFileDevice_ (HandleBase handle, FileDevice device) const
void	setFileHandleDivSize_ (FileHandle *handle, u32 div_size) const

Protected Attributes
ArchiveRes *	mArchive
Protected Attributes inherited from sead::FileDevice
FixedSafeString< cDriveNameBufferSize >	mDriveName
bool	mPermission

Additional Inherited Members
Public Types inherited from sead::FileDevice
enum	FileOpenFlag { cFileOpenFlag_ReadOnly = 0 , cFileOpenFlag_WriteOnly = 1 , cFileOpenFlag_ReadWrite = 2 , cFileOpenFlag_Create = 3 }
enum	SeekOrigin { cSeekOrigin_Begin = 0 , cSeekOrigin_Current = 1 , cSeekOrigin_End = 2 }
Public Attributes inherited from sead::TListNode< FileDevice * >
FileDevice *	mData
TList< FileDevice * > *	mList
Static Public Attributes inherited from sead::FileDevice
static const s32	cDriveNameBufferSize = 32
static const s32	cBufferMinAlignment = 64

Constructor & Destructor Documentation

◆ ArchiveFileDevice()

sead::ArchiveFileDevice::ArchiveFileDevice ( ArchiveRes * archive = nullptr )

inline

◆ ~ArchiveFileDevice()

virtual sead::ArchiveFileDevice::~ArchiveFileDevice ( )

inlinevirtual

Member Function Documentation

◆ setArchive()

void sead::ArchiveFileDevice::setArchive ( ArchiveRes * archive )

inline

◆ getArchive()

ArchiveRes * sead::ArchiveFileDevice::getArchive ( ) const

inline

◆ tryOpenWithEntryID()

FileDevice * sead::ArchiveFileDevice::tryOpenWithEntryID	(	FileHandle *	handle,
		s32	entry_id,
		FileOpenFlag	flag,
		u32	div_size )

◆ tryLoadWithEntryID()

u8 * sead::ArchiveFileDevice::tryLoadWithEntryID	(	s32	entry_id,
		LoadArg &	arg )

◆ tryConvertPathToEntryID()

s32 sead::ArchiveFileDevice::tryConvertPathToEntryID ( const SafeString & filename )

◆ setCurrentDirectory()

bool sead::ArchiveFileDevice::setCurrentDirectory ( const SafeString & path )

◆ doIsAvailable_()

virtual bool sead::ArchiveFileDevice::doIsAvailable_ ( ) const

inlineprotectedvirtual

Implements sead::FileDevice.

◆ doLoad_()

u8 * sead::ArchiveFileDevice::doLoad_ ( LoadArg & arg )

protectedvirtual

Reimplemented from sead::FileDevice.

◆ doLoadWithEntryID_()

u8 * sead::ArchiveFileDevice::doLoadWithEntryID_	(	s32	entry_id,
		LoadArg &	arg )

protectedvirtual

◆ doOpen_()

FileDevice * sead::ArchiveFileDevice::doOpen_	(	FileHandle *	handle,
		const SafeString &	filename,
		FileOpenFlag	flag )

protectedvirtual

Implements sead::FileDevice.

◆ doOpenWithEntryID_()

FileDevice * sead::ArchiveFileDevice::doOpenWithEntryID_	(	FileHandle *	handle,
		s32	entry_id,
		FileOpenFlag	flag )

protectedvirtual

◆ doConvertPathToEntryID_()

s32 sead::ArchiveFileDevice::doConvertPathToEntryID_ ( const SafeString & filename )

protectedvirtual

◆ doClose_()

bool sead::ArchiveFileDevice::doClose_ ( FileHandle * handle )

protectedvirtual

Implements sead::FileDevice.

◆ doRead_()

bool sead::ArchiveFileDevice::doRead_	(	u32 *	read_size,
		FileHandle *	handle,
		u8 *	buf,
		u32	size )

protectedvirtual

Implements sead::FileDevice.

◆ doWrite_()

virtual bool sead::ArchiveFileDevice::doWrite_	(	u32 *	write_size,
		FileHandle *	handle,
		const u8 *	buf,
		u32	size )

inlineprotectedvirtual

Implements sead::FileDevice.

◆ doSeek_()

bool sead::ArchiveFileDevice::doSeek_	(	FileHandle *	handle,
		s32	offset,
		SeekOrigin	origin )

protectedvirtual

Implements sead::FileDevice.

◆ doGetCurrentSeekPos_()

bool sead::ArchiveFileDevice::doGetCurrentSeekPos_	(	u32 *	pos,
		FileHandle *	handle )

protectedvirtual

Implements sead::FileDevice.

◆ doGetFileSize_() [1/2]

bool sead::ArchiveFileDevice::doGetFileSize_	(	u32 *	size,
		const SafeString &	path )

protectedvirtual

Implements sead::FileDevice.

◆ doGetFileSize_() [2/2]

bool sead::ArchiveFileDevice::doGetFileSize_	(	u32 *	size,
		FileHandle *	handle )

protectedvirtual

Implements sead::FileDevice.

◆ doIsExistFile_()

bool sead::ArchiveFileDevice::doIsExistFile_	(	bool *	is_exist,
		const SafeString &	path )

protectedvirtual

Implements sead::FileDevice.

◆ doIsExistDirectory_()

bool sead::ArchiveFileDevice::doIsExistDirectory_	(	bool *	is_exist,
		const SafeString &	path )

protectedvirtual

Implements sead::FileDevice.

◆ doOpenDirectory_()

FileDevice * sead::ArchiveFileDevice::doOpenDirectory_	(	DirectoryHandle *	handle,
		const SafeString &	dirname )

protectedvirtual

Implements sead::FileDevice.

◆ doCloseDirectory_()

bool sead::ArchiveFileDevice::doCloseDirectory_ ( DirectoryHandle * handle )

protectedvirtual

Implements sead::FileDevice.

◆ doReadDirectory_()

bool sead::ArchiveFileDevice::doReadDirectory_	(	u32 *	read_num,
		DirectoryHandle *	handle,
		DirectoryEntry *	entry,
		u32	num )

protectedvirtual

Implements sead::FileDevice.

◆ doMakeDirectory_()

bool sead::ArchiveFileDevice::doMakeDirectory_	(	const SafeString &	path,
		u32	permission )

protectedvirtual

Implements sead::FileDevice.

◆ doGetLastRawError_()

RawErrorCode sead::ArchiveFileDevice::doGetLastRawError_ ( ) const

protectedvirtual

Implements sead::FileDevice.

◆ doSetCurrentDirectory_()

bool sead::ArchiveFileDevice::doSetCurrentDirectory_ ( const SafeString & path )

protectedvirtual

◆ getArchiveFileHandle_()

ArchiveFileDevice::ArchiveFileHandle * sead::ArchiveFileDevice::getArchiveFileHandle_ ( FileHandle * handle )

protected

Member Data Documentation

◆ mArchive

ArchiveRes* sead::ArchiveFileDevice::mArchive

protected

sead

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ArchiveFileDevice()

◆ ~ArchiveFileDevice()

Member Function Documentation

◆ setArchive()

◆ getArchive()

◆ tryOpenWithEntryID()

◆ tryLoadWithEntryID()

◆ tryConvertPathToEntryID()

◆ setCurrentDirectory()

◆ doIsAvailable_()

◆ doLoad_()

◆ doLoadWithEntryID_()

◆ doOpen_()

◆ doOpenWithEntryID_()

◆ doConvertPathToEntryID_()

◆ doClose_()

◆ doRead_()

◆ doWrite_()

◆ doSeek_()

◆ doGetCurrentSeekPos_()

◆ doGetFileSize_() [1/2]

◆ doGetFileSize_() [2/2]

◆ doIsExistFile_()

◆ doIsExistDirectory_()

◆ doOpenDirectory_()

◆ doCloseDirectory_()

◆ doReadDirectory_()

◆ doMakeDirectory_()

◆ doGetLastRawError_()

◆ doSetCurrentDirectory_()

◆ getArchiveFileHandle_()

Member Data Documentation

◆ mArchive