81 lines
2.3 KiB
C
81 lines
2.3 KiB
C
/**
|
|
* @file key.h
|
|
*
|
|
* Key encoding module - encode key events into terminal escape sequences.
|
|
*/
|
|
|
|
#ifndef GHOSTTY_VT_KEY_H
|
|
#define GHOSTTY_VT_KEY_H
|
|
|
|
/** @defgroup key Key Encoding
|
|
*
|
|
* Utilities for encoding key events into terminal escape sequences,
|
|
* supporting both legacy encoding as well as Kitty Keyboard Protocol.
|
|
*
|
|
* ## Basic Usage
|
|
*
|
|
* 1. Create an encoder instance with ghostty_key_encoder_new()
|
|
* 2. Configure encoder options with ghostty_key_encoder_setopt().
|
|
* 3. For each key event:
|
|
* - Create a key event with ghostty_key_event_new()
|
|
* - Set event properties (action, key, modifiers, etc.)
|
|
* - Encode with ghostty_key_encoder_encode()
|
|
* - Free the event with ghostty_key_event_free()
|
|
* - Note: You can also reuse the same key event multiple times by
|
|
* changing its properties.
|
|
* 4. Free the encoder with ghostty_key_encoder_free() when done
|
|
*
|
|
* ## Example
|
|
*
|
|
* @code{.c}
|
|
* #include <assert.h>
|
|
* #include <stdio.h>
|
|
* #include <ghostty/vt.h>
|
|
*
|
|
* int main() {
|
|
* // Create encoder
|
|
* GhosttyKeyEncoder encoder;
|
|
* GhosttyResult result = ghostty_key_encoder_new(NULL, &encoder);
|
|
* assert(result == GHOSTTY_SUCCESS);
|
|
*
|
|
* // Enable Kitty keyboard protocol with all features
|
|
* ghostty_key_encoder_setopt(encoder, GHOSTTY_KEY_ENCODER_OPT_KITTY_FLAGS,
|
|
* &(uint8_t){GHOSTTY_KITTY_KEY_ALL});
|
|
*
|
|
* // Create and configure key event for Ctrl+C press
|
|
* GhosttyKeyEvent event;
|
|
* result = ghostty_key_event_new(NULL, &event);
|
|
* assert(result == GHOSTTY_SUCCESS);
|
|
* ghostty_key_event_set_action(event, GHOSTTY_KEY_ACTION_PRESS);
|
|
* ghostty_key_event_set_key(event, GHOSTTY_KEY_C);
|
|
* ghostty_key_event_set_mods(event, GHOSTTY_MODS_CTRL);
|
|
*
|
|
* // Encode the key event
|
|
* char buf[128];
|
|
* size_t written = 0;
|
|
* result = ghostty_key_encoder_encode(encoder, event, buf, sizeof(buf), &written);
|
|
* assert(result == GHOSTTY_SUCCESS);
|
|
*
|
|
* // Use the encoded sequence (e.g., write to terminal)
|
|
* fwrite(buf, 1, written, stdout);
|
|
*
|
|
* // Cleanup
|
|
* ghostty_key_event_free(event);
|
|
* ghostty_key_encoder_free(encoder);
|
|
* return 0;
|
|
* }
|
|
* @endcode
|
|
*
|
|
* For a complete working example, see example/c-vt-key-encode in the
|
|
* repository.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#include <ghostty/vt/key/event.h>
|
|
#include <ghostty/vt/key/encoder.h>
|
|
|
|
/** @} */
|
|
|
|
#endif /* GHOSTTY_VT_KEY_H */
|