mirror of
https://github.com/ghostty-org/ghostty.git
synced 2026-04-18 05:20:29 +00:00
15b8976d64
Extract inline @code blocks from vt headers (size_report.h, modes.h, sgr.h, paste.h, mouse.h, key.h) into standalone buildable examples under example/. Each header now uses Doxygen @snippet tags to include code from the example source files, keeping documentation in sync with code that is verified to compile and run. New example projects: c-vt-size-report and c-vt-modes. Existing examples (c-vt-sgr, c-vt-paste, c-vt-mouse-encode, c-vt-key-encode) gain snippet markers so their code can be referenced from the headers. Conceptual snippets in key.h, mouse.h, and key/encoder.h that show terminal-state usage patterns remain inline since they cannot be compiled standalone.
71 lines
2.2 KiB
C
71 lines
2.2 KiB
C
/**
|
|
* @file mouse.h
|
|
*
|
|
* Mouse encoding module - encode mouse events into terminal escape sequences.
|
|
*/
|
|
|
|
#ifndef GHOSTTY_VT_MOUSE_H
|
|
#define GHOSTTY_VT_MOUSE_H
|
|
|
|
/** @defgroup mouse Mouse Encoding
|
|
*
|
|
* Utilities for encoding mouse events into terminal escape sequences,
|
|
* supporting X10, UTF-8, SGR, URxvt, and SGR-Pixels mouse protocols.
|
|
*
|
|
* ## Basic Usage
|
|
*
|
|
* 1. Create an encoder instance with ghostty_mouse_encoder_new().
|
|
* 2. Configure encoder options with ghostty_mouse_encoder_setopt() or
|
|
* ghostty_mouse_encoder_setopt_from_terminal().
|
|
* 3. For each mouse event:
|
|
* - Create a mouse event with ghostty_mouse_event_new().
|
|
* - Set event properties (action, button, modifiers, position).
|
|
* - Encode with ghostty_mouse_encoder_encode().
|
|
* - Free the event with ghostty_mouse_event_free() or reuse it.
|
|
* 4. Free the encoder with ghostty_mouse_encoder_free() when done.
|
|
*
|
|
* For a complete working example, see example/c-vt-mouse-encode in the
|
|
* repository.
|
|
*
|
|
* ## Example
|
|
*
|
|
* @snippet c-vt-mouse-encode/src/main.c mouse-encode
|
|
*
|
|
* ## Example: Encoding with Terminal State
|
|
*
|
|
* When you have a GhosttyTerminal, you can sync its tracking mode and
|
|
* output format into the encoder automatically:
|
|
*
|
|
* @code{.c}
|
|
* // Create a terminal and feed it some VT data that enables mouse tracking
|
|
* GhosttyTerminal terminal;
|
|
* ghostty_terminal_new(NULL, &terminal,
|
|
* (GhosttyTerminalOptions){.cols = 80, .rows = 24, .max_scrollback = 0});
|
|
*
|
|
* // Application might write data that enables mouse reporting, etc.
|
|
* ghostty_terminal_vt_write(terminal, vt_data, vt_len);
|
|
*
|
|
* // Create an encoder and sync its options from the terminal
|
|
* GhosttyMouseEncoder encoder;
|
|
* ghostty_mouse_encoder_new(NULL, &encoder);
|
|
* ghostty_mouse_encoder_setopt_from_terminal(encoder, terminal);
|
|
*
|
|
* // Encode a mouse event using the terminal-derived options
|
|
* char buf[128];
|
|
* size_t written = 0;
|
|
* ghostty_mouse_encoder_encode(encoder, event, buf, sizeof(buf), &written);
|
|
*
|
|
* ghostty_mouse_encoder_free(encoder);
|
|
* ghostty_terminal_free(terminal);
|
|
* @endcode
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#include <ghostty/vt/mouse/event.h>
|
|
#include <ghostty/vt/mouse/encoder.h>
|
|
|
|
/** @} */
|
|
|
|
#endif /* GHOSTTY_VT_MOUSE_H */
|