term-session-client 0.8.20-alpha

IPC-based session client for term-wm. For internal usage.
Documentation
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
mod remote_pane;

pub use remote_pane::RemotePane;

use std::io::{self, Write, stdout};
use std::sync::Arc;
use std::time::Duration;

use crossterm::QueueableCommand;
use crossterm::cursor::{Hide, Show};
use crossterm::event as crossterm_event;
use crossterm::terminal::{
    EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode,
};
use muxio_tokio_mpsc_adapter::ChannelCallerExt;
use muxio_tokio_rpc_ipc_client::{RpcCallPrebuffered, RpcIpcClient, RpcServiceCallerInterface};
use portable_pty::PtySize;
use term_session_muxio_service_definitions::{
    STREAM_INPUT_METHOD_ID, SUBSCRIBE_OUTPUT_METHOD_ID, Spawn,
};
use term_wm_core::events::{Event, KeyKind};
use term_wm_pty_engine::Pane;
use term_wm_pty_engine::clipboard::{Clipboard, extract_osc52_text};
use term_wm_pty_engine::input_encoding::{key_to_bytes, mouse_event_to_bytes};
use term_wm_pty_engine::signal::install_sigint_handler;
use tokio::sync::mpsc;
use vt100::{MouseProtocolEncoding, MouseProtocolMode};

/// Number of iterations to wait for initial PTY output.
/// Windows ConPTY needs more time to initialize and flush its internal buffers.
#[cfg(target_os = "windows")]
const INITIAL_WAIT_ITERS: usize = 60;
#[cfg(not(target_os = "windows"))]
const INITIAL_WAIT_ITERS: usize = 20;

struct TerminalGuard;

impl Drop for TerminalGuard {
    fn drop(&mut self) {
        let _ = stdout().queue(crossterm::event::DisableMouseCapture);
        let _ = stdout().queue(Show);
        let _ = stdout().queue(LeaveAlternateScreen);
        let _ = disable_raw_mode();
        let _ = stdout().flush();
    }
}

