mirror of
https://github.com/ghostty-org/ghostty.git
synced 2026-04-06 07:38:21 +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.
Example: ghostty-vt C Key Encoding
This example demonstrates how to use the ghostty-vt C library to encode key
events into terminal escape sequences.
This example specifically shows how to:
- Create a key encoder with the C API
- Configure Kitty keyboard protocol flags (this example uses KKP)
- Create and configure a key event
- Encode the key event into a terminal escape sequence
The example encodes a Ctrl key release event with the Ctrl modifier set,
producing the escape sequence \x1b[57442;5:3u.
Usage
Run the program:
zig build run