file.h

#include <modkit/file.h>17 functions · 6 structs · 3 enums · 15 typedefs · 7 macros

Retained cross-platform file references and asynchronous pickers.

Functions

mk_async_request_cancelfunction

bool mk_async_request_cancel(mk_async_request_t request)

Cancellation is idempotent; a successful cancel still completes later.

Parameter	Type	Description
request	mk_async_request_t	Value for request.

Returns True when the operation succeeds.

mk_file_enumerate_desc_initfunction

void mk_file_enumerate_desc_init(mk_file_enumerate_desc_t *desc)

Initialize the file enumerate desc.

Parameter	Type	Description
desc	mk_file_enumerate_desc_t *	Configuration descriptor.

mk_file_picker_desc_initfunction

void mk_file_picker_desc_init(mk_file_picker_desc_t *desc)

Initialize the file picker desc.

Parameter	Type	Description
desc	mk_file_picker_desc_t *	Configuration descriptor.

mk_file_picker_filter_initfunction

void mk_file_picker_filter_init(mk_file_picker_filter_t *filter)

Initialize the file picker filter.

Parameter	Type	Description
filter	mk_file_picker_filter_t *	Value for filter.

mk_file_picker_showfunction

mk_result mk_file_picker_show(const mk_file_picker_desc_t *desc, mk_file_picker_fn callback, void *user_data, mk_async_request_t *request)

Perform the file picker show operation.

Parameter	Type	Description
desc	const mk_file_picker_desc_t *	Configuration descriptor.
callback	mk_file_picker_fn	Completion callback.
user_data	void *	Caller-provided context.
request	mk_async_request_t *	Value for request.

Returns MK_SUCCESS or an error result.

mk_file_picker_supportedfunction

bool mk_file_picker_supported(mk_file_picker_type_t type)

Perform the file picker supported operation.

Parameter	Type	Description
type	mk_file_picker_type_t	Value for type.

Returns True when the condition holds.

mk_file_read_desc_initfunction

void mk_file_read_desc_init(mk_file_read_desc_t *desc)

Read desc init for the file.

Parameter	Type	Description
desc	mk_file_read_desc_t *	Configuration descriptor.

mk_file_ref_enumerate_asyncfunction

mk_result mk_file_ref_enumerate_async(mk_file_ref_t *directory, const mk_file_enumerate_desc_t *desc, mk_file_enumerate_fn callback, void *user_data, mk_async_request_t *request)

Perform the file ref enumerate async operation.

Parameter	Type	Description
directory	mk_file_ref_t *	Value for directory.
desc	const mk_file_enumerate_desc_t *	Configuration descriptor.
callback	mk_file_enumerate_fn	Completion callback.
user_data	void *	Caller-provided context.
request	mk_async_request_t *	Value for request.

Returns MK_SUCCESS or an error result.

mk_file_ref_from_pathfunction

mk_file_ref_t * mk_file_ref_from_path(const char *path)

Perform the file ref from path operation.

Parameter	Type	Description
path	const char *	Value for path.

Returns A borrowed pointer, or NULL when unavailable.

mk_file_ref_get_infofunction

mk_result mk_file_ref_get_info(const mk_file_ref_t *file, mk_file_ref_info_t *info)

Get info from the file ref.

Parameter	Type	Description
file	const mk_file_ref_t *	Value for file.
info	mk_file_ref_info_t *	Value for info.

Returns MK_SUCCESS or an error result.

mk_file_ref_info_initfunction

void mk_file_ref_info_init(mk_file_ref_info_t *info)

Initialize the file ref info.

Parameter	Type	Description
info	mk_file_ref_info_t *	Value for info.

mk_file_ref_is_validfunction

bool mk_file_ref_is_valid(const mk_file_ref_t *file)

Test whether the file ref is valid.

Parameter	Type	Description
file	const mk_file_ref_t *	Value for file.

Returns True when the condition holds.

mk_file_ref_read_asyncfunction

mk_result mk_file_ref_read_async(mk_file_ref_t *file, const mk_file_read_desc_t *desc, mk_file_read_fn callback, void *user_data, mk_async_request_t *request)

Read async for the file ref.

Parameter	Type	Description
file	mk_file_ref_t *	Value for file.
desc	const mk_file_read_desc_t *	Configuration descriptor.
callback	mk_file_read_fn	Completion callback.
user_data	void *	Caller-provided context.
request	mk_async_request_t *	Value for request.

Returns MK_SUCCESS or an error result.

mk_file_ref_releasefunction

void mk_file_ref_release(mk_file_ref_t *file)

Release file ref.

Parameter	Type	Description
file	mk_file_ref_t *	Value for file.

mk_file_ref_retainfunction

mk_file_ref_t * mk_file_ref_retain(mk_file_ref_t *file)

Retain file ref.

Parameter	Type	Description
file	mk_file_ref_t *	Value for file.

Returns A borrowed pointer, or NULL when unavailable.

mk_file_ref_write_asyncfunction

mk_result mk_file_ref_write_async(mk_file_ref_t *file, const mk_file_write_desc_t *desc, mk_file_write_fn callback, void *user_data, mk_async_request_t *request)

Write async for the file ref.

Parameter	Type	Description
file	mk_file_ref_t *	Value for file.
desc	const mk_file_write_desc_t *	Configuration descriptor.
callback	mk_file_write_fn	Completion callback.
user_data	void *	Caller-provided context.
request	mk_async_request_t *	Value for request.

Returns MK_SUCCESS or an error result.

mk_file_write_desc_initfunction

void mk_file_write_desc_init(mk_file_write_desc_t *desc)