/// Connect to a term-session-server and run the TUI viewer.
///
/// This function is synchronous. It creates a background tokio runtime
/// for muxio IPC, then runs the synchronous crossterm event loop on the
/// calling thread.
pub fn run_session(socket_path: &str) -> io::Result<()> {
    let rt =
        tokio::runtime::Runtime::new().map_err(|e| io::Error::other(format!("runtime: {e}")))?;

    // Connect via muxio IPC
    let client: Arc<RpcIpcClient> = rt
        .block_on(RpcIpcClient::new(socket_path))
        .map_err(|e| io::Error::new(io::ErrorKind::ConnectionRefused, format!("{e:?}")))?;

    // Channel for raw PTY output bytes from the subscription stream
    let (push_tx, push_rx) = mpsc::unbounded_channel::<Vec<u8>>();

    // Get terminal size
    let (term_cols, term_rows) = crossterm::terminal::size()?;

    // Spawn session on the server
    rt.block_on(async {
        Spawn::call(&*client, (None, term_cols, term_rows))
            .await
            .map_err(|e| io::Error::other(format!("spawn: {e:?}")))
    })?;

    // Open streaming channels for output subscription and input
    let writer = rt.block_on(async {
        // Subscribe to PTY output via the mpsc adapter.
        // `reader` yields response chunks (raw PTY output bytes).
        let (_, mut reader) = client
            .open_channel(SUBSCRIBE_OUTPUT_METHOD_ID, 0)
            .await
            .map_err(|e| io::Error::other(format!("subscribe: {e:?}")))?;

        // Forward response chunks to push_tx.  When the stream ends
        // (session exits), push_tx is dropped, and `drain_pushes`
        // detects the disconnect.
        rt.spawn(async move {
            while let Some(chunk) = reader.recv().await {
                match chunk {
                    Ok(data) => {
                        let _ = push_tx.send(data);
                    }
                    Err(_) => break,
                }
            }
        });

        // Open streaming channel for PTY input.
        // `writer` accepts keystroke bytes.
        let (writer, _) = client
            .open_channel(STREAM_INPUT_METHOD_ID, 0)
            .await
            .map_err(|e| io::Error::other(format!("stream input: {e:?}")))?;

        Ok::<_, io::Error>(writer)
    })?;

    let input_writer = Box::new(move |data: &[u8]| -> io::Result<()> {
        writer
            .send(data.to_vec())
            .map_err(|e| io::Error::other(e.to_string()))?;
        Ok(())
    });

    let mut pane = RemotePane::new(
        1u64,
        client.clone(),
        rt.handle().clone(),
        term_cols,
        term_rows,
        push_rx,
        input_writer,
    );

    // Wait for initial output
    for _ in 0..INITIAL_WAIT_ITERS {
        pane.drain_pushes();
        let parser = pane.shared_parser();
        let parser = parser.lock().unwrap();
        if !parser.screen().contents_formatted().is_empty() {
            break;
        }
        drop(parser);
        std::thread::sleep(Duration::from_millis(50));
    }

    enable_raw_mode()?;
    let mut out = stdout();
    out.queue(EnterAlternateScreen)?;
    out.queue(Hide)?;
    out.queue(crossterm::event::EnableMouseCapture)?;
    out.flush()?;
    let _guard = TerminalGuard;

    let mut clipboard = Clipboard::new();
    let sigint = install_sigint_handler()?;

    // Initial full screen render
    {
        let parser = pane.shared_parser();
        let parser = parser.lock().unwrap();
        let screen = parser.screen();
        let data = screen.contents_formatted();
        out.write_all(&data)?;
        out.flush()?;
    }

    let mut prev_content: Option<Vec<u8>> = None;

    loop {
        let frame_start = std::time::Instant::now();

        // Drain pushes from the server (this updates the parser)
        pane.drain_pushes();

        // Detect screen changes
        let current_content = {
            let parser = pane.shared_parser();
            let parser = parser.lock().unwrap();
            parser.screen().contents_formatted()
        };
        let has_new_data = prev_content.as_deref() != Some(&current_content);

        // Process OSC 52 clipboard data
        if has_new_data && let Some(text) = extract_osc52_text(&current_content) {
            let _ = clipboard.set(&text);
        }

        // Check connection health
        if !client.is_connected() {
            return Err(io::Error::other("connection to session server lost"));
        }

        // Drain SIGINT (Ctrl-C) — send 0x03 through the input stream
        if sigint.received() {
            sigint.ack();
            let _ = pane.write_bytes(&[0x03]);
        }

        // Poll input with a short timeout
        let had_input = if crossterm_event::poll(Duration::from_millis(4))? {
            let crossterm_evt = crossterm_event::read()?;
            // Convert crossterm event to core-owned event
            let evt = match crossterm_evt {
                crossterm_event::Event::Key(key) => Event::Key(term_wm_core::events::KeyEvent {
                    code: match key.code {
                        crossterm_event::KeyCode::Char(c) => term_wm_core::events::KeyCode::Char(c),
                        crossterm_event::KeyCode::Enter => term_wm_core::events::KeyCode::Enter,
                        crossterm_event::KeyCode::Tab => term_wm_core::events::KeyCode::Tab,
                        crossterm_event::KeyCode::Backspace => {
                            term_wm_core::events::KeyCode::Backspace
                        }
                        crossterm_event::KeyCode::Esc => term_wm_core::events::KeyCode::Esc,
                        crossterm_event::KeyCode::Left => term_wm_core::events::KeyCode::Left,
                        crossterm_event::KeyCode::Right => term_wm_core::events::KeyCode::Right,
                        crossterm_event::KeyCode::Up => term_wm_core::events::KeyCode::Up,
                        crossterm_event::KeyCode::Down => term_wm_core::events::KeyCode::Down,
                        crossterm_event::KeyCode::Home => term_wm_core::events::KeyCode::Home,
                        crossterm_event::KeyCode::End => term_wm_core::events::KeyCode::End,
                        crossterm_event::KeyCode::PageUp => term_wm_core::events::KeyCode::PageUp,
                        crossterm_event::KeyCode::PageDown => {
                            term_wm_core::events::KeyCode::PageDown
                        }
                        crossterm_event::KeyCode::Delete => term_wm_core::events::KeyCode::Delete,
                        crossterm_event::KeyCode::Insert => term_wm_core::events::KeyCode::Insert,
                        crossterm_event::KeyCode::F(n) => term_wm_core::events::KeyCode::F(n),
                        _ => continue,
                    },
                    modifiers: term_wm_core::events::KeyModifiers {
                        shift: key.modifiers.contains(crossterm_event::KeyModifiers::SHIFT),
                        control: key
                            .modifiers
                            .contains(crossterm_event::KeyModifiers::CONTROL),
                        alt: key.modifiers.contains(crossterm_event::KeyModifiers::ALT),
                    },
                    kind: match key.kind {
                        crossterm_event::KeyEventKind::Press => KeyKind::Press,
                        crossterm_event::KeyEventKind::Repeat => KeyKind::Repeat,
                        crossterm_event::KeyEventKind::Release => KeyKind::Release,
                    },
                }),
                crossterm_event::Event::Mouse(mouse) => {
                    Event::Mouse(term_wm_core::events::MouseEvent {
                        kind: match mouse.kind {
                            crossterm_event::MouseEventKind::Down(btn) => {
                                term_wm_core::events::MouseEventKind::Press(match btn {
                                    crossterm_event::MouseButton::Left => {
                                        term_wm_core::events::MouseButton::Left
                                    }
                                    crossterm_event::MouseButton::Right => {
                                        term_wm_core::events::MouseButton::Right
                                    }
                                    crossterm_event::MouseButton::Middle => {
                                        term_wm_core::events::MouseButton::Middle
                                    }
                                })
                            }
                            crossterm_event::MouseEventKind::Up(btn) => {
                                term_wm_core::events::MouseEventKind::Release(match btn {
                                    crossterm_event::MouseButton::Left => {
                                        term_wm_core::events::MouseButton::Left
                                    }
                                    crossterm_event::MouseButton::Right => {
                                        term_wm_core::events::MouseButton::Right
                                    }
                                    crossterm_event::MouseButton::Middle => {
                                        term_wm_core::events::MouseButton::Middle
                                    }
                                })
                            }
                            crossterm_event::MouseEventKind::Drag(btn) => {
                                term_wm_core::events::MouseEventKind::Drag(match btn {
                                    crossterm_event::MouseButton::Left => {
                                        term_wm_core::events::MouseButton::Left
                                    }
                                    crossterm_event::MouseButton::Right => {
                                        term_wm_core::events::MouseButton::Right
                                    }
                                    crossterm_event::MouseButton::Middle => {
                                        term_wm_core::events::MouseButton::Middle
                                    }
                                })
                            }
                            crossterm_event::MouseEventKind::Moved => {
                                term_wm_core::events::MouseEventKind::Moved
                            }
                            crossterm_event::MouseEventKind::ScrollUp => {
                                term_wm_core::events::MouseEventKind::ScrollUp
                            }
                            crossterm_event::MouseEventKind::ScrollDown => {
                                term_wm_core::events::MouseEventKind::ScrollDown
                            }
                            crossterm_event::MouseEventKind::ScrollLeft => {
                                term_wm_core::events::MouseEventKind::ScrollLeft
                            }
                            crossterm_event::MouseEventKind::ScrollRight => {
                                term_wm_core::events::MouseEventKind::ScrollRight
                            }
                        },
                        modifiers: term_wm_core::events::KeyModifiers {
                            shift: mouse
                                .modifiers
                                .contains(crossterm_event::KeyModifiers::SHIFT),
                            control: mouse
                                .modifiers
                                .contains(crossterm_event::KeyModifiers::CONTROL),
                            alt: mouse.modifiers.contains(crossterm_event::KeyModifiers::ALT),
                        },
                        column: mouse.column,
                        row: mouse.row,
                    })
                }
                crossterm_event::Event::Resize(w, h) => Event::Resize(w, h),
                crossterm_event::Event::FocusGained => Event::FocusGained,
                crossterm_event::Event::FocusLost => Event::FocusLost,
                crossterm_event::Event::Paste(text) => Event::Paste(text),
            };
            match evt {
                Event::Key(ref key)
                    if key.kind == KeyKind::Press || key.kind == KeyKind::Repeat =>
                {
                    // Convert core-owned KeyEvent to pty-engine KeyEvent
                    let pty_key = term_wm_pty_engine::input_encoding::KeyEvent {
                        code: match key.code {
                            term_wm_core::events::KeyCode::Char(c) => {
                                term_wm_pty_engine::input_encoding::KeyCode::Char(c)
                            }
                            term_wm_core::events::KeyCode::Enter => {
                                term_wm_pty_engine::input_encoding::KeyCode::Enter
                            }
                            term_wm_core::events::KeyCode::Tab => {
                                term_wm_pty_engine::input_encoding::KeyCode::Tab
                            }
                            term_wm_core::events::KeyCode::Backspace => {
                                term_wm_pty_engine::input_encoding::KeyCode::Backspace
                            }
                            term_wm_core::events::KeyCode::Esc => {
                                term_wm_pty_engine::input_encoding::KeyCode::Esc
                            }
                            term_wm_core::events::KeyCode::Left => {
                                term_wm_pty_engine::input_encoding::KeyCode::Left
                            }
                            term_wm_core::events::KeyCode::Right => {
                                term_wm_pty_engine::input_encoding::KeyCode::Right
                            }
                            term_wm_core::events::KeyCode::Up => {
                                term_wm_pty_engine::input_encoding::KeyCode::Up
                            }
                            term_wm_core::events::KeyCode::Down => {
                                term_wm_pty_engine::input_encoding::KeyCode::Down
                            }
                            term_wm_core::events::KeyCode::Home => {
                                term_wm_pty_engine::input_encoding::KeyCode::Home
                            }
                            term_wm_core::events::KeyCode::End => {
                                term_wm_pty_engine::input_encoding::KeyCode::End
                            }
                            term_wm_core::events::KeyCode::PageUp => {
                                term_wm_pty_engine::input_encoding::KeyCode::PageUp
                            }
                            term_wm_core::events::KeyCode::PageDown => {
                                term_wm_pty_engine::input_encoding::KeyCode::PageDown
                            }
                            term_wm_core::events::KeyCode::Delete => {
                                term_wm_pty_engine::input_encoding::KeyCode::Delete
                            }
                            term_wm_core::events::KeyCode::Insert => {
                                term_wm_pty_engine::input_encoding::KeyCode::Insert
                            }
                            term_wm_core::events::KeyCode::F(n) => {
                                term_wm_pty_engine::input_encoding::KeyCode::F(n)
                            }
                            _ => continue,
                        },
                        modifiers: term_wm_pty_engine::input_encoding::KeyModifiers {
                            shift: key.modifiers.shift,
                            control: key.modifiers.control,
                            alt: key.modifiers.alt,
                        },
                    };
                    let bytes = key_to_bytes(&pty_key);
                    if !bytes.is_empty() {
                        let _ = pane.write_bytes(&bytes);
                    }
                    true
                }
                Event::Mouse(ref mouse) => {
                    let mouse_active = {
                        let parser = pane.shared_parser();
                        let parser = parser.lock().unwrap();
                        parser.screen().mouse_protocol_mode() != MouseProtocolMode::None
                    };
                    if mouse_active {
                        // Convert core-owned MouseEvent to pty-engine MouseEvent
                        let pty_mouse = term_wm_pty_engine::input_encoding::MouseEvent {
                            kind: match mouse.kind {
                                term_wm_core::events::MouseEventKind::Press(btn) => term_wm_pty_engine::input_encoding::MouseEventKind::Press(match btn {
                                    term_wm_core::events::MouseButton::Left => term_wm_pty_engine::input_encoding::MouseButton::Left,
                                    term_wm_core::events::MouseButton::Right => term_wm_pty_engine::input_encoding::MouseButton::Right,
                                    term_wm_core::events::MouseButton::Middle => term_wm_pty_engine::input_encoding::MouseButton::Middle,
                                }),
                                term_wm_core::events::MouseEventKind::Release(btn) => term_wm_pty_engine::input_encoding::MouseEventKind::Release(match btn {
                                    term_wm_core::events::MouseButton::Left => term_wm_pty_engine::input_encoding::MouseButton::Left,
                                    term_wm_core::events::MouseButton::Right => term_wm_pty_engine::input_encoding::MouseButton::Right,
                                    term_wm_core::events::MouseButton::Middle => term_wm_pty_engine::input_encoding::MouseButton::Middle,
                                }),
                                term_wm_core::events::MouseEventKind::Drag(btn) => term_wm_pty_engine::input_encoding::MouseEventKind::Drag(match btn {
                                    term_wm_core::events::MouseButton::Left => term_wm_pty_engine::input_encoding::MouseButton::Left,
                                    term_wm_core::events::MouseButton::Right => term_wm_pty_engine::input_encoding::MouseButton::Right,
                                    term_wm_core::events::MouseButton::Middle => term_wm_pty_engine::input_encoding::MouseButton::Middle,
                                }),
                                term_wm_core::events::MouseEventKind::Moved => term_wm_pty_engine::input_encoding::MouseEventKind::Moved,
                                term_wm_core::events::MouseEventKind::ScrollUp => term_wm_pty_engine::input_encoding::MouseEventKind::ScrollUp,
                                term_wm_core::events::MouseEventKind::ScrollDown => term_wm_pty_engine::input_encoding::MouseEventKind::ScrollDown,
                                term_wm_core::events::MouseEventKind::ScrollLeft => term_wm_pty_engine::input_encoding::MouseEventKind::ScrollLeft,
                                term_wm_core::events::MouseEventKind::ScrollRight => term_wm_pty_engine::input_encoding::MouseEventKind::ScrollRight,
                            },
                            modifiers: term_wm_pty_engine::input_encoding::KeyModifiers {
                                shift: mouse.modifiers.shift,
                                control: mouse.modifiers.control,
                                alt: mouse.modifiers.alt,
                            },
                            column: mouse.column,
                            row: mouse.row,
                        };
                        let bytes = mouse_event_to_bytes(&pty_mouse, MouseProtocolEncoding::Sgr);
                        if !bytes.is_empty() {
                            let _ = pane.write_bytes(&bytes);
                        }
                    }
                    mouse_active
                }
                Event::Resize(w, h) => {
                    let size = PtySize {
                        rows: h,
                        cols: w,
                        pixel_width: 0,
                        pixel_height: 0,
                    };
                    prev_content = None;
                    let _ = pane.resize(size);
                    true
                }
                _ => false,
            }
        } else {
            false
        };

        // Diff-based incremental render
        if has_new_data || prev_content.is_none() {
            let parser = pane.shared_parser();
            let parser = parser.lock().unwrap();
            let screen = parser.screen();
            let (rows, cols) = screen.size();

            let diff = match &prev_content {
                Some(prev) => {
                    let mut prev_parser = vt100::Parser::new(rows, cols, 0);
                    prev_parser.process(prev);
                    screen.contents_diff(prev_parser.screen())
                }
                None => screen.contents_formatted(),
            };

            if !diff.is_empty() {
                out.write_all(&diff)?;
                out.flush()?;
            }

            prev_content = Some(screen.contents_formatted());
        }

        // Exit on session exit
        if pane.has_exited() {
            return Ok(());
        }

        // Pace the loop
        if !has_new_data && !had_input {
            let elapsed = frame_start.elapsed();
            if elapsed < Duration::from_millis(8) {
                std::thread::sleep(Duration::from_millis(8) - elapsed);
            }
        }
    }
}