#include <evmu_file_manager.h>

Inheritance diagram for EvmuFileManager:

Data Fields
union {

EvmuFileManagerClass * pClass

EvmuFat base

};

Data Fields inherited from EvmuFat
union {

EvmuFatClass * pClass

EvmuFlash base

};

Data Fields inherited from EvmuFlash
union {

EvmuFlashClass * pClass

EvmuPeripheral base

};

GblBool	dataChanged

Data Fields inherited from EvmuPeripheral
union {

EvmuPeripheralClass * pClass

GblObject base

};

GblFlags	logLevel

Related Symbols
(Note that these are not member symbols.)
Filesystem Operations
Methods for serializing and deserializing the filesystem
EVMU_RESULT	EvmuFileManager_load (EvmuFileManager pSelf, const char pPath)

EVMU_RESULT	EvmuFileManager_save (const EvmuFileManager pSelf, const char pPath)

EVMU_RESULT	EvmuFileManager_defrag (EvmuFileManager *pSelf)

File Discovery
Methods for enumerating, looking-up, and retrieving files
size_t	EvmuFileManager_count (const EvmuFileManager *pSelf)

EvmuDirEntry *	EvmuFileManager_file (const EvmuFileManager *pSelf, size_t index)

EvmuDirEntry *	EvmuFileManager_game (const EvmuFileManager *pSelf)

EvmuDirEntry *	EvmuFileManager_iconData (const EvmuFileManager *pSelf)

EvmuDirEntry *	EvmuFileManager_find (const EvmuFileManager pSelf, const char pName)

GblBool	EvmuFileManager_foreach (const EvmuFileManager pSelf, EvmuDirEntryIterFn pFnIt, void pClosure)

File Operations
Methods for operating on and with files
EvmuDirEntry *	EvmuFileManager_alloc (EvmuFileManager pSelf, EvmuNewFileInfo pInfo, const void *pData)

size_t	EvmuFileManager_free (EvmuFileManager pSelf, EvmuDirEntry pEntry)

size_t	EvmuFileManager_read (const EvmuFileManager pSelf, const EvmuDirEntry pEntry, void *pBuffer, size_t size, size_t offset, GblBool inclHdr)

size_t	EvmuFileManager_write (const EvmuFileManager pSelf, const EvmuDirEntry pEntry, const void *pBuffer, size_t size, size_t offset)

EVMU_RESULT	EvmuFileManager_export (const EvmuFileManager pSelf, const EvmuDirEntry pEntry, const char *pPath)

File Information
Methods for calculating and retrieving file info
size_t	EvmuFileManager_bytes (const EvmuFileManager pSelf, const EvmuDirEntry pEntry)

size_t	EvmuFileManager_visibleBytes (const EvmuFileManager pSelf, const EvmuDirEntry pEntry, GblBool inclHdr)

size_t	EvmuFileManager_index (const EvmuFileManager pSelf, const EvmuDirEntry pEntry)

EvmuVms *	EvmuFileManager_vms (const EvmuFileManager pSelf, const EvmuDirEntry pEntry)

uint16_t	EvmuFileManager_crc (const EvmuFileManager pSelf, const EvmuDirEntry pEntry)

Related Symbols inherited from EvmuFat
EvmuRootBlock *	EvmuFat_root (const EvmuFat *pSelf)

EVMU_RESULT	EvmuFat_info (const EvmuFat pSelf, EvmuFatInfo pInfo)

EVMU_RESULT	EvmuFat_format (const EvmuFat pSelf, const EvmuRootBlock pRoot)

GblBool	EvmuFat_isFormatted (const EvmuFat *pSelf)

size_t	EvmuFat_capacity (const EvmuFat *pSelf)

size_t	EvmuFat_toBlocks (const EvmuFat *pSelf, size_t bytes)

void	EvmuFat_usage (const EvmuFat pSelf, EvmuFatUsage pUsage)

size_t	EvmuFat_seqFreeBlocks (const EvmuFat *pSelf)

size_t	EvmuFat_userBlocks (const EvmuFat *pSelf)

void	EvmuFat_log (const EvmuFat *pSelf)

size_t	EvmuFat_blockSize (const EvmuFat *pSelf)

size_t	EvmuFat_blockCount (const EvmuFat *pSelf)

EvmuBlock	EvmuFat_blockTable (const EvmuFat *pSelf)

EvmuBlock	EvmuFat_blockDirectory (const EvmuFat *pSelf)

const void *	EvmuFat_blockData (const EvmuFat *pSelf, EvmuBlock block)

EvmuBlock	EvmuFat_blockNext (const EvmuFat *pSelf, EvmuBlock block)

EVMU_RESULT	EvmuFat_blockLink (const EvmuFat *pSelf, EvmuBlock b, EvmuBlock lnk)

EVMU_RESULT	EvmuFat_blockFree (const EvmuFat *pSelf, EvmuBlock block)

EvmuBlock	EvmuFat_blockAlloc (const EvmuFat *pSelf, EvmuBlock prev, EVMU_FILE_TYPE type)

size_t	EvmuFat_dirEntryCount (const EvmuFat *pSelf)

EvmuDirEntry *	EvmuFat_dirEntry (const EvmuFat *pSelf, size_t index)

size_t	EvmuFat_dirEntryIndex (const EvmuFat pSelf, const EvmuDirEntry pEntry)

EvmuDirEntry *	EvmuFat_dirEntryAlloc (const EvmuFat *pSelf, EVMU_FILE_TYPE fileType)

void	EvmuFat_dirEntryLog (const EvmuFat pSelf, const EvmuDirEntry pEntry)

Related Symbols inherited from EvmuFlash
EVMU_FLASH_PROGRAM_STATE	EvmuFlash_programState (const EvmuFlash *pSelf)

size_t	EvmuFlash_programBytes (const EvmuFlash *pSelf)

EvmuAddress	EvmuFlash_targetAddress (const EvmuFlash *pSelf)

GblBool	EvmuFlash_unlocked (const EvmuFlash *pSelf)

EvmuWord	EvmuFlash_readByte (const EvmuFlash *pSelf, EvmuAddress address)

EVMU_RESULT	EvmuFlash_readBytes (const EvmuFlash pSelf, EvmuAddress base, void pData, size_t *pBytes)

EVMU_RESULT	EvmuFlash_writeByte (EvmuFlash *pSelf, EvmuAddress address, EvmuWord value)

EVMU_RESULT	EvmuFlash_writeBytes (EvmuFlash pSelf, EvmuAddress base, const void pData, size_t *pBytes)

Related Symbols inherited from EvmuPeripheral
EvmuDevice *	EvmuPeripheral_device (const EvmuPeripheral *pSelf)

Related Symbols inherited from EvmuIMemory
size_t	EvmuIMemory_capacity (const EvmuIMemory *pSelf)

EvmuWord	EvmuIMemory_readByte (const EvmuIMemory *pSelf, EvmuAddress address)

EVMU_RESULT	EvmuIMemory_readBytes (const EvmuIMemory pSelf, EvmuAddress base, void pData, size_t *pBytes)

EVMU_RESULT	EvmuIMemory_writeByte (EvmuIMemory *pSelf, EvmuAddress address, EvmuWord value)

EVMU_RESULT	EvmuIMemory_writeBytes (EvmuIMemory pSelf, EvmuAddress base, const void pData, size_t *pBytes)

EVMU_RESULT	EvmuIMemory_fillBytes (EvmuIMemory pSelf, EvmuAddress base, size_t regionSize, const void pData, size_t dataBytes)

Detailed Description

High-level file-oriented flash API.

EvmuFileManager is the most high-level, user-friendly way to manage the VMU's filesystem and handle loading and saving both both individual ROM images and the entire flash filesystem.

See also: EvmuFileManagerClass

Definition at line 69 of file evmu_file_manager.h.

Friends And Related Symbol Documentation

◆ EvmuFileManager_alloc()

EvmuDirEntry * EvmuFileManager_alloc	(	EvmuFileManager *	pSelf,
		EvmuNewFileInfo *	pInfo,
		const void *	pData )

Creates storage for a new file with the given info, copying its contents into the filesystem.

◆ EvmuFileManager_bytes()

size_t EvmuFileManager_bytes	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry )

Returns the total byte size of the file on the filesystem, including the VMS header, icons, eyecatc, etc.

◆ EvmuFileManager_count()

size_t EvmuFileManager_count ( const EvmuFileManager * pSelf )

Returns the number of files which are currently loaded within the filesystem.

◆ EvmuFileManager_crc()

uint16_t EvmuFileManager_crc	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry )

Calculates the 16-bit CRC for an existing file on the filesystem.

◆ EvmuFileManager_defrag()

EVMU_RESULT EvmuFileManager_defrag ( EvmuFileManager * pSelf )

Defragments the filesystem, consolidating all free blocks, storing all files contiguously.

◆ EvmuFileManager_export()

EVMU_RESULT EvmuFileManager_export	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry,
		const char *	pPath )

