mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-10-17 10:55:06 +00:00
55 lines
1.4 KiB
C
55 lines
1.4 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <sys/types.h>
|
|
|
|
#include <tactility/error.h>
|
|
#include <tactility/freertos/freertos.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef enum {
|
|
APP_FILE_WAIT_READABLE,
|
|
APP_FILE_WAIT_WRITABLE,
|
|
} AppFileWait;
|
|
|
|
#define APP_FILE_READABLE (1u << 0)
|
|
#define APP_FILE_WRITABLE (1u << 1)
|
|
|
|
/** Request codes recognized by AppFileOps::ioctl(), if the bound object supports them. */
|
|
typedef enum {
|
|
/** arg: struct AppWindowSize*. Analogous to POSIX ioctl(fd, TIOCGWINSZ, ...). */
|
|
APP_IOCTL_GET_WINDOW_SIZE,
|
|
} AppIoctlRequest;
|
|
|
|
/** Terminal/window dimensions, as reported by APP_IOCTL_GET_WINDOW_SIZE. */
|
|
struct AppWindowSize {
|
|
uint16_t columns;
|
|
uint16_t rows;
|
|
};
|
|
|
|
struct AppFileOps {
|
|
ssize_t (*read)(void* object, void* buffer, size_t size);
|
|
ssize_t (*write)(void* object, const void* buffer, size_t size);
|
|
error_t (*close)(void* object);
|
|
error_t (*await)(void* object, AppFileWait wait, TickType_t timeout);
|
|
uint32_t (*poll)(void* object);
|
|
void (*retain)(void* object);
|
|
void (*release)(void* object);
|
|
/** Optional; nullptr if the object supports no ioctl requests. */
|
|
error_t (*ioctl)(void* object, AppIoctlRequest request, void* arg);
|
|
};
|
|
|
|
struct AppFile {
|
|
const struct AppFileOps* ops;
|
|
void* object;
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|