mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-04-21 23:05:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9033f6f8ce2bc50fb2529616764fcb2325ae67b2
ghostty/src/terminal/c/AGENTS.md
Mitchell Hashimoto 9033f6f8ce libghostty: add kitty graphics placement iterator API 
Add a C API for iterating over Kitty graphics placements via the
new GhosttyKittyGraphics opaque handle. The API follows the same
pattern as the render state row iterator: allocate an iterator with
ghostty_kitty_graphics_placement_iterator_new, populate it from a
graphics handle via ghostty_kitty_graphics_get with the
PLACEMENT_ITERATOR data kind, advance with
ghostty_kitty_graphics_placement_next, and query per-placement
fields with ghostty_kitty_graphics_placement_get.
2026-04-06 09:15:26 -07:00

1.2 KiB
Raw Blame History

libghostty-vt C API

  • C API must be designed with ABI compatibility in mind
  • Zig tagged unions must be converted to C ABI compatible unions via lib.TaggedUnion.
  • Any functions must be updated all the way through from here to src/terminal/c/main.zig to src/lib_vt.zig and the headers in include/ghostty/vt.h. Specifically:
    1. Define the function in src/terminal/c/<module>.zig.
    2. Re-export it via a pub const in src/terminal/c/main.zig.
    3. Add an @export call in src/lib_vt.zig with the ghostty_ prefixed symbol name.
    4. Declare it in the corresponding header under include/ghostty/vt/.
  • In include/ghostty/vt.h, always sort the header contents by: (1) macros, (2) forward declarations, (3) types, (4) functions

ABI Compatibility

  • Prefer opaque pointers for long-lived objects, such as GhosttyTerminal.
  • Structs:
    • May contain padding bytes if we're confident we'll never grow beyond a certain size.
    • May use the "sized struct" pattern: an extern struct with size: usize = @sizeOf(Self) as the first field. In the C header, callers use GHOSTTY_INIT_SIZED from types.h to zero-initialize and set the size.