docs: explain why TUI is reinitialized on resume (#27177)

This commit is contained in:
Gregory Anders 2024-01-28 08:38:59 -06:00 committed by GitHub
parent 1bc7e18aa8
commit 47cd532bf1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -269,6 +269,10 @@ static void tui_query_kitty_keyboard(TUIData *tui)
out(tui, S_LEN("\x1b[?u\x1b[c")); out(tui, S_LEN("\x1b[?u\x1b[c"));
} }
/// Enable the alternate screen and emit other control sequences to start the TUI.
///
/// This is also called when the TUI is resumed after being suspended. We reinitialize all state
/// from terminfo just in case the controlling terminal has changed (#27177).
static void terminfo_start(TUIData *tui) static void terminfo_start(TUIData *tui)
{ {
tui->scroll_region_is_full_screen = true; tui->scroll_region_is_full_screen = true;
@ -418,6 +422,7 @@ static void terminfo_start(TUIData *tui)
flush_buf(tui); flush_buf(tui);
} }
/// Disable the alternate screen and prepare for the TUI to close.
static void terminfo_stop(TUIData *tui) static void terminfo_stop(TUIData *tui)
{ {
// Destroy output stuff // Destroy output stuff
@ -489,7 +494,7 @@ static void tui_terminal_after_startup(TUIData *tui)
flush_buf(tui); flush_buf(tui);
} }
/// stop the terminal but allow it to restart later (like after suspend) /// Stop the terminal but allow it to restart later (like after suspend)
static void tui_terminal_stop(TUIData *tui) static void tui_terminal_stop(TUIData *tui)
{ {
if (uv_is_closing((uv_handle_t *)&tui->output_handle)) { if (uv_is_closing((uv_handle_t *)&tui->output_handle)) {