Write desc init for the file.

Parameter	Type	Description
desc	mk_file_write_desc_t *	Configuration descriptor.

Structs

mk_file_enumerate_descstruct

Data for file enumerate desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
include_hidden	bool	The include hidden.

mk_file_picker_descstruct

Data for file picker desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
type	mk_file_picker_type_t	The type.
title	const char *	The title.
default_location	mk_file_ref_t *	The default location.
filters	const mk_file_picker_filter_t *	The filters.
filter_count	uint32_t	The filter count.
allow_multiple	bool	The allow multiple.

mk_file_picker_filterstruct

Data for file picker filter.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
name	const char *	The name.
pattern	const char *	The pattern.

mk_file_read_descstruct

Data for file read desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
offset	uint64_t	The offset.
max_bytes	uint64_t	The max bytes.

mk_file_ref_infostruct

Data for file ref info.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
source	mk_file_ref_source_t	The source.
kind	mk_file_kind_t	The kind.
display_name	const char *	The display name.
local_path	const char *	The local path.
size	uint64_t	The size.
readable	bool	The readable.
writable	bool	The writable.

mk_file_write_descstruct

Data for file write desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
data	const void *	The data.
size	size_t	The size.
offset	uint64_t	The offset.
truncate	bool	The truncate.

Enums

mk_file_kindenum

Values for file kind.

Value	Description
MK_FILE_KIND_UNKNOWN	Selects unknown.
MK_FILE_KIND_FILE	Selects file.
MK_FILE_KIND_DIRECTORY	Selects directory.

mk_file_picker_typeenum

Values for file picker type.

Value	Description
MK_FILE_PICKER_OPEN	Selects open.
MK_FILE_PICKER_SAVE	Selects save.
MK_FILE_PICKER_FOLDER	Selects folder.

mk_file_ref_sourceenum

Values for file ref source.

Value	Description
MK_FILE_REF_PATH	Selects path.
MK_FILE_REF_BROWSER_FILE	Selects browser file.
MK_FILE_REF_CONTENT_URI	Selects content uri.
MK_FILE_REF_SECURITY_SCOPED_URL	Selects security scoped URL.

Typedefs

mk_async_request_ttypedef

typedef uint64_t mk_async_request_t

Type used for async request.

mk_file_enumerate_desc_ttypedef

typedef struct mk_file_enumerate_desc mk_file_enumerate_desc_t

Data for file enumerate desc.

mk_file_enumerate_fntypedef

typedef void(*) mk_file_enumerate_fn(mk_async_request_t request, mk_result result, mk_file_ref_t *directory, mk_file_ref_t *const  *entries, uint32_t entry_count, void *user_data)

Callback used for file enumerate.

mk_file_kind_ttypedef

typedef enum mk_file_kind mk_file_kind_t

Values for file kind.

mk_file_picker_desc_ttypedef

typedef struct mk_file_picker_desc mk_file_picker_desc_t

Data for file picker desc.

mk_file_picker_filter_ttypedef

typedef struct mk_file_picker_filter mk_file_picker_filter_t

Data for file picker filter.

mk_file_picker_fntypedef

typedef void(*) mk_file_picker_fn(mk_async_request_t request, mk_result result, mk_file_ref_t *const  *files, uint32_t file_count, int32_t selected_filter, void *user_data)

Callback used for file picker.

mk_file_picker_type_ttypedef

typedef enum mk_file_picker_type mk_file_picker_type_t

Values for file picker type.

mk_file_read_desc_ttypedef

typedef struct mk_file_read_desc mk_file_read_desc_t

Data for file read desc.

mk_file_read_fntypedef

typedef void(*) mk_file_read_fn(mk_async_request_t request, mk_result result, mk_file_ref_t *file, const void *data, size_t size, void *user_data)

Callback used for file read.

mk_file_ref_info_ttypedef

typedef struct mk_file_ref_info mk_file_ref_info_t

Data for file ref info.

mk_file_ref_source_ttypedef

typedef enum mk_file_ref_source mk_file_ref_source_t

Values for file ref source.

mk_file_ref_ttypedef

typedef struct mk_file_ref_s mk_file_ref_t

Type used for file ref.

mk_file_write_desc_ttypedef

typedef struct mk_file_write_desc mk_file_write_desc_t

Data for file write desc.

mk_file_write_fntypedef

typedef void(*) mk_file_write_fn(mk_async_request_t request, mk_result result, mk_file_ref_t *file, size_t bytes_written, void *user_data)

Callback used for file write.

Macros

MK_ASYNC_REQUEST_INVALIDdefine

MK_ASYNC_REQUEST_INVALID

Invalid sentinel for async request.

MK_FILE_ENUMERATE_DESC_VERSIONdefine

MK_FILE_ENUMERATE_DESC_VERSION

ABI or format version for file enumerate desc.

MK_FILE_PICKER_DESC_VERSIONdefine

MK_FILE_PICKER_DESC_VERSION

ABI or format version for file picker desc.

MK_FILE_PICKER_FILTER_VERSIONdefine

MK_FILE_PICKER_FILTER_VERSION

ABI or format version for file picker filter.

MK_FILE_READ_DESC_VERSIONdefine

MK_FILE_READ_DESC_VERSION

ABI or format version for file read desc.

MK_FILE_REF_INFO_VERSIONdefine

MK_FILE_REF_INFO_VERSION

ABI or format version for file ref info.

MK_FILE_WRITE_DESC_VERSIONdefine

MK_FILE_WRITE_DESC_VERSION

ABI or format version for file write desc.