Exports an existing file to the given path, with the file format automatically deduced from the extension type.

◆ EvmuFileManager_file()

EvmuDirEntry * EvmuFileManager_file	(	const EvmuFileManager *	pSelf,
		size_t	index )

Returns the directory entry for the file at the given index, or NULL if there isn't one.

◆ EvmuFileManager_find()

EvmuDirEntry * EvmuFileManager_find	(	const EvmuFileManager *	pSelf,
		const char *	pName )

Searches for a directory entry with the given name, returning it if found or returning NULL if not found.

◆ EvmuFileManager_foreach()

GblBool EvmuFileManager_foreach	(	const EvmuFileManager *	pSelf,
		EvmuDirEntryIterFn	pFnIt,
		void *	pClosure )

Iterates over directory entries, passing each with pClosure to pFnIt, returning early with GBL_TRUE if pFnIt returns GBL_TRUE.

◆ EvmuFileManager_free()

size_t EvmuFileManager_free	(	EvmuFileManager *	pSelf,
		EvmuDirEntry *	pEntry )

Destroys an existing file, releasing resources back to the filesystem.

◆ EvmuFileManager_game()

EvmuDirEntry * EvmuFileManager_game ( const EvmuFileManager * pSelf )

Returns the directory entry for the currently loaded GAME file, or NULL if there isn't one.

◆ EvmuFileManager_iconData()

EvmuDirEntry * EvmuFileManager_iconData ( const EvmuFileManager * pSelf )

Returns the directory entry for the currently loaded ICONDATA.VMS file, or NULL if there isn't one.

◆ EvmuFileManager_index()

size_t EvmuFileManager_index	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry )

Returns the file index corresponding to a given directory entry for a file, or EVMU_FILE_INDEX_INVALID if not found.

◆ EvmuFileManager_load()

EVMU_RESULT EvmuFileManager_load	(	EvmuFileManager *	pSelf,
		const char *	pPath )

Loads a generic image whose type is determined by its extension into flash.

◆ EvmuFileManager_read()

size_t EvmuFileManager_read	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry,
		void *	pBuffer,
		size_t	size,
		size_t	offset,
		GblBool	inclHdr )

Performs a generic read from an existing file, returning the number of bytes successfully read. When inclHdr is false, the VMS header/images region is omitted and offset is relative to that headerless byte stream.

◆ EvmuFileManager_save()

EVMU_RESULT EvmuFileManager_save	(	const EvmuFileManager *	pSelf,
		const char *	pPath )

Saves a binary image of the entire contents of flash to a file, whose format is determined by its extension.

◆ EvmuFileManager_visibleBytes()

size_t EvmuFileManager_visibleBytes	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry,
		GblBool	inclHdr )

Returns the byte size of the logical stream exposed by EvmuFileManager_read() for the given inclHdr mode.

◆ EvmuFileManager_vms()

EvmuVms * EvmuFileManager_vms	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry )

Returns the VMS header segment (ONLY) for an existing file (not the entire VMS data with icons, eyecatch, etc)

◆ EvmuFileManager_write()

size_t EvmuFileManager_write	(	const EvmuFileManager *	pSelf,
		const EvmuDirEntry *	pEntry,
		const void *	pBuffer,
		size_t	size,
		size_t	offset )

Performs a generic write from an existing file, returning the number of bytes successfully written.

Field Documentation

◆ base

EvmuFat EvmuFileManager::base

Inherited base instance structure.

Definition at line 69 of file evmu_file_manager.h.

◆ pClass

EvmuFileManagerClass* EvmuFileManager::pClass

Pointer to class/vtable structure.

Definition at line 69 of file evmu_file_manager.h.

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

evmu_file_manager.h

Data Fields

Related Symbols

Detailed Description

Friends And Related Symbol Documentation

◆ EvmuFileManager_alloc()

◆ EvmuFileManager_bytes()

◆ EvmuFileManager_count()

◆ EvmuFileManager_crc()

◆ EvmuFileManager_defrag()

◆ EvmuFileManager_export()

◆ EvmuFileManager_file()

◆ EvmuFileManager_find()

◆ EvmuFileManager_foreach()

◆ EvmuFileManager_free()

◆ EvmuFileManager_game()

◆ EvmuFileManager_iconData()

◆ EvmuFileManager_index()

◆ EvmuFileManager_load()

◆ EvmuFileManager_read()

◆ EvmuFileManager_save()

◆ EvmuFileManager_visibleBytes()

◆ EvmuFileManager_vms()

◆ EvmuFileManager_write()

Field Documentation

◆ base

◆ pClass