1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
use super::*;
/// State tracking for the thin client.
pub(super) struct ClientState {
/// Stateful semantic-frame encoder used when the server sends FrameData.
pub(super) blit_encoder: render_ansi::BlitEncoder,
pub(super) mouse_capture_active: bool,
pub(super) endpoint_mouse_capture_requested: bool,
pub(super) endpoint_sgr_pixels_requested: bool,
/// Latest physical host theme observations, retained so an endpoint selected after the
/// observation receives the same client-owned baseline.
pub(super) host_theme_updates: Vec<crate::protocol::ClientHostThemeUpdate>,
pub(super) direct_mouse_capture_preference: bool,
pub(super) shell_mouse_capture_preference: bool,
pub(super) direct_keyboard_protocol: crate::terminal_modes::DirectHostKeyboardState,
pub(super) pane_keyboard_report_all: bool,
pub(super) keyboard_report_all_active: bool,
pub(super) reported_size: (u16, u16),
pub(super) reported_cell_size: (u32, u32),
pub(super) sound_config: crate::config::SoundConfig,
pub(super) kitty_graphics_enabled: bool,
pub(super) pixel_geometry_enabled: bool,
pub(super) pixel_geometry_exact: bool,
#[cfg(unix)]
pub(super) direct_graphics_response: Arc<Mutex<direct_graphics::ResponseMatcher>>,
#[cfg(unix)]
pub(super) retired_direct_graphics: Option<(endpoint::ClientEndpointId, u64, u32)>,
#[cfg(unix)]
pub(super) pending_surface_graphics:
HashMap<(endpoint::ClientEndpointId, u64, u32), crate::protocol::SurfaceGraphicsAssetKey>,
pub(super) attach_escape: Option<AttachEscapeState>,
#[cfg(unix)]
pub(super) mouse_scroll_lines: usize,
pub(super) remote_image_paste_key:
Option<(crossterm::event::KeyCode, crossterm::event::KeyModifiers)>,
pub(super) redraw_on_focus_gained: bool,
pub(super) repaint_pending: bool,
/// During a source-off-first handoff the currently blitted frame remains authoritative until
/// an acknowledged target snapshot/surface pair commits.
pub(super) presentation_frozen: bool,
pub(super) draw_host_cursor: bool,
pub(super) detached_process_children: Vec<std::process::Child>,
pub(super) shell: Option<shell::ClientShellState>,
}
impl Drop for ClientState {
fn drop(&mut self) {
if self.attach_escape.is_some() {
let _ = crate::terminal_modes::set_direct_host_keyboard_protocol(
&mut io::stdout(),
&mut self.direct_keyboard_protocol,
0,
0,
);
}
}
}
impl ClientState {
pub(super) fn request_repaint(&mut self) {
self.repaint_pending = true;
}
pub(super) fn freeze_presentation(&mut self) {
self.presentation_frozen = true;
}
pub(super) fn record_host_theme_update(
&mut self,
update: &crate::protocol::ClientHostThemeUpdate,
) {
use crate::protocol::ClientHostThemeUpdate;
match update {
ClientHostThemeUpdate::DefaultColor { kind, .. } => {
self.host_theme_updates.retain(|current| {
!matches!(
current,
ClientHostThemeUpdate::DefaultColor {
kind: current_kind,
..
} if current_kind == kind
)
});
}
ClientHostThemeUpdate::PaletteColors(_) => self
.host_theme_updates
.retain(|current| !matches!(current, ClientHostThemeUpdate::PaletteColors(_))),
ClientHostThemeUpdate::Appearance(_) => self
.host_theme_updates
.retain(|current| !matches!(current, ClientHostThemeUpdate::Appearance(_))),
}
self.host_theme_updates.push(update.clone());
}
/// Replay the retained physical-host baseline only after an endpoint owns the committed
/// presentation. The endpoint transport preserves this order ahead of the resync control.
pub(super) fn replay_host_theme(
&self,
endpoints: &mut endpoint::EndpointRegistry,
endpoint_id: &endpoint::ClientEndpointId,
) {
for update in &self.host_theme_updates {
let _ = endpoints.send_to(
endpoint_id,
&crate::protocol::ClientMessage::ClientShellHostTheme {
update: update.clone(),
},
);
}
}
pub(super) fn unfreeze_presentation(&mut self) {
self.presentation_frozen = false;
// A resize or metadata event may have happened while frozen. Force a full frame rather
// than attempting to patch the old source frame.
self.request_repaint();
}
/// Present a composed error/chrome frame while retaining the handoff input freeze. The pane
/// cells are still the last coherent surface; only client chrome (including the error) moves.
pub(super) fn present_frozen_chrome(&mut self, frame_data: FrameData) {
let frozen = self.presentation_frozen;
self.presentation_frozen = false;
self.present_frame(frame_data);
self.presentation_frozen = frozen;
}
pub(super) fn present_graphics(&mut self, graphics: &[u8]) {
if self.presentation_frozen || graphics.is_empty() || !self.kitty_graphics_enabled {
return;
}
let mut stdout = io::stdout();
let _ = write_encoded_frame_with_graphics(&mut stdout, &[], graphics);
let _ = stdout.flush();
}
pub(super) fn present_surface_patch(
&mut self,
patch: shell::ClientComposedSurfacePatch,
) -> io::Result<bool> {
if self.presentation_frozen || self.repaint_pending {
crate::render_prof::event("client_surface_patch.fallback.repaint");
return Ok(false);
}
let rows = if self.draw_host_cursor {
let Some(rows) = self
.blit_encoder
.patch_rows_with_drawn_cursor(&patch.rows, patch.cursor.as_ref())
else {
crate::render_prof::event("client_surface_patch.fallback.drawn_cursor");
return Ok(false);
};
rows
} else {
patch.rows
};
let encode_started = crate::render_prof::timer();
let Some(encoded) =
self.blit_encoder
.encode_patch(&rows, patch.cursor.clone(), self.draw_host_cursor)
else {
crate::render_prof::event("client_surface_patch.fallback.encode");
return Ok(false);
};
crate::render_prof::duration_since("client_surface_patch.encode", encode_started);
let write_started = crate::render_prof::timer();
let mut stdout = io::stdout();
stdout.write_all(&encoded.bytes)?;
stdout.flush()?;
crate::render_prof::duration_since("client_surface_patch.write", write_started);
let committed = self.blit_encoder.commit_patch(&rows, patch.cursor, encoded);
crate::render_prof::event(if committed {
"client_surface_patch.success"
} else {
"client_surface_patch.fallback.commit"
});
Ok(committed)
}
#[cfg(unix)]
pub(super) fn retire_endpoint_graphics(&mut self, endpoint_id: &endpoint::ClientEndpointId) {
let transfer_ids = self
.pending_surface_graphics
.keys()
.filter(|(owner, _, _)| owner == endpoint_id)
.map(|(_, transfer_id, _)| *transfer_id)
.collect::<Vec<_>>();
self.pending_surface_graphics
.retain(|(owner, _, _), _| owner != endpoint_id);
if self
.retired_direct_graphics
.as_ref()
.is_some_and(|(owner, _, _)| owner == endpoint_id)
{
self.retired_direct_graphics = None;
}
if let Ok(mut matcher) = self.direct_graphics_response.lock() {
for transfer_id in transfer_ids {
matcher.retire(transfer_id);
}
}
}
pub(super) fn present_frame(&mut self, frame_data: FrameData) {
if self.presentation_frozen {
return;
}
let frame_data = if self.draw_host_cursor {
render_ansi::frame_with_drawn_cursor(frame_data)
} else {
frame_data
};
let encoded = if self.draw_host_cursor {
self.blit_encoder
.encode_with_suppressed_visible_cursor(&frame_data, self.repaint_pending)
} else {
self.blit_encoder.encode(&frame_data, self.repaint_pending)
};
let mut stdout = io::stdout();
let graphics = if self.kitty_graphics_enabled {
frame_data.graphics.as_slice()
} else {
&[]
};
let _ = write_encoded_frame_with_graphics(&mut stdout, &encoded.bytes, graphics);
let _ = stdout.flush();
self.blit_encoder.commit(frame_data, encoded);
self.repaint_pending = false;
}
}
|
