sead
Loading...
Searching...
No Matches
sead::AnyFileDevice Class Reference

#include <seadAnyFileDevice.h>

Inherits sead::FileDevice.

Public Member Functions

 AnyFileDevice (s32 limit_num, Heap *heap, s32 alignment=4)
 ~AnyFileDevice () override
bool pushBack (FileDevice *device)
bool pushFront (FileDevice *device)
bool erase (FileDevice *device)
void traceFilePath (const SafeString &path) const override
void traceDirectoryPath (const SafeString &path) const override
void resolveFilePath (BufferedSafeString *out, const SafeString &path) const override
void resolveDirectoryPath (BufferedSafeString *out, const SafeString &path) const override
const FileDeviceList & getFileDeviceList () const
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
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

bool doIsAvailable_ () const override
u8 * doLoad_ (LoadArg &arg) override
FileDevice * findFileDeviceByFile_ (const SafeString &path) const
FileDevice * findFileDeviceByDirectory_ (const SafeString &path) const
FileDevice * doOpen_ (FileHandle *handle, const SafeString &filename, FileOpenFlag flag) override
bool doClose_ (FileHandle *handle) override
bool doRead_ (u32 *read_size, FileHandle *handle, u8 *buf, u32 size) override
bool doWrite_ (u32 *write_size, FileHandle *handle, const u8 *buf, u32 size) override
bool doSeek_ (FileHandle *handle, s32 offset, SeekOrigin origin) override
bool doGetCurrentSeekPos_ (u32 *pos, FileHandle *handle) override
bool doGetFileSize_ (u32 *size, const SafeString &path) override
bool doGetFileSize_ (u32 *size, FileHandle *handle) override
bool doIsExistFile_ (bool *is_exist, const SafeString &path) override
bool doIsExistDirectory_ (bool *is_exist, const SafeString &path) override
FileDevice * doOpenDirectory_ (DirectoryHandle *handle, const SafeString &dirname) override
bool doCloseDirectory_ (DirectoryHandle *handle) override
bool doReadDirectory_ (u32 *read_num, DirectoryHandle *handle, DirectoryEntry *entry, u32 num) override
bool doMakeDirectory_ (const SafeString &path, u32 permission) override
bool isMatchDevice_ (const HandleBase *handle) const override
RawErrorCode doGetLastRawError_ () const override
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

FileDeviceList mFileDeviceList
FileDevice * mLastFileDevice
Protected Attributes inherited from sead::FileDevice
FixedSafeString< cDriveNameBufferSize > mDriveName
bool mPermission

Private Types

typedef PtrArray< FileDevice > FileDeviceList

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

Member Typedef Documentation

◆ FileDeviceList

Constructor & Destructor Documentation

◆ AnyFileDevice()

sead::AnyFileDevice::AnyFileDevice ( s32 limit_num,
Heap * heap,
s32 alignment = 4 )

◆ ~AnyFileDevice()

sead::AnyFileDevice::~AnyFileDevice ( )
override

Member Function Documentation

◆ pushBack()

bool sead::AnyFileDevice::pushBack ( FileDevice * device)

◆ pushFront()

bool sead::AnyFileDevice::pushFront ( FileDevice * device)

◆ erase()

bool sead::AnyFileDevice::erase ( FileDevice * device)

◆ traceFilePath()

void sead::AnyFileDevice::traceFilePath ( const SafeString & path) const
overridevirtual

Reimplemented from sead::FileDevice.

◆ traceDirectoryPath()

void sead::AnyFileDevice::traceDirectoryPath ( const SafeString & path) const
overridevirtual

Reimplemented from sead::FileDevice.

◆ resolveFilePath()

void sead::AnyFileDevice::resolveFilePath ( BufferedSafeString * out,
const SafeString & path ) const
overridevirtual

Reimplemented from sead::FileDevice.

◆ resolveDirectoryPath()

void sead::AnyFileDevice::resolveDirectoryPath ( BufferedSafeString * out,
const SafeString & path ) const
overridevirtual

Reimplemented from sead::FileDevice.

◆ getFileDeviceList()

const FileDeviceList & sead::AnyFileDevice::getFileDeviceList ( ) const
inline

◆ doIsAvailable_()

bool sead::AnyFileDevice::doIsAvailable_ ( ) const
overrideprotectedvirtual

Implements sead::FileDevice.

◆ doLoad_()

u8 * sead::AnyFileDevice::doLoad_ ( LoadArg & arg)
overrideprotectedvirtual

Reimplemented from sead::FileDevice.

◆ findFileDeviceByFile_()

FileDevice * sead::AnyFileDevice::findFileDeviceByFile_ ( const SafeString & path) const
protected

◆ findFileDeviceByDirectory_()

FileDevice * sead::AnyFileDevice::findFileDeviceByDirectory_ ( const SafeString & path) const
protected

◆ doOpen_()

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

Implements sead::FileDevice.

◆ doClose_()

bool sead::AnyFileDevice::doClose_ ( FileHandle * handle)
overrideprotectedvirtual

Implements sead::FileDevice.

◆ doRead_()

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

Implements sead::FileDevice.

◆ doWrite_()

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

Implements sead::FileDevice.

◆ doSeek_()

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

Implements sead::FileDevice.

◆ doGetCurrentSeekPos_()

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

Implements sead::FileDevice.

◆ doGetFileSize_() [1/2]

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

Implements sead::FileDevice.

◆ doGetFileSize_() [2/2]

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

Implements sead::FileDevice.

◆ doIsExistFile_()

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

Implements sead::FileDevice.

◆ doIsExistDirectory_()

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

Implements sead::FileDevice.

◆ doOpenDirectory_()

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

Implements sead::FileDevice.

◆ doCloseDirectory_()

bool sead::AnyFileDevice::doCloseDirectory_ ( DirectoryHandle * handle)
overrideprotectedvirtual

Implements sead::FileDevice.

◆ doReadDirectory_()

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

Implements sead::FileDevice.

◆ doMakeDirectory_()

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

Implements sead::FileDevice.

◆ isMatchDevice_()

bool sead::AnyFileDevice::isMatchDevice_ ( const HandleBase * handle) const
overrideprotectedvirtual

Reimplemented from sead::FileDevice.

◆ doGetLastRawError_()

RawErrorCode sead::AnyFileDevice::doGetLastRawError_ ( ) const
overrideprotectedvirtual

Implements sead::FileDevice.

Member Data Documentation

◆ mFileDeviceList

FileDeviceList sead::AnyFileDevice::mFileDeviceList
protected

◆ mLastFileDevice

FileDevice* sead::AnyFileDevice::mLastFileDevice
protected