mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-04-19 14:00:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

vt: expose title and pwd in C API

Browse Source 
Add title and pwd as both gettable data keys
(GHOSTTY_TERMINAL_DATA_TITLE/PWD) and settable options
(GHOSTTY_TERMINAL_OPT_TITLE/PWD) in the C terminal API. Getting
returns a borrowed GhosttyString; setting copies the data into the
terminal via setTitle/setPwd.

The underlying Terminal.setTitle/setPwd now append a null sentinel so
that getTitle/getPwd can return sentinel-terminated slices ([:0]const
u8), which is useful for downstream consumers that need C strings.

Change ghostty_terminal_set to return GhosttyResult instead of void
so that the new title/pwd options can report allocation failures.
Existing option-setting calls cannot fail so the return value is
backwards-compatible for callers that discard it.
This commit is contained in:
Mitchell Hashimoto
2026-03-24 12:59:04 -07:00
parent f21455b7e7
commit 8f1ac0bd4e
3 changed files with 201 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
include/ghostty/vt/terminal.h
View File

@@ -414,6 +414,26 @@ typedef enum {
* Input type: GhosttyTerminalDeviceAttributesFn*
*/
GHOSTTY_TERMINAL_OPT_DEVICE_ATTRIBUTES = 8,
/**
* Set the terminal title manually.
*
* The string data is copied into the terminal. A NULL value pointer
* clears the title (equivalent to setting an empty string).
*
* Input type: GhosttyString*
*/
GHOSTTY_TERMINAL_OPT_TITLE = 9,
/**
* Set the terminal working directory manually.
*
* The string data is copied into the terminal. A NULL value pointer
* clears the pwd (equivalent to setting an empty string).
*
* Input type: GhosttyString*
*/
GHOSTTY_TERMINAL_OPT_PWD = 10,
} GhosttyTerminalOption;
/**
@@ -513,6 +533,29 @@ typedef enum {
* Output type: bool *
*/
GHOSTTY_TERMINAL_DATA_MOUSE_TRACKING = 11,
/**
* The terminal title as set by escape sequences (e.g. OSC 0/2).
*
* Returns a borrowed string. The pointer is valid until the next call
* to ghostty_terminal_vt_write() or ghostty_terminal_reset(). An empty
* string (len=0) is returned when no title has been set.
*
* Output type: GhosttyString *
*/
GHOSTTY_TERMINAL_DATA_TITLE = 12,
/**
* The terminal's current working directory as set by escape sequences
* (e.g. OSC 7).
*
* Returns a borrowed string. The pointer is valid until the next call
* to ghostty_terminal_vt_write() or ghostty_terminal_reset(). An empty
* string (len=0) is returned when no pwd has been set.
*
* Output type: GhosttyString *
*/
GHOSTTY_TERMINAL_DATA_PWD = 13,
} GhosttyTerminalData;
/**
@@ -590,9 +633,9 @@ GhosttyResult ghostty_terminal_resize(GhosttyTerminal terminal,
*
* @ingroup terminal
*/
void ghostty_terminal_set(GhosttyTerminal terminal,
GhosttyTerminalOption option,
const void* value);
GhosttyResult ghostty_terminal_set(GhosttyTerminal terminal,
GhosttyTerminalOption option,
const void* value);
/**
* Write VT-encoded data to the terminal for processing.