Sandboxed file access on the plugins FAT partition. More...

Functions
int	host_fs_write (const char name, const uint8_t data, size_t len)
	Create or overwrite name with len bytes.
int	host_fs_read (const char name, uint8_t buf, size_t *len)
	Read name into buf.
int	host_fs_remove (const char *name)
	Delete name.
int	host_fs_size (const char name, size_t out)
	Write the byte size of name to *out.
int	host_fs_list (char out, size_t out_len)
	Enumerate the plugin's own files.
int	host_fs_view (const char *name)
	Open one of the plugin's own files in a scrollable on-screen text viewer (same as opening the file in the vFAT explorer). Useful for a bundled readme / help page.
int	host_fs_view_image (const char *name)
	Decode and show one of the plugin's own image files (PNG/JPEG) on the e-paper, dithered and scaled to fit.
int	host_fs_view_markdown (const char *name)
	Render and show one of the plugin's own Markdown files in the scrollable text viewer.

Detailed Description

Sandboxed file access on the plugins FAT partition.

Each plugin can only touch files in its own private folder; the host builds and confines every path. Requires the vFAT file storage (plugin-sandboxed) capability. name is a bare filename: characters [A-Za-z0-9._-], no path separators, no leading dot, at most 64 bytes.

Function Documentation

◆ host_fs_list()

int host_fs_list	(	char *	out,
		size_t *	out_len )

Enumerate the plugin's own files.

Parameters

out_len In: capacity of out; out: bytes written ('
'-separated list).

Definition at line 124 of file host_api_fs.cpp.

References HOST_ERR_INVALID_ARG, HOST_ERR_NOT_FOUND, and HOST_OK.

Referenced by cdc::plugin_manager::w_host_fs_list().

◆ host_fs_read()

int host_fs_read	(	const char *	name,
		uint8_t *	buf,
		size_t *	len )

Read name into buf.

Parameters

len	In: capacity of buf; out: bytes actually read.

Returns: HOST_OK, HOST_ERR_NOT_FOUND, or another HOST_ERR_*.

Definition at line 90 of file host_api_fs.cpp.

References HOST_ERR_INVALID_ARG, HOST_ERR_NOT_FOUND, HOST_OK, name, and cdc::core::openFile().

Referenced by cdc::plugin_manager::w_host_fs_read().

◆ host_fs_remove()

int host_fs_remove ( const char * name )

Delete name.

Returns: HOST_OK or HOST_ERR_NOT_FOUND.

Definition at line 103 of file host_api_fs.cpp.

References HOST_ERR_NOT_FOUND, HOST_OK, and name.

Referenced by cdc::plugin_manager::w_host_fs_remove().

◆ host_fs_size()

int host_fs_size	(	const char *	name,
		size_t *	out )

Write the byte size of name to *out.

Returns: HOST_OK or HOST_ERR_NOT_FOUND.

Definition at line 111 of file host_api_fs.cpp.

References HOST_ERR_INVALID_ARG, HOST_ERR_NOT_FOUND, HOST_OK, and name.

Referenced by cdc::plugin_manager::w_host_fs_size().

◆ host_fs_view()

int host_fs_view ( const char * name )

Open one of the plugin's own files in a scrollable on-screen text viewer (same as opening the file in the vFAT explorer). Useful for a bundled readme / help page.