mirror of
https://github.com/ghostty-org/ghostty.git
synced 2026-05-25 14:28:32 +00:00
40d108599f
Rename the shared library visibility macro from GHOSTTY_EXPORT to GHOSTTY_API across all public C headers. This applies to both the libghostty-vt headers under include/ghostty/vt/ and the main include/ghostty.h header. This is a bit more idiomatic compared to other C libs and addresses the fact that we're not always exporting...
76 lines
1.9 KiB
C
76 lines
1.9 KiB
C
/**
|
|
* @file focus.h
|
|
*
|
|
* Focus encoding - encode focus in/out events into terminal escape sequences.
|
|
*/
|
|
|
|
#ifndef GHOSTTY_VT_FOCUS_H
|
|
#define GHOSTTY_VT_FOCUS_H
|
|
|
|
/** @defgroup focus Focus Encoding
|
|
*
|
|
* Utilities for encoding focus gained/lost events into terminal escape
|
|
* sequences (CSI I / CSI O) for focus reporting mode (mode 1004).
|
|
*
|
|
* ## Basic Usage
|
|
*
|
|
* Use ghostty_focus_encode() to encode a focus event into a caller-provided
|
|
* buffer. If the buffer is too small, the function returns
|
|
* GHOSTTY_OUT_OF_SPACE and sets the required size in the output parameter.
|
|
*
|
|
* ## Example
|
|
*
|
|
* @snippet c-vt-encode-focus/src/main.c focus-encode
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#include <stddef.h>
|
|
#include <ghostty/vt/types.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Focus event types for focus reporting mode (mode 1004).
|
|
*/
|
|
typedef enum {
|
|
/** Terminal window gained focus */
|
|
GHOSTTY_FOCUS_GAINED = 0,
|
|
/** Terminal window lost focus */
|
|
GHOSTTY_FOCUS_LOST = 1,
|
|
} GhosttyFocusEvent;
|
|
|
|
/**
|
|
* Encode a focus event into a terminal escape sequence.
|
|
*
|
|
* Encodes a focus gained (CSI I) or focus lost (CSI O) report into the
|
|
* provided buffer.
|
|
*
|
|
* If the buffer is too small, the function returns GHOSTTY_OUT_OF_SPACE
|
|
* and writes the required buffer size to @p out_written. The caller can
|
|
* then retry with a sufficiently sized buffer.
|
|
*
|
|
* @param event The focus event to encode
|
|
* @param buf Output buffer to write the encoded sequence into (may be NULL)
|
|
* @param buf_len Size of the output buffer in bytes
|
|
* @param[out] out_written On success, the number of bytes written. On
|
|
* GHOSTTY_OUT_OF_SPACE, the required buffer size.
|
|
* @return GHOSTTY_SUCCESS on success, GHOSTTY_OUT_OF_SPACE if the buffer
|
|
* is too small
|
|
*/
|
|
GHOSTTY_API GhosttyResult ghostty_focus_encode(
|
|
GhosttyFocusEvent event,
|
|
char* buf,
|
|
size_t buf_len,
|
|
size_t* out_written);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/** @} */
|
|
|
|
#endif /* GHOSTTY_VT_FOCUS_H */
|