justerm_core/term.rs
1//! The terminal state model: a `vte::Perform` that maps parsed VT actions onto
2//! the grid, cursor, and pen. This is where the "hidden VT state" lives —
3//! pending-wrap, the wide-char spacer, and the pen (BCE seam).
4
5use std::collections::VecDeque;
6
7use unicode_width::{UnicodeWidthChar, UnicodeWidthStr};
8use vte::{Params, Perform};
9
10use crate::cell::{Cell, CellFlags};
11use crate::color::Color;
12use crate::cursor::{Cursor, CursorShape, Pen};
13use crate::damage::{LineBounds, LineDamage, ScrollOp, TermDamage};
14use crate::event::TermEvent;
15use crate::grid::{ExtAttrs, Grid, Row};
16use crate::input::{
17 KeyEvent, MouseEncoding, MouseEvent, MouseProtocol, encode_focus, encode_key, encode_mouse,
18 encode_paste,
19};
20use crate::search::Match;
21use crate::selection::{BufferPoint, Selection};
22use crate::serialize::{Frame, FrameKind, MAX_SCROLL_COUNT, MarkerId, MarkerKind, Overlay, Span};
23
24/// Buffer-walk primitives shared by every read surface (#585). A child module, so
25/// it reaches `Term`'s private fields directly — no field is widened for it.
26mod walk;
27
28/// The search query surface (#586) — finding matches, and the highlight set the
29/// consumer pushes back. Stands on `walk`, whose `pub(super)` reaches a sibling
30/// module because both are descendants of `term`.
31mod search;
32
33/// The selection surface (#587) — gestures, the anchor fixups the write path drives,
34/// and text extraction. Stands on `walk` like its siblings.
35mod selection;
36
37/// The decoration-marker surface (#588) — marks anchored to absolute buffer lines, the
38/// OSC 133 command queries over them, and the anchor fixups the write path drives.
39mod markers;
40
41/// Viewport logical lines (#601) — the soft-wrap-joined text a consumer needs for URL
42/// detection and the a11y mirror. The last read surface to leave this file under #584.
43mod logical;
44
45/// Tracked points (#691) — absolute positions the engine keeps on their content for a
46/// holder that lives outside it, and the anchor fixups the write path drives.
47mod tracked;
48
49/// Owns the authoritative screen state and applies VT actions to it.
50pub struct Term {
51 grid: Grid,
52 /// The inactive screen. Swapped with `grid` on alt-screen enter/leave; holds
53 /// whichever of primary/alternate is not currently shown. The alt screen has
54 /// no scrollback (#3 only rings the primary).
55 alt_grid: Grid,
56 cursor: Cursor,
57 /// Cursor saved on alt-screen enter (DEC 1049), restored on leave.
58 saved_cursor: Cursor,
59 /// Whether the alternate screen is currently active. Guards enter/leave so a
60 /// double-enter or double-leave is a no-op.
61 on_alt: bool,
62 /// One flag per column: is there a tab stop here? Explicit per-column state
63 /// (HTS sets, TBC clears), not a fixed modulo. Default = every 8th column.
64 tabs: Vec<bool>,
65 /// Which characters end a word for Word (semantic) selection — **consumer policy**,
66 /// not engine state (ADR-0017). Defaults to [`DEFAULT_WORD_SEPARATORS`]; replaced
67 /// through `set_word_separators`, which is also where the `' '` floor is enforced.
68 ///
69 /// Being *policy* is what puts it on the short list `full_reset` carries across RIS,
70 /// beside `replies` and `events`: `ESC c` resets the terminal's state, and a
71 /// consumer's configuration is not that. All three references survive RIS here by
72 /// construction rather than by remembering to — alacritty's `reset_state` never
73 /// touches `self.config`, xterm.js holds it in `OptionsService`, and ghostty passes
74 /// the set in per call.
75 word_separators: String,
76 /// Origin mode (DECOM ?6): when set, cursor addressing is relative to the
77 /// scroll region's top margin (and clamped to it).
78 origin_mode: bool,
79 /// Autowrap (DECAWM ?7): default on. When off, a glyph past the right margin
80 /// pins the cursor to the last column and overwrites in place instead of
81 /// wrapping to the next line (matches xterm.js) (#63).
82 autowrap: bool,
83 /// Insert mode (IRM, the non-private SM/RM mode 4): default off (replace).
84 /// When on, a printed glyph shifts the row's tail right first (#64).
85 insert_mode: bool,
86 /// New-line mode (LNM, the non-private SM/RM mode 20): default off. When on,
87 /// a line feed also carriage-returns (`convertEol`). Output-only — the Enter
88 /// key still encodes CR, matching xterm.js (#71).
89 newline_mode: bool,
90 /// Reverse wraparound (DEC ?45): default off. When on, a *backspace* at
91 /// column 0 of a soft-wrapped row moves back to the end of the previous row
92 /// (BS only, soft wraps only — matches xterm.js) (#80).
93 reverse_wraparound: bool,
94 /// Bracketed-paste mode (DEC ?2004). The engine owns the flag; the input
95 /// encoder (#11) reads it to decide whether to wrap pasted text in markers.
96 bracketed_paste: bool,
97 /// Synchronized output (DEC ?2026): the app brackets a frame of output so the
98 /// renderer can paint it atomically. The engine only *tracks* the flag — the
99 /// consumer owns the paint-hold and the spec-mandated timeout (#73).
100 synchronized_output: bool,
101 /// Color-scheme-update notifications (DEC ?2031): the app asked to be told
102 /// when the light/dark scheme changes. The engine is theme-agnostic — it only
103 /// tracks the flag; the consumer (which knows the scheme) drives the ?997
104 /// notification via `report_color_scheme` (#85).
105 color_scheme_updates: bool,
106 /// Grapheme-cluster mode (DEC ?2027, default OFF): the app opted into UAX #29 grapheme-cluster
107 /// width — a ZWJ / skin-tone / flag / emoji+VS16 sequence is clustered into ONE cell instead of
108 /// one cell per scalar (#295). OFF keeps the per-char (wcwidth-compatible) behaviour so the
109 /// cursor stays in sync with wcwidth apps — clustering is opt-in for exactly that reason (#301).
110 grapheme_clustering: bool,
111 /// win32-input-mode (DEC ?9001): the app asked for keys as raw Windows
112 /// key-records. The engine only *tracks* the flag — the raw record encoding
113 /// (`CSI Vk;Sc;Uc;Kd;Cs;Rc _`) is a non-goal (raw passthrough, no semantic
114 /// conversion), left to the ConPTY consumer; `encode_key` is unchanged (#86).
115 win32_input_mode: bool,
116 /// Application cursor keys (DECCKM ?1): when set, cursor keys / Home / End
117 /// encode as SS3 rather than CSI (see `input.rs`).
118 app_cursor_keys: bool,
119 /// Application keypad mode (DECNKM ?66 / DECKPAM `ESC =` / DECKPNM `ESC >`):
120 /// tracked for protocol completeness + DECRQM, but NOT yet acted on in key
121 /// encoding — xterm.js tracks it the same way and never reads it (#74).
122 application_keypad: bool,
123 /// VT52 compatibility mode (DECANM ?2 *reset*): when set, `esc_dispatch` is
124 /// re-routed into the pre-ANSI VT52 dialect (`ESC A`-style sequences) instead
125 /// of the ANSI meaning. `ESC <` clears it. Default off (ANSI). (#84)
126 vt52_mode: bool,
127 /// VT52 `ESC Y row col` direct-addressing state (#84). vte tokenizes `ESC Y`
128 /// as a final and returns to ground, so the two coordinate bytes arrive as
129 /// `print()` calls — not part of the escape sequence. This counts them down
130 /// (2 → 1 → 0; 0 = not addressing) and `vt52_y_row` parks the first (row)
131 /// until the second (col) lands. Each byte decodes as `value - 0x20`.
132 vt52_y_pending: u8,
133 vt52_y_row: usize,
134 /// Mouse tracking mode — what events the app asked to be reported
135 /// (?1000/?1002/?1003). `Off` by default.
136 mouse_protocol: MouseProtocol,
137 /// Mouse coordinate encoding (default X10 vs ?1006 SGR).
138 mouse_encoding: MouseEncoding,
139 /// Focus in/out reporting (?1004): emit `CSI I`/`CSI O` on focus change.
140 focus_events: bool,
141 /// Kitty keyboard-protocol progressive-enhancement flags currently in effect
142 /// (bit0 disambiguate, bit1 report-events, bit2 alt-keys, bit3 all-as-escape,
143 /// bit4 associated-text). 0 = legacy. `encode_key` consults these (#23).
144 kitty_flags: u8,
145 /// Saved `kitty_flags` for the protocol's push/pop stack (`CSI > u` pushes,
146 /// `CSI < u` pops). Capped depth — overflow drops the oldest entry.
147 kitty_stack: Vec<u8>,
148 /// Consumer events (title / bell / cwd) accumulated since the last
149 /// `drain_events` (#12). Pull, not push — see `event.rs`.
150 events: Vec<TermEvent>,
151 /// Outbound reply bytes (DA/DSR/DECRQM query answers, #27) accumulated
152 /// during `feed` for the consumer to write back to the PTY. Raw bytes →
153 /// PTY, kept separate from typed `events` → UI.
154 replies: Vec<u8>,
155 /// The hyperlink currently open (OSC 8 with a URI), stamped onto every glyph
156 /// written until closed (OSC 8 with empty URI). Ambient pen-like state — not
157 /// part of the pen/SGR, and *not* cleared by an SGR reset.
158 ///
159 /// The URI itself, not a pool index — there is no pool (#628). The lead paragraph
160 /// here used to describe one (*"Hyperlink side-table … referenced by `Cell.link`
161 /// (1-based). Append-only (#26)"*), left behind when its field was deleted.
162 current_link: Option<std::sync::Arc<str>>,
163 /// Live OSC 8 `id=` groups: `"id;;uri"` → the allocation that key already named,
164 /// held **weakly** (#635).
165 ///
166 /// `Weak`, not `Arc`, is the whole lifetime story. A strong entry here would make
167 /// every id'd link immortal for the life of the `Term` — precisely the leak #628
168 /// deleted, re-entering through the door grouping opens. A dangling key is the
169 /// correct answer rather than a hole: the link it named has left the buffer, so a
170 /// later open of the same id is genuinely a new link. xterm.js expresses the same
171 /// lifetime by *deleting* its `_entriesWithId` entry when the last line marker
172 /// referencing it is disposed (`OscLinkService.ts:98-100`); justerm has no disposal
173 /// hook by design, and `Weak` is that lifetime without one.
174 link_ids: std::collections::HashMap<String, std::sync::Weak<str>>,
175 /// Map length at which [`Self::link_ids`] is swept for dangling keys, doubling each
176 /// time so the sweep is amortised O(1) per open and dead keys stay O(live).
177 ///
178 /// A sweep is affordable here for the reason #628's rejected option (c) was not:
179 /// staleness is observable in O(1) (`Weak::strong_count`), where (c) had to decide
180 /// "is the pool oversized" by counting live references — the O(buffer) walk it was
181 /// trying to avoid.
182 link_ids_sweep_at: usize,
183 /// Scroll region top/bottom margins (DECSTBM), 0-based inclusive. A
184 /// line-feed at `scroll_bottom` scrolls only rows `[scroll_top..=scroll_bottom]`.
185 /// Default = the full screen.
186 scroll_top: usize,
187 scroll_bottom: usize,
188 /// Lines that have scrolled off the top of the primary screen, oldest at the
189 /// front. Accrues only on a top-anchored, primary-screen scroll.
190 scrollback: VecDeque<Row>,
191 /// How many lines the viewport is scrolled up from the bottom. 0 = following
192 /// the live screen; clamped to `[0, scrollback.len()]`.
193 display_offset: usize,
194 /// Maximum scrollback lines retained; the oldest are evicted past this.
195 scrollback_limit: usize,
196 /// A spare row buffer recycled across full-screen scrolls: the cap-evicted
197 /// oldest line is parked here and reused as the next scroll's blank bottom,
198 /// so a steady-state flood allocates nothing (ADR-0009).
199 recycled_row: Option<Row>,
200 /// Per-line damage bounds since the last `reset_damage` (ack), one per row.
201 line_damage: Vec<LineBounds>,
202 /// A first-class scroll recorded since the last `reset_damage`.
203 scroll: Option<ScrollOp>,
204 /// The whole screen changed (alt switch / clear / later resize+flood) — the
205 /// renderer must redraw everything.
206 full_damage: bool,
207 /// The cursor `(row, col)` at the last `reset_damage` (ack) — where the
208 /// consumer last saw the caret. A pure cursor move records no content
209 /// damage, so `damage()` folds this *old* cell plus the current one into the
210 /// frame; without it a cell-invert caret ghosts at the old spot (mirrors
211 /// Alacritty's `last_cursor`). #38.
212 prev_cursor: (usize, usize),
213 /// The live selection, in absolute buffer coordinates. `None` when nothing
214 /// is selected. See `selection.rs`.
215 selection: Option<Selection>,
216 /// The search highlights the consumer asked to paint (#108). Search
217 /// matches are consumer-owned (it drives next/prev), so the engine holds only
218 /// the set handed back via `set_search_highlights`, and `frame()` projects it
219 /// onto the viewport — the same anchoring path as the selection.
220 search_highlights: Vec<Match>,
221 /// The *active* (current) search match (#428), stored as its absolute span
222 /// (#436) — designated by the consumer (next/prev is its policy) either as
223 /// an index into `search_highlights` (resolved to the span at call time) or
224 /// directly by span, which a capping backend uses for a past-cap match
225 /// (xterm creates its active decoration from the found result, OUTSIDE the
226 /// capped highlight list). A span is NOT structurally tied to the set, so
227 /// every path that voids the set must void this too: `set_search_highlights`
228 /// (hand-over reset, #428) and `invalidate_search_highlights` (the single
229 /// funnel for eviction / every region scroll incl. the accrual sub-region
230 /// branch (#449) / reflow / both alt swaps) — a stale span would otherwise
231 /// keep painting coordinates that now hold other text.
232 active_search_highlight: Option<Match>,
233 /// Engine-owned decoration markers (#118), split per buffer like xterm's
234 /// `BufferSet` (#177 S0): each a stable id bound to an absolute buffer line
235 /// that re-anchors through eviction/scroll/reflow like a selection anchor. The
236 /// active buffer's list is selected by `on_alt` — `markers`/`markers_mut`.
237 /// `alt_markers` stays empty while the alt guards (#158/#164) are in place; it
238 /// is disposed on alt-leave (xterm `clearAllMarkers`). `next_marker_id` hands
239 /// out monotonic ids across both buffers so ids never alias.
240 normal_markers: VecDeque<Marker>,
241 alt_markers: VecDeque<Marker>,
242 next_marker_id: u32,
243 /// The basis that keeps a *pulled* marker index valid without re-pulling
244 /// (#490). Both are reported by [`Term::marker_index`] and — from the wire
245 /// slice on — by the frame header, so a consumer can compare what it holds
246 /// against what is current.
247 ///
248 /// `evicted_total` counts lines popped off the front of scrollback since
249 /// startup or RIS. Eviction shifts **every** live marker by the same −1, so
250 /// that whole class of movement is one number rather than M facts, and a
251 /// consumer rebases a held line by the delta.
252 ///
253 /// `marker_epoch` covers everything the delta cannot express: a mutation
254 /// after which a held line is wrong for a reason no single offset repairs.
255 /// It says *"what you pulled no longer describes this buffer"* — not *"a verb
256 /// ran"*, which is why the movers bump it only when a surviving marker's line
257 /// actually moved. Disposal is deliberately **not** a bump: a consumer learns
258 /// of that through `TermEvent::MarkerDisposed` and can drop the entry without
259 /// asking for the rest again.
260 evicted_total: u64,
261 marker_epoch: u32,
262 /// Positions the engine keeps on their content for a holder that lives
263 /// *outside* it (#691). Split per buffer and re-anchored by the same fixups as
264 /// the markers beside them; the difference is that nothing here reaches a
265 /// frame — a tracked point is answered on request, never projected.
266 normal_tracked: Vec<TrackedPoint>,
267 alt_tracked: Vec<TrackedPoint>,
268 next_tracked_id: u32,
269 /// Cursor state saved by DECSC (ESC 7), restored by DECRC (ESC 8). A slot
270 /// separate from `saved_cursor` (which is the alt-screen save). Defaults to
271 /// home/default so a DECRC with no prior DECSC restores a sane state.
272 decsc: SavedCursor,
273 /// SCS-designated character sets G0..G3 (#62). `gl` indexes the active (GL)
274 /// set, switched by SI (→G0) / SO (→G1). First cut uses G0/G1.
275 charsets: [Charset; 4],
276 gl: usize,
277}
278
279/// A character set designated by SCS (#62). First cut: ASCII (default), DEC
280/// Special Graphics (line-drawing), and UK. G2/G3 and the GR half are later.
281#[derive(Clone, Copy, PartialEq, Eq, Default)]
282enum Charset {
283 #[default]
284 Ascii,
285 DecSpecialGraphics,
286 Uk,
287}
288
289impl Charset {
290 /// Map one GL byte (a `char` in the 7-bit range) through this set. ASCII and
291 /// any out-of-range char pass through; UK swaps `#`→£; DEC Special Graphics
292 /// translates `_`..`~` to the line-drawing / symbol glyphs.
293 fn map(self, c: char) -> char {
294 match self {
295 Charset::Ascii => c,
296 Charset::Uk if c == '#' => '£',
297 Charset::Uk => c,
298 Charset::DecSpecialGraphics => dec_special_graphics(c),
299 }
300 }
301}
302
303/// The VT100 DEC Special Graphics set: bytes `_`..`~` (0x5F..0x7E) map to the
304/// box-drawing and symbol glyphs. Matches xterm/alacritty; anything outside the
305/// range passes through unchanged.
306fn dec_special_graphics(c: char) -> char {
307 // Keys ``..`~` only — `_` (0x5F) is deliberately absent, matching xterm.js /
308 // alacritty (it passes through as a literal underscore), not the strict-DEC
309 // "0x5F = blank" reading.
310 match c {
311 '`' => '◆',
312 'a' => '▒',
313 'b' => '␉',
314 'c' => '␌',
315 'd' => '␍',
316 'e' => '␊',
317 'f' => '°',
318 'g' => '±',
319 'h' => '',
320 'i' => '␋',
321 'j' => '┘',
322 'k' => '┐',
323 'l' => '┌',
324 'm' => '└',
325 'n' => '┼',
326 'o' => '⎺',
327 'p' => '⎻',
328 'q' => '─',
329 'r' => '⎼',
330 's' => '⎽',
331 't' => '├',
332 'u' => '┤',
333 'v' => '┴',
334 'w' => '┬',
335 'x' => '│',
336 'y' => '≤',
337 'z' => '≥',
338 '{' => 'π',
339 '|' => '≠',
340 '}' => '£',
341 '~' => '·',
342 other => other,
343 }
344}
345
346/// Default scrollback retention when not specified.
347const DEFAULT_SCROLLBACK: usize = 10_000;
348
349/// The narrowest screen the engine represents: **two columns**.
350///
351/// A width-2 glyph occupies a `WIDE_CHAR` lead *and* the `WIDE_CHAR_SPACER` that
352/// stands for its second half, so one column cannot hold one — and a pair with only
353/// one half written is the malformed state every repair path in this crate keys off
354/// (ADR-0025 D4). `Term::with_scrollback` and [`Term::resize`] clamp `cols` up to
355/// this, which is what makes D4 (*both halves of a pair move together*)
356/// unconditionally satisfiable rather than true only above some unstated width.
357///
358/// Both references that a terminal *engine* can be compared to forbid one column for
359/// exactly this reason — alacritty's `MIN_COLUMNS = 2` and xterm.js's
360/// `MINIMUM_COLS = 2` — and the third (ghostty) permits it only by destroying the
361/// glyph.
362///
363/// The clamp is **silent and pull-only**: a `resize(1, rows)` during a pane drag is
364/// widened rather than rejected, and no event reports it. Both references instead
365/// make the clamped size the one that travels outward — alacritty derives its
366/// `WindowSize` from the clamped `SizeInfo`, xterm.js fires `onResize` with the
367/// clamped pair — so a justerm consumer must do that correlation itself: read the
368/// width back from [`Term::grid`] / the frame header and size the PTY from *that*,
369/// never from the value it requested. Sizing a PTY to one column leaves the
370/// application rendering for a width the buffer does not have (#547).
371pub const MIN_COLUMNS: usize = 2;
372
373/// The built-in word-boundary set for Word (semantic) selection — the default value of
374/// [`Term::set_word_separators`], and **policy the consumer may replace** (ADR-0017:
375/// mechanism in core, policy injected).
376///
377/// It is alacritty's `SEMANTIC_ESCAPE_CHARS` (`alacritty_terminal/src/term/mod.rs:45`
378/// @ `852e971`) verbatim — space, tab and a punctuation set that deliberately omits
379/// `.`, `/` and `-` so a path or URL stays one word — **plus U+3000 IDEOGRAPHIC
380/// SPACE**, which is justerm's one divergence from every reference default.
381///
382/// Two properties of this list are load-bearing and neither is obvious:
383///
384/// - **It is a literal set, not the Unicode `White_Space` property.** The predicate was
385/// `char::is_whitespace()` until #545, so every space-like codepoint ended a word —
386/// including the four `Line_Break=GL` (glue) ones U+00A0, U+2007, U+202F and U+205F,
387/// whose whole purpose is "do not break here". A locale-formatted `1<NNBSP>234`
388/// double-clicked as `1`. All three references are literal sets for the same reason.
389/// - **U+3000 is in it, and no reference's default has it.** It is the only
390/// East-Asian-Wide codepoint `White_Space` accepts (measured over U+0000–U+10FFFF),
391/// so on alacritty and xterm.js ` abc` is one word while justerm gives the useful
392/// answer. Keeping it was argued in #535 *on the grounds that core had no injection
393/// point*; that ground is gone, so it survives here as a **default**, and a consumer
394/// who wants reference-exact behaviour removes it.
395///
396/// [`Term::set_word_separators`] additionally forces `' '` into whatever it is given —
397/// see there for why that floor is not optional.
398pub const DEFAULT_WORD_SEPARATORS: &str = ",│`|:\"' ()[]{}<>\t\u{3000}";
399
400/// A declared OSC 8 hyperlink, as handed to a consumer.
401///
402/// **Owned, not borrowed**, and that is the point: the URI lives in a row's side map, so
403/// a `&str` into it would be tied to `&Engine` and a caller could not hold the link
404/// across the next `feed()` — which is precisely what a hover handler does. Measured on
405/// the alternative: reading a borrow costs 0.75 ns, but keeping it *does not compile*, so
406/// the caller copies the string instead at 62.6 ns. Handing back this handle is 17.9 ns
407/// — cheaper than the workaround it removes, on a call made once per hover.
408///
409/// Cloning is a refcount bump; the allocation is shared with every cell of the same OSC 8
410/// open and released when the last row holding it dies (#628).
411///
412/// **A struct rather than a bare `Arc<str>`** for two reasons: it keeps `Arc` out of the
413/// published signature, and OSC 8's `id=` parameter (#635) lands here as a field without
414/// changing the return type again. Same shape as alacritty's `Hyperlink`, for the same
415/// reasons (`alacritty_terminal/src/term/cell.rs`).
416///
417/// **Link *identity* is deliberately not exposed yet.** Two OSC 8 opens of an identical
418/// URI are two links here, so `uri() == uri()` cannot answer "is this cell part of the
419/// same link as that one?" — an `Arc::ptr_eq` accessor would. It is left out because no
420/// consumer asks it today (nothing outside this crate's tests calls `link_at` at all),
421/// and unlike this type's *shape*, adding a method later is not a breaking change. The
422/// asymmetry decides it: shipping an accessor nobody uses is hard to undo, adding one
423/// when a caller appears is free.
424#[derive(Clone, PartialEq, Eq, Debug)]
425pub struct Hyperlink {
426 uri: std::sync::Arc<str>,
427}
428
429impl Hyperlink {
430 pub(crate) fn new(uri: std::sync::Arc<str>) -> Self {
431 Hyperlink { uri }
432 }
433
434 /// The link target, exactly as the application declared it — never validated,
435 /// never resolved. Whether it is a URL a consumer is willing to open is that
436 /// consumer's policy (ADR-0017), the same way colour resolution is.
437 pub fn uri(&self) -> &str {
438 &self.uri
439 }
440}
441
442/// Length at which the `id=` group map is first swept for dangling keys, doubling from
443/// there. Small enough that a session declaring a handful of ids never pays a sweep,
444/// large enough that the sweep is not the common path.
445const LINK_IDS_FIRST_SWEEP: usize = 16;
446
447/// The `id=` value out of an OSC 8 `params` field, or `None` when it is absent or empty.
448///
449/// Three rules, each taken from xterm.js's `_createHyperlink` verbatim rather than from
450/// the spec prose, because each is a place a reasonable reading goes wrong
451/// (`src/common/InputHandler.ts:3128-3131` at the pinned SHA `699f5537b023`):
452///
453/// - **`:`-separated**, not `;` — `params` is one OSC argument holding a key=value list
454/// (`id=xyz123:foo=bar:baz=quux`), so the split is on colons (`params.split(':')`).
455/// - **`id` may sit anywhere in it** (`findIndex(e => e.startsWith('id='))`), so matching
456/// only a leading `id=` is the wrong parse and passes a single-parameter test.
457/// - **an empty value is not an id** (`slice(3) || undefined`). This is the one with teeth:
458/// an empty key would group every `id=`-with-no-value link in a session into one link
459/// across unrelated URIs, and it is a wrong answer that grows with uptime.
460///
461/// Only the first `id=` is consulted, matching `findIndex` — an empty first one yields
462/// `None` rather than searching on for a non-empty sibling.
463fn osc8_link_id(params: &[u8]) -> Option<&[u8]> {
464 params
465 .split(|b| *b == b':')
466 .find_map(|kv| kv.strip_prefix(b"id="))
467 .filter(|value| !value.is_empty())
468}
469
470/// The widest grid the engine will hold, and the mirror of [`MIN_COLUMNS`] — but derived
471/// from a different kind of constraint, which is why the two are not symmetric.
472///
473/// The floor is **semantic**: a width-2 glyph needs two cells, so one column is a screen
474/// no correct grid can be. The ceiling is **representational**: the frame header stores
475/// `cols` and `rows` as `u16` each, so a grid wider than `u16::MAX` cannot be *described*
476/// to a consumer even though the engine could hold it. Without the clamp that mismatch was
477/// silent — measured, `Engine::new(70_000, 2)` built a 70 000-column grid whose frame
478/// declared `cols = 4464` and decoded `Ok`, so a consumer laid out 4464 columns of a
479/// 70 000-column screen with nothing reporting the difference (#621).
480///
481/// No reference bounds a grid this way, and that is expected rather than a divergence:
482/// none of them serializes a grid, so none has a header field to overflow. This is the
483/// one axis where justerm's own wire is the only authority.
484///
485/// **A backstop, not a policy.** A 4K display at a very small font is roughly 550 columns;
486/// this is two orders of magnitude past any real terminal, so it should never be reached
487/// by a consumer that is not already doing something wrong. The clamp is silent and
488/// pull-only on the same terms as [`MIN_COLUMNS`] — read the size back from
489/// [`Term::grid`] rather than trusting the value you passed in.
490pub const MAX_COLUMNS: usize = u16::MAX as usize;
491
492/// The tallest grid the engine will hold. The row half of [`MAX_COLUMNS`] — same
493/// `u16` header field, same reasoning, same silent-clamp contract.
494pub const MAX_ROWS: usize = u16::MAX as usize;
495
496/// The most live markers one buffer will hold (#721).
497///
498/// Derived from the wire the same way [`MAX_COLUMNS`] is: the marker group's count
499/// are `u16`, so a population past `u16::MAX` encodes a wrapped count while writing
500/// every record, and `decode` then reads the next group's count out of the middle of
501/// a marker record and returns `Ok`. The field bounds the value; this constant only
502/// writes that bound down where the value is produced, because `encode` returns
503/// `Vec<u8>` and has no channel to refuse.
504///
505/// **Why a bound is needed at all**, rather than a wider field: markers are allocated
506/// by the *stream*. `add_command_mark` appends per OSC 133 sequence, several marks can
507/// share one line, and scrollback eviction only drops a marker when its line reaches
508/// absolute 0 — so a stream that never emits a newline accumulates marks in a 24-row
509/// buffer without bound (measured: 70 000, #721). [`crate::Engine::feed`] is an untrusted
510/// entry point (ADR-0007), and unbounded allocation behind it is a defect class that
511/// record exists to catch.
512///
513/// **A backstop, not a policy**, on the same terms as [`MAX_COLUMNS`]. Ordinary shell
514/// integration emits at most four marks per command and a command occupies at least one
515/// line, so a default-scrollback session tops out near 40 000 — this is not reached by a
516/// consumer that is not already being fed something hostile. Overflow disposes the
517/// *oldest* marker and announces it through `TermEvent::MarkerDisposed`, which is the
518/// channel scrollback eviction already uses for the same event.
519pub const MAX_MARKERS: usize = u16::MAX as usize;
520
521/// The state DECSC (ESC 7) saves and DECRC (ESC 8) restores: position, pen/SGR,
522/// pending-wrap, and origin mode (per ADR-0004 — DECRC restores origin mode,
523/// which Alacritty omits). Cursor *visibility* is deliberately not part of this
524/// (DECTCEM is separate from DECSC).
525#[derive(Clone, Copy, Default)]
526struct SavedCursor {
527 row: usize,
528 col: usize,
529 pen: Pen,
530 pending_wrap: bool,
531 origin_mode: bool,
532 /// SCS charset state at save time — DECSC/DECRC round-trip the designated
533 /// sets and the active GL shift (#62).
534 charsets: [Charset; 4],
535 gl: usize,
536}
537
538/// An engine-owned decoration marker (#118): a stable id bound to an absolute
539/// buffer line. The line shifts in lockstep with eviction/region scroll/reflow
540/// (the same coordinate moves the selection anchor tracks); the marker is
541/// dropped when its line leaves the buffer.
542struct Marker {
543 id: MarkerId,
544 line: usize,
545 /// The cursor column at emit time (#166). Meaningful for OSC-133 command
546 /// marks — CommandStart(B)/OutputStart(C) columns bound the *typed command*
547 /// (excluding the prompt), like VSCode's `commandStartX`/`commandExecutedX`.
548 /// Plain `add_marker` decorations are row-granular and carry `col = 0`.
549 ///
550 /// **Domain is `[0, cols]`, not `[0, cols - 1]` (#562)** — a bound, not a cell.
551 /// A command that exactly fills its row ends *one past* the last column, and
552 /// that value is what `extract_lines` wants: it clips `[b_col, c_col)`, so the
553 /// exclusive end absorbs it through `.min(cells.len())`. Storing `cursor.col`
554 /// alone (the cursor is held at `cols - 1` with `pending_wrap`) cost such a
555 /// command its last character with no resize involved. The **inclusive** side
556 /// cannot absorb it, so `extract_lines` steps a `from` of `cells.len()` to the
557 /// next line rather than selecting an empty run and flushing a `\n`.
558 col: usize,
559 /// Plain for a `add_marker` decoration; a command-boundary role for an
560 /// OSC 133 mark (#158). All kinds share the anchor/eviction machinery.
561 kind: MarkerKind,
562}
563
564/// A stable handle to a tracked buffer position (#691), handed out by
565/// [`Term::track_point`].
566///
567/// It is deliberately **not** a [`MarkerId`]: a marker is a decoration anchor and
568/// rides two frame groups, so every marker a consumer registers is something the
569/// renderer paints. A tracked point is private to whoever asked for it.
570#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
571pub struct TrackedId(pub(crate) u32);
572
573/// One tracked position: an absolute buffer `(line, col)` the write path keeps on
574/// its content (#691). The element type of `normal_tracked` / `alt_tracked`.
575struct TrackedPoint {
576 id: TrackedId,
577 line: usize,
578 col: usize,
579}
580
581/// One live marker, as the pull query reports it (#490): its stable id, its
582/// **absolute** `[scrollback ++ screen]` line, and the static facts a consumer
583/// would otherwise have to re-learn from every frame.
584///
585/// `kind` and `exit` ride here rather than on the frame because they never change
586/// after `push_marker` — re-sending them per frame is the same class of waste as
587/// re-sending the line.
588#[derive(Debug, Clone, PartialEq, Eq)]
589pub struct MarkerEntry {
590 pub id: MarkerId,
591 pub line: u32,
592 pub kind: MarkerKind,
593}
594
595/// The answer to [`Term::marker_index`] (#490) — every live marker of the *active*
596/// buffer, plus the basis that says how long the answer stays usable.
597///
598/// The consumer keeps this and rebases per frame:
599/// `current = line - (evicted_total_now - evicted_total)`, valid for exactly as long
600/// as `epoch` is unchanged. When the epoch moves, the held lines are wrong in a way
601/// no offset repairs and the consumer asks again.
602///
603/// It reports the active buffer because an absolute index means a different thing on
604/// each screen — the same reason `markers`/`markers_mut` route by `on_alt`. An
605/// alt-screen switch therefore bumps the epoch even though no line moved: what the
606/// answer *describes* changed.
607#[derive(Debug, Clone, PartialEq, Eq)]
608pub struct MarkerIndex {
609 pub markers: Vec<MarkerEntry>,
610 pub evicted_total: u64,
611 pub epoch: u32,
612}
613
614/// One executed shell command recovered from OSC-133 marks (#166), for
615/// screen-reader command navigation. The consumer jumps prompt-to-prompt over
616/// these and announces `command` + a success/fail signal from `exit`.
617#[derive(Debug, Clone, PartialEq, Eq)]
618pub struct CommandLine {
619 /// The command's jump anchor as a *document* line — the logical-line index of
620 /// the CommandStart(B) mark within [`Term::accessible_text`], so the consumer
621 /// reveals the right row of the accessible view (soft-wrapped rows collapse to
622 /// one logical line). This is core's analog of VSCode's
623 /// `bufferToEditorLineMapping`; the frame-mode web side has no wrap info to
624 /// map it itself.
625 pub line: usize,
626 /// The typed command text, prompt- and output-excluded (B→C columns).
627 pub command: String,
628 /// The CommandFinished(D) exit code, if the shell reported one and the
629 /// command has finished.
630 pub exit: Option<i32>,
631}
632
633/// Collect per-line damage bounds into damaged `LineDamage` spans (undamaged
634/// lines dropped). Shared by `damage` (content-only) and `frame_damage`
635/// (content + cursor cells).
636fn bounds_to_lines(bounds: &[LineBounds]) -> Vec<LineDamage> {
637 bounds
638 .iter()
639 .enumerate()
640 .filter(|(_, b)| b.is_damaged())
641 .map(|(line, b)| {
642 let (left, right) = b.span();
643 LineDamage { line, left, right }
644 })
645 .collect()
646}
647
648impl Term {
649 pub fn new(cols: usize, rows: usize) -> Self {
650 Self::with_scrollback(cols, rows, DEFAULT_SCROLLBACK)
651 }
652
653 pub fn with_scrollback(cols: usize, rows: usize, scrollback_limit: usize) -> Self {
654 // Both clamps mirror `resize` exactly, so a screen cannot be born at a size a
655 // resize would refuse. They are not the same *kind* of rule, though: the width
656 // floor is a published contract (#547 — one column was supported and no longer
657 // is), while the row floor is `resize`'s own long-standing "a terminal is never
658 // 0-tall" that this constructor merely failed to enforce while carrying the
659 // same `scroll_bottom: rows - 1` below. That gap was a subtract-overflow panic
660 // on `rows == 0`, not a degenerate screen.
661 // …and the ceiling is the header's, not the glyph's: `frame.cols`/`rows` are u16,
662 // so a wider grid would be built and then misdescribed on the wire (#621).
663 let cols = cols.clamp(MIN_COLUMNS, MAX_COLUMNS);
664 let rows = rows.clamp(1, MAX_ROWS);
665 Term {
666 grid: Grid::new(cols, rows),
667 alt_grid: Grid::new(cols, rows),
668 cursor: Cursor::default(),
669 saved_cursor: Cursor::default(),
670 on_alt: false,
671 origin_mode: false,
672 autowrap: true,
673 insert_mode: false,
674 newline_mode: false,
675 reverse_wraparound: false,
676 bracketed_paste: false,
677 synchronized_output: false,
678 color_scheme_updates: false,
679 grapheme_clustering: false,
680 win32_input_mode: false,
681 app_cursor_keys: false,
682 application_keypad: false,
683 vt52_mode: false,
684 vt52_y_pending: 0,
685 vt52_y_row: 0,
686 mouse_protocol: MouseProtocol::Off,
687 mouse_encoding: MouseEncoding::Default,
688 focus_events: false,
689 kitty_flags: 0,
690 kitty_stack: Vec::new(),
691 events: Vec::new(),
692 replies: Vec::new(),
693 current_link: None,
694 link_ids: std::collections::HashMap::new(),
695 link_ids_sweep_at: LINK_IDS_FIRST_SWEEP,
696 tabs: default_tabs(cols),
697 word_separators: DEFAULT_WORD_SEPARATORS.to_owned(),
698 scroll_top: 0,
699 scroll_bottom: rows - 1,
700 scrollback: VecDeque::new(),
701 display_offset: 0,
702 scrollback_limit,
703 recycled_row: None,
704 line_damage: vec![LineBounds::undamaged(cols); rows],
705 scroll: None,
706 full_damage: false,
707 prev_cursor: (0, 0), // matches the default cursor's home position
708 selection: None,
709 search_highlights: Vec::new(),
710 active_search_highlight: None,
711 normal_markers: VecDeque::new(),
712 alt_markers: VecDeque::new(),
713 next_marker_id: 0,
714 evicted_total: 0,
715 marker_epoch: 0,
716 normal_tracked: Vec::new(),
717 alt_tracked: Vec::new(),
718 next_tracked_id: 0,
719 decsc: SavedCursor::default(),
720 charsets: [Charset::Ascii; 4],
721 gl: 0,
722 }
723 }
724
725 /// What changed since the last `reset_damage()` — line ranges, each with a
726 /// changed column span. See ADR-0003.
727 pub fn damage(&self) -> TermDamage {
728 if self.full_damage {
729 return TermDamage::Full;
730 }
731 // Scrolled up under follow-bottom "stay": the viewport is frozen, so
732 // screen changes below it are not visible — report nothing. (A user
733 // scroll that moves the viewport sets full_damage above.)
734 if self.display_offset > 0 {
735 return TermDamage::Partial(Vec::new());
736 }
737 TermDamage::Partial(bounds_to_lines(&self.line_damage))
738 }
739
740 /// Render damage: content damage plus the cursor cells, for [`Term::frame`].
741 ///
742 /// A pure cursor move changes no cell *content*, so [`Term::damage`] (which
743 /// stays content-only, the cadence/flow-control primitive) would miss it —
744 /// yet a cell-invert caret must clear its old spot and ink the new one. So
745 /// the frame producer folds the old (last-acked) + current cursor cells in,
746 /// but only when the cursor actually moved: a still cursor needs no redraw,
747 /// keeping an idle frame empty. Mirrors Alacritty's `last_cursor`. #38.
748 fn frame_damage(&self) -> TermDamage {
749 if self.full_damage {
750 return TermDamage::Full;
751 }
752 if self.display_offset > 0 {
753 return TermDamage::Partial(Vec::new());
754 }
755 let cur = self.cursor.point();
756 if cur == self.prev_cursor {
757 return TermDamage::Partial(bounds_to_lines(&self.line_damage));
758 }
759 let mut bounds = self.line_damage.clone();
760 bounds[cur.0].expand(cur.1, cur.1);
761 let pr = self.prev_cursor.0.min(self.grid.rows() - 1);
762 let pc = self.prev_cursor.1.min(self.grid.cols() - 1);
763 bounds[pr].expand(pc, pc);
764 TermDamage::Partial(bounds_to_lines(&bounds))
765 }
766
767 /// Clear accumulated damage. The consumer calls this after applying a frame
768 /// (the ack); the next `damage()` reflects only changes since.
769 pub fn reset_damage(&mut self) {
770 for b in &mut self.line_damage {
771 b.reset();
772 }
773 self.scroll = None;
774 self.full_damage = false;
775 // The consumer has now seen the caret at the current position; the next
776 // frame's cursor-move damage is measured from here (#38).
777 self.prev_cursor = self.cursor.point();
778 }
779
780 /// Mark the whole screen damaged (alt switch / clear / flood, and a consumer
781 /// reattach that needs a full re-sync — see [`crate::Engine::mark_fully_damaged`]).
782 pub fn mark_fully_damaged(&mut self) {
783 self.full_damage = true;
784 }
785
786 /// Record that columns `[left, right]` of `row` changed.
787 ///
788 /// Both columns are **clamped to the last column, and asserted in debug** (#536).
789 ///
790 /// Ten of the fourteen call sites derive their bound from a cursor column or from `cols`.
791 /// **Four derive it from a wide pair's width**, and that is the shape worth centralising:
792 /// `write_glyph`'s `col + width - 1` (which had no guard — this issue), `promote_cluster_to_wide`'s
793 /// `col + 1` (guarded by its own `col + 1 >= cols` early return), `demote_cluster_to_narrow`'s
794 /// `(col + 1).min(cols - 1)` (self-clamped), and `relocate_cluster_wide`'s literal `(0, 1)`
795 /// (valid only because `MIN_COLUMNS = 2`, #547). Three carried a private guard and one did not.
796 ///
797 /// No reference has this shape to port a clamp from: alacritty computes damage ranges too
798 /// (`term/mod.rs:1406`, `:1649` @ `852e971`) but always from a column or `columns()` — its print
799 /// path records no damage at all, relying on the previous and current cursor *points* to bracket
800 /// the line — while xterm.js tracks whole rows (`markDirty(y)`) and ghostty a per-row
801 /// `dirty: bool`. alacritty's `LineDamageBounds::expand`, which this one is a copy of, is equally
802 /// unguarded.
803 ///
804 /// The two halves do different jobs:
805 ///
806 /// - the **`debug_assert` is the detector**. An out-of-range bound is stored silently and
807 /// detonates later, when `frame()` slices the row, so the stack trace accuses the reader
808 /// rather than the writer. That delay is what #536 was filed about, and the assert collapses
809 /// it — a bad caller dies here, at the site that recorded it (measured: an injected off-by-one
810 /// moved the panic from `frame()`'s slice to this line).
811 /// - the **clamp is the release backstop**, and it clamps *toward a false positive*. justerm is
812 /// a library, so a panic crosses into the consumer's process; over-damaging repaints a cell
813 /// that did not change, which costs nothing a consumer can see. ghostty states the asymmetry
814 /// as a rule: *"Dirty tracking may have false positives but should never have false negatives.
815 /// A false negative would result in a visual artifact on the screen."* (`page.zig:1993-1995`).
816 ///
817 /// **`left` is guarded for that reason, and it is the axis that can actually lose a cell.**
818 /// Clamping `right` cannot under-report — columns past the last do not exist. But `LineBounds`
819 /// marks a line undamaged with `left = cols, right = 0` and `is_damaged()` is `left <= right`,
820 /// so a single `expand` with `left > right` on an otherwise-clean line leaves the line reading
821 /// as undamaged and **drops its whole span silently**. Unreachable from the ten column-derived
822 /// sites today; guarded because that is precisely the failure ghostty's rule forbids.
823 ///
824 /// `row` is deliberately left to panic on the index, and that is **not** in tension with
825 /// `frame_damage` clamping a row fifty lines below (`prev_cursor.0.min(rows - 1)`). The two
826 /// rows are different kinds of thing under the same rule: `prev_cursor` is a *stale remembered*
827 /// coordinate that a shrinking resize may have put out of range, so clamping it repaints the
828 /// nearest surviving cell — a false positive. `row` here is a *live computed* index for the
829 /// mutation just made, so clamping it would damage a different line than the one that changed:
830 /// a false negative on the real line, which is the outcome the rule forbids.
831 fn damage_span(&mut self, row: usize, left: usize, right: usize) {
832 let last = self.grid.cols().saturating_sub(1);
833 debug_assert!(
834 left <= right && right <= last,
835 "damage_span({row}, {left}, {right}) is not a span inside [0, {last}]"
836 );
837 self.line_damage[row].expand(left.min(last), right.min(last));
838 }
839
840 /// The first-class scroll recorded since the last `reset_damage`, if any.
841 /// Suppressed while scrolled up — a content scroll must not shift the frozen
842 /// viewport.
843 ///
844 /// **The count is capped at the region's own height (#661).** Shifting a region
845 /// by more than its height moves every source row outside it, so the surplus
846 /// names nothing a consumer can act on — while it does overflow the wire's
847 /// `i16` and turn an up-scroll into a down-scroll: measured, a single
848 /// 32 770-byte `feed()` of newlines, no slow consumer required. Both references
849 /// that state a quantity at their own scroll sites clamp it to the same bound
850 /// (alacritty `term/mod.rs:773`, ghostty `Terminal.zig:2703`).
851 ///
852 /// The cap is here, on the **read**, and not on the accumulator in
853 /// `record_scroll`: a region that scrolls far and comes back then still reports
854 /// its true small net, instead of one walked down from a saturated value.
855 ///
856 /// A second, crate-internal bound backs it up, and it is representational rather
857 /// than semantic: [`MAX_ROWS`] is `u16::MAX` while the wire field is `i16`, so a
858 /// region can legally be taller than any count that field can hold. In that
859 /// corner the magnitude truncates. What it never does is wrap — a wrapped count
860 /// arrives with the opposite sign and the consumer shifts the wrong way, which is
861 /// the whole of #661.
862 pub fn scroll_delta(&self) -> Option<ScrollOp> {
863 if self.display_offset > 0 {
864 return None;
865 }
866 self.scroll.map(cap_scroll)
867 }
868
869 /// Build a serializable [`Frame`] from the current damage + grid + grapheme
870 /// pool (#6). `Full` ships every row; `Partial` ships the damaged spans. The
871 /// global side-table is remapped to **frame-local** indices — the engine pool
872 /// is append-only and leaky, so a frame carries only the clusters its cells
873 /// reference, renumbered, with each cell's `extra` rewritten to the local id.
874 pub fn frame(&self) -> Frame {
875 let cols = self.grid.cols();
876 let rows = self.grid.rows();
877 let (kind, line_spans): (FrameKind, Vec<(usize, usize, usize)>) = match self.frame_damage()
878 {
879 TermDamage::Full => (
880 FrameKind::Full,
881 (0..rows).map(|l| (l, 0, cols - 1)).collect(),
882 ),
883 TermDamage::Partial(lines) => (
884 FrameKind::Partial,
885 lines
886 .into_iter()
887 .map(|d| (d.line, d.left, d.right))
888 .collect(),
889 ),
890 };
891
892 // Frame-local numbering for the hyperlink table (#26). Keyed by the URI's
893 // *identity* — the `Arc` pointer — so two cells sharing one open share one entry
894 // and a distinct open gets its own, which is exactly the semantics the pool
895 // index used to carry.
896 //
897 // Sized by this frame, not by session history (#628). It was
898 // `vec![0u32; hyperlink_pool.len() + 1]`, allocated and zeroed on **every**
899 // frame against every OSC 8 the session had ever seen — measured at 10 µs per
900 // frame with 100 000 opens retained. With the pool gone there is nothing left to
901 // size it by, and the cost disappears rather than being reduced.
902 let mut link_table: Vec<String> = Vec::new();
903 let mut link_remap: std::collections::HashMap<*const u8, u32> =
904 std::collections::HashMap::new();
905 // Cells come from the viewport at `display_offset`, not the live grid:
906 // viewport row `line` is absolute buffer line `top + line` (scrollback
907 // when scrolled up, the live grid when `display_offset == 0`, where
908 // `top == scrollback.len()` and this is identical to reading the grid).
909 // Without this, a wire consumer — cells reach it only through `frame()` —
910 // could never display scrollback (#48).
911 let top = self.scrollback.len() - self.display_offset;
912 let mut spans = Vec::with_capacity(line_spans.len());
913 for (line, left, right) in line_spans {
914 let mut cells = Vec::with_capacity(right - left + 1);
915 let mut combining = std::collections::BTreeMap::new();
916 let mut links = std::collections::BTreeMap::new();
917 let mut ucolors = std::collections::BTreeMap::new();
918 let row = self.abs_row(top + line);
919 let last_col = row.len().saturating_sub(1);
920 for col in left..=right {
921 let mut cell = row[col];
922 // Soft-wrap is a row property (#538), but the wire has no per-row slot — so it is
923 // *derived* back onto the last cell's WRAPLINE bit here, which keeps the format
924 // byte-identical and is why moving the storage needed no VERSION bump. The bit is
925 // therefore wire-only: on a live grid it is never set, and `Row::is_wrapped` is
926 // the question to ask.
927 if col == last_col && row.is_wrapped() {
928 cell.insert_flags(CellFlags::WRAPLINE);
929 }
930 // Combining clusters and hyperlinks live in the row's maps; each
931 // tagged cell contributes its reference to the frame, recorded on
932 // the span by span-relative column (the cell holds only the bit).
933 if let Some(marks) = row.combining_at(col) {
934 // The cluster itself, at its column — no side table and no index
935 // since v14 (#621). Nothing interned these (this push was
936 // unconditional), so the index only ever bought indirection.
937 combining.insert(col - left, marks.to_vec());
938 }
939 if let Some(uri) = row.link_at(col) {
940 // Number each distinct open once per frame (only referenced URIs
941 // ship). The wire keeps its interning — #621 measured inlining a URI
942 // per linked cell at +171…403% — so this stays an index into
943 // `link_table`; only the *engine* side stopped being a table.
944 let key = std::sync::Arc::as_ptr(uri) as *const u8;
945 let next = link_table.len() as u32 + 1;
946 let fidx = *link_remap.entry(key).or_insert_with(|| {
947 link_table.push(uri.to_string());
948 next
949 });
950 let fidx = core::num::NonZeroU32::new(fidx)
951 .expect("frame-local link indices are 1-based");
952 links.insert(col - left, fidx);
953 }
954 // Underline colour (SGR 58, #520): a colour reference, not a
955 // side-table index, so it rides the span inline. `ucolor_at` is
956 // flag-gated + already Default-filtered (the stamp only fires on an
957 // underlined cell), so a present entry is a real non-default colour.
958 if let Some(color) = row.ucolor_at(col) {
959 ucolors.insert(col - left, color);
960 }
961 cells.push(cell);
962 }
963 spans.push(Span {
964 line: line as u16,
965 left: left as u16,
966 right: right as u16,
967 cells,
968 combining,
969 links,
970 ucolors,
971 });
972 }
973
974 Frame {
975 cols: cols as u16,
976 rows: rows as u16,
977 kind,
978 // The live cursor: position in screen coords + DECTCEM visibility.
979 // Reported, not drawn — the consumer renders the caret (#38).
980 cursor_row: self.cursor.row as u16,
981 cursor_col: self.cursor.col as u16,
982 // Hidden while scrolled up: the live cursor is off the frozen
983 // viewport, and a cell-invert caret would otherwise ink over
984 // scrollback. Consistent with the frozen-damage policy (no cursor
985 // damage is emitted while scrolled) and with xterm.js / alacritty,
986 // which hide the caret when it falls outside the visible rows (#48).
987 cursor_visible: self.cursor.visible && self.display_offset == 0,
988 cursor_shape: self.cursor.shape,
989 cursor_blink: self.cursor.blink,
990 // Viewport scroll position for the consumer's scrollbar (ADR-0013).
991 display_offset: self.display_offset as u32,
992 scrollback_len: self.scrollback.len() as u32,
993 evicted_total: self.evicted_total,
994 marker_epoch: self.marker_epoch,
995 // The active buffer's population, which is what `marker_index` reports and
996 // therefore what a consumer's held index is compared against (#490).
997 marker_count: self.markers().len() as u32,
998 // The mouse tracking mode as a routing mask (#129): which mouse events
999 // the app wants, derived from the protocol by the single source
1000 // `encode_mouse` shares. The consumer routes app-vs-local on it.
1001 mouse_events: self.mouse_protocol.wanted_events(),
1002 // Alt-screen flag (#149): buffer-global state the consumer can't
1003 // derive from viewport damage; the a11y announce policy gates on it.
1004 alt_screen: self.on_alt,
1005 scroll: self.scroll_delta(),
1006 spans,
1007 link_table,
1008 // Interaction overlays projected onto this viewport (#108): the
1009 // engine-owned selection and the consumer-supplied search highlights,
1010 // each re-projected here so the scroll offset is applied once, by the
1011 // same authority that projects the cells.
1012 overlay: Overlay {
1013 selection: self.selection_range(),
1014 matches: self
1015 .search_highlights
1016 .iter()
1017 .flat_map(|m| self.match_spans(m))
1018 .collect(),
1019 // The consumer-designated active match (#428), projected through
1020 // the same `match_spans` math — usually also present in `matches`
1021 // above (the renderer's ranking resolves the overlap, #424), but
1022 // a span designation may sit OUTSIDE a capped hand-over (#436).
1023 active_match: self
1024 .active_search_highlight
1025 .as_ref()
1026 .map(|m| self.match_spans(m))
1027 .unwrap_or_default(),
1028 markers: self.marker_positions(),
1029 },
1030 }
1031 }
1032
1033 /// Record a scroll of rows `[top, bottom]` by `count` (positive = up).
1034 ///
1035 /// Damage is indexed by row position, so it must follow the content the
1036 /// scroll just moved: rotate the bounds the same way and mark the newly
1037 /// exposed line fully damaged (it is new blank content for the consumer).
1038 fn record_scroll(&mut self, top: usize, bottom: usize, count: isize) {
1039 let cols = self.grid.cols();
1040 match count {
1041 1 => {
1042 self.line_damage[top..=bottom].rotate_left(1);
1043 self.line_damage[bottom] = LineBounds::fully_damaged(cols);
1044 }
1045 -1 => {
1046 self.line_damage[top..=bottom].rotate_right(1);
1047 self.line_damage[top] = LineBounds::fully_damaged(cols);
1048 }
1049 _ => {}
1050 }
1051 // Accumulate repeated scrolls of the same region into one op (flow
1052 // control). A *different* region cannot be expressed as one op, so
1053 // degrade to full rather than silently dropping the earlier scroll.
1054 match self.scroll {
1055 Some(op) if op.top == top && op.bottom == bottom => {
1056 self.scroll = Some(ScrollOp {
1057 top,
1058 bottom,
1059 count: op.count + count,
1060 });
1061 }
1062 None => self.scroll = Some(ScrollOp { top, bottom, count }),
1063 Some(_) => {
1064 self.scroll = None;
1065 self.mark_fully_damaged();
1066 }
1067 }
1068 }
1069
1070 /// Number of lines currently held in scrollback history.
1071 /// Replace the word-boundary set used by Word (semantic) selection — the policy half
1072 /// of `selection_begin(.., SelectionType::Word)`, injected per ADR-0017 (core owns
1073 /// the buffer walk, the consumer owns which characters separate words). The default
1074 /// is [`DEFAULT_WORD_SEPARATORS`].
1075 ///
1076 /// **`' '` is forced into whatever you pass**, and that is not a convenience. A
1077 /// blank cell packs `' '`, so the space terminates the walk at the end of a row's
1078 /// written text *and* backstops the wide-pair rule: without it, double-clicking next
1079 /// to a wide separator starts the highlight on that separator's trailing spacer,
1080 /// bisecting the glyph, and the walk then runs to the row's end through the padding.
1081 /// Enforcing it here rather than in the walk is ghostty's shape — it prepends its own
1082 /// blank codepoint to every parsed set at the config intake (`config/Config.zig`,
1083 /// *"Always include null as first boundary"*), so `selectWord` never has to.
1084 ///
1085 /// A consequence worth knowing before you narrow the set: this predicate is the only
1086 /// thing bounding the walk, so a set that omits the separators actually present in
1087 /// the buffer makes one double-click walk the whole soft-wrap run (see #206).
1088 pub fn set_word_separators(&mut self, separators: &str) {
1089 let mut set: String = separators.to_owned();
1090 if !set.contains(' ') {
1091 set.push(' ');
1092 }
1093 self.word_separators = set;
1094 }
1095
1096 /// The word-boundary set currently in force — what was passed to
1097 /// [`Term::set_word_separators`] plus the forced `' '`, or
1098 /// [`DEFAULT_WORD_SEPARATORS`] if it was never called.
1099 pub fn word_separators(&self) -> &str {
1100 &self.word_separators
1101 }
1102
1103 pub fn scrollback_len(&self) -> usize {
1104 self.scrollback.len()
1105 }
1106
1107 /// Whether the app has an open synchronized-output block (DEC ?2026, #73).
1108 pub fn synchronized_output(&self) -> bool {
1109 self.synchronized_output
1110 }
1111
1112 /// Whether the app enabled color-scheme-update notifications (DEC ?2031, #85).
1113 pub fn color_scheme_updates(&self) -> bool {
1114 self.color_scheme_updates
1115 }
1116
1117 /// Whether the app enabled grapheme-cluster mode (DEC ?2027, #295): emoji ZWJ / skin-tone /
1118 /// flag / VS16 sequences are clustered into one cell. OFF (default) is per-char, wcwidth-compat.
1119 pub fn grapheme_clustering(&self) -> bool {
1120 self.grapheme_clustering
1121 }
1122
1123 /// Whether the app enabled win32-input-mode (DEC ?9001, #86). The engine does
1124 /// not encode the raw key-records itself (a non-goal); a ConPTY consumer reads
1125 /// this to decide whether to emit them.
1126 pub fn win32_input_mode(&self) -> bool {
1127 self.win32_input_mode
1128 }
1129
1130 /// Queue a color-scheme report (`CSI ? 997 ; 1 n` dark / `; 2 n` light) on the
1131 /// reply channel. The consumer calls this to answer a `ColorSchemeQuery` event
1132 /// or, when its scheme changes and `color_scheme_updates()` is set, to send the
1133 /// unsolicited notification. The engine never stores or interprets the scheme
1134 /// (#85).
1135 pub fn report_color_scheme(&mut self, dark: bool) {
1136 let ps = if dark { 1 } else { 2 };
1137 self.replies
1138 .extend_from_slice(format!("\x1b[?997;{ps}n").as_bytes());
1139 }
1140
1141 /// OSC 10/11 set/query the default fg/bg, stacking the `;`-separated specs
1142 /// across the `[foreground, background]` slots — xterm's
1143 /// `_setOrReportSpecialColor` offset loop (#137). OSC 10 starts at slot 0
1144 /// (fg → bg), OSC 11 at slot 1 (bg). A `?` spec is a query. xterm's 3rd slot
1145 /// (cursor / OSC 12) is out of scope, so the stack caps at two slots — extra
1146 /// specs are dropped.
1147 fn special_color(&mut self, params: &[&[u8]], start: usize) {
1148 for (i, &spec) in params[1..].iter().enumerate() {
1149 let event = match start + i {
1150 0 if spec == b"?" => TermEvent::QueryForeground,
1151 0 => TermEvent::SetForeground(String::from_utf8_lossy(spec).into_owned()),
1152 1 if spec == b"?" => TermEvent::QueryBackground,
1153 1 => TermEvent::SetBackground(String::from_utf8_lossy(spec).into_owned()),
1154 _ => break, // past [fg, bg] — cursor (OSC 12) unsupported
1155 };
1156 self.events.push(event);
1157 }
1158 }
1159
1160 /// Answer an OSC 4 palette query (#122): wrap the consumer-supplied spec for
1161 /// `index` in the OSC 4 reply envelope, ST-terminated.
1162 pub fn report_palette_color(&mut self, index: u8, spec: &str) {
1163 self.replies
1164 .extend_from_slice(format!("\x1b]4;{index};{spec}\x1b\\").as_bytes());
1165 }
1166
1167 /// Answer an OSC 10 foreground query (#122): wrap the consumer-supplied spec
1168 /// in the OSC 10 reply envelope, ST-terminated.
1169 pub fn report_foreground(&mut self, spec: &str) {
1170 self.replies
1171 .extend_from_slice(format!("\x1b]10;{spec}\x1b\\").as_bytes());
1172 }
1173
1174 /// Answer an OSC 11 background query (#122): wrap the consumer-supplied spec
1175 /// (it knows its palette) in the OSC 11 reply envelope, ST-terminated. The
1176 /// engine formats the envelope only — it never knows the colour.
1177 pub fn report_background(&mut self, spec: &str) {
1178 self.replies
1179 .extend_from_slice(format!("\x1b]11;{spec}\x1b\\").as_bytes());
1180 }
1181
1182 /// The cells of visible row `i` (0..rows) at the current scroll position.
1183 /// The viewport windows into `[history.. ; screen..]`: rows above
1184 /// `scrollback.len()` come from history, the rest from the live screen.
1185 pub fn viewport_line(&self, i: usize) -> &[Cell] {
1186 let top = self.scrollback.len() - self.display_offset;
1187 let idx = top + i;
1188 if idx < self.scrollback.len() {
1189 &self.scrollback[idx]
1190 } else {
1191 self.grid.row(idx - self.scrollback.len())
1192 }
1193 }
1194
1195 /// Scroll the viewport up by `n` lines into history (clamped to the oldest).
1196 pub fn scroll_up(&mut self, n: usize) {
1197 let target = (self.display_offset + n).min(self.scrollback.len());
1198 self.set_display_offset(target);
1199 }
1200
1201 /// Scroll the viewport down by `n` lines toward the live screen.
1202 pub fn scroll_down(&mut self, n: usize) {
1203 let target = self.display_offset.saturating_sub(n);
1204 self.set_display_offset(target);
1205 }
1206
1207 /// Jump the viewport back to the live screen (follow the bottom).
1208 pub fn scroll_to_bottom(&mut self) {
1209 self.set_display_offset(0);
1210 }
1211
1212 /// Move the viewport. A user scroll changes which lines are visible, so the
1213 /// whole viewport is repainted (full damage) when the offset actually moves.
1214 fn set_display_offset(&mut self, offset: usize) {
1215 // The alt screen has no scrollback to view; scroll intents are no-ops.
1216 if self.on_alt {
1217 return;
1218 }
1219 if offset != self.display_offset {
1220 self.display_offset = offset;
1221 self.mark_fully_damaged();
1222 }
1223 }
1224
1225 // ---- selection -----------------------------------------------------------
1226
1227 /// Map a viewport cell `(row, col)` to an absolute buffer point. The top
1228 /// visible row is `scrollback.len() - display_offset`, so viewport row `i`
1229 /// is that plus `i`.
1230 ///
1231 /// **`row` is clamped to the last visible row, and that is the anchor's whole defence
1232 /// against a caller that hands it one past the end (#660).** The row arrives from a
1233 /// pointer position, so it is off the end whenever a drag leaves the grid — including
1234 /// the ordinary case where the container is a sub-cell remainder taller than
1235 /// `rows × cell_height` and a click lands in that strip. Stored unclamped it does not
1236 /// fail here: it detonates later, in whichever read walks the selection
1237 /// (`selection_range`, `selection_text`, the word extents), so the stack trace accuses
1238 /// the reader rather than the caller — the delay `damage_span`'s doc describes and
1239 /// #536 was filed about.
1240 ///
1241 /// **Clamped, and deliberately *not* `debug_assert`ed** — which is where this differs
1242 /// from `damage_span`, whose split it otherwise mirrors. That function is engine-
1243 /// internal, so an out-of-range span there is a justerm bug and the assert names its
1244 /// producer. This one is reached from `Engine::selection_begin` / `selection_extend`,
1245 /// whose documented input is *"what a mouse event carries"* — and a pointer leaves the
1246 /// grid whenever a drag does, so a row past the end is **ordinary input, not a defect**.
1247 /// Asserting on it would panic a consumer's debug build for a legal gesture.
1248 ///
1249 /// Clamping is also what every producer already wants: a drag past the bottom edge
1250 /// selects to the edge. alacritty clamps at the same boundary (`Point::grid_clamp`);
1251 /// ghostty's pins cannot express an out-of-range row at all.
1252 ///
1253 /// **This is a backstop, and since #667 nothing in the family relies on it.** The
1254 /// sentence here used to read that justerm-web's selection converter did *not* clamp,
1255 /// which was what made an unclamped row reachable in the shipped stack rather than
1256 /// only in theory; that converter now bounds both axes at its own seam, as all three
1257 /// references do at theirs. The claim is retracted rather than deleted because it was
1258 /// the record of why this clamp was worth adding.
1259 ///
1260 /// **`col` is bounded the same way, and against the grid rather than the line
1261 /// (#671).** #660 reasoned about the row alone and this function passed the column
1262 /// through, which was not a smaller version of the same gap — it was a *different*
1263 /// one, because the two axes are consumed differently downstream. A column reaches
1264 /// `resolve`, where the `Side` decides whether it gets a `+ 1`, and the two readers
1265 /// then bound only one end each: `selection_range`'s Linear arm clips `right_excl`
1266 /// and not `left`, `selection_text`'s Block arm clips `hi` and not `from`. So
1267 /// `Side::Right` was already safe by accident (its `+ 1` lands past the end and the
1268 /// clip catches it) while **`Side::Left` had no `+ 1` to clip**, and the raw column
1269 /// survived into `left` — silently deleting the anchor's own row from both the
1270 /// projection and the copy. `usize::MAX` was the one value that panicked instead,
1271 /// on the `+ 1`.
1272 ///
1273 /// Bounding here rather than in `resolve` keeps one site answering "what does a
1274 /// viewport coordinate mean", and makes both axes total for the same reason; the
1275 /// alternative — clamping at each `+ 1` — is five sites for one rule. alacritty
1276 /// bounds both endpoints' columns in `Selection::to_range` *before* its own side
1277 /// arithmetic and pairs the `+ 1` with an explicit *"column == columns → wrap to the
1278 /// next line"*; justerm reaches that same outcome through the reader's
1279 /// `right_excl > left`, which is why an **in-range** `Side::Right` on the last column
1280 /// still starts the selection on the following row and is pinned as unchanged.
1281 ///
1282 /// The grid, not `abs_line(..).len()`, is the bound: `SelectionType::Line` already
1283 /// resolves `to` as `grid.cols()`, so the whole type works in grid coordinates and a
1284 /// short line must not shrink a selection that reaches past it.
1285 ///
1286 /// **`resolve`'s five `+ 1`s stay unguarded, and that is sound only while every stored
1287 /// anchor arrives through here.** The completeness pass enumerated the writers: the
1288 /// three coordinate fixups move `.line` or write columns that are in range by
1289 /// construction, `resize`'s primary branch re-clamps the reflowed points (#562) and its
1290 /// alt branch drops the selection outright (#660), and `Term::resize` is the only writer
1291 /// of `grid.cols()`. So no path strands a column that was clamped here. The condition is
1292 /// **a fourth writer of `self.selection`** — one that builds an `Anchor` without this
1293 /// function would put `resolve` back in reach of its own arithmetic.
1294 fn viewport_to_abs(&self, row: usize, col: usize) -> BufferPoint {
1295 let top = self.scrollback.len() - self.display_offset;
1296 let last = self.grid.rows().saturating_sub(1);
1297 BufferPoint {
1298 line: top + row.min(last),
1299 col: col.min(self.grid.cols().saturating_sub(1)),
1300 }
1301 }
1302
1303 /// The hyperlink **URI** at **screen** `(row, col)` (the live grid), or `None` —
1304 /// flag-gated through the row's link map. Since #628 the map holds the URI itself,
1305 /// so there is no index and no second call to resolve one.
1306 /// Mirrors `grid().cell(row, col)`.
1307 pub(crate) fn screen_link_at(&self, row: usize, col: usize) -> Option<Hyperlink> {
1308 self.grid
1309 .row_ref(row)
1310 .link_at(col)
1311 .cloned()
1312 .map(Hyperlink::new)
1313 }
1314
1315 /// The underline colour (SGR 58, #520) at screen `(row, col)`, as a theme-agnostic
1316 /// reference. `Color::Default` means "follow the fg" — the common case, and what an
1317 /// unset cell returns. Mirror of [`Term::screen_link_at`].
1318 pub(crate) fn screen_underline_color_at(&self, row: usize, col: usize) -> Color {
1319 self.grid.row_ref(row).ucolor_at(col).unwrap_or_default()
1320 }
1321
1322 /// The hyperlink URI at **viewport** `(row, col)` (visible window, history
1323 /// included at the current scroll), or `None`. Mirrors `viewport_line(row)`.
1324 pub(crate) fn viewport_link_at(&self, row: usize, col: usize) -> Option<Hyperlink> {
1325 let idx = self.scrollback.len() - self.display_offset + row;
1326 self.abs_row(idx).link_at(col).cloned().map(Hyperlink::new)
1327 }
1328
1329 /// Resize the screen to `cols` x `rows`. Rows dropped off the top (on shrink)
1330 /// enter scrollback. Column reflow of soft-wrapped lines is layered on top
1331 /// separately (#7). The whole screen is damaged.
1332 ///
1333 /// `cols` is widened to [`MIN_COLUMNS`] — a narrower screen cannot hold a
1334 /// width-2 glyph, so it is clamped rather than represented (#547).
1335 pub fn resize(&mut self, cols: usize, rows: usize) {
1336 // A terminal is never 0-tall; clamp so the math below (rows - 1) can't
1337 // underflow. Columns clamp to MIN_COLUMNS, not 1: chunking by cols needs a
1338 // non-zero width, but a *wide glyph* needs two (#547). The ceiling is the frame
1339 // header's u16, clamped here as well as in the constructor — a ceiling that held
1340 // only until the first resize is the gap `new` had against this function's own row
1341 // floor before #547 (#621).
1342 let cols = cols.clamp(MIN_COLUMNS, MAX_COLUMNS);
1343 let rows = rows.clamp(1, MAX_ROWS);
1344 let old_cols = self.grid.cols();
1345 let old_rows = self.grid.rows();
1346 let limit = self.scrollback_limit;
1347
1348 // A reflow rewrites marker lines outright, at three separate sites below and in
1349 // two different frames of reference — so a held index goes stale in a way no
1350 // offset repairs (#490). Bumped **here**, once, rather than beside each rewrite:
1351 // this function is the only way any of them runs, and a per-site obligation is
1352 // the shape `docs/map/territory/marker.md` already records as a known hole for
1353 // the alt guard. Gated on a *dimension change* as well as on there being a marker:
1354 // `resize` has no early return for unchanged geometry, and `justerm-web`'s fit
1355 // loop re-asserts the size every frame (`ResizePort` states no idempotency
1356 // guarantee), so an ungated bump is a full re-pull per frame — measured at 100
1357 // bumps for 100 no-op resizes.
1358 if (cols != old_cols || rows != old_rows)
1359 && (!self.normal_markers.is_empty() || !self.alt_markers.is_empty())
1360 {
1361 self.bump_marker_epoch();
1362 }
1363
1364 // A reflow moves match coordinates (and can change the match set), so the
1365 // query-derived highlights are invalidated; the consumer re-searches at
1366 // the new width. The selection re-anchors below — it is user-authored.
1367 self.invalidate_search_highlights();
1368
1369 // ...except on the alt screen, where a *shrink* drops the selection (#660). The
1370 // primary pane carries user-authored points through `reflow_pane` and gets them back
1371 // mapped to the new geometry; on alt the selection is dropped instead.
1372 //
1373 // **This is a policy choice, not a capability limit, and the difference matters
1374 // because the first version of this comment got it wrong.** It claimed the alt pane
1375 // has "nothing to re-anchor through" — measurably false: the alt branch below makes
1376 // its own `reflow_pane` call with tracked points and already uses the returned
1377 // `extras` / `evicted` to rotate and dispose alt *markers*. `reflow: false` disables
1378 // the column re-split, not the point tracking. Installing a false "cannot" as the
1379 // justification for fixing a false "cannot" is precisely the failure #660 is.
1380 //
1381 // What actually makes rotation the wrong trade here is that a marker and a selection
1382 // are different shapes. A marker is one point with a binary fate — survive, or be
1383 // disposed with an event. A selection is two *ordered* endpoints, so when a shrink
1384 // destroys the row under one of them and not the other, "dispose" has no meaning and
1385 // the correct behaviour is the clamp-and-overtake policy `selection_rotate_region`
1386 // implements for scrolls. Reusing the marker path would give a selection whose ends
1387 // moved by different rules; writing the second policy is a feature, not this fix.
1388 // And on a column shrink an alt anchor would additionally need the `.min(cols - 1)`
1389 // the primary branch applies, which alt markers deliberately do *not* take.
1390 //
1391 // Both references drop rather than rotate on the axis they consider unsafe —
1392 // alacritty on a width change (`term/mod.rs:680-682`), xterm.js on a height change,
1393 // its comment naming this bug class outright (`SelectionService.ts:156-160`).
1394 //
1395 // **Any geometry change, not just a shrink — and the `!=` is load-bearing in the
1396 // direction that looks wasteful.** The obvious refinement is to keep the selection on
1397 // a *grow*, since the alt pane pads rather than moving content, so no anchor looks
1398 // invalidated. That was tried and a randomised sweep refuted it in one run: an alt
1399 // resize also reflows the **primary** pane below, and on the alt screen `scrollback`
1400 // *is* that primary history — so `scrollback.len()` moves under an anchor whose
1401 // absolute line was measured from the old base, even when the alt grid itself does not
1402 // move at all. `selection_text` then walks off the end. The branch below already knows
1403 // this and converts alt *markers* through `old_base` → new base for exactly that
1404 // reason ("the primary scrollback below may rewrap and change length even when the alt
1405 // grid does not move"); the selection has no such conversion, so the geometry change
1406 // is the honest trigger.
1407 //
1408 // Rebasing instead of dropping is the better answer and is not done here: a grow has
1409 // no destroyed row, so both endpoints could shift by the base delta unambiguously —
1410 // but a *shrink* still needs the two-endpoint policy below, and shipping half of it
1411 // would leave the two axes behaving differently for no stated reason.
1412 //
1413 // The exact no-op is still not a resize: nothing reflows when neither axis moves, so
1414 // the base cannot shift, and a consumer that re-asserts its size every frame (a
1415 // `fit()` loop) must not make selecting on the alt screen impossible.
1416 if self.on_alt && (cols != old_cols || rows != old_rows) {
1417 self.selection = None;
1418 }
1419
1420 // Both screens are resized. Scrollback pairs with the PRIMARY screen
1421 // (whichever is active) — the alt screen has no history of its own.
1422 // `reflow: true` is the *primary* pane's setting and is deliberately a constant, **not**
1423 // `self.autowrap`. ghostty gates its equivalent on DECAWM — `.reflow =
1424 // self.modes.get(.wraparound)` (`terminal/Terminal.zig` `resize`) — and the reading that
1425 // makes that coherent is the one this file just accepted for the alt screen: an application
1426 // that turns autowrap off is placing lines itself, so its content is a layout rather than a
1427 // flow, and re-wrapping it changes what it drew.
1428 //
1429 // Not followed here, for three reasons, and they are recorded rather than filed because
1430 // nothing observable is known to break either way (measured: with DECAWM off, a full
1431 // 6-column row still re-splits into two rows at width 3 exactly as it does with DECAWM on;
1432 // the difference against ghostty is that ghostty truncates that row instead).
1433 //
1434 // - **The wrap flag is not a lie.** `Row::is_wrapped` means "this row continues into the
1435 // next", which after a re-split is simply true. DECAWM governs the **write** path — where
1436 // a glyph goes when the cursor is at the last column — not how stored content is laid out
1437 // again later. Dropping the flag would make `"abcdef"` extract as `"abc\ndef"`.
1438 // - **The mode is global and momentary; the buffer is neither.** DECAWM is read at resize
1439 // time and would decide the fate of history written under the opposite setting. A TUI that
1440 // turns it off while drawing would, on a resize landing in that window, leave every
1441 // properly wrapped line in scrollback un-reflowed.
1442 // - **It costs content.** Not reflowing truncates each row to the new width, so the tail of
1443 // a long line leaves the grid. justerm keeps it.
1444 //
1445 // There is no per-row signal to be finer with: a row written under DECAWM off and a row that
1446 // merely ended early are both simply unwrapped. "Do not re-split an unwrapped logical line"
1447 // would break ordinary reflow, since a line that exactly fills its width carries no wrap
1448 // flag either.
1449 let dims = ReflowDims {
1450 old_cols,
1451 cols,
1452 rows,
1453 limit,
1454 reflow: true,
1455 };
1456 let scrollback = std::mem::take(&mut self.scrollback);
1457 if self.on_alt {
1458 // Active = alt (cursor, no scrollback); inactive = primary. No selection anchors
1459 // to track here — but *because the geometry change above dropped them* (#660),
1460 // not because there cannot be any. This comment used to read "selection is
1461 // primary-only and cleared on alt enter": the clearing is real
1462 // (`enter_alt_screen` / `leave_alt_screen`, "a selection cannot survive a screen
1463 // swap") and says nothing about a selection made *while* the alt screen is up,
1464 // which is the ordinary act of copying out of vim. A premise that held at one
1465 // instant was read as an invariant holding for the screen's lifetime.
1466 // Alt markers still ride this pane, but **not because it reflows** — since #567 it does
1467 // not, so a marker's content no longer moves under it and the old reason here ("justerm
1468 // column-reflows the alt grid, so a marker must follow its content") is retracted. What
1469 // they ride it for is the row *fit*: a shrink still drops rows off the top, and a marker
1470 // on one of those has left a screen with no history to hold it. Their stored line is
1471 // `base + alt_row` (base = primary scrollback len), so convert to alt-local rows here
1472 // and re-anchor on the new base afterward — the primary scrollback below may rewrap and
1473 // change length even when the alt grid does not move at all.
1474 let old_base = scrollback.len();
1475 let mut alt_pts: Vec<(usize, usize)> = self
1476 .alt_markers
1477 .iter()
1478 .map(|m| (m.line - old_base, m.col))
1479 .collect();
1480 // Alt-scoped tracked points are stored on the same `base + alt_row`
1481 // frame as the alt markers, so they convert and come back the same way
1482 // (#691).
1483 let alt_tracked_off = alt_pts.len();
1484 alt_pts.extend(
1485 self.alt_tracked
1486 .iter()
1487 .map(|p| (p.line.saturating_sub(old_base), p.col)),
1488 );
1489 let alt = self.grid.take_lines();
1490 let r_alt = reflow_pane(
1491 alt,
1492 VecDeque::new(),
1493 self.cursor.point(),
1494 &alt_pts,
1495 ReflowDims {
1496 limit: 0,
1497 reflow: false,
1498 ..dims
1499 },
1500 );
1501 self.grid.set_screen(r_alt.screen, cols, rows);
1502 self.cursor.set_point(r_alt.cursor, rows, cols);
1503
1504 // Primary is inactive here, but markers anchor *primary* content, so
1505 // they reflow with it. There is no *primary* selection to carry alongside them —
1506 // `switch_to_alt` nulls it before the alt screen exists, so one cannot coexist
1507 // with `on_alt` — which is a different statement from the "cleared on alt enter"
1508 // this comment used to make, and the difference is #660: that clearing says
1509 // nothing about the *alt* selection the branch above now drops.
1510 // `(line, col)`, not `(line, 0)`: the column is what bounds OSC-133 command-text
1511 // extraction (#166), and discarding it here truncated the recorded command for any
1512 // resize taken while a full-screen app was up. The primary branch below has always
1513 // passed and restored both; this one is the sibling that did not.
1514 let mut marker_pts: Vec<(usize, usize)> = self
1515 .normal_markers
1516 .iter()
1517 .map(|m| (m.line, m.col))
1518 .collect();
1519 // Primary-scoped tracked points anchor primary content too, so they
1520 // reflow with this pane even though the alt screen is the active one
1521 // (#691) — the same reason the markers above do.
1522 let tracked_off = marker_pts.len();
1523 marker_pts.extend(self.normal_tracked.iter().map(|p| (p.line, p.col)));
1524 let primary = self.alt_grid.take_lines();
1525 let r = reflow_pane(
1526 primary,
1527 scrollback,
1528 self.saved_cursor.point(),
1529 &marker_pts,
1530 dims,
1531 );
1532 self.alt_grid.set_screen(r.screen, cols, rows);
1533 self.scrollback = r.scrollback;
1534 self.saved_cursor.set_point(r.cursor, rows, cols);
1535 for (i, m) in self.normal_markers.iter_mut().enumerate() {
1536 m.line = r.extras[i].0.saturating_sub(r.evicted);
1537 m.col = r.extras[i].1;
1538 }
1539 // Released rather than clamped when the reflow evicted its line — see
1540 // the primary-active branch for why the two loops differ (#691).
1541 let mut ti = 0;
1542 let evicted = r.evicted;
1543 let extras = &r.extras;
1544 self.normal_tracked.retain_mut(|p| {
1545 let (line, col) = extras[tracked_off + ti];
1546 ti += 1;
1547 match line.checked_sub(evicted) {
1548 Some(line) => {
1549 p.line = line;
1550 p.col = col;
1551 true
1552 }
1553 None => false,
1554 }
1555 });
1556 // The alt half lives in a different frame from the primary one above, and adding the
1557 // two was the defect: `extras` count from the top of the alt pane's own history, and
1558 // the alt screen **has** no history — every row the shrink pushed off the top is gone,
1559 // not archived. Passing the primary's scrollback limit made `reflow_pane` keep them,
1560 // so a rows-only resize (no reflow at all) reported a marker four lines past the end of
1561 // the buffer. The limit is `0` here because that is what an alt screen's history is.
1562 //
1563 // A marker whose row went with it is **disposed**, matching what the alt screen already
1564 // does when a row leaves by scrolling (`markers_rotate_region` fires `MarkerDisposed`
1565 // for the marker on the departing edge). Silently relocating it to row 0 would put a
1566 // decoration on content it was never attached to.
1567 let new_base = self.scrollback.len();
1568 let mut alt_disposed = Vec::new();
1569 let mut i = 0;
1570 self.alt_markers.retain_mut(|m| {
1571 let (line, col) = r_alt.extras[i];
1572 i += 1;
1573 match line.checked_sub(r_alt.evicted) {
1574 Some(row) if row < rows => {
1575 m.line = new_base + row;
1576 // The column rides along for the same reason as the primary half, but
1577 // **unpinned**: `add_marker` always passes column 0, and I could not get an
1578 // OSC-133 mark (the only column-bearing kind) to appear in `alt_markers` at
1579 // all. That is a gap in my knowledge, not evidence the column is
1580 // structurally zero — `push_marker` takes a column and `markers_mut` routes
1581 // by active buffer, so the field is reachable in principle. Carrying it
1582 // keeps the two halves stating one invariant; if the alt path really is
1583 // marker-column-free, this line is a no-op.
1584 m.col = col;
1585 true
1586 }
1587 _ => {
1588 alt_disposed.push(m.id);
1589 false
1590 }
1591 }
1592 });
1593 for id in alt_disposed {
1594 self.events.push(TermEvent::MarkerDisposed(id));
1595 }
1596 // The alt half's tracked points, on the alt marker's rule: a row the
1597 // shrink pushed off an unarchived screen is gone, so the point is
1598 // released rather than relocated (#691).
1599 //
1600 // The `row < rows` half of that guard is **unproven, deliberately kept**.
1601 // A mutation dropping it stays green, and a sweep of 324 alt resizes
1602 // (rows 1..6 x cols {4,10,30}, both directions, a point on every alt row
1603 // at columns 0 / 1 / cols-1 / cols plus one past the pane) never reached
1604 // it — the alt fit runs with `reflow: false`, so a surviving row always
1605 // maps below the new row count. That is a measured *validity condition*,
1606 // not a proof of unreachability, and the marker loop above carries the
1607 // same bound: parity is the reason it stays.
1608 let mut ai = 0;
1609 let alt_extras = &r_alt.extras;
1610 let alt_evicted = r_alt.evicted;
1611 self.alt_tracked.retain_mut(|p| {
1612 let (line, col) = alt_extras[alt_tracked_off + ai];
1613 ai += 1;
1614 match line.checked_sub(alt_evicted) {
1615 Some(row) if row < rows => {
1616 p.line = new_base + row;
1617 p.col = col;
1618 true
1619 }
1620 _ => false,
1621 }
1622 });
1623 } else {
1624 // Active = primary (cursor, scrollback); inactive = alt. The selection
1625 // anchors (absolute) reflow alongside the cursor so they keep their
1626 // content across a column change.
1627 let sel_pts: Vec<(usize, usize)> = self
1628 .selection
1629 .as_ref()
1630 .map(|s| {
1631 vec![
1632 (s.anchor.point.line, s.anchor.point.col),
1633 (s.focus.point.line, s.focus.point.col),
1634 ]
1635 })
1636 .unwrap_or_default();
1637 // Markers reflow on the same pane by (line, col) — the column matters
1638 // for OSC-133 command marks, whose B/C columns bound the extracted
1639 // command text (#166). They ride after the selection points so each
1640 // reads its own reflowed slot back from `extras` (#118).
1641 let mut pts = sel_pts.clone();
1642 pts.extend(self.normal_markers.iter().map(|m| (m.line, m.col)));
1643 // Tracked points ride after the markers, reading their own slots back
1644 // by the same offset idiom (#691).
1645 let tracked_off = pts.len();
1646 pts.extend(self.normal_tracked.iter().map(|p| (p.line, p.col)));
1647
1648 let primary = self.grid.take_lines();
1649 let r = reflow_pane(primary, scrollback, self.cursor.point(), &pts, dims);
1650 self.grid.set_screen(r.screen, cols, rows);
1651 self.scrollback = r.scrollback;
1652 self.cursor.set_point(r.cursor, rows, cols);
1653 if let Some(sel) = &mut self.selection {
1654 // A selection endpoint is **UI** state, so its reading of `col == cols` (#562) is
1655 // neither the cursor's nor a mark's: it is clamped into the grid. UI state may not
1656 // move the application's content to make room for itself — the criterion that
1657 // decided this, and the one ghostty encodes by clamping every non-cursor pin before
1658 // it can widen a row (`terminal/PageList.zig:1576-1585` @ `e6e26e1`) while leaving
1659 // the cursor pin unclamped (`:1602-1606`).
1660 sel.anchor.point = BufferPoint {
1661 line: r.extras[0].0.saturating_sub(r.evicted),
1662 col: r.extras[0].1.min(cols - 1),
1663 };
1664 sel.focus.point = BufferPoint {
1665 line: r.extras[1].0.saturating_sub(r.evicted),
1666 col: r.extras[1].1.min(cols - 1),
1667 };
1668 }
1669 let marker_off = sel_pts.len();
1670 for (i, m) in self.normal_markers.iter_mut().enumerate() {
1671 m.line = r.extras[marker_off + i].0.saturating_sub(r.evicted);
1672 m.col = r.extras[marker_off + i].1;
1673 }
1674 // A point whose reflowed line fell inside the evicted prefix has left
1675 // the buffer, so it is released rather than clamped to line 0 (#691) —
1676 // deliberately unlike the marker loop above, which saturates. A marker
1677 // that lands on the wrong line still paints something the consumer can
1678 // see and correct; a tracked point is *asked* for a position, and
1679 // answering with content the caller never anchored to is the exact
1680 // failure this whole module exists to remove.
1681 let mut i = 0;
1682 let evicted = r.evicted;
1683 let extras = &r.extras;
1684 self.normal_tracked.retain_mut(|p| {
1685 let (line, col) = extras[tracked_off + i];
1686 i += 1;
1687 match line.checked_sub(evicted) {
1688 Some(line) => {
1689 p.line = line;
1690 p.col = col;
1691 true
1692 }
1693 None => false,
1694 }
1695 });
1696
1697 let alt = self.alt_grid.take_lines();
1698 let r = reflow_pane(
1699 alt,
1700 VecDeque::new(),
1701 (0, 0),
1702 &[],
1703 ReflowDims {
1704 limit: 0,
1705 reflow: false,
1706 ..dims
1707 },
1708 );
1709 self.alt_grid.set_screen(r.screen, cols, rows);
1710 }
1711
1712 // Carry the deferred wrap across the resize — it is *cursor* state, and it used to be
1713 // reset here alongside the margins and tab stops, which are screen configuration and do
1714 // legitimately reset. Losing it meant the next byte overwrote the last glyph instead of
1715 // wrapping past it, on a column resize *and* on a rows-only one where no reflow runs at
1716 // all.
1717 //
1718 // The flag means "the cursor is logically one past the column it sits on". Where the
1719 // reflow leaves it somewhere other than the last column that logical position **is**
1720 // representable, so the flag is cleared and the cursor takes it instead — ghostty's rule,
1721 // stated in its own words for the saved cursor: *"If we had pending wrap set and we're no
1722 // longer at the end of the line, we unset the pending wrap and move the cursor to reflect
1723 // the correct next position"* (`terminal/Screen.zig:2092-2098` @ `e6e26e1`). alacritty
1724 // reaches the same place from the other side, lifting the cursor outside the grid before
1725 // reflowing and clamping it back afterwards (`grid/resize.rs:113-116`, `:248-251`,
1726 // `:173-177` @ `852e971`); xterm.js needs no rule because `x === cols` is representable.
1727 //
1728 // `col + 1` cannot overflow the row: the branch requires `col != cols - 1`, and `col` is
1729 // already clamped below `cols` by `Cursor::set_point`.
1730 if self.cursor.pending_wrap && self.cursor.col != cols - 1 {
1731 self.cursor.pending_wrap = false;
1732 self.cursor.col += 1;
1733 }
1734 self.scroll_top = 0;
1735 self.scroll_bottom = rows - 1;
1736 self.tabs = default_tabs(cols);
1737 self.display_offset = self.display_offset.min(self.scrollback.len());
1738
1739 // Damage tracking is sized to the screen; a resize repaints everything,
1740 // so drop any pending scroll op (it points at the old rows).
1741 self.line_damage = vec![LineBounds::undamaged(cols); rows];
1742 self.scroll = None;
1743 self.mark_fully_damaged();
1744 }
1745
1746 pub fn grid(&self) -> &Grid {
1747 &self.grid
1748 }
1749
1750 pub fn cursor(&self) -> &Cursor {
1751 &self.cursor
1752 }
1753
1754 /// Whether bracketed-paste mode (DEC ?2004) is enabled. The input encoder
1755 /// (#11) reads this to decide whether to wrap pasted text in markers.
1756 pub fn bracketed_paste(&self) -> bool {
1757 self.bracketed_paste
1758 }
1759
1760 // ---- input encoding (#11) ------------------------------------------------
1761
1762 /// Encode a key event to bytes using the active cursor-key mode (DECCKM)
1763 /// and the kitty keyboard-protocol flags (`encode_key` consults both).
1764 pub fn encode_key(&self, ev: KeyEvent) -> Option<Vec<u8>> {
1765 encode_key(
1766 &ev,
1767 self.app_cursor_keys,
1768 self.application_keypad,
1769 self.kitty_flags,
1770 )
1771 }
1772
1773 /// Encode a mouse event using the active tracking mode + encoding. `None`
1774 /// when reporting is off or the event is filtered by the mode.
1775 pub fn encode_mouse(&self, ev: MouseEvent) -> Option<Vec<u8>> {
1776 encode_mouse(&ev, self.mouse_protocol, self.mouse_encoding)
1777 }
1778
1779 /// Encode pasted text, wrapping it in bracketed-paste markers when ?2004 is
1780 /// on.
1781 pub fn encode_paste(&self, text: &str) -> Vec<u8> {
1782 encode_paste(text, self.bracketed_paste)
1783 }
1784
1785 /// Encode a focus change (`CSI I`/`CSI O`), or `None` when focus reporting
1786 /// (?1004) is off.
1787 pub fn encode_focus(&self, focused: bool) -> Option<Vec<u8>> {
1788 encode_focus(focused, self.focus_events)
1789 }
1790
1791 /// Take the consumer events queued since the last drain, emptying the queue.
1792 pub fn drain_events(&mut self) -> Vec<TermEvent> {
1793 std::mem::take(&mut self.events)
1794 }
1795
1796 /// Take the reply bytes queued since the last drain (DA/DSR/DECRQM answers),
1797 /// emptying the buffer. The consumer writes them back to the PTY.
1798 pub fn drain_replies(&mut self) -> Vec<u8> {
1799 std::mem::take(&mut self.replies)
1800 }
1801
1802 /// Device Status Report (CSI Ps n): 6 = cursor position, 5 = operating
1803 /// status. Queues the reply for `drain_replies` (#27).
1804 fn device_status_report(&mut self, param: u16) {
1805 match param {
1806 6 => {
1807 // CSI row;col R, 1-based — region-relative under origin mode
1808 // (the coordinate system the app is addressing in).
1809 let row = if self.origin_mode {
1810 self.cursor.row.saturating_sub(self.scroll_top)
1811 } else {
1812 self.cursor.row
1813 } + 1;
1814 let col = self.cursor.col + 1;
1815 self.replies
1816 .extend_from_slice(format!("\x1b[{row};{col}R").as_bytes());
1817 }
1818 5 => self.replies.extend_from_slice(b"\x1b[0n"), // status: OK
1819 _ => {}
1820 }
1821 }
1822
1823 /// Kitty keyboard-protocol negotiation (#23). `lead` is the leading CSI
1824 /// intermediate: `?` query, `>` push, `=` set, `<` pop.
1825 fn kitty_dispatch(&mut self, lead: u8, params: &Params) {
1826 match lead {
1827 // Query → report the current flags as `CSI ? flags u` (#27 channel).
1828 b'?' => self
1829 .replies
1830 .extend_from_slice(format!("\x1b[?{}u", self.kitty_flags).as_bytes()),
1831 // Push: save the current flags, then set the new ones (default 0).
1832 b'>' => {
1833 const KITTY_STACK_CAP: usize = 16;
1834 if self.kitty_stack.len() >= KITTY_STACK_CAP {
1835 self.kitty_stack.remove(0); // drop the oldest on overflow
1836 }
1837 self.kitty_stack.push(self.kitty_flags);
1838 self.kitty_flags = param_or(params, 0, 0) as u8;
1839 }
1840 // Pop `n` (default 1): restore from the stack, 0 once empty.
1841 b'<' => {
1842 for _ in 0..param_or(params, 0, 1) {
1843 self.kitty_flags = self.kitty_stack.pop().unwrap_or(0);
1844 }
1845 }
1846 // Set in place (no push): mode 1 replace, 2 or-in, 3 and-not.
1847 b'=' => {
1848 let flags = param_or(params, 0, 0) as u8;
1849 self.kitty_flags = match param_or(params, 1, 1) {
1850 1 => flags,
1851 2 => self.kitty_flags | flags,
1852 3 => self.kitty_flags & !flags,
1853 _ => self.kitty_flags,
1854 };
1855 }
1856 _ => {}
1857 }
1858 }
1859
1860 /// DECRQM (CSI ? Ps $ p): report whether DEC private mode `Ps` is set —
1861 /// `CSI ? Ps ; val $ y` with val 1=set, 2=reset, 0=not recognized (#27).
1862 fn decrqm(&mut self, mode: u16) {
1863 let state = match mode {
1864 1 => Some(self.app_cursor_keys),
1865 // DECANM (#84): set = ANSI mode (the normal state), reset = VT52.
1866 2 => Some(!self.vt52_mode),
1867 6 => Some(self.origin_mode),
1868 // DECCOLM: derived from the actual width, never a tracked flag — a
1869 // flag would lie if the consumer ignored the resize request (#82).
1870 3 => Some(self.grid.cols() == 132),
1871 7 => Some(self.autowrap),
1872 45 => Some(self.reverse_wraparound),
1873 9 => Some(self.mouse_protocol == MouseProtocol::X10),
1874 66 => Some(self.application_keypad),
1875 12 => Some(self.cursor.blink),
1876 25 => Some(self.cursor.visible),
1877 // Mouse tracking is a single-state enum (the levels are mutually
1878 // exclusive — an app enables one), so querying ?1000 while ?1002 is
1879 // active reports "reset". Faithful to that model.
1880 1000 => Some(self.mouse_protocol == MouseProtocol::Normal),
1881 1002 => Some(self.mouse_protocol == MouseProtocol::ButtonEvent),
1882 1003 => Some(self.mouse_protocol == MouseProtocol::AnyEvent),
1883 1004 => Some(self.focus_events),
1884 1006 => Some(self.mouse_encoding == MouseEncoding::Sgr),
1885 1015 => Some(self.mouse_encoding == MouseEncoding::Urxvt),
1886 1005 => Some(self.mouse_encoding == MouseEncoding::Utf8),
1887 1016 => Some(self.mouse_encoding == MouseEncoding::SgrPixels),
1888 47 | 1047 | 1049 => Some(self.on_alt),
1889 2004 => Some(self.bracketed_paste),
1890 2026 => Some(self.synchronized_output),
1891 2027 => Some(self.grapheme_clustering),
1892 2031 => Some(self.color_scheme_updates),
1893 9001 => Some(self.win32_input_mode),
1894 _ => None,
1895 };
1896 let val = match state {
1897 Some(true) => 1,
1898 Some(false) => 2,
1899 None => 0,
1900 };
1901 self.replies
1902 .extend_from_slice(format!("\x1b[?{mode};{val}$y").as_bytes());
1903 }
1904
1905 // ---- cursor / scroll primitives ------------------------------------------
1906
1907 /// Move down one line. At the bottom margin, scroll the region instead;
1908 /// below the region, just descend (no scroll). Column is unchanged (raw LF;
1909 /// CR is what returns to column 0).
1910 /// An ordinary line feed — `LF`/`VT`/`FF`, `IND` and `NEL`. None of them serves a wrap.
1911 fn linefeed(&mut self) {
1912 self.linefeed_inner(false);
1913 }
1914
1915 /// A line feed, carrying the one fact the shift itself cannot see: whether the auto-wrap asked
1916 /// for it.
1917 ///
1918 /// `serves_wrap` is the **bottom** seam's exemption in `shift_region`, the mirror of
1919 /// `evicts_to_scrollback` for the top one. When `wrapline` drives this, the blank that lands at
1920 /// the region's bottom *is* where the wrapped text is about to go — so the row that #540 would
1921 /// call "the one that lost its continuation to the blank" is in fact the row whose continuation
1922 /// that blank **is** (#557).
1923 ///
1924 /// xterm.js threads the identical fact through the identical seam, in the opposite direction:
1925 /// `BufferService.scroll(eraseAttr, isWrapped)` stamps the *destination* row
1926 /// (`common/services/BufferService.ts:68`/`:77` @ `699f553`), and exactly one of its four
1927 /// non-test callers passes `true` — the auto-wrap branch of `_print` (`InputHandler.ts:588`),
1928 /// not `lineFeed`, `index` or the ED-2 loop.
1929 fn linefeed_inner(&mut self, serves_wrap: bool) {
1930 // New-line mode (LNM ?20): a line feed also returns to column 0 (#71).
1931 if self.newline_mode {
1932 self.carriage_return();
1933 }
1934 if self.cursor.row == self.scroll_bottom {
1935 // A top-anchored primary-screen scroll pushes the evicted top line
1936 // into scrollback history.
1937 if self.scroll_top == 0 && !self.on_alt {
1938 // Scrollback accrues whenever the scroll is top-anchored on the
1939 // primary screen (`scroll_top == 0`) — but the O(1) ring handshake
1940 // only applies to a *full-screen* scroll (`scroll_bottom` at the
1941 // last row). A top-anchored *sub-region* (`[0..k]`, k < rows-1)
1942 // still accrues, yet must scroll only its region, so it keeps the
1943 // copy + region scroll. These are distinct predicates (ADR-0009).
1944 let evicted = if self.scroll_bottom == self.grid.rows() - 1 {
1945 // Full-screen hot path: move the evicted top row out, install
1946 // a recycled blank as the new bottom (zero-alloc steady state).
1947 let blank = self
1948 .recycled_row
1949 .take()
1950 .unwrap_or_else(|| Row::from_cells(Vec::with_capacity(self.grid.cols())));
1951 let evicted = self.grid.scroll_up_recycle(blank);
1952 // The one row-shifting path that does not route through `shift_region` (it
1953 // needs the primitive that *returns* the evicted row), so it records its own
1954 // scroll op — and owes no seam clear, which is now an argument rather than a
1955 // coincidence: the top seam is exempt because this evicts into scrollback
1956 // (adjacency is preserved one row back), and the bottom seam is exempt because
1957 // this branch only runs at `scroll_bottom == rows - 1`, where a wrap on the
1958 // last row is the state the scroll exists to serve.
1959 self.record_scroll(self.scroll_top, self.scroll_bottom, 1);
1960 evicted
1961 } else {
1962 // Top-anchored sub-region: copy row 0, then region-scroll
1963 // `[0..=scroll_bottom]` (rows below stay fixed).
1964 //
1965 // #449: the fixed rows keep their GRID position while
1966 // scrollback grows, so their content's concatenated absolute
1967 // index shifts +1 — re-anchor the content-tracking anchors
1968 // (selection, markers; alacritty's swap-back of the fixed
1969 // bottom lines is the screen-relative equivalent of this)
1970 // and invalidate the query-derived highlights
1971 // (drop-not-re-anchor policy, #108). In-region and
1972 // scrollback content keeps stable indices — untouched.
1973 let below = self.scrollback.len() + self.scroll_bottom + 1;
1974 self.selection_shift_below_margin(below);
1975 self.markers_shift_below_margin(below);
1976 self.tracked_shift_below_margin(below);
1977 self.invalidate_search_highlights();
1978 let evicted = self.grid.row_owned(0);
1979 self.shift_region(
1980 self.scroll_top,
1981 self.scroll_bottom,
1982 false,
1983 true,
1984 serves_wrap,
1985 );
1986 evicted
1987 };
1988 self.scrollback.push_back(evicted);
1989 // Follow-bottom = stay: if the user is scrolled up, bump the
1990 // offset so the same lines stay in view instead of being yanked
1991 // to the bottom.
1992 if self.display_offset > 0 {
1993 self.display_offset = (self.display_offset + 1).min(self.scrollback.len());
1994 }
1995 // Cap: evict the oldest line past the limit. The view is anchored
1996 // to history, so dropping the front shifts the offset down too
1997 // (xterm.js trims ybase and ydisp together) — also keeps the
1998 // offset within `[0, len]`. The evicted row is parked for reuse.
1999 if self.scrollback.len() > self.scrollback_limit {
2000 self.recycled_row = self.scrollback.pop_front();
2001 // Every absolute index below just shifted by exactly one, which is
2002 // what makes this class of movement expressible as a scalar (#490).
2003 // Counted here rather than in `markers_evict_oldest` because the fact
2004 // is about the *buffer*, not about markers.
2005 //
2006 // **Scope, because the name over-promises.** This counts the
2007 // scrollback *cap* evicting one line. Reflow also drops lines off the
2008 // front (`PaneReflow::evicted`, installed by replacing the deque) and
2009 // is deliberately not counted: it moves the survivors non-uniformly,
2010 // so no delta repairs them and `marker_epoch` signals it instead. A
2011 // holder rebasing off this number *without* also watching the epoch
2012 // gets a wrong answer across every resize.
2013 self.evicted_total += 1;
2014 // Every absolute index just shifted down by one; move the
2015 // selection with it so its anchors keep their content.
2016 self.selection_evict_oldest();
2017 // Query-derived highlights can't survive the index shift (see
2018 // the method doc); selection re-anchors, highlights invalidate.
2019 self.invalidate_search_highlights();
2020 // Markers are persistent anchors: shift them down with the
2021 // index, disposing any whose line was the evicted one (#118).
2022 self.markers_evict_oldest();
2023 // Same obligation for a position held outside the engine — the
2024 // one holder in this space that had no fixup at all (#691).
2025 self.tracked_evict_oldest();
2026 if self.display_offset > 0 {
2027 // Scrolled up: evicting the oldest line advanced the
2028 // viewport, so it must be repainted (the "frozen while
2029 // scrolled" rule does not apply when the view itself moved).
2030 self.display_offset -= 1;
2031 self.mark_fully_damaged();
2032 }
2033 }
2034 } else {
2035 // Region (top margin > 0) or alt-screen scroll: the evicted line
2036 // does NOT enter scrollback, so content moves *within* the screen
2037 // and absolute indices in the region shift. Rotate the selection
2038 // up so it follows; an endpoint on the dropped line clears it.
2039 let base = self.scrollback.len();
2040 self.selection_rotate_region(
2041 base + self.scroll_top,
2042 base + self.scroll_bottom,
2043 true,
2044 );
2045 // Rotate the active buffer's markers with the content (#187):
2046 // per-buffer storage (#186) scopes them, so an alt scroll rotates
2047 // *alt* marks and leaves the frozen primary list untouched — no
2048 // guard needed. `markers_rotate_region` routes via `markers_mut`.
2049 self.markers_rotate_region(base + self.scroll_top, base + self.scroll_bottom, true);
2050 self.tracked_rotate_region(base + self.scroll_top, base + self.scroll_bottom, true);
2051 self.invalidate_search_highlights();
2052 self.shift_region(
2053 self.scroll_top,
2054 self.scroll_bottom,
2055 false,
2056 false,
2057 serves_wrap,
2058 );
2059 }
2060 } else if self.cursor.row + 1 < self.grid.rows() {
2061 self.cursor.row += 1;
2062 }
2063 }
2064
2065 /// DECSTBM (CSI r): set the top/bottom scroll margins (1-based inclusive).
2066 /// An invalid region (top ≥ bottom) is ignored.
2067 fn set_scroll_region(&mut self, top: usize, bottom: usize) {
2068 let bottom = bottom.min(self.grid.rows());
2069 if top >= bottom {
2070 return;
2071 }
2072 self.scroll_top = top - 1;
2073 self.scroll_bottom = bottom - 1;
2074 self.goto(0, 0); // DECSTBM homes the cursor (absolute)
2075 }
2076
2077 // ---- alt screen (DEC 1049) -----------------------------------------------
2078
2079 /// Enter the alternate screen: save the cursor, swap in the other grid, and
2080 /// clear it.
2081 /// Save the cursor into the alt-screen slot — `?1048` set, and the first
2082 /// half of `?1049` enter (#72).
2083 fn save_alt_cursor(&mut self) {
2084 self.saved_cursor = self.cursor;
2085 }
2086
2087 /// Restore the cursor from the alt-screen slot — `?1048` reset, and the
2088 /// second half of `?1049` leave. DECTCEM visibility is a standalone mode, not
2089 /// part of the save, so preserve it across the restore (#38/#72).
2090 fn restore_alt_cursor(&mut self) {
2091 let visible = self.cursor.visible;
2092 self.cursor = self.saved_cursor;
2093 self.cursor.visible = visible;
2094 }
2095
2096 /// Switch to the (cleared) alternate buffer without touching the cursor —
2097 /// `?47`/`?1047` set, and the second half of `?1049` enter (#72).
2098 fn switch_to_alt(&mut self) {
2099 if self.on_alt {
2100 return;
2101 }
2102 // The pulled index reports the ACTIVE buffer, so a swap changes what the
2103 // consumer's held answer even describes — with no line having moved (#490).
2104 // Gated on a marker existing on either side, since an empty index is already
2105 // correct for both buffers.
2106 if !self.normal_markers.is_empty() || !self.alt_markers.is_empty() {
2107 self.bump_marker_epoch();
2108 }
2109 std::mem::swap(&mut self.grid, &mut self.alt_grid);
2110 self.grid.clear();
2111 self.on_alt = true;
2112 self.display_offset = 0; // the alt screen has no scrollback to view
2113 self.selection = None; // a selection cannot survive a screen swap
2114 self.invalidate_search_highlights(); // matches index the primary buffer
2115 self.mark_fully_damaged();
2116 }
2117
2118 /// Switch back to the primary buffer without touching the cursor —
2119 /// `?47`/`?1047` reset, and the first half of `?1049` leave (#72).
2120 fn switch_to_primary(&mut self) {
2121 if !self.on_alt {
2122 return;
2123 }
2124 // Dispose the alt buffer's markers on leave — xterm `activateNormalBuffer`
2125 // → `clearAllMarkers` (#177 S0). Empty while the alt guards stand, so this
2126 // fires nothing today; it's the seam the alt-marker slices (#187) build on.
2127 for m in self.alt_markers.drain(..) {
2128 self.events.push(TermEvent::MarkerDisposed(m.id));
2129 }
2130 // Same fate for alt-scoped tracked points, and for the same reason: the alt
2131 // buffer is not archived, so leaving it destroys what they named (#691).
2132 // No announcement — `tracked_point` answers `None` on the next ask.
2133 // The pulled index reports the ACTIVE buffer, so a swap changes what the
2134 // consumer's held answer even describes — with no line having moved (#490).
2135 // Only `normal_markers` is asked: the drain above just emptied `alt_markers`, so
2136 // an `|| !alt_markers.is_empty()` disjunct would be dead code carrying a comment
2137 // that claims it reads "either side". What was alt-scoped left through
2138 // `MarkerDisposed`; what can still be stale is the primary population.
2139 if !self.normal_markers.is_empty() {
2140 self.bump_marker_epoch();
2141 }
2142 self.alt_tracked.clear();
2143 std::mem::swap(&mut self.grid, &mut self.alt_grid);
2144 self.on_alt = false;
2145 self.display_offset = 0; // return to the primary at its bottom
2146 self.selection = None; // a selection cannot survive a screen swap
2147 self.invalidate_search_highlights(); // matches index the swapped-out buffer
2148 self.mark_fully_damaged();
2149 }
2150
2151 fn enter_alt_screen(&mut self) {
2152 if self.on_alt {
2153 return;
2154 }
2155 self.save_alt_cursor();
2156 self.switch_to_alt();
2157 }
2158
2159 /// Leave the alternate screen: swap the primary grid back in and restore the
2160 /// saved cursor.
2161 fn leave_alt_screen(&mut self) {
2162 if !self.on_alt {
2163 return;
2164 }
2165 self.switch_to_primary();
2166 self.restore_alt_cursor();
2167 }
2168
2169 /// RI (ESC M): move up one line. At the top margin, scroll the region down
2170 /// instead.
2171 fn reverse_index(&mut self) {
2172 if self.cursor.row == self.scroll_top {
2173 // RI never enters scrollback; the region scrolls down within the
2174 // screen, so absolute indices in it shift down. Rotate the selection.
2175 let base = self.scrollback.len();
2176 self.selection_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2177 // Rotate the active buffer's markers (#187) — alt-scoped on the alt
2178 // screen, so no guard (see `linefeed`).
2179 self.markers_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2180 self.tracked_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2181 self.invalidate_search_highlights();
2182 self.shift_region(self.scroll_top, self.scroll_bottom, true, false, false);
2183 } else if self.cursor.row > 0 {
2184 self.cursor.row -= 1;
2185 }
2186 }
2187
2188 // ---- cursor save/restore (DECSC / DECRC) ---------------------------------
2189
2190 /// DECSC (ESC 7): save the cursor position, pen, pending-wrap, and origin
2191 /// mode. Visibility is not saved (DECTCEM is separate).
2192 fn save_cursor(&mut self) {
2193 self.decsc = SavedCursor {
2194 row: self.cursor.row,
2195 col: self.cursor.col,
2196 pen: self.cursor.pen,
2197 pending_wrap: self.cursor.pending_wrap,
2198 origin_mode: self.origin_mode,
2199 charsets: self.charsets,
2200 gl: self.gl,
2201 };
2202 }
2203
2204 /// DECRC (ESC 8): restore what DECSC saved. Origin mode is restored (per
2205 /// ADR-0004); visibility is left as-is. The position is clamped to the
2206 /// current screen in case it shrank since the save.
2207 fn restore_cursor(&mut self) {
2208 let s = self.decsc;
2209 self.cursor.row = s.row.min(self.grid.rows() - 1);
2210 self.cursor.col = s.col.min(self.grid.cols() - 1);
2211 self.cursor.pen = s.pen;
2212 self.cursor.pending_wrap = s.pending_wrap;
2213 self.origin_mode = s.origin_mode;
2214 self.charsets = s.charsets;
2215 self.gl = s.gl;
2216 }
2217
2218 /// RIS (ESC c) — full reset to the power-on state (#53). Reconstruct every
2219 /// screen/mode field to its construction default (preserving only the
2220 /// dimensions and the scrollback cap), but keep the consumer-bound output
2221 /// queues (`replies`/`events`) that accrued earlier in this `feed`, and
2222 /// signal a full repaint. The vte parser lives outside `Term`, so replacing
2223 /// `self` does not disturb in-progress parsing. Mirrors xterm.js fullReset.
2224 fn full_reset(&mut self) {
2225 let replies = std::mem::take(&mut self.replies);
2226 let mut events = std::mem::take(&mut self.events);
2227 // RIS wipes the buffer, so every marker's line is gone — announce each
2228 // disposal so the consumer drops its decorations (and isn't confused when
2229 // the reset id counter reissues the same ids). The events survive the
2230 // reset below (#118).
2231 events.extend(
2232 self.normal_markers
2233 .iter()
2234 .chain(&self.alt_markers)
2235 .map(|m| TermEvent::MarkerDisposed(m.id)),
2236 );
2237 let (cols, rows) = (self.grid.cols(), self.grid.rows());
2238 // The word-boundary set is consumer *policy* (ADR-0017), not terminal state, so
2239 // RIS does not own it — an application printing `reset` must not silently revert
2240 // a setting the embedder chose. It rides across with `replies`/`events` because
2241 // this reset rebuilds `Term` wholesale; the references never face the question,
2242 // holding the equivalent outside the object RIS clears (#545).
2243 let word_separators = std::mem::take(&mut self.word_separators);
2244 // Tracked points die here with everything else, but their *id counter*
2245 // rides across (#691). They have no disposal event — a holder learns its
2246 // point is gone by being told `None` — so a reissued id would answer a
2247 // stale ask with a *different* point's position, silently. The markers
2248 // above take the other route and announce; the counter is what a pull-only
2249 // handle has instead.
2250 let next_tracked_id = self.next_tracked_id;
2251 // The marker epoch rides across too, and then moves — for the reason one
2252 // paragraph up, now that a marker index is *pulled* as well as announced (#490).
2253 // A consumer re-pulls when the epoch differs; resetting it to 0 leaves it equal
2254 // to the value a quiet session already holds, so the one signal it watches would
2255 // not fire for the mutation that invalidates everything. `evicted_total`
2256 // legitimately restarts — the buffer it counted is gone — and the epoch change is
2257 // what stops the consumer rebasing against the old basis.
2258 let marker_epoch = self.marker_epoch;
2259 // Marker ids ride across for the *same* reason as `next_tracked_id`, which this
2260 // slice makes true of markers: a pulled handle outlives the announcement that
2261 // killed it, so a reissued id lets a stale `MarkerDisposed(7)` drop the live
2262 // post-RIS marker 7.
2263 let next_marker_id = self.next_marker_id;
2264 *self = Term::with_scrollback(cols, rows, self.scrollback_limit);
2265 self.replies = replies;
2266 self.events = events;
2267 self.word_separators = word_separators;
2268 self.next_tracked_id = next_tracked_id;
2269 self.next_marker_id = next_marker_id;
2270 self.marker_epoch = marker_epoch;
2271 self.bump_marker_epoch();
2272 self.mark_fully_damaged();
2273 }
2274
2275 /// DECSTR (CSI ! p) — soft reset (#53). Resets a defined subset of modes to
2276 /// their defaults *without* destroying screen content or scrollback, moving
2277 /// the active cursor, or touching the mouse/focus reporting subsystem. Per
2278 /// xterm.js softReset, autowrap returns to ON (the xterm default), not off.
2279 fn soft_reset(&mut self) {
2280 self.cursor.visible = true;
2281 self.cursor.pen = Pen::default();
2282 self.scroll_top = 0;
2283 self.scroll_bottom = self.grid.rows() - 1;
2284 self.origin_mode = false;
2285 self.app_cursor_keys = false;
2286 self.bracketed_paste = false;
2287 self.grapheme_clustering = false; // ?2027 back to the wcwidth-compat default (#295)
2288 self.autowrap = true; // xterm default is ON (not the VT100 "off")
2289 self.insert_mode = false;
2290 self.charsets = [Charset::Ascii; 4];
2291 self.gl = 0;
2292 self.decsc = SavedCursor::default();
2293 }
2294
2295 fn carriage_return(&mut self) {
2296 self.cursor.col = 0;
2297 self.cursor.pending_wrap = false;
2298 }
2299
2300 /// DECSCUSR (CSI Ps SP q): set the caret shape + blink (#89). 0/2 = steady
2301 /// block, 1 = blinking block; 3/4 = blinking/steady underline; 5/6 =
2302 /// blinking/steady bar (odd = blink). 0 resets to the default (steady block).
2303 /// An unknown param leaves the style unchanged. Mirrors xterm.js.
2304 fn set_cursor_style(&mut self, param: u16) {
2305 let (shape, blink) = match param {
2306 0 | 2 => (CursorShape::Block, false),
2307 1 => (CursorShape::Block, true),
2308 3 => (CursorShape::Underline, true),
2309 4 => (CursorShape::Underline, false),
2310 5 => (CursorShape::Bar, true),
2311 6 => (CursorShape::Bar, false),
2312 _ => return,
2313 };
2314 self.cursor.shape = shape;
2315 self.cursor.blink = blink;
2316 }
2317
2318 /// Backspace (BS, 0x08): move the cursor one column left. With reverse
2319 /// wraparound (?45) a backspace at column 0 of a *soft-wrapped* row moves
2320 /// back to the last column of the previous row — undoing one autowrap. Only
2321 /// soft wraps reverse (the previous row carries `WRAPLINE`); a hard CR/LF
2322 /// line does not. BS only (not cursor-left), matching xterm.js (#80).
2323 fn backspace(&mut self) {
2324 self.cursor.pending_wrap = false;
2325 if self.cursor.col > 0 {
2326 self.cursor.col -= 1;
2327 return;
2328 }
2329 if self.reverse_wraparound
2330 && self.cursor.row > self.scroll_top
2331 && self.cursor.row <= self.scroll_bottom
2332 {
2333 let prev = self.cursor.row - 1;
2334 let last = self.grid.cols() - 1;
2335 if self.grid.row_ref(prev).is_wrapped() {
2336 self.grid.row_mut(prev).set_wrapped(false);
2337 self.cursor.row = prev;
2338 self.cursor.col = last;
2339 }
2340 }
2341 }
2342
2343 /// Auto-wrap at end of line: line-feed then return to column 0.
2344 fn wrapline(&mut self) {
2345 self.linefeed_inner(true);
2346 self.cursor.col = 0;
2347 self.cursor.pending_wrap = false;
2348 }
2349
2350 // ---- tab stops (HT / HTS / TBC) ------------------------------------------
2351
2352 /// HT: advance to the next set tab stop, or the last column if none remain
2353 /// (no wrap).
2354 fn put_tab(&mut self) {
2355 let cols = self.grid.cols();
2356 let mut col = self.cursor.col;
2357 while col + 1 < cols {
2358 col += 1;
2359 if self.tabs[col] {
2360 break;
2361 }
2362 }
2363 self.cursor.col = col;
2364 self.cursor.pending_wrap = false;
2365 }
2366
2367 /// HTS (ESC H): set a tab stop at the cursor column.
2368 fn set_tab_stop(&mut self) {
2369 let col = self.cursor.col;
2370 self.tabs[col] = true;
2371 }
2372
2373 /// TBC (CSI g): clear the tab stop at the cursor (mode 0) or all stops
2374 /// (mode 3).
2375 fn clear_tab_stop(&mut self, mode: u16) {
2376 match mode {
2377 0 => {
2378 let col = self.cursor.col;
2379 self.tabs[col] = false;
2380 }
2381 3 => self.tabs.iter_mut().for_each(|t| *t = false),
2382 _ => {}
2383 }
2384 }
2385
2386 // ---- printing ------------------------------------------------------------
2387
2388 /// The extended attributes the pen currently stamps onto a cell it writes: the open OSC 8
2389 /// hyperlink (#26/#46) and a non-default underline colour (SGR 58, #520).
2390 ///
2391 /// The colour is gated on the UNDERLINE attribute — an underline colour is meaningless on a
2392 /// cell that draws no underline, and xterm likewise does not persist it there
2393 /// (`AttributeData isEmpty()` ignores the colour; `InputHandler.test.ts:2084`). That keeps
2394 /// it off the wire for cells that never draw it (ADR-0020: no inert per-cell payload). SGR 58
2395 /// is the *underline* colour, so STRIKETHROUGH alone does not arm it.
2396 ///
2397 /// One place, because there are three sites that write a pen-built cell (the glyph, its wide
2398 /// spacer, and the vacated wrap column) — mirroring the pen half of `Row::ext_attrs_at`, so a
2399 /// later rider is added here rather than at each of them (#521/#528).
2400 fn pen_ext_attrs(&self) -> ExtAttrs {
2401 let ucolor = self.cursor.pen.underline_color;
2402 let armed =
2403 ucolor != Color::Default && self.cursor.pen.flags.contains(CellFlags::UNDERLINE);
2404 ExtAttrs::from_pen(self.current_link.clone(), armed.then_some(ucolor))
2405 }
2406
2407 /// Free a cell that has stopped being part of a glyph — the *structural repair* every
2408 /// overwrite, erase and row-shift owes the no-orphan invariant when it destroys one half of
2409 /// a width-2 glyph, plus the spacer a mode-2027 demotion no longer needs.
2410 ///
2411 /// This is **not** an erase. The app asked for something at a *different* column; freeing
2412 /// this one is the engine keeping its own invariant. But it is still a mutation, so it
2413 /// **damages** — and that is the half every site used to forget, because each function
2414 /// damaged its own range and the repaired cell lies outside it by construction (that is what
2415 /// makes it a repair). A frame-mode consumer therefore kept painting the destroyed glyph.
2416 /// Bundling the reset with its damage is the point of this helper: a repair site added later
2417 /// cannot forget the half that has no compiler behind it (#530).
2418 ///
2419 /// The cell it leaves is a **blank carrying the current background** — the same rule
2420 /// `clear_cells` already applies to a BCE erase, extended to the repair, so one sentence
2421 /// covers both: *a blank cell carries the current background.* A bare `Cell::default()`
2422 /// would punch an uncoloured notch into a coloured run, which no reference implementation
2423 /// does.
2424 ///
2425 /// Deliberately the pen's **background only** — not its full attributes, and this is not a
2426 /// compromise between references: it is byte-for-byte xterm.js's `_eraseAttrData()`
2427 /// (`DEFAULT_ATTR_DATA` + `curAttr.bg & ~0xFC000000`, i.e. default everything plus the pen's
2428 /// background colour), which is what its `replaceCells` / `insertCells` / `deleteCells`
2429 /// repairs are handed — eight of the twelve sites here. Only xterm's *print* path uses the
2430 /// whole pen. Taking the whole pen
2431 /// (xterm.js `setCellFromCodepoint(x, 0, 1, curAttr)`) would plant the pen's hyperlink and,
2432 /// worse, its DECSCA protection onto a cell the app never wrote — a cell no later erase could
2433 /// clear. Taking the *cell's own* attributes (alacritty `clear_wide`, which keeps `extra`)
2434 /// would leave the destroyed glyph's hyperlink alive and clickable, the defect #529 is filed
2435 /// against. Both were considered and rejected; the maintainer chose this on 2026-07-24 and it
2436 /// is theirs to reverse (see #530 for what they were shown).
2437 ///
2438 /// What used to be recorded here as a known limitation is **resolved** (#538, ADR-0025 D1):
2439 /// `reset()` still clears the whole content word, but the soft-wrap link is no longer part of
2440 /// it. The live flag is on the `Row`, so freeing the last column — here or on the erase path —
2441 /// cannot break a wrap; `CellFlags::WRAPLINE` is wire-only, derived onto the last cell at
2442 /// encode time and never read back (`cell.rs`). Ending a wrap is now an explicit per-verb call
2443 /// (`end_wrap`), which is the shape both references already had and the reason the move was
2444 /// made: ghostty and xterm.js hold the flag on the row/line, and xterm.js takes `clearWrap` as
2445 /// an explicit argument on its erase helper (`_eraseInBufferLine`, `InputHandler.ts:1175`)
2446 /// rather than letting a cell clear decide it.
2447 ///
2448 /// Known cost, accepted rather than overlooked: with DECSCA the freed cell loses its
2449 /// protection. ghostty has the same hole and flags it in its own source; justerm does not
2450 /// implement DECSCA today, so revisit if it lands.
2451 fn free_cell(&mut self, row: usize, col: usize) {
2452 let bg = self.cursor.pen.bg;
2453 let cell = self.grid.cell_mut(row, col);
2454 cell.reset();
2455 cell.set_bg(bg);
2456 // As in `clear_cells`: the bits are gone, so release what they gated (#628).
2457 self.grid.row_mut(row).purge_side_maps(col..col + 1);
2458 self.damage_span(row, col, col);
2459 }
2460
2461 /// Will the next `wrapline()` actually reach another row?
2462 ///
2463 /// `wrapline` → `linefeed` advances in exactly two cases: the cursor sits at the scroll
2464 /// region's bottom (so the region scrolls under it), or it has a row below it on screen.
2465 /// Parked *below* a DECSTBM region on the last row it does neither — it silently stays put.
2466 ///
2467 /// Both wide-at-boundary paths must ask before they commit anything, because both destroy
2468 /// content on the assumption that the row is about to change: `write_glyph` blanks the column
2469 /// it is leaving, and `relocate_cluster_wide` writes its cluster to `(cursor.row, 0..=1)`
2470 /// *after* the wrap — which is the same row when nothing advanced, so it lands on live cells.
2471 /// Reasoning only about the vacated source column misses that second case entirely.
2472 ///
2473 /// This mirrors `linefeed`'s own condition; the two must be read together.
2474 fn wrapline_advances(&self) -> bool {
2475 self.cursor.row == self.scroll_bottom || self.cursor.row + 1 < self.grid.rows()
2476 }
2477
2478 /// Blank the last column as the soft-wrap artefact it is, when a width-2 glyph could not fit
2479 /// there (#528). Shared by the two paths that reach this state: `write_glyph`'s wide-at-boundary
2480 /// wrap and `relocate_cluster_wide`'s promoted cluster.
2481 ///
2482 /// The column is **written**, not merely flagged: a blank built from the current pen, exactly
2483 /// as every reference does it — xterm.js `setCellFromCodepoint(col, 0, 1, curAttr)`
2484 /// (`InputHandler.ts:609-611`; `BufferLine.ts:244-251` takes the pen's fg/bg *and* its
2485 /// `extended` link/colour), ghostty `printCell(0, .spacer_head)` (`Terminal.zig:1410-1412`,
2486 /// whose `printCell` stamps the cursor's hyperlink), alacritty `write_at_cursor(' ')` under a
2487 /// `LEADING_WIDE_CHAR_SPACER` template (`mod.rs:1108-1113`, assigning `extra` from it).
2488 ///
2489 /// Flagging in place instead left the previous occupant's glyph, hyperlink and underline colour
2490 /// alive in a cell every text reader skips — so a renderer drew a character that could not be
2491 /// copied, searched or announced (#528). Building from `Pen::cell` also clears the presence
2492 /// bits, so no stale side-map entry can be read back through the new cell.
2493 ///
2494 /// WRAPLINE marks the row a continuation rather than a hard line-end (search, logical lines
2495 /// #113 and reflow #7 all read it); the leading-spacer marker makes the text extractors skip
2496 /// the blank instead of joining `"ab한"` → `"ab 한"`.
2497 ///
2498 /// The marker is **alacritty's** `LEADING_WIDE_CHAR_SPACER` (`term/cell.rs`) — ghostty calls
2499 /// the same thing `.spacer_head`. It is *not* xterm's: xterm.js has no marker at all, writing
2500 /// a bare null cell and re-inferring the artefact at reflow time from "ends in null and the
2501 /// following line starts with a wide char". That difference has a consequence here — in
2502 /// xterm.js a lost marker degrades to an empty cell that trimming drops anyway, whereas
2503 /// justerm writes `' '`, so the marker is the *only* thing keeping this column out of the
2504 /// extracted text.
2505 fn vacate_for_wrap(&mut self, row: usize, col: usize) {
2506 // Writing this column makes the vacate an overwrite like any other, so it inherits the
2507 // no-orphan obligation every other overwrite site carries (`write_glyph`,
2508 // `promote_cluster_to_wide`, `insert_chars`, `delete_chars`, the erase path): if the
2509 // column was the *spacer* of a wide glyph, blanking it destroys the spacer marker and
2510 // strands the lead. That is unrecoverable rather than merely untidy — every repair path
2511 // keys off `is_wide_spacer()`, so once the marker is gone no later write, ECH, EL, ICH
2512 // or DCH can ever clear the orphan.
2513 if col > 0 && self.grid.cell(row, col).is_wide_spacer() {
2514 self.free_cell(row, col - 1);
2515 }
2516 let mut vacated = self.cursor.pen.cell(' ');
2517 vacated.set_leading_spacer();
2518 *self.grid.cell_mut(row, col) = vacated;
2519 self.begin_wrap(row);
2520 let ext = self.pen_ext_attrs();
2521 self.grid.row_mut(row).set_ext_attrs(col, ext);
2522 // The cell's contents changed, so a frame-mode consumer must be told or it keeps painting
2523 // the old glyph (ADR-0003: every mutation site records damage). The *repaired* lead above
2524 // is damaged by `free_cell`, which owns that pairing for all twelve repair sites — this
2525 // site used to hand-roll it, and keeping both left neither able to discriminate.
2526 self.damage_span(row, col, col);
2527 }
2528
2529 /// Write one glyph at the cursor, handling deferred wrap and the wide-char
2530 /// spacer, then advance the cursor (deferring the wrap if it hits the edge).
2531 fn write_glyph(&mut self, c: char, width: usize) {
2532 // Every wide branch below is gated on `width == 2`, and the four unguarded uses
2533 // (`insert_chars`, `col + width - 1` twice, the cursor advance) assume the same bound.
2534 // The caller coerces (#595); this states the assumption at the site that holds it, so a
2535 // future second caller fails a test rather than writing an unmarked run of blanks.
2536 // Ghostty pairs its own source-side clamp with the same assertion for the same reason
2537 // (`Terminal.zig`, *"it is possible to have a width of 3 … assert(width <= 2)"*).
2538 debug_assert!(
2539 width <= 2,
2540 "write_glyph({c:?}, {width}) — the cell model represents at most a pair"
2541 );
2542 let cols = self.grid.cols();
2543
2544 // Resolve a deferred last-column wrap before placing the next glyph.
2545 // The row being left soft-wrapped: mark its last cell so reflow (#7) can
2546 // tell it from a hard CR/LF line-end.
2547 if self.cursor.pending_wrap {
2548 let row = self.cursor.row;
2549 // Claim the wrap only if there will *be* a next row to continue into. Parked below a
2550 // DECSTBM region on the last row, `wrapline` → `linefeed` advances nothing and the
2551 // glyph overwrites this same row from column 0 — so the wrap never happened, and a
2552 // flag set here is permanently false: the cursor never leaves, nothing clears it, and
2553 // it survives into `backspace`'s reverse-wraparound, reflow, and every text reader.
2554 //
2555 // The predicate is not new and neither is its rationale: `wrapline_advances` was
2556 // written for exactly this state and is already asked by both wide-at-boundary paths.
2557 // This narrow path was the one caller that committed without asking. (Surfaced by the
2558 // #540 completeness pass, which found a row-shift verb inheriting the bogus flag and
2559 // merging two unrelated logical lines.)
2560 if self.wrapline_advances() {
2561 self.begin_wrap(row);
2562 }
2563 self.wrapline();
2564 }
2565
2566 // A width-2 glyph that cannot fit in the last column wraps first — unless
2567 // autowrap is off, in which case it is dropped (xterm.js `continue`), not
2568 // squeezed or wrapped.
2569 if width == 2 && self.cursor.col + 1 >= cols {
2570 if !self.autowrap {
2571 return;
2572 }
2573 // …but only if the wrap actually happens: vacating for a wrap that never occurs
2574 // blanks a column holding a live glyph.
2575 if self.wrapline_advances() {
2576 self.vacate_for_wrap(self.cursor.row, cols - 1);
2577 }
2578 self.wrapline();
2579 }
2580
2581 // Insert mode (IRM): open a `width`-wide gap at the cursor first, shifting
2582 // the row's tail right (off-edge cells discarded, wide halves repaired),
2583 // then write into the gap — mirrors xterm.js's insertCells (#64).
2584 if self.insert_mode {
2585 self.insert_chars(width);
2586 }
2587
2588 let (row, col) = (self.cursor.row, self.cursor.col);
2589
2590 // Overwriting either half of a pair that wrapped from the row above ends that pair, so the
2591 // row above's artefact record is void (#534). The one exception is the in-place same-width
2592 // overwrite — a wide lead replaced by another wide lead at the same column — which is
2593 // ghostty's `if (cell.wide != wide)` escape and the reason this is asked *before* the
2594 // write rather than after it. Note IRM has already run its own check inside `insert_chars`
2595 // by the time this would fire, on the pre-shift state, which is the correct one.
2596 if col <= 1 && self.wrapped_pair_at_row_start(row) && !(col == 0 && width == 2) {
2597 self.void_wrap_artefact_above(row);
2598 }
2599
2600 // Overwriting one half of an existing wide glyph orphans the other —
2601 // clear it so no stray lead/spacer is left behind.
2602 let last = col + width - 1;
2603 if col > 0 && self.grid.cell(row, col).is_wide_spacer() {
2604 self.free_cell(row, col - 1);
2605 }
2606 if last + 1 < cols && self.grid.cell(row, last).is_wide() {
2607 self.free_cell(row, last + 1);
2608 }
2609
2610 let mut cell = self.cursor.pen.cell(c);
2611 if width == 2 {
2612 cell.insert_flags(CellFlags::WIDE_CHAR);
2613 }
2614 *self.grid.cell_mut(row, col) = cell;
2615 // Stamp the pen's extended attrs — the open hyperlink (#26/#46) and a non-default
2616 // underline colour (#520) — into the row's side maps.
2617 let ext = self.pen_ext_attrs();
2618 // `.clone()`: `ExtAttrs` stopped being `Copy` at #628 (the link rider is a shared
2619 // `Arc<str>`), and the spacer below stamps the same value — a refcount bump, not
2620 // a second string.
2621 self.grid.row_mut(row).set_ext_attrs(col, ext.clone());
2622
2623 // The trailing column of a wide glyph carries a distinct spacer marker —
2624 // and the same link + underline colour, so a hover/selection/underline over
2625 // either half agrees.
2626 if width == 2 && col + 1 < cols {
2627 let mut spacer = self.cursor.pen.cell(' ');
2628 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
2629 *self.grid.cell_mut(row, col + 1) = spacer;
2630 self.grid.row_mut(row).set_ext_attrs(col + 1, ext);
2631 }
2632
2633 // Record damage for the cell(s) just written.
2634 self.damage_span(row, col, col + width - 1);
2635
2636 // Advance. Reaching/passing the last column sets pending-wrap instead of
2637 // wrapping eagerly — the cursor parks on the last column.
2638 let new_col = col + width;
2639 if new_col >= cols {
2640 self.cursor.col = cols - 1;
2641 // With autowrap off (DECAWM ?7l) the cursor pins to the last column
2642 // and the next glyph overwrites in place — no deferred wrap (#63).
2643 self.cursor.pending_wrap = self.autowrap;
2644 } else {
2645 self.cursor.col = new_col;
2646 }
2647 }
2648
2649 /// Attach a combining mark (width-0 code point) to the grapheme it modifies —
2650 /// the cell the cursor just left. With pending-wrap the cursor still sits on
2651 /// the just-written last-column glyph, so attach in place (no back-up, no
2652 /// deferred wrap); otherwise step back one column, and once more over a
2653 /// wide-char spacer to reach its lead. Stored in the grapheme side-table.
2654 fn push_combining(&mut self, c: char) {
2655 let row = self.cursor.row;
2656 let mut col = if self.cursor.pending_wrap {
2657 self.cursor.col
2658 } else {
2659 self.cursor.col.saturating_sub(1)
2660 };
2661 if self.grid.cell(row, col).is_wide_spacer() {
2662 col = col.saturating_sub(1);
2663 }
2664 // Append the mark to the row's combining map at this column (setting the
2665 // cell's combining bit). No global pool — the cluster rides the row.
2666 self.grid.row_mut(row).push_combining(col, c);
2667 self.damage_span(row, col, col);
2668 }
2669
2670 /// Mode 2027 (#295): if `c` **extends** the previous cell's grapheme cluster (UAX #29), append
2671 /// it to that cell's side-table — no new cell, no cursor advance — and return `true`. Otherwise
2672 /// return `false` so `print` takes the normal per-scalar path (a break starts a new cell).
2673 ///
2674 /// The break state is reconstructed fresh from the previous cell's stored cluster (base scalar +
2675 /// side-table marks) rather than persisted across calls, so cursor moves / CR-LF can't corrupt
2676 /// it (mirrors ghostty). Width promotion for a narrow base (a flag's second RI, a text-base +
2677 /// VS16) is handled by the caller in a later step; here the base's existing width holds.
2678 fn try_grapheme_join(&mut self, c: char) -> bool {
2679 let row = self.cursor.row;
2680 // Locate the previous cluster's base cell, exactly as `push_combining`: with pending-wrap
2681 // the cursor still sits on the last glyph; else step back one, and over a wide spacer.
2682 let col = if self.cursor.pending_wrap {
2683 self.cursor.col
2684 } else if self.cursor.col == 0 {
2685 return false; // nothing precedes on this row
2686 } else {
2687 self.cursor.col - 1
2688 };
2689 let col = if self.grid.cell(row, col).is_wide_spacer() {
2690 col.saturating_sub(1)
2691 } else {
2692 col
2693 };
2694 // Reconstruct the previous cluster's text: base scalar + any already-joined scalars.
2695 let mut prev = String::new();
2696 prev.push(self.grid.cell(row, col).c());
2697 if let Some(marks) = self.grid.row_ref(row).combining_at(col) {
2698 prev.extend(marks.iter().copied());
2699 }
2700 if !crate::grapheme::grapheme_extends(&prev, c) {
2701 return false;
2702 }
2703 // Join: ride the side-table (no new cell).
2704 self.grid.row_mut(row).push_combining(col, c);
2705 // Width promotion: a flag's second regional indicator, or a text-base + VS16, grows the
2706 // cluster to width 2. `UnicodeWidthStr` gives the cluster width (RI-pair → 2, VS16 → 2). If
2707 // the base cell is still narrow, widen it in place.
2708 let cluster_w = {
2709 prev.push(c);
2710 UnicodeWidthStr::width(prev.as_str())
2711 };
2712 if cluster_w == 2 && !self.grid.cell(row, col).is_wide() {
2713 self.promote_cluster_to_wide(row, col);
2714 } else if cluster_w == 1 && self.grid.cell(row, col).is_wide() {
2715 // The mirror case: a default-wide emoji + VS15 (text selector) shrinks to width 1.
2716 self.demote_cluster_to_narrow(row, col);
2717 }
2718 self.damage_span(row, col, col);
2719 true
2720 }
2721
2722 /// Shrink a wide cluster cell back to a single-width cell (#295): a default-wide emoji joined by
2723 /// VS15 (U+FE0E, the text selector) requests text presentation → width 1. Remove `WIDE_CHAR`,
2724 /// free the spacer, and back the cursor up over it (the inverse of `promote_cluster_to_wide`).
2725 fn demote_cluster_to_narrow(&mut self, row: usize, col: usize) {
2726 let cols = self.grid.cols();
2727 self.grid
2728 .cell_mut(row, col)
2729 .remove_flags(CellFlags::WIDE_CHAR);
2730 if col + 1 < cols {
2731 self.free_cell(row, col + 1); // free the now-unused spacer
2732 }
2733 // The cluster shrank 2→1: the cursor sat just past the wide cell (col+2, or pending-wrap on
2734 // the last column); it now sits just past the single-width cell at col+1.
2735 self.cursor.pending_wrap = false;
2736 self.cursor.col = (col + 1).min(cols - 1);
2737 self.damage_span(row, col, (col + 1).min(cols - 1));
2738 }
2739
2740 /// Widen a narrow base cell to a double-width cluster in place (#295): set `WIDE_CHAR`, write
2741 /// its spacer, and step the cursor over it. Only reached when a joining scalar (flag's 2nd RI,
2742 /// VS16) promotes the cluster to width 2. A base pinned at the last column has no room for a
2743 /// spacer — relocation is a later step; until then it stays narrow (rare, renders single-width).
2744 fn promote_cluster_to_wide(&mut self, row: usize, col: usize) {
2745 let cols = self.grid.cols();
2746 if col + 1 >= cols {
2747 // No spacer room at the last column: relocate the whole cluster to the next line as a
2748 // wide cell (the row soft-wraps), mirroring write_glyph's wide-at-boundary wrap (#303).
2749 self.relocate_cluster_wide(row, col);
2750 return;
2751 }
2752 // Overwriting col+1 with the spacer can orphan the far half of a WIDE glyph standing there
2753 // (the cursor may have been repositioned before the joining scalar arrived). Reset that
2754 // orphan, exactly as write_glyph does (2462-2470), so no dangling spacer survives.
2755 if self.grid.cell(row, col + 1).is_wide() && col + 2 < cols {
2756 self.free_cell(row, col + 2);
2757 }
2758 self.grid
2759 .cell_mut(row, col)
2760 .insert_flags(CellFlags::WIDE_CHAR);
2761 // The spacer is the lead's second half, so it takes the LEAD's extended attrs — the
2762 // hyperlink and underline colour riding the row's side maps — exactly as write_glyph
2763 // stamps both halves of a wide write. `pen.cell(' ')` carries neither (and the pen may
2764 // have moved on since the base was printed), so they are re-attached here; a base with
2765 // none clears whatever the overwritten column held (#521).
2766 let ext = self.grid.row_ref(row).ext_attrs_at(col);
2767 let mut spacer = self.cursor.pen.cell(' ');
2768 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
2769 *self.grid.cell_mut(row, col + 1) = spacer;
2770 self.grid.row_mut(row).set_ext_attrs(col + 1, ext);
2771 // The cursor sat at col+1 (just past the narrow base); move it over the new spacer, applying
2772 // the same last-column pending-wrap rule as a wide write.
2773 let new_col = col + 2;
2774 if new_col >= cols {
2775 self.cursor.col = cols - 1;
2776 self.cursor.pending_wrap = self.autowrap;
2777 } else {
2778 self.cursor.col = new_col;
2779 }
2780 self.damage_span(row, col, col + 1);
2781 }
2782
2783 /// Relocate a last-column narrow cluster to the next line as a wide cell (#303): its base +
2784 /// side-table marks move to `(next_row, 0..=1)` and the vacated last column becomes a soft-wrap
2785 /// (WRAPLINE + leading spacer), exactly as `write_glyph` wraps a wide glyph that can't fit. With
2786 /// autowrap off it stays narrow.
2787 ///
2788 /// The destination is an **overwrite**, so it owes the no-orphan repair every other overwrite
2789 /// site owes (#529, ADR-0025 D4) — see the comment at that site for why justerm restates it
2790 /// once per wide-writing path where the references get it structurally.
2791 ///
2792 /// The `cols < 2` arm is **unreachable since #547** —
2793 /// `MIN_COLUMNS = 2` is the floor on every path that sets a width — and is kept only as a
2794 /// bounds guard for the `col + 1` writes below, not as a described behaviour.
2795 fn relocate_cluster_wide(&mut self, row: usize, col: usize) {
2796 let cols = self.grid.cols();
2797 if cols < 2 || !self.autowrap || !self.wrapline_advances() {
2798 // Nowhere to place a wide cell — leave it narrow. `!wrapline_advances()` joins the
2799 // other two for the same reason: with no next row, the relocation would write the
2800 // cluster over columns 0-1 of the *current* row and destroy whatever is there.
2801 return;
2802 }
2803 // Capture the base cell (glyph + attrs), its marks, and its extended attrs before
2804 // vacating. The extended attrs (hyperlink, underline colour) must be read HERE and not
2805 // after the move: they live in the *source row's* side maps, and `wrapline()` below may
2806 // scroll — after which that row is a different (or recycled) `Row` (#521).
2807 let base = *self.grid.cell(row, col);
2808 let marks: Vec<char> = self
2809 .combining_at(row, col)
2810 .map(<[char]>::to_vec)
2811 .unwrap_or_default();
2812 let ext = self.grid.row_ref(row).ext_attrs_at(col);
2813 // Vacate the last column as a soft-wrap artefact — the same step `write_glyph` takes for a
2814 // wide glyph that cannot fit, and now literally the same code, so the two cannot drift
2815 // apart again (#528; they held opposite behaviours until then).
2816 self.vacate_for_wrap(row, col);
2817 // Advance to the next line (scrolls if at the bottom); cursor lands at col 0.
2818 self.wrapline();
2819 let nr = self.cursor.row;
2820 // The destination is an overwrite like any other, so it owes the same no-orphan repair
2821 // `write_glyph` performs for its own trailing column (#529, D4): the spacer about to land
2822 // on `(nr, 1)` half-destroys a wide glyph standing there, stranding its far half at
2823 // `(nr, 2)` — a `WIDE_CHAR_SPACER` with no lead to its left, still carrying the destroyed
2824 // glyph's hyperlink and underline colour. Asked *before* the writes, on the pre-write
2825 // state, exactly as `write_glyph`'s `last + 1` check is.
2826 //
2827 // Two of the three references have this exact site, and both repair it without a rule of
2828 // their own, because they write a pair as two *separate* cell writes and the repair lives
2829 // in the write:
2830 // - xterm.js names the case outright — *"Combining character widens 1 column to 2. Move
2831 // old character to next line."* (`InputHandler.ts:583-611` @ 699f553,
2832 // `copyCellsFrom(oldRow, oldCol, 0, oldWidth, false)` at `:605-607`). The relocation
2833 // leaves `x == 2`, so its once-per-run right-edge repair (`:668-669`) lands on exactly
2834 // the orphaned column.
2835 // - ghostty relocates in `Terminal.zig:1188-1252` @ e6e26e1 and reaches the repair
2836 // through `cursorRight(1); printCell(0, .spacer_tail)` (`:1251-1252`) — that second
2837 // `printCell` runs the `cell.wide != wide` switch (`:1484`) whose `.wide` arm clears
2838 // the neighbouring lead's tail (`:1489-1499`).
2839 // - alacritty has **no** counterpart: a width-0 codepoint returns early through
2840 // `push_zerowidth` (`term/mod.rs:1069-1085` @ 852e971), so a cluster never changes
2841 // width and nothing is ever relocated. Its orphan repair (`:994-1008`) is still the
2842 // mechanism reference, reached the same way — one repair per `write_at_cursor`.
2843 // justerm writes both halves in one step, so the repair is not structural here and each
2844 // wide-writing path restates it — this is the third (`write_glyph`,
2845 // `promote_cluster_to_wide`, and now the relocation).
2846 //
2847 // What justerm does **not** copy is ghostty's reach-back at this site: its `.wide` arm
2848 // also clears the previous row's `.spacer_head` (`:1504-1506`, gated `cursor.y > 0 and
2849 // cursor.x <= 1`) — the very marker this relocation set seven statements earlier
2850 // (`:1200`). Derived from source, not executed. Suppressing it here is #534's rule
2851 // verbatim: a repair keyed on a state predicate must not fire while that state is
2852 // mid-construction.
2853 //
2854 // The other two obligations `write_glyph` carries are N/A here, recorded because an
2855 // unexplained omission is what gets re-litigated:
2856 // - the *left*-orphan repair asks `col > 0`, and the lead lands at column 0.
2857 // - `void_wrap_artefact_above(nr)` would clear a record that `vacate_for_wrap` **just
2858 // set**, in both the advance case (`nr == row + 1`, so its target `nr - 1` is `row`)
2859 // and the scroll case (`nr == row`, the source rotated up to `row - 1`). Firing it
2860 // would be self-clobbering, not merely redundant — the same shape as #534's
2861 // mid-construction rule. Measured after a repairing relocation: `is_row_wrapped(0)`
2862 // and `(0, cols-1).is_leading_spacer()` both hold.
2863 //
2864 // `2 < cols` is a live bound, not defence in depth. The print paths cannot leave a
2865 // `WIDE_CHAR` lead in the last column — `write_glyph` wraps rather than write one there
2866 // and `promote_cluster_to_wide` relocates rather than promote in place — but `Row::resize`
2867 // can: the alt screen resizes without reflowing (#567), so truncating a row through a pair
2868 // strands its lead in the final column. The relocation then meets `is_wide() == true` at
2869 // `cols == 2`, and without the bound reads `(nr, 2)` on a two-column grid — an
2870 // out-of-bounds panic in a library, inside a consumer's process, reachable by shrinking a
2871 // window over a CJK glyph. Pinned by `min_columns.rs::
2872 // a_relocation_beside_a_truncated_wide_lead_does_not_index_past_the_row`.
2873 if 2 < cols && self.grid.cell(nr, 1).is_wide() {
2874 self.free_cell(nr, 2);
2875 }
2876 // Re-place the base as a wide lead + spacer, re-attaching the marks fresh (drop the combining
2877 // bit so push_combining starts a clean cluster at the new column).
2878 let mut lead = base;
2879 lead.set_combined(false);
2880 lead.insert_flags(CellFlags::WIDE_CHAR);
2881 *self.grid.cell_mut(nr, 0) = lead;
2882 for m in marks {
2883 self.grid.row_mut(nr).push_combining(0, m);
2884 }
2885 // Re-attach the extended attrs to BOTH halves at the new row. `lead` copied the base's
2886 // presence bits but not its map entries, so without this the bit is set with nothing
2887 // behind it — the read is gated and silently returns the default, and the frame stops
2888 // round-tripping (the cell encodes as linked with no index).
2889 self.grid.row_mut(nr).set_ext_attrs(0, ext.clone());
2890 let mut spacer = self.cursor.pen.cell(' ');
2891 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
2892 *self.grid.cell_mut(nr, 1) = spacer;
2893 self.grid.row_mut(nr).set_ext_attrs(1, ext);
2894 // Cursor just past the wide cell (pending-wrap if it fills a 2-column row).
2895 if cols <= 2 {
2896 self.cursor.col = cols - 1;
2897 self.cursor.pending_wrap = self.autowrap;
2898 } else {
2899 self.cursor.col = 2;
2900 self.cursor.pending_wrap = false;
2901 }
2902 self.damage_span(nr, 0, 1);
2903 }
2904
2905 // ---- cursor movement (CSI A/B/C/D/G/d/H/f) -------------------------------
2906
2907 fn move_up(&mut self, n: usize) {
2908 self.cursor.row = self.cursor.row.saturating_sub(n);
2909 self.cursor.pending_wrap = false;
2910 }
2911
2912 fn move_down(&mut self, n: usize) {
2913 self.cursor.row = (self.cursor.row + n).min(self.grid.rows() - 1);
2914 self.cursor.pending_wrap = false;
2915 }
2916
2917 fn move_forward(&mut self, n: usize) {
2918 self.cursor.col = (self.cursor.col + n).min(self.grid.cols() - 1);
2919 self.cursor.pending_wrap = false;
2920 }
2921
2922 fn move_back(&mut self, n: usize) {
2923 self.cursor.col = self.cursor.col.saturating_sub(n);
2924 self.cursor.pending_wrap = false;
2925 }
2926
2927 fn set_col(&mut self, col: usize) {
2928 self.cursor.col = col.min(self.grid.cols() - 1);
2929 self.cursor.pending_wrap = false;
2930 }
2931
2932 fn set_row(&mut self, row: usize) {
2933 self.cursor.row = row.min(self.grid.rows() - 1);
2934 self.cursor.pending_wrap = false;
2935 }
2936
2937 fn goto(&mut self, row: usize, col: usize) {
2938 // Origin mode addresses rows relative to the scroll region's top margin
2939 // and clamps to its bottom; otherwise rows are absolute to the screen.
2940 let (offset, max_row) = if self.origin_mode {
2941 (self.scroll_top, self.scroll_bottom)
2942 } else {
2943 (0, self.grid.rows() - 1)
2944 };
2945 self.cursor.row = (row + offset).min(max_row);
2946 self.cursor.col = col.min(self.grid.cols() - 1);
2947 self.cursor.pending_wrap = false;
2948 }
2949
2950 // ---- erase (CSI J / K) ---------------------------------------------------
2951
2952 /// Clear cells `from..to` on `row`.
2953 ///
2954 /// Background Color Erase (BCE): erased cells carry the current SGR
2955 /// background only — fg and text attributes reset to default (matches
2956 /// xterm/alacritty, where the fill is `cursor.template.bg.into()`).
2957 ///
2958 /// **Cleared concern, with its validity condition — an empty range would break the pair
2959 /// invariant.** With `from == to` the first guard below still frees the lead at `from - 1`
2960 /// while the second is skipped (`to > from` is false) and the fill loop does nothing, so the
2961 /// spacer at `from` would survive its lead — an ADR-0025 D4 break, and the exact lead-less
2962 /// orphan the word walk must then treat as opaque. This is unreachable **as long as every
2963 /// caller passes a non-empty range**, which holds today: `ECH` clamps to
2964 /// `(col + n).min(cols)` with `n >= 1` (both `CSI X` and `CSI 0 X` erase one cell), and every
2965 /// `EL`/`ED` site passes `0..cols` or `0..=cursor`. A future caller that can pass an empty
2966 /// range must guard here first.
2967 fn clear_cells(&mut self, row: usize, from: usize, to: usize) {
2968 let cols = self.grid.cols();
2969 // Erasing either half of a pair that wrapped from the row above ends it, so that row's
2970 // artefact record is void (#534). `from <= 1` rather than `from == 0` because erasing from
2971 // column 1 destroys the spacer and the no-orphan repair below then frees the lead. ghostty
2972 // reaches the same row from its erase path — `Screen.splitCellBoundary`'s `x == 0 or x ==
2973 // 1` branch (`Screen.zig:1873` @ `e6e26e1`), called from `eraseChars` (`Terminal.zig:3159`).
2974 if from <= 1 && to > from && self.wrapped_pair_at_row_start(row) {
2975 self.void_wrap_artefact_above(row);
2976 }
2977 // Don't orphan a wide char straddling the erase boundary.
2978 if from > 0 && self.grid.cell(row, from).is_wide_spacer() {
2979 self.free_cell(row, from - 1);
2980 }
2981 if to > from && to < cols && self.grid.cell(row, to - 1).is_wide() {
2982 self.free_cell(row, to);
2983 }
2984
2985 let bg = self.cursor.pen.bg;
2986 for col in from..to {
2987 let cell = self.grid.cell_mut(row, col);
2988 cell.reset();
2989 cell.set_bg(bg);
2990 }
2991 // `reset` cleared the presence bits; this releases what they gated (#628).
2992 self.grid.row_mut(row).purge_side_maps(from..to);
2993 if to > from {
2994 self.damage_span(row, from, to - 1);
2995 }
2996 }
2997
2998 /// End `row`'s soft wrap, because something just destroyed the content that was continuing
2999 /// onto the next row.
3000 ///
3001 /// Which verbs owe this is **not** derivable from the erased range — it is a per-verb rule,
3002 /// and both references spell it out call site by call site rather than inferring it:
3003 ///
3004 /// | verb | ends the wrap? | xterm | ghostty |
3005 /// |---|---|---|---|
3006 /// | `EL 0` (erase right) | **yes**, at any column | `ClearRight` → `LineClrWrapped` unconditionally (`util.c:1871`) | `cursorResetWrap()` in `eraseLine(.right)` |
3007 /// | `ECH` | **yes**, at any column | same `ClearRight` (`util.c:1961`) | `cursorResetWrap()` in `eraseChars` |
3008 /// | `DCH` | **yes** | `screen.c` | `cursorResetWrap()` — *"Our row's soft-wrap is always reset"* |
3009 /// | `EL 1` (erase left) | no | `ClearLeft`, no clear | no |
3010 /// | `ICH` | no | no | no |
3011 ///
3012 /// The shape behind the three that do: each destroys content **from the cursor rightward**, so
3013 /// "this row continues past its last column" can no longer be asserted. Erasing leftward or
3014 /// inserting blanks leaves the tail — and whatever it flowed into — intact.
3015 ///
3016 /// **`EL 2` is a deliberate divergence.** justerm ends the wrap; xterm does not (`ClearLine`,
3017 /// `util.c:1905`, has no `LineClrWrapped`) and ghostty copies that with a comment naming it —
3018 /// *"it seems like complete should reset the soft-wrap state of the line but in xterm it does
3019 /// not."* justerm differs because it *joins* logical lines for `accessible_text` / `search` /
3020 /// selection text, so a blanked-but-still-wrapped row visibly merges two lines in copy — a
3021 /// consequence xterm does not carry. Recorded rather than silently matched or silently
3022 /// Mark `row` as soft-wrapping into the next one — and damage the cell the bit rides on.
3023 ///
3024 /// The exact mirror of [`Term::end_wrap`], and it exists for the mirror of that function's
3025 /// reason. The flag lives on the `Row` (#538) and reaches a consumer only as the last cell's
3026 /// `WRAPLINE`, derived at encode time. Every other cell-carried fact changes when that cell is
3027 /// written, so damage covers it for free; this one does not, and a `Partial` frame would never
3028 /// ship the bit — a frame-mode consumer rebuilding logical lines from cells then keeps the two
3029 /// rows *split* forever, the exact dual of the "joined forever" that `end_wrap` guards.
3030 ///
3031 /// `end_wrap` took that obligation in #540; the set side never did. It stayed invisible because
3032 /// a wrap normally moves the cursor to the next row, and `frame_damage` tops the frame up with
3033 /// the old cursor cell. When a **scroll serves the wrap** the cursor keeps its row index, so
3034 /// nothing tops it up — which is how #557 surfaced it.
3035 ///
3036 /// Damaging here rather than at each caller is what keeps this true for set sites added later,
3037 /// the same argument `end_wrap`'s comment makes.
3038 fn begin_wrap(&mut self, row: usize) {
3039 self.grid.row_mut(row).set_wrapped(true);
3040 let last = self.grid.cols() - 1;
3041 self.damage_span(row, last, last);
3042 }
3043
3044 /// diverged; see #538.
3045 fn end_wrap(&mut self, row: usize) {
3046 self.grid.row_mut(row).set_wrapped(false);
3047 // The flag is stored on the `Row` but rides the wire on the row's **last cell**, derived
3048 // at encode time. Every other cell-carried fact changes only when that cell is written,
3049 // so damage covers it for free; this one does not, and a `Partial` frame would never
3050 // re-ship the bit — leaving a frame-mode consumer with two rows joined forever. Damaging
3051 // here rather than at each caller is what keeps that true for call sites added later.
3052 let last = self.grid.cols() - 1;
3053 self.damage_span(row, last, last);
3054 // The wrap artefact goes with the wrap. The marker's claim is "the last column is the
3055 // blank a width-2 glyph vacated **because this row continues onto the next**", so a row
3056 // that stops continuing cannot hold one (ADR-0025 D3 — position is part of the test, and
3057 // so is the wrap it is positioned in). Coupling the two here is what makes the row-shift
3058 // seams and every wrap-ending erase a single rule instead of a clear per verb: ghostty
3059 // couples them in one function the same way — `Screen.cursorResetWrap`
3060 // (`terminal/Screen.zig:1524` @ `e6e26e1`, spacer-head clear at `:1539-1545`), reached from
3061 // `deleteChars` / `eraseChars` / `eraseLine`. It early-returns on `if (!page_row.wrap)`;
3062 // this one clears unconditionally, which is strictly safer.
3063 //
3064 // Most callers erase through this column anyway, so the clear is redundant for them; the
3065 // ones it is *not* redundant for are the row-shift seams (#540's `shift_region`, which
3066 // ends a wrap without touching a cell) and `delete_chars`, whose marker rides the shift.
3067 // The leftward erases are the mirror case — they blank this column while the wrap
3068 // legitimately survives — and go through `drop_artefact_if_erased` instead.
3069 //
3070 // One wrap-ending path deliberately does *not* reach here: `shift_region`'s `top == 0`
3071 // seam, whose row is in scrollback rather than the grid. It couples the same two clears
3072 // inline; see the comment there.
3073 self.grid.cell_mut(row, last).clear_leading_spacer();
3074 }
3075
3076 /// The pair that wrapped into `row` is about to be destroyed or moved, so the artefact record
3077 /// on the row **above** it is void — drop it. **Call before the mutation.**
3078 ///
3079 /// The marker makes a claim with two clauses: this row soft-wraps (owned by `end_wrap`), and
3080 /// its last column is the blank *that specific pair* vacated. This is the second clause, and
3081 /// the rule behind every call site is one sentence: **the record survives only an in-place
3082 /// same-width overwrite.** Anything else that reaches columns 0/1 of the continuation — a
3083 /// narrow write, an erase, a shift in either direction — ends the pair the record was about,
3084 /// and a wide lead that arrives afterwards by some other route did not *wrap* from anywhere.
3085 ///
3086 /// Both references gate on that, and both gate on the state **before** the write rather than
3087 /// after it:
3088 ///
3089 /// - ghostty `Terminal.zig:1484` @ `e6e26e1` — the whole wide-repair `switch` sits under
3090 /// `if (cell.wide != wide)`, so a wide glyph overwritten by another wide glyph skips it; the
3091 /// reach-back stanza then appears in the `.wide` (`:1501-1506`) and `.spacer_tail`
3092 /// (`:1529-1532`) arms only.
3093 /// - alacritty `term/mod.rs:994` @ `852e971` — the reach-back at `:1004-1008` is inside
3094 /// `if cursor_cell.flags.intersects(WIDE_CHAR | WIDE_CHAR_SPACER)`, but with no
3095 /// width-unchanged escape, so it drops a record that is still true. Alacritty is the outlier
3096 /// of the two and justerm follows ghostty.
3097 ///
3098 /// Asking *after* the mutation instead looks equivalent and is not: it answers "is some wide
3099 /// lead standing at column 0", which a `DCH` that pulls the *next* wide glyph left also
3100 /// satisfies, and which a two-step placement (a narrow base promoted to wide by VS16 under
3101 /// mode 2027, or IRM's insert-then-write) satisfies only at the end. Both were measured
3102 /// disagreeing with the rule above before this took its current form.
3103 ///
3104 /// The erase and intra-row-shift call sites are **ported, not derived**: ghostty's
3105 /// `Screen.splitCellBoundary` (`Screen.zig:1831`, the `x == 0 or x == 1` branch at `:1873`)
3106 /// reaches up one row and clears the previous row's spacer head, and it is called from
3107 /// `deleteChars` (`Terminal.zig:3107-3109`) and `eraseChars` (`:3159-3160`). Only justerm's
3108 /// `ICH` site has no counterpart — ghostty's `insertBlanks` (`:2988`) calls it nowhere.
3109 ///
3110 /// `row == 0` does not mean "no row above": on the primary screen the text readers walk
3111 /// `[scrollback ++ grid]` as one buffer (`abs_floor() == 0`), so the row above grid row 0 is
3112 /// the last **scrollback** row and it can carry the marker. Alacritty reaches the same row for
3113 /// the same reason — its `topmost_line()` is `Line(-history_size)` (`grid/mod.rs:504`), so
3114 /// `point.line - 1` indexes into history; ghostty is the one that stops at the viewport
3115 /// (`cursor.y > 0`). On the alt screen `abs_floor()` is the screen top, so no join crosses the
3116 /// boundary and there is nothing to repair.
3117 ///
3118 /// No damage is owed by either branch, and for a stronger reason than #540's: the marker is a
3119 /// `content` bit outside `CONTENT_MARKER_MASK`, so `Cell::flags()` never sees it and it does
3120 /// not cross the wire at all. The `damage_span` below is defensive, not load-bearing.
3121 fn void_wrap_artefact_above(&mut self, row: usize) {
3122 if row > 0 {
3123 let last = self.grid.cols() - 1;
3124 if self.grid.cell(row - 1, last).is_leading_spacer() {
3125 self.grid.cell_mut(row - 1, last).clear_leading_spacer();
3126 self.damage_span(row - 1, last, last);
3127 }
3128 } else if !self.on_alt
3129 && let Some(cell) = self.scrollback.back_mut().and_then(|r| r.last_mut())
3130 {
3131 cell.clear_leading_spacer();
3132 }
3133 }
3134
3135 /// Is a wide pair standing at columns 0..=1 of `row` — i.e. is there a record for
3136 /// `void_wrap_artefact_above` to void? A cheap pre-mutation test the four call sites share, so
3137 /// the rule lives in one place rather than being re-derived per verb (ADR-0025 D2).
3138 fn wrapped_pair_at_row_start(&self, row: usize) -> bool {
3139 self.grid.cell(row, 0).is_wide()
3140 }
3141
3142 /// Drop a wide-wrap artefact marker that has outlived the wrap it belonged to, without
3143 /// touching the wrap itself.
3144 ///
3145 /// The mirror of the marker clean-up inside `end_wrap`, for the verbs that erase *leftward*:
3146 /// `EL 1` and `ED 1` correctly leave the wrap alone (the row's tail still flows onward), but
3147 /// they can still clear the last column, and then the artefact's blank turns into visible
3148 /// text that a reflow bakes in permanently. Only the marker goes; the wrap is the caller's
3149 /// business.
3150 fn drop_artefact_if_erased(&mut self, row: usize, from: usize, to: usize) {
3151 let last = self.grid.cols() - 1;
3152 if from <= last && to > last {
3153 self.grid.cell_mut(row, last).clear_leading_spacer();
3154 }
3155 }
3156
3157 /// Shift `[top..=bottom]` by one line — up unless `down` — and end the wraps the shift
3158 /// falsified. Every row-shifting verb (IL/DL/SU/SD and the region paths in LF/RI) goes
3159 /// through here so the repair cannot be forgotten at a call site (ADR-0025 D2).
3160 ///
3161 /// The wrap flag claims "this row continues into the **next** row", so it is a statement about
3162 /// *adjacency*, and rotating whole `Row`s keeps it true for free: both halves of a pair inside
3163 /// the region move by the same line, so the claim still describes the same neighbour. Only the
3164 /// two seams falsify it, where a row's next neighbour changed underneath it:
3165 ///
3166 /// - **`top - 1`**, just outside the region. Its continuation rotated away (up-shift) or was
3167 /// pushed down (down-shift), so whatever now sits at `top` is a stranger. This is the seam
3168 /// that merges two unrelated logical lines in copy/search/accessible text (#540's repro).
3169 /// - **the row that lost its continuation to the blank** — `bottom - 1` after an up-shift (the
3170 /// blank lands at `bottom`), `bottom` after a down-shift (its continuation rotated up to
3171 /// `top` and was blanked there). The down-shift form is the one that reaches *outside* the
3172 /// region: the stale claim points at `bottom + 1`, a row the verb never touched.
3173 ///
3174 /// Damaging matters as much as clearing, and `end_wrap` does both: `top - 1` is outside the
3175 /// region, so the scroll op the caller records does not cover it and a `Partial` frame would
3176 /// never re-ship the derived `WRAPLINE` bit.
3177 ///
3178 /// **Each seam has exactly one exemption, and both are facts about the caller that this
3179 /// function cannot see** — which is why they are parameters rather than tests:
3180 ///
3181 /// - `evicts_to_scrollback` exempts the **top** seam: a linefeed pushes row 0 into scrollback,
3182 /// so the readers' `[scrollback ++ grid]` walk finds the continuation one row further back
3183 /// and adjacency survives.
3184 /// - `serves_wrap` exempts the **bottom** seam: the shift was asked for by `wrapline`, so the
3185 /// blank it exposes at `bottom` is not a stranger that displaced a continuation — it *is*
3186 /// the continuation, about to be written into (#557).
3187 ///
3188 /// Both are one-sided on purpose. A wrap-serving scroll still falsifies the top seam, and a
3189 /// scrollback-evicting linefeed still falsifies the bottom one when no wrap asked for it.
3190 ///
3191 /// **No reference implements this rule**, so it is derived rather than ported — ADR-0004, the
3192 /// spec is the authority for VT semantics, above any implementation:
3193 ///
3194 /// - **ghostty** clears the wrap on *every* row a full-width IL/DL touches
3195 /// (`terminal/Terminal.zig:2746-2752`, `:2906-2912` @ `e6e26e1`). The clear runs *before* the
3196 /// row swap at `:2936-2939`, so both ends stay false: an interior pair is split, not
3197 /// preserved. It still never reaches the row above the shifted range.
3198 /// - **alacritty** has no `WRAPLINE` clear on any scroll path (@ `852e971`).
3199 /// - **xterm.js** splices whole line objects and never touches `isWrapped`
3200 /// (`common/InputHandler.ts:1345-1402` @ `699f553`). Its opposite polarity — "I continue the
3201 /// *previous* row" (`common/buffer/Buffer.ts:566-570`) — moves the exposure to the mirrored
3202 /// seam rather than removing it: a spliced-in line keeps a continuation claim about a
3203 /// predecessor it never met.
3204 ///
3205 /// The seam row's wide-wrap *marker* is the same shift's other half, and it now rides along:
3206 /// `end_wrap` clears both (#534), and the `top == 0` branch below — the one seam whose row is
3207 /// not a grid row — couples them inline for the same reason.
3208 ///
3209 /// **Validity condition for clearing at the seams rather than everywhere.** ghostty clears the
3210 /// wrap and the spacer head on *every* row a full-width IL/DL touches, and its own comment
3211 /// gives two reasons: it splits interior pairs, **and** it supports left/right margins
3212 /// (DECSLRM), where a partial-row shift can break an interior pair without moving its
3213 /// neighbour. justerm rotates whole `Row`s and implements no DECSLRM, so an interior pair and
3214 /// its continuation always move together and seam-only is sound. If left/right margins ever
3215 /// land, this rule and #534's marker rule break at the same time — neither is safe under a
3216 /// shift that moves part of a row.
3217 fn shift_region(
3218 &mut self,
3219 top: usize,
3220 bottom: usize,
3221 down: bool,
3222 evicts_to_scrollback: bool,
3223 serves_wrap: bool,
3224 ) {
3225 if down {
3226 self.grid.scroll_down_region(top, bottom);
3227 } else {
3228 self.grid.scroll_up_region(top, bottom);
3229 }
3230 // Recording the scroll op is part of shifting, not a step a caller adds after: damage is
3231 // indexed by row position, so `record_scroll` rotates `line_damage` with the content. A
3232 // seam clear damaged *before* that rotation is carried to the wrong row — and on a
3233 // down-shift it lands on `top`, which `record_scroll` immediately overwrites with
3234 // `fully_damaged`. The clear then never reaches the wire at all: the model splits the
3235 // rows, a `Partial` frame does not say so, and the consumer keeps them joined forever.
3236 // Ordering it here is what makes that unrepeatable at a sixth call site.
3237 self.record_scroll(top, bottom, if down { -1 } else { 1 });
3238 if top > 0 {
3239 self.end_wrap(top - 1);
3240 } else if !evicts_to_scrollback && !self.on_alt {
3241 // `top == 0` does not mean "no row above": on the primary the text readers walk
3242 // `[scrollback ++ grid]` as one buffer (`abs_floor() == 0`), so the row above grid row
3243 // 0 is the last *scrollback* row and it can wrap into the screen. A full-screen SU /
3244 // DL / RI therefore leaves this issue's defect one row higher, outside the grid.
3245 //
3246 // `evicts_to_scrollback` is what keeps `linefeed` out: it pushes grid row 0 into
3247 // scrollback, so the continuation is re-attached one row further back and the claim
3248 // stays true — clearing there would split a line the scroll preserved. On the alt
3249 // screen `abs_floor()` is the screen top, so no join crosses the boundary at all.
3250 //
3251 // No damage is owed with the clear, unlike `end_wrap`'s grid form: a scrollback row
3252 // only reaches the wire while `display_offset > 0`, and there `damage()` returns an
3253 // empty `Partial` (`term.rs`, the frozen-viewport short-circuit) while any scroll that
3254 // *moves* the viewport marks full damage. Valid as long as that short-circuit holds.
3255 //
3256 // The artefact marker goes with the wrap here exactly as it does in `end_wrap`, and
3257 // this branch is the reason that coupling cannot simply live in `end_wrap`: it is the
3258 // one wrap-ending path whose row is not a grid row, so it does not call it. Leaving it
3259 // out left #534's defect alive one row above the grid — reachable from every
3260 // `scroll_region_lines` verb, since all of them pass `evicts_to_scrollback: false`,
3261 // and visible as a word selection one cell too wide plus a reflow that bakes the
3262 // stranded marker mid-row.
3263 if let Some(row) = self.scrollback.back_mut() {
3264 row.set_wrapped(false);
3265 if let Some(cell) = row.last_mut() {
3266 cell.clear_leading_spacer();
3267 }
3268 }
3269 }
3270 // The blank lands at `bottom` going up and at `top` going down, so the row that lost its
3271 // continuation is the one just above it. Going down that is `top - 1`, already cleared
3272 // above; going up it is `bottom - 1`, which for a one-row region is that same row.
3273 //
3274 // The up-shift form needs the `bottom + 1` guard, and it is not defensive — without it the
3275 // clear destroys a **live** wrap. A row at the screen's bottom edge that wraps is the
3276 // ordinary soft-wrap-at-the-last-row state: `wrapline` sets the flag and the linefeed
3277 // scrolls precisely so the continuation has somewhere to land, which is the *next* row
3278 // after this shift. Its claim is about a row that does not exist yet, so the shift makes it
3279 // true rather than false.
3280 //
3281 // **The rest of that guard's original rationale was too narrow, and #557 is what it cost.**
3282 // It read: *"the link is only broken when there is a stationary row below the region
3283 // (`bottom + 1 < rows`): then the continuation stayed put while its lead moved up."* A
3284 // stationary row below is **necessary but not sufficient**. At a *region's* bottom the same
3285 // wrapline-asked-for scroll happens with `bottom + 1 < rows` perfectly true, and the clear
3286 // then split the logical line the scroll existed to continue. The geometry was never the
3287 // discriminator; **why the shift is happening** is — which is what `serves_wrap` carries.
3288 //
3289 // The guard stays anyway: it is the screen-bottom case of the same fact, and it also holds
3290 // for a *non*-wrap-serving linefeed at the screen edge.
3291 //
3292 // One invariant is still worth naming, because it was not true when this guard was first
3293 // written: **a row only claims a wrap if a next row will exist for it**. A row parked below
3294 // a DECSTBM region kept a permanent false claim, and this guard preserved it — the #540
3295 // completeness pass merged two unrelated logical lines through exactly that hole. The claim
3296 // is now gated at its set site (`write_glyph` asks `wrapline_advances`), so the guard's
3297 // premise holds. Valid as long as that gate stays.
3298 let orphaned = if serves_wrap {
3299 // The blank this shift just exposed is the continuation the wrap is waiting for, so
3300 // there is nothing to falsify — see the `serves_wrap` note on `linefeed_inner` (#557).
3301 None
3302 } else if down {
3303 Some(bottom)
3304 } else if bottom + 1 < self.grid.rows() {
3305 bottom.checked_sub(1)
3306 } else {
3307 None
3308 };
3309 if let Some(row) = orphaned {
3310 self.end_wrap(row);
3311 }
3312 }
3313
3314 fn erase_display(&mut self, mode: u16) {
3315 let (cols, rows) = (self.grid.cols(), self.grid.rows());
3316 let (cr, cc) = (self.cursor.row, self.cursor.col);
3317 match mode {
3318 0 => {
3319 // Erases this row's tail and every row below, so nothing can continue from here
3320 // — and the rows below cannot continue either.
3321 self.clear_cells(cr, cc, cols);
3322 self.end_wrap(cr);
3323 for row in (cr + 1)..rows {
3324 self.clear_cells(row, 0, cols);
3325 self.end_wrap(row);
3326 }
3327 }
3328 1 => {
3329 // Leftward: this row's tail survives, so its own wrap does. The rows *above* are
3330 // gone entirely.
3331 for row in 0..cr {
3332 self.clear_cells(row, 0, cols);
3333 self.end_wrap(row);
3334 }
3335 self.clear_cells(cr, 0, cc + 1);
3336 self.drop_artefact_if_erased(cr, 0, cc + 1);
3337 // Covering the whole row means nothing continues from it. xterm.js has a
3338 // dedicated arm for exactly this case, in its own words: *"Deleted entire
3339 // previous line. This next line can no longer be wrapped."*
3340 // (`InputHandler.ts:1248-1252` — under its continuation polarity that assignment
3341 // is this engine's `end_wrap(cr)`.) `EL 1` has no such arm there, and none here.
3342 if cc + 1 == cols {
3343 self.end_wrap(cr);
3344 }
3345 }
3346 2 => {
3347 for row in 0..rows {
3348 self.clear_cells(row, 0, cols);
3349 self.end_wrap(row);
3350 }
3351 }
3352 // Notably **`3` (ED 3, erase scrollback) is not implemented** and falls through
3353 // here as a no-op. Recorded rather than filed, because an unimplemented verb is
3354 // not a defect — but whoever implements it inherits an obligation that is invisible
3355 // from this site (#660's completeness pass): it would be the first verb that
3356 // shortens the buffer *from the front* by N lines, so it needs both an anchor
3357 // fixup (selection, markers **and** tracked points are absolute-from-oldest — three
3358 // holders since #691, and the third has no frame to make its drift visible) and a `display_offset`
3359 // clamp. Without the second, `selection_range`'s `scrollback.len() - display_offset`
3360 // underflows — and so do the same expressions in `viewport_line`,
3361 // `viewport_link_at` and `match_spans`. alacritty's `ClearMode::Saved` arm does
3362 // both (`term/mod.rs:1806-1811`).
3363 _ => {}
3364 }
3365 }
3366
3367 /// Erase in line (EL): 0 = cursor→end, 1 = start→cursor, 2 = whole line.
3368 fn erase_line(&mut self, mode: u16) {
3369 let cols = self.grid.cols();
3370 let (cr, cc) = (self.cursor.row, self.cursor.col);
3371 match mode {
3372 // Erase right — ends the wrap at any column (xterm's `ClearRight`).
3373 0 => {
3374 self.clear_cells(cr, cc, cols);
3375 self.end_wrap(cr);
3376 }
3377 // Erase left — the tail survives, so the wrap does. The artefact marker does not:
3378 // if the erase reached the last column it just blanked the cell the marker described.
3379 1 => {
3380 self.clear_cells(cr, 0, cc + 1);
3381 self.drop_artefact_if_erased(cr, 0, cc + 1);
3382 }
3383 // Erase the whole line — see `end_wrap`: a deliberate divergence from xterm.
3384 2 => {
3385 self.clear_cells(cr, 0, cols);
3386 self.end_wrap(cr);
3387 }
3388 _ => {}
3389 }
3390 }
3391
3392 // ---- intra-line editing (ICH / DCH / ECH) --------------------------------
3393
3394 /// ECH (CSI Pn X): erase `n` cells in place from the cursor — no shift.
3395 /// BCE-filled (via `clear_cells`); pending-wrap is left untouched.
3396 fn erase_chars(&mut self, n: usize) {
3397 let cols = self.grid.cols();
3398 let (row, col) = (self.cursor.row, self.cursor.col);
3399 let to = (col + n).min(cols);
3400 self.clear_cells(row, col, to);
3401 // Destroys content from the cursor rightward, so the row can no longer be continuing —
3402 // unconditionally, at any column and for any `n`. Both references do exactly this (see
3403 // `end_wrap`): xterm routes ECH through the same `ClearRight` as `EL 0`, ghostty calls
3404 // `cursorResetWrap()` in `eraseChars`.
3405 self.end_wrap(row);
3406 }
3407
3408 /// ICH (CSI Pn @): insert `n` blanks at the cursor, shifting the rest of the
3409 /// line right; cells pushed past the right edge are lost. The opened gap is
3410 /// BCE-filled; pending-wrap is left untouched.
3411 fn insert_chars(&mut self, n: usize) {
3412 let cols = self.grid.cols();
3413 let (r, col) = (self.cursor.row, self.cursor.col);
3414 let n = n.min(cols - col);
3415 if n == 0 {
3416 return;
3417 }
3418 // Shifting a wrapped pair out of columns 0/1 ends it, so the row above's artefact record
3419 // is void (#534). Asked **before** the shift, which is what keeps IRM correct: `write_glyph`
3420 // routes its wide-at-boundary insert through here *after* `vacate_for_wrap` has just set
3421 // the marker on the row above, and a post-shift test would see the freshly blanked gap and
3422 // clear the marker inside its own SET site's critical section. Pre-shift the question is
3423 // about the pair that was actually there, which is the one the record is about.
3424 if col <= 1 && self.wrapped_pair_at_row_start(r) {
3425 self.void_wrap_artefact_above(r);
3426 }
3427 let bg = self.cursor.pen.bg;
3428 let row = self.grid.row_mut(r);
3429 // Shift [col .. cols-n) right by n; the tail falls off the edge. The
3430 // combining map follows the moved cells (the bit travels with the raw
3431 // copy, the cluster data must too).
3432 row.copy_within(col..cols - n, col + n);
3433 row.move_maps(col..cols - n, col + n);
3434 for cell in &mut row[col..col + n] {
3435 cell.reset();
3436 cell.set_bg(bg);
3437 }
3438 // Repair wide-char halves split at the seams (no-orphan invariant):
3439 // a lead just before the gap lost its spacer; the first shifted cell may
3440 // be a spacer whose lead did not move.
3441 if col > 0 && self.grid.cell(r, col - 1).is_wide() {
3442 self.free_cell(r, col - 1);
3443 }
3444 if col + n < cols && self.grid.cell(r, col + n).is_wide_spacer() {
3445 self.free_cell(r, col + n);
3446 }
3447 // A lead shifted to the last column lost its spacer off the edge.
3448 if self.grid.cell(r, cols - 1).is_wide() {
3449 self.free_cell(r, cols - 1);
3450 }
3451 // Note ICH needs no repair to *this* row's marker: a right shift always pushes the last
3452 // column off the edge, so it discards a marker rather than carrying one inward —
3453 // measured, and pinned by `ich_discards_the_marker_off_the_edge`.
3454 self.damage_span(r, col, cols - 1);
3455 }
3456
3457 /// DCH (CSI Pn P): delete `n` cells at the cursor, shifting the tail left; the
3458 /// vacated cells at the right are BCE-blanked. Pending-wrap is left untouched.
3459 fn delete_chars(&mut self, n: usize) {
3460 let cols = self.grid.cols();
3461 let (r, col) = (self.cursor.row, self.cursor.col);
3462 let n = n.min(cols - col);
3463 if n == 0 {
3464 return;
3465 }
3466 // The shift pulls the tail left and blanks the far end, so the row stops continuing —
3467 // ghostty says it outright (*"Our row's soft-wrap is always reset"* in `deleteChars`,
3468 // `Terminal.zig:3133` @ `e6e26e1`).
3469 //
3470 // **Before the shift, not after** (#534): `end_wrap` clears the artefact marker at the
3471 // *last* column, and the marker is a cell bit that the shift carries inward with every
3472 // other cell. Ending the wrap afterwards would clear a column the marker has already left,
3473 // stranding it mid-row where it describes nothing (ADR-0025 D3) and silently swallows the
3474 // blank between two runs in copy, search and accessible text. Same shape as #540's
3475 // `record_scroll` ordering: the clear has to happen where the state still is.
3476 self.end_wrap(r);
3477 // Deleting a wrapped pair out of columns 0/1 ends it, so the row above's artefact record
3478 // is void — and this is where the "ask before, not after" rule earns its keep twice over:
3479 // a `DCH` can pull the *next* wide glyph left into column 0, which a post-shift "is a wide
3480 // lead standing here?" test happily accepts even though the pair the record was about has
3481 // been deleted. ghostty asks the same question at the same point:
3482 // `Screen.splitCellBoundary(cursor.x)` from `deleteChars` (`Terminal.zig:3107` @ `e6e26e1`),
3483 // whose `x == 0 or x == 1` branch reaches up a row and clears the spacer head.
3484 if col <= 1 && self.wrapped_pair_at_row_start(r) {
3485 self.void_wrap_artefact_above(r);
3486 }
3487 let bg = self.cursor.pen.bg;
3488 let row = self.grid.row_mut(r);
3489 // Shift [col+n .. cols) left to [col ..); BCE-fill the vacated tail. The
3490 // combining map follows the moved cells.
3491 row.copy_within(col + n..cols, col);
3492 row.move_maps(col + n..cols, col);
3493 for cell in &mut row[cols - n..cols] {
3494 cell.reset();
3495 cell.set_bg(bg);
3496 }
3497 // Repair wide-char halves split by the deletion (no-orphan invariant):
3498 // a lead just before the cut lost its spacer; the cell now at the cursor
3499 // may be a spacer whose lead was deleted.
3500 if col > 0 && self.grid.cell(r, col - 1).is_wide() {
3501 self.free_cell(r, col - 1);
3502 }
3503 if self.grid.cell(r, col).is_wide_spacer() {
3504 self.free_cell(r, col);
3505 }
3506 self.damage_span(r, col, cols - 1);
3507 }
3508
3509 // ---- line/region editing (IL / DL / SU / SD) -----------------------------
3510
3511 /// Scroll rows `[top..=bottom]` by `n` lines, BCE-filling the exposed lines.
3512 /// `down` inserts blanks at the top (content moves down); otherwise content
3513 /// moves up and blanks appear at the bottom. Reuses the one-line region scroll
3514 /// primitives (so damage + scroll-op accumulation come for free), then fills
3515 /// the exposed lines with the current SGR background.
3516 fn scroll_region_lines(&mut self, top: usize, bottom: usize, n: usize, down: bool) {
3517 let height = bottom - top + 1;
3518 let n = n.min(height);
3519 if n == 0 {
3520 return;
3521 }
3522 // Anchors (selection #3, markers #118/#158) live at absolute buffer lines;
3523 // SU/SD/IL/DL don't accrue scrollback, so `base` is stable across the loop.
3524 let base = self.scrollback.len();
3525 for _ in 0..n {
3526 self.shift_region(top, bottom, down, false, false);
3527 // Rotate anchors with the content, like `linefeed`/`reverse_index`
3528 // (#162). `up` = content moved up = the non-`down` case. Markers rotate
3529 // with the active buffer (#187) — alt-scoped on the alt screen, so no
3530 // guard. **The selection is unguarded here for the same reason, not because
3531 // "it is cleared on alt enter"** — that was this comment's claim until #660 and
3532 // it is false: a selection made while the alt screen is up is ordinary, it does
3533 // reach this line, and rotating it is correct, because the content really did
3534 // move under it. The code was right; only its stated reason was wrong.
3535 self.selection_rotate_region(base + top, base + bottom, !down);
3536 self.markers_rotate_region(base + top, base + bottom, !down);
3537 self.tracked_rotate_region(base + top, base + bottom, !down);
3538 }
3539 self.invalidate_search_highlights();
3540 // BCE-fill the n exposed lines (the primitives blank to default).
3541 let bg = self.cursor.pen.bg;
3542 let (fill_top, fill_end) = if down {
3543 (top, top + n)
3544 } else {
3545 (bottom + 1 - n, bottom + 1)
3546 };
3547 let cols = self.grid.cols();
3548 for r in fill_top..fill_end {
3549 for c in 0..cols {
3550 let cell = self.grid.cell_mut(r, c);
3551 cell.reset();
3552 cell.set_bg(bg);
3553 }
3554 }
3555 }
3556
3557 /// SU (CSI Pn S): scroll the scroll region up by `n`.
3558 fn scroll_up_lines(&mut self, n: usize) {
3559 self.scroll_region_lines(self.scroll_top, self.scroll_bottom, n, false);
3560 }
3561
3562 /// SD (CSI Pn T): scroll the scroll region down by `n`.
3563 fn scroll_down_lines(&mut self, n: usize) {
3564 self.scroll_region_lines(self.scroll_top, self.scroll_bottom, n, true);
3565 }
3566
3567 /// IL (CSI Pn L): insert `n` blank lines at the cursor, scrolling
3568 /// `[cursor..=scroll_bottom]` down. A no-op when the cursor is outside the
3569 /// scroll region.
3570 fn insert_lines(&mut self, n: usize) {
3571 let cur = self.cursor.row;
3572 if cur < self.scroll_top || cur > self.scroll_bottom {
3573 return;
3574 }
3575 self.scroll_region_lines(cur, self.scroll_bottom, n, true);
3576 }
3577
3578 /// DL (CSI Pn M): delete `n` lines at the cursor, scrolling
3579 /// `[cursor..=scroll_bottom]` up. A no-op when the cursor is outside the
3580 /// scroll region.
3581 fn delete_lines(&mut self, n: usize) {
3582 let cur = self.cursor.row;
3583 if cur < self.scroll_top || cur > self.scroll_bottom {
3584 return;
3585 }
3586 self.scroll_region_lines(cur, self.scroll_bottom, n, false);
3587 }
3588
3589 // ---- SGR (CSI m) ---------------------------------------------------------
3590
3591 fn sgr(&mut self, params: &Params) {
3592 let pen = &mut self.cursor.pen;
3593 let mut iter = params.iter();
3594 while let Some(param) = iter.next() {
3595 let code = param.first().copied().unwrap_or(0);
3596 match code {
3597 0 => pen.reset(),
3598 1 => pen.flags.insert(CellFlags::BOLD),
3599 2 => pen.flags.insert(CellFlags::DIM),
3600 3 => pen.flags.insert(CellFlags::ITALIC),
3601 4 => pen.flags.insert(CellFlags::UNDERLINE),
3602 5 => pen.flags.insert(CellFlags::BLINK),
3603 7 => pen.flags.insert(CellFlags::INVERSE),
3604 8 => pen.flags.insert(CellFlags::HIDDEN),
3605 9 => pen.flags.insert(CellFlags::STRIKETHROUGH),
3606 22 => pen.flags.remove(CellFlags::BOLD | CellFlags::DIM),
3607 23 => pen.flags.remove(CellFlags::ITALIC),
3608 24 => pen.flags.remove(CellFlags::UNDERLINE),
3609 25 => pen.flags.remove(CellFlags::BLINK),
3610 27 => pen.flags.remove(CellFlags::INVERSE),
3611 28 => pen.flags.remove(CellFlags::HIDDEN),
3612 29 => pen.flags.remove(CellFlags::STRIKETHROUGH),
3613 30..=37 => pen.fg = Color::Indexed((code - 30) as u8),
3614 38 => {
3615 if let Some(c) = parse_extended_color(param, &mut iter) {
3616 pen.fg = c;
3617 }
3618 }
3619 39 => pen.fg = Color::Default,
3620 40..=47 => pen.bg = Color::Indexed((code - 40) as u8),
3621 48 => {
3622 if let Some(c) = parse_extended_color(param, &mut iter) {
3623 pen.bg = c;
3624 }
3625 }
3626 49 => pen.bg = Color::Default,
3627 // Underline colour (SGR 58 / 59, #520) — same extended-colour grammar
3628 // as 38/48 (colon `58:2:r:g:b` / `58:5:n`, or legacy semicolon), so it
3629 // reuses `parse_extended_color` verbatim. 59 returns to "follow the fg".
3630 58 => {
3631 if let Some(c) = parse_extended_color(param, &mut iter) {
3632 pen.underline_color = c;
3633 }
3634 }
3635 59 => pen.underline_color = Color::Default,
3636 // bright foreground/background (aixterm) → palette 8..=15.
3637 90..=97 => pen.fg = Color::Indexed((code - 90 + 8) as u8),
3638 100..=107 => pen.bg = Color::Indexed((code - 100 + 8) as u8),
3639 _ => {}
3640 }
3641 }
3642 }
3643}
3644
3645/// Cap a recorded scroll to what a consumer can act on **and** what the wire can
3646/// carry (#661) — two bounds for two different reasons, see [`Term::scroll_delta`].
3647///
3648/// A free function so the second bound is provable without building the grid that
3649/// reaches it: a region taller than `i16::MAX` means a screen taller than 32 767
3650/// rows, and every scroll of it rotates a `line_damage` of that length, so driving
3651/// the engine to that corner costs ~10⁹ element moves (measured: 16 s in a debug
3652/// build, for one assertion). The engine-level tests in `tests/damage.rs` prove
3653/// `scroll_delta` applies this at ordinary sizes; the wire-level one in
3654/// `tests/serialize.rs` proves a count at the bound survives `encode`.
3655fn cap_scroll(op: ScrollOp) -> ScrollOp {
3656 let height = op.bottom.saturating_sub(op.top).saturating_add(1) as isize;
3657 let bound = height.min(MAX_SCROLL_COUNT);
3658 ScrollOp {
3659 count: op.count.clamp(-bound, bound),
3660 ..op
3661 }
3662}
3663
3664/// Parse `38`/`48`/`58` extended colour (foreground / background / underline colour, #520), in
3665/// either form:
3666/// - sub-parameter (colon) form inline in `param`: `38:5:n`, `38:2:r:g:b`
3667/// (optionally `38:2:cs:r:g:b` with a colorspace id), or
3668/// - legacy (semicolon) form: pull the following top-level params from `iter`.
3669///
3670/// The colon RGB form is **count-based** (`off = if param.len() >= 6 { 3 } else { 2 }`): a 5-param
3671/// `38:2:r:g:b` (no colorspace slot) reads RGB(r,g,b) directly, while a 6-param `38:2:cs:r:g:b` — or
3672/// `38:2::r:g:b` with an *empty* cs, the form kitty/nvim actually emit — skips the colorspace slot.
3673/// The short 5-param form is **non-conformant to T.416 / ISO-8613-6** (the de-jure standard always
3674/// carries a colorspace field), but tolerating it is the **ecosystem-dominant** behaviour, verified
3675/// against real source (2026-07, #520): VTE (`src/sgr.hh`, branches on `n > 4`), foot (`csi.c`,
3676/// `sub.idx >= 5`) and alacritty (`ansi.rs`, `params.len() > 4`) all count the sub-parameters and
3677/// decode the short form as RGB(r,g,b), exactly as here. VTE's own comment calls it a "common
3678/// misinterpretation of the standard" (foot: "bastard version") that it supports anyway; **only
3679/// xterm.js is strict** (always consumes a colorspace slot, so it misreads the short form). So a
3680/// difference from xterm here is deliberate leniency shared with the non-xterm ecosystem, not a
3681/// defect — the ADR-0004 spec-faithfulness is about not *omitting* behaviour, not about rejecting a
3682/// widely-emitted non-standard input.
3683fn parse_extended_color<'a, I>(param: &[u16], iter: &mut I) -> Option<Color>
3684where
3685 I: Iterator<Item = &'a [u16]>,
3686{
3687 if param.len() > 1 {
3688 // Colon sub-parameter form: kind is param[1].
3689 match param[1] {
3690 2 => {
3691 // 38:2:r:g:b (len 5) or 38:2:cs:r:g:b (len 6, colorspace skipped).
3692 let off = if param.len() >= 6 { 3 } else { 2 };
3693 let r = *param.get(off)? as u8;
3694 let g = *param.get(off + 1)? as u8;
3695 let b = *param.get(off + 2)? as u8;
3696 Some(Color::Rgb(r, g, b))
3697 }
3698 5 => Some(Color::Indexed(*param.get(2)? as u8)),
3699 _ => None,
3700 }
3701 } else {
3702 // Legacy semicolon form: kind, then its operands, are separate params.
3703 match iter.next()?.first().copied()? {
3704 2 => {
3705 let r = iter.next()?.first().copied()? as u8;
3706 let g = iter.next()?.first().copied()? as u8;
3707 let b = iter.next()?.first().copied()? as u8;
3708 Some(Color::Rgb(r, g, b))
3709 }
3710 5 => Some(Color::Indexed(iter.next()?.first().copied()? as u8)),
3711 _ => None,
3712 }
3713 }
3714}
3715
3716/// Reflow one screen (joined with its `scrollback`) to `cols` x `rows`, tracking
3717/// `point` (a cursor in screen coordinates). Returns the new screen rows, the new
3718/// scrollback (capped to `limit`), and the new point. The alt screen passes an
3719/// empty scrollback and discards the returned one.
3720/// The fixed dimensions a resize reflows toward.
3721#[derive(Clone, Copy)]
3722struct ReflowDims {
3723 old_cols: usize,
3724 cols: usize,
3725 rows: usize,
3726 limit: usize,
3727 /// Whether a column change may **re-split** this pane's content, or only re-fit its rows.
3728 ///
3729 /// False for the alt screen (#567). Reflow re-splits a long line so history stays readable at
3730 /// the new width — it assumes the content is text that *flows*. The alt screen has no history,
3731 /// its content is a **layout** rather than a paragraph (re-wrapping htop's columns means
3732 /// nothing), and the application already knows the new size and repaints. All three references
3733 /// take the same position with the same shape — one flag on the same resize function:
3734 /// ghostty `alt.resize(.{ .reflow = false })`, alacritty `grid.resize(!is_alt, …)`, xterm.js
3735 /// gating on `_hasScrollback` with the alt buffer built as `new Buffer(false, …)`.
3736 ///
3737 /// It is not merely wasted work: measured on a real `htop` recording taken across a live
3738 /// `SIGWINCH`, re-splitting leaves debris in the cells htop does not overwrite, because htop
3739 /// repaints **without** clearing. `vim` hides it by erasing first.
3740 reflow: bool,
3741}
3742
3743/// The result of reflowing one pane.
3744struct PaneReflow {
3745 screen: Vec<Row>,
3746 scrollback: VecDeque<Row>,
3747 /// The cursor's new screen-relative position.
3748 cursor: (usize, usize),
3749 /// Each tracked extra point's new position **in this pane's own `[history ++ screen]` frame**,
3750 /// index-aligned with the `extra_abs` argument — *before* any history the caller discards.
3751 ///
3752 /// Reported raw, with `evicted` beside it, because the two callers translate differently and
3753 /// doing it here silently picked the primary's answer for both: the primary keeps its history,
3754 /// so an extra's absolute line only moves by what the cap threw away, while the alt pane has no
3755 /// history at all and everything above the screen is *gone*. Adding the alt result to the
3756 /// primary's scrollback length then produced a line the buffer does not have — reachable
3757 /// without any reflow, on a rows-only resize.
3758 extras: Vec<(usize, usize)>,
3759 /// Rows that left the buffer entirely off the front of this pane's history. For the primary
3760 /// that is the scrollback cap's eviction; for the alt pane, whose limit is `0` because it has
3761 /// no history, it is every row the shrink pushed off the top. An extra whose raw line is below
3762 /// this **is not in the buffer any more** — the caller decides what that means for its kind.
3763 evicted: usize,
3764}
3765
3766/// Reflow one pane (its `scrollback` joined with `screen`) to `dims`, tracking
3767/// the screen-relative cursor `point` plus any `extra_abs` points given in
3768/// **absolute** `[scrollback ++ screen]` coordinates (selection anchors).
3769fn reflow_pane(
3770 screen: Vec<Row>,
3771 scrollback: VecDeque<Row>,
3772 point: (usize, usize),
3773 extra_abs: &[(usize, usize)],
3774 dims: ReflowDims,
3775) -> PaneReflow {
3776 let scroll_len = scrollback.len();
3777 let mut all: Vec<Row> = scrollback.into();
3778 all.extend(screen);
3779
3780 // The cursor is screen-relative; lift it to absolute, then track it together
3781 // with the already-absolute extras.
3782 let mut pts: Vec<(usize, usize)> = Vec::with_capacity(1 + extra_abs.len());
3783 pts.push((scroll_len + point.0, point.1));
3784 pts.extend_from_slice(extra_abs);
3785
3786 let pts = if dims.reflow && dims.cols != dims.old_cols {
3787 let (reflowed, np) = crate::grid::reflow(all, dims.cols, &pts);
3788 all = reflowed;
3789 np
3790 } else {
3791 pts
3792 };
3793
3794 // The cursor can land one row past everything the reflow emitted — "just after the content"
3795 // when the content ends on a full row (#562). That row is real, and while the pane is shorter
3796 // than the screen the caller's fit supplies it for free. When the content already fills the
3797 // pane it has to be bought, and the price is one row of history: the pane **scrolls**, which is
3798 // what a terminal does when content grows past the bottom. Without it the cursor was pulled
3799 // back onto the last glyph and the next byte destroyed a character — the ordinary shell shape,
3800 // a prompt at the bottom of a full screen.
3801 //
3802 // Five earlier designs made `reflow` itself materialise the row and were rejected on
3803 // measurements (a cursor at column 59 resized to width 4 emptied the buffer; a blank-line
3804 // exemption turned 22 alt lines into 21). `reflow` cannot see this pane's budget, so it spent
3805 // what it did not have. Here the budget is in scope, and it is the gate: a pane with no history
3806 // cannot pay — the displaced row would be destroyed rather than archived — so it keeps clamping.
3807 //
3808 // `limit > 0`, deliberately, and not "is this the alt screen": since #567 the alt panes pass
3809 // `limit: 0` because that is what an alt screen's history is, so they are excluded by the budget
3810 // rather than by a branch. That branch is what the design carrying this rule was rejected for
3811 // needing.
3812 //
3813 // This **amends** ADR-0025 rather than reading it narrowly: `reflow` does not create rows; the
3814 // seam may, when the pane can pay. What that record measured is that materialising
3815 // *unconditionally* destroys content.
3816 let cursor_abs = pts[0].0 + usize::from(pts[0].1 == dims.cols);
3817 if dims.limit > 0 {
3818 while all.len() <= cursor_abs {
3819 all.push(Row::blank(dims.cols));
3820 }
3821 }
3822
3823 let split = all.len().saturating_sub(dims.rows);
3824 let history: Vec<Row> = all.drain(0..split).collect();
3825 let mut sb: VecDeque<Row> = history.into();
3826 let mut dropped = 0usize;
3827 while sb.len() > dims.limit {
3828 sb.pop_front();
3829 dropped += 1;
3830 }
3831
3832 // `reflow` may answer `col == cols` — "just after the last cell", which is a real place in the
3833 // logical line and no place in the grid (#562). The **cursor's** reading of it is the next
3834 // *write* position, so a full row means the start of the row after; the caller's row fit
3835 // provides that row (`Grid::set_screen` pads at the bottom). A mark reads the same value the
3836 // opposite way and keeps it verbatim — see `Term::resize`.
3837 let cursor_row = pts[0].0.saturating_sub(split);
3838 let cursor = if pts[0].1 == dims.cols {
3839 (cursor_row + 1, 0)
3840 } else {
3841 (cursor_row, pts[0].1)
3842 };
3843
3844 // The bound on a tracked line belongs **here**, not inside `reflow`: this is where the final
3845 // geometry is known. The screen is padded to `dims.rows` whatever `reflow` emitted, so this
3846 // pane's last addressable line is `split + dims.rows - 1`. Bounding against `reflow`'s own row
3847 // count instead clamped away rows the fit was about to create (#562), while still being the
3848 // only thing standing between an out-of-range anchor and a panic in the consumer's process —
3849 // selection anchors and marks are written back raw, unlike the cursor (`Cursor::set_point`).
3850 // Expressed in this pane's own frame, so it is the same frame `extras` and `evicted` are in.
3851 let max_line = split + dims.rows - 1;
3852
3853 // The cursor returns to screen-relative (its absolute index minus the history split). The
3854 // extras stay in this pane's frame — see the field docs for why they are not shifted here.
3855 PaneReflow {
3856 cursor,
3857 extras: pts[1..]
3858 .iter()
3859 .map(|&(l, c)| (l.min(max_line), c))
3860 .collect(),
3861 evicted: dropped,
3862 screen: all,
3863 scrollback: sb,
3864 }
3865}
3866
3867/// Default tab stops: one every 8 columns (incl. column 0), matching xterm.
3868fn default_tabs(cols: usize) -> Vec<bool> {
3869 (0..cols).map(|i| i % 8 == 0).collect()
3870}
3871
3872/// First sub-parameter of CSI param `idx`, or `default` when absent or zero
3873/// (a zero/omitted numeric param means "1" for cursor movement and "0" for
3874/// erase — callers pass the right default).
3875fn param_or(params: &Params, idx: usize, default: u16) -> u16 {
3876 match params.iter().nth(idx).and_then(|p| p.first().copied()) {
3877 Some(v) if v != 0 => v,
3878 _ => default,
3879 }
3880}
3881
3882impl Term {
3883 /// Apply one DEC private mode set (`'h'`) or reset (`'l'`). DECSET/DECRST
3884 /// carry a list of modes, so `csi_dispatch` folds this over every parameter
3885 /// (#56); each mode is an independent toggle, not a stack.
3886 fn set_dec_private_mode(&mut self, action: char, mode: u16) {
3887 match (action, mode) {
3888 ('h', 1049) => self.enter_alt_screen(),
3889 ('l', 1049) => self.leave_alt_screen(),
3890 // Legacy alt-screen variants (#72): ?47/?1047 switch the buffer
3891 // without saving the cursor; ?1048 saves/restores the cursor without
3892 // switching. ?1049 is the two combined.
3893 ('h', 47) | ('h', 1047) => self.switch_to_alt(),
3894 ('l', 47) | ('l', 1047) => self.switch_to_primary(),
3895 ('h', 1048) => self.save_alt_cursor(),
3896 ('l', 1048) => self.restore_alt_cursor(),
3897 ('h', 6) => {
3898 // DECOM: set homes the cursor to the region top.
3899 self.origin_mode = true;
3900 self.goto(0, 0);
3901 }
3902 ('l', 6) => self.origin_mode = false, // unset leaves the cursor put
3903 ('h', 7) => self.autowrap = true, // DECAWM
3904 ('l', 7) => self.autowrap = false,
3905 ('h', 45) => self.reverse_wraparound = true, // reverse wraparound (#80)
3906 ('l', 45) => self.reverse_wraparound = false,
3907 // DECCOLM (#82): the engine is dimension-free, so emit a request the
3908 // consumer may honor by resizing — no screen/cursor/margin change here.
3909 ('h', 3) => self.events.push(TermEvent::ColumnMode { cols: 132 }),
3910 ('l', 3) => self.events.push(TermEvent::ColumnMode { cols: 80 }),
3911 ('h', 25) => self.cursor.visible = true, // DECTCEM show
3912 ('l', 25) => self.cursor.visible = false, // DECTCEM hide
3913 ('h', 12) => self.cursor.blink = true, // att610 cursor blink (#81)
3914 ('l', 12) => self.cursor.blink = false,
3915 ('h', 2004) => self.bracketed_paste = true,
3916 ('l', 2004) => self.bracketed_paste = false,
3917 ('h', 2026) => self.synchronized_output = true, // synchronized output (#73)
3918 ('l', 2026) => self.synchronized_output = false,
3919 ('h', 2027) => self.grapheme_clustering = true, // grapheme-cluster mode (#295)
3920 ('l', 2027) => self.grapheme_clustering = false,
3921 ('h', 2031) => self.color_scheme_updates = true, // color-scheme notifications (#85)
3922 ('l', 2031) => self.color_scheme_updates = false,
3923 ('h', 9001) => self.win32_input_mode = true, // win32-input-mode (#86)
3924 ('l', 9001) => self.win32_input_mode = false,
3925
3926 // Input-encoding modes (#11): DECCKM, mouse tracking + encoding,
3927 // focus reporting. Each set assigns the level; each reset clears
3928 // it (apps enable/disable the same mode, not a stack).
3929 ('h', 1) => self.app_cursor_keys = true, // DECCKM
3930 ('l', 1) => self.app_cursor_keys = false,
3931 ('h', 66) => self.application_keypad = true, // DECNKM (#74)
3932 ('l', 66) => self.application_keypad = false,
3933 // DECANM (#84): set = ANSI (the normal state); reset enters VT52. Only
3934 // the reset is meaningful — `?2h` is a no-op (already ANSI).
3935 ('l', 2) => self.vt52_mode = true,
3936 ('h', 9) => self.mouse_protocol = MouseProtocol::X10, // X10 mouse (#70)
3937 ('h', 1000) => self.mouse_protocol = MouseProtocol::Normal,
3938 ('h', 1002) => self.mouse_protocol = MouseProtocol::ButtonEvent,
3939 ('h', 1003) => self.mouse_protocol = MouseProtocol::AnyEvent,
3940 ('l', 9) | ('l', 1000) | ('l', 1002) | ('l', 1003) => {
3941 self.mouse_protocol = MouseProtocol::Off
3942 }
3943 ('h', 1006) => self.mouse_encoding = MouseEncoding::Sgr,
3944 ('l', 1006) => self.mouse_encoding = MouseEncoding::Default,
3945 ('h', 1015) => self.mouse_encoding = MouseEncoding::Urxvt,
3946 ('l', 1015) => self.mouse_encoding = MouseEncoding::Default,
3947 ('h', 1005) => self.mouse_encoding = MouseEncoding::Utf8,
3948 ('l', 1005) => self.mouse_encoding = MouseEncoding::Default,
3949 ('h', 1016) => self.mouse_encoding = MouseEncoding::SgrPixels,
3950 ('l', 1016) => self.mouse_encoding = MouseEncoding::Default,
3951 ('h', 1004) => self.focus_events = true,
3952 ('l', 1004) => self.focus_events = false,
3953
3954 _ => {} // other DEC modes are later slices
3955 }
3956 }
3957
3958 /// Dispatch one VT52 escape sequence (`ESC <final>`), reached only while
3959 /// `vt52_mode` is set (#84). VT52 is a pre-ANSI dialect: the cursor/erase
3960 /// finals map to the same `Term` primitives the ANSI path uses. `ESC <`
3961 /// returns to ANSI. Unknown finals are ignored.
3962 fn vt52_dispatch(&mut self, byte: u8) {
3963 match byte {
3964 b'A' => self.move_up(1), // cursor up
3965 b'B' => self.move_down(1), // cursor down
3966 b'C' => self.move_forward(1), // cursor right
3967 b'D' => self.move_back(1), // cursor left
3968 b'H' => self.goto(0, 0), // cursor home
3969 b'I' => self.reverse_index(), // reverse line feed
3970 b'J' => self.erase_display(0), // erase cursor → end of screen
3971 b'K' => self.erase_line(0), // erase cursor → end of line
3972 b'Y' => self.vt52_y_pending = 2, // direct address: two coord bytes follow
3973 // Identify (DECID): reply `ESC / Z` — "I am a VT52".
3974 b'Z' => self.replies.extend_from_slice(b"\x1b/Z"),
3975 b'=' => self.application_keypad = true, // enter alternate keypad
3976 b'>' => self.application_keypad = false, // exit alternate keypad
3977 b'<' => self.vt52_mode = false, // exit VT52, return to ANSI
3978 // RIS (`ESC c`) is honored even here: it is a hard "recover from any
3979 // state" reset, and `full_reset` rebuilds `Term` with `vt52_mode`
3980 // cleared, so RIS always escapes VT52 back to ANSI. VT52 defines no
3981 // other meaning for `ESC c`.
3982 b'c' => self.full_reset(),
3983 // Graphics mode (`ESC F`/`ESC G`) is a documented non-goal: the VT52
3984 // graphics glyph set differs from DEC Special Graphics, so reusing that
3985 // charset would render the wrong glyphs. No-op rather than approximate.
3986 b'F' | b'G' => {}
3987 _ => {} // unknown VT52 finals are ignored
3988 }
3989 }
3990
3991 /// Consume one `ESC Y` coordinate byte (#84). The first byte is the row, the
3992 /// second the column; each decodes as `value - 0x20`. On the second byte the
3993 /// cursor is addressed (`goto` clamps out-of-range coordinates). Reached only
3994 /// from `print` while `vt52_y_pending > 0`.
3995 fn vt52_take_coord(&mut self, c: char) {
3996 let coord = (c as usize).saturating_sub(0x20);
3997 if self.vt52_y_pending == 2 {
3998 self.vt52_y_row = coord;
3999 self.vt52_y_pending = 1;
4000 } else {
4001 self.vt52_y_pending = 0;
4002 self.goto(self.vt52_y_row, coord);
4003 }
4004 }
4005
4006 /// The allocation an OSC 8 `id=` names: the live one if that id already named a link
4007 /// with this same URI, else a fresh one recorded under the key (#635).
4008 ///
4009 /// Keyed on **id and URI together**, mirroring xterm.js's `_getEntryIdKey`
4010 /// (`` `${id};;${uri}` ``, `OscLinkService.ts:87`). Keying on the id alone would follow
4011 /// a reused id to a stale target — an application saying "same link" about two
4012 /// different destinations has not said anything the engine should honour.
4013 fn link_for_id(&mut self, id: &str, uri: &str) -> std::sync::Arc<str> {
4014 let key = format!("{id};;{uri}");
4015 // A key whose link has left the buffer is *absent*, not stale — the group it named
4016 // is gone, so this open starts a new one. That is xterm.js's behaviour too, reached
4017 // by deleting the entry rather than by letting a reference die.
4018 if let Some(live) = self.link_ids.get(&key).and_then(std::sync::Weak::upgrade) {
4019 return live;
4020 }
4021 // Amortised sweep before inserting, so dangling keys stay O(live) rather than
4022 // O(ids ever declared). Doubling the threshold keeps it O(1) per open.
4023 if self.link_ids.len() >= self.link_ids_sweep_at {
4024 self.link_ids.retain(|_, weak| weak.strong_count() > 0);
4025 self.link_ids_sweep_at = (self.link_ids.len() * 2).max(LINK_IDS_FIRST_SWEEP);
4026 }
4027 let fresh: std::sync::Arc<str> = std::sync::Arc::from(uri);
4028 self.link_ids.insert(key, std::sync::Arc::downgrade(&fresh));
4029 fresh
4030 }
4031}
4032
4033impl Perform for Term {
4034 fn print(&mut self, c: char) {
4035 // VT52 `ESC Y` direct addressing (#84): vte delivers the two coordinate
4036 // bytes here (it returned to ground after the `Y` final), so intercept
4037 // them before they would be written as glyphs.
4038 if self.vt52_y_pending > 0 {
4039 self.vt52_take_coord(c);
4040 return;
4041 }
4042 // Translate through the active (GL) character set first (#62): under DEC
4043 // Special Graphics a printable byte becomes a line-drawing glyph.
4044 let c = self.charsets[self.gl].map(c);
4045 // Grapheme-cluster mode (DEC ?2027, #295): if `c` extends the previous cell's cluster,
4046 // join it there instead of placing a new cell. OFF → the per-char (wcwidth) path below.
4047 if self.grapheme_clustering && self.try_grapheme_join(c) {
4048 return;
4049 }
4050 match c.width() {
4051 // Zero-width (combining marks): the grapheme-cluster side-table is a
4052 // later slice; drop for now rather than mis-place it as its own cell.
4053 // A zero-width code point is a combining mark — attach it to the
4054 // previous base glyph rather than dropping it.
4055 Some(0) => self.push_combining(c),
4056 None => {}
4057 // Coerced to a pair, because a pair is the only multi-column shape the cell model
4058 // has (`WIDE_CHAR` + exactly one `WIDE_CHAR_SPACER`) — see ADR-0025, which states
4059 // every clause over "a pair" and never over a wider run. `unicode-width` genuinely
4060 // returns 3 for at least one codepoint (U+17D8 KHMER SIGN BEYYAL, a ligature drawn
4061 // as three characters), and that value is not wrong — it is unrepresentable here.
4062 //
4063 // Left uncoerced, the width fell through *every* wide branch in `write_glyph`
4064 // (each gated on `width == 2`) while still driving the cursor advance, so the glyph
4065 // landed as a lone narrow cell followed by columns that no flag distinguished from
4066 // real blanks: search could not find the text on screen and word selection split
4067 // the run, handing the clipboard a space the buffer never held (#595).
4068 //
4069 // All three references bound it, and ghostty says why in the same words —
4070 // `unicode/props.zig:11-13`, *"We clamp to [0, 2] … i.e. 3-em dash becomes a 2-em
4071 // dash"*. Clamping *here* rather than inside `write_glyph` keeps the two jobs apart:
4072 // this is the policy for an out-of-range external value, and the invariant it
4073 // establishes is asserted at the site that depends on it.
4074 Some(width) => self.write_glyph(c, width.min(2)),
4075 }
4076 }
4077
4078 fn execute(&mut self, byte: u8) {
4079 match byte {
4080 // LF, VT, FF all line-feed.
4081 b'\n' | 0x0b | 0x0c => self.linefeed(),
4082 b'\r' => self.carriage_return(),
4083 0x08 => self.backspace(),
4084 b'\t' => self.put_tab(),
4085 0x07 => self.events.push(TermEvent::Bell), // BEL (#12)
4086 0x0e => self.gl = 1, // SO (LS1): GL = G1 (#62)
4087 0x0f => self.gl = 0, // SI (LS0): GL = G0
4088 _ => {}
4089 }
4090 }
4091
4092 fn csi_dispatch(&mut self, params: &Params, intermediates: &[u8], _ignore: bool, action: char) {
4093 // Kitty keyboard-protocol negotiation: CSI > / = / < / ? ... u. The
4094 // leading intermediate distinguishes it from plain `CSI u` (SCORC) (#23).
4095 if action == 'u'
4096 && let Some(&lead) = intermediates.first()
4097 && matches!(lead, b'>' | b'<' | b'=' | b'?')
4098 {
4099 self.kitty_dispatch(lead, params);
4100 return;
4101 }
4102 // DEC private modes arrive with a '?' intermediate.
4103 if intermediates.first() == Some(&b'?') {
4104 // DECRQM (CSI ? Ps $ p) — report whether mode Ps is set. The '$'
4105 // intermediate distinguishes it from a plain `?...p`. It queries a
4106 // single mode, so it keys off the first parameter only.
4107 if action == 'p' && intermediates.contains(&b'$') {
4108 self.decrqm(param_or(params, 0, 0));
4109 return;
4110 }
4111 // Private DSR (CSI ? Ps n): ?996 = color-scheme query (#85). The
4112 // theme-agnostic engine relays it as an event for the consumer.
4113 if action == 'n' {
4114 if param_or(params, 0, 0) == 996 {
4115 self.events.push(TermEvent::ColorSchemeQuery);
4116 }
4117 return;
4118 }
4119 // DECSET/DECRST carry a *list* of modes; apply set/reset to EVERY
4120 // parameter, not just the first — htop batches `?1006;1000h` into one
4121 // CSI, so folding only params[0] dropped the 1000 (#56).
4122 for mode in params.iter().filter_map(|p| p.first().copied()) {
4123 self.set_dec_private_mode(action, mode);
4124 }
4125 return;
4126 }
4127 // DECSTR soft reset: CSI ! p (#53).
4128 if intermediates.first() == Some(&b'!') && action == 'p' {
4129 self.soft_reset();
4130 return;
4131 }
4132 // DECSCUSR set cursor style: CSI Ps SP q (space intermediate) (#89). An
4133 // absent param means 1 (block blink); an explicit 0 means reset — so the
4134 // raw value matters and `param_or` (which folds 0 to its default) is wrong.
4135 if intermediates.first() == Some(&b' ') && action == 'q' {
4136 let param = params.iter().next().and_then(|p| p.first().copied());
4137 self.set_cursor_style(param.unwrap_or(1));
4138 return;
4139 }
4140 // Other private/intermediate sequences are later slices; ignore them
4141 // rather than misinterpret.
4142 if !intermediates.is_empty() {
4143 return;
4144 }
4145 match action {
4146 'A' => self.move_up(param_or(params, 0, 1) as usize),
4147 'B' | 'e' => self.move_down(param_or(params, 0, 1) as usize),
4148 'C' | 'a' => self.move_forward(param_or(params, 0, 1) as usize),
4149 'D' => self.move_back(param_or(params, 0, 1) as usize),
4150 'G' | '`' => self.set_col(param_or(params, 0, 1) as usize - 1),
4151 'd' => self.set_row(param_or(params, 0, 1) as usize - 1),
4152 'H' | 'f' => {
4153 let row = param_or(params, 0, 1) as usize - 1;
4154 let col = param_or(params, 1, 1) as usize - 1;
4155 self.goto(row, col);
4156 }
4157 'J' => self.erase_display(param_or(params, 0, 0)),
4158 'K' => self.erase_line(param_or(params, 0, 0)),
4159 'X' => self.erase_chars(param_or(params, 0, 1) as usize),
4160 '@' => self.insert_chars(param_or(params, 0, 1) as usize),
4161 'P' => self.delete_chars(param_or(params, 0, 1) as usize),
4162 'S' => self.scroll_up_lines(param_or(params, 0, 1) as usize),
4163 'T' => self.scroll_down_lines(param_or(params, 0, 1) as usize),
4164 'L' => self.insert_lines(param_or(params, 0, 1) as usize),
4165 'M' => self.delete_lines(param_or(params, 0, 1) as usize),
4166 'g' => self.clear_tab_stop(param_or(params, 0, 0)),
4167 'r' => {
4168 let rows = self.grid.rows() as u16;
4169 let top = param_or(params, 0, 1) as usize;
4170 let bottom = param_or(params, 1, rows) as usize;
4171 self.set_scroll_region(top, bottom);
4172 }
4173 'm' => self.sgr(params),
4174 's' => self.save_cursor(), // SCOSC (CSI s) — alias of DECSC
4175 'u' => self.restore_cursor(), // SCORC (CSI u) — alias of DECRC
4176 // DA1 (primary device attributes, CSI c): advertise VT220 + ANSI
4177 // colour — the levels justerm actually implements (#27).
4178 'c' => self.replies.extend_from_slice(b"\x1b[?62;22c"),
4179 'n' => self.device_status_report(param_or(params, 0, 0)),
4180 // Non-private SM/RM. Folded over every parameter (modes can batch,
4181 // like the private path #56). IRM (4) and LNM (20) so far.
4182 'h' => {
4183 for m in params.iter().filter_map(|p| p.first().copied()) {
4184 match m {
4185 4 => self.insert_mode = true,
4186 20 => self.newline_mode = true,
4187 _ => {}
4188 }
4189 }
4190 }
4191 'l' => {
4192 for m in params.iter().filter_map(|p| p.first().copied()) {
4193 match m {
4194 4 => self.insert_mode = false,
4195 20 => self.newline_mode = false,
4196 _ => {}
4197 }
4198 }
4199 }
4200 _ => {}
4201 }
4202 }
4203
4204 fn esc_dispatch(&mut self, intermediates: &[u8], _ignore: bool, byte: u8) {
4205 // VT52 mode (#84): the pre-ANSI dialect reuses the same `ESC <final>`
4206 // tokens vte already produces, but with different meanings, so it is a
4207 // mode-gated branch here rather than a separate parser. All VT52 sequences
4208 // are intermediate-free; anything with an intermediate is not VT52.
4209 if self.vt52_mode && intermediates.is_empty() {
4210 self.vt52_dispatch(byte);
4211 return;
4212 }
4213 if let Some(&i) = intermediates.first() {
4214 // SCS: designate a charset to G0 (`ESC ( F`) or G1 (`ESC ) F`) (#62).
4215 if matches!(i, b'(' | b')') {
4216 let set = match byte {
4217 b'0' => Charset::DecSpecialGraphics,
4218 b'A' => Charset::Uk,
4219 b'B' => Charset::Ascii,
4220 _ => return, // other sets are later slices
4221 };
4222 self.charsets[if i == b'(' { 0 } else { 1 }] = set;
4223 }
4224 // Other intermediates (G2/G3 designators, etc.) are later slices.
4225 return;
4226 }
4227 match byte {
4228 b'D' => self.linefeed(), // IND (line-feed without CR)
4229 b'E' => {
4230 // NEL (next line): carriage return + line-feed.
4231 self.carriage_return();
4232 self.linefeed();
4233 }
4234 b'H' => self.set_tab_stop(), // HTS
4235 b'M' => self.reverse_index(), // RI
4236 b'7' => self.save_cursor(), // DECSC
4237 b'8' => self.restore_cursor(), // DECRC
4238 b'c' => self.full_reset(), // RIS (#53)
4239 b'=' => self.application_keypad = true, // DECKPAM (#74)
4240 b'>' => self.application_keypad = false, // DECKPNM
4241 _ => {}
4242 }
4243 }
4244
4245 /// OSC dispatch (#12 event surface): title (0/2), cwd (7). OSC 8 hyperlink
4246 /// is per-cell state, handled in its own slice (#26), not here.
4247 fn osc_dispatch(&mut self, params: &[&[u8]], _bell_terminated: bool) {
4248 // params[0] is the OSC number; params[1..] the payload fields.
4249 let Some(&number) = params.first() else {
4250 return;
4251 };
4252 match number {
4253 // OSC 0 = icon + window title, OSC 2 = window title. Both set title.
4254 b"0" | b"2" => {
4255 if let Some(&title) = params.get(1) {
4256 self.events.push(TermEvent::Title(
4257 String::from_utf8_lossy(title).into_owned(),
4258 ));
4259 }
4260 }
4261 // OSC 7 = current working directory (a file:// URI).
4262 b"7" => {
4263 if let Some(&cwd) = params.get(1) {
4264 self.events
4265 .push(TermEvent::Cwd(String::from_utf8_lossy(cwd).into_owned()));
4266 }
4267 }
4268 // OSC 133 = FinalTerm/iTerm2 shell-integration command marks (#158):
4269 // `A` prompt start, `B` command start, `C` output start, `D[;exit]`
4270 // command finished. Each anchors a kinded marker at the cursor line;
4271 // pairing + navigation is consumer policy (#160). Unknown subcommands
4272 // (or none) are ignored. `D`'s exit field parses to `i32`, else None.
4273 b"133" => match params.get(1).copied() {
4274 Some(b"A") => self.add_command_mark(MarkerKind::PromptStart),
4275 Some(b"B") => self.add_command_mark(MarkerKind::CommandStart),
4276 Some(b"C") => self.add_command_mark(MarkerKind::OutputStart),
4277 Some(b"D") => {
4278 let exit = params
4279 .get(2)
4280 .and_then(|p| core::str::from_utf8(p).ok())
4281 .and_then(|s| s.parse::<i32>().ok());
4282 self.add_command_mark(MarkerKind::CommandFinished(exit));
4283 }
4284 _ => {}
4285 },
4286 // OSC 8 = hyperlink: `OSC 8 ; params ; URI`. A non-empty URI opens a
4287 // link (made current); an empty URI closes it. `params` carries the
4288 // optional `id=` that groups runs into one link (#635).
4289 b"8" => {
4290 // One allocation per *open*, shared by that open's cells and dropped
4291 // with the last row holding it (#628 — there is no pool). Two opens of
4292 // an identical URI stay two links, deliberately: merging them would
4293 // override a distinction the application controls through `id=`. That
4294 // parameter is the *only* dedup performed, which is one rule and not
4295 // two — xterm.js states it as "links with no id will only ever be
4296 // registered a single time" beside a lookup keyed on id-plus-uri
4297 // (`OscLinkService.ts:34`, `:49-54`).
4298 // The URI is `params[2..]` **rejoined**, not `params[2]` (#650). vte splits the
4299 // OSC payload on `;`, so a URI carrying an unencoded `;` arrives in pieces and
4300 // reading only the first dropped the rest — silently, with no error. Nothing is
4301 // lost at the parser: measured, `]8;;https://x/a;b=c` arrives as
4302 // `["8", "", "https://x/a", "b=c"]`. xterm.js special-cases the same thing from
4303 // the other side, splitting on the *first* `;` only and taking all the rest as
4304 // the URI, *"to support unencoded semi-colons in the URIs"*
4305 // (`InputHandler.ts:3106-3112`). Reachable without anything exotic: `?a=1;b=2`
4306 // is a legal query string and `;` is a legal filename byte.
4307 //
4308 // The close survives this: `]8;;` arrives as `["8", "", ""]`, whose rejoin is
4309 // empty, and an empty URI still closes. Never decoded — a `%3B` stays `%3B`,
4310 // because the engine hands the target over exactly as declared (ADR-0017).
4311 let uri: Vec<u8> = params.get(2..).unwrap_or_default().join(&b';');
4312 self.current_link = if uri.is_empty() {
4313 None
4314 } else {
4315 let uri = String::from_utf8_lossy(&uri);
4316 Some(match osc8_link_id(params.get(1).copied().unwrap_or(b"")) {
4317 // No id declared: fresh per open, the reference-correct default.
4318 None => std::sync::Arc::from(&*uri),
4319 Some(id) => self.link_for_id(&String::from_utf8_lossy(id), &uri),
4320 })
4321 };
4322 }
4323 // OSC 4 = set/query an ANSI palette entry: `OSC 4 ; index ; spec`
4324 // (#122). The engine forwards index + raw spec; the consumer applies
4325 // it to its palette (theme-agnostic — the cell keeps `Indexed`).
4326 b"4" => {
4327 // One event per `index ; spec` pair (xterm's `while slots > 1`).
4328 let mut rest = ¶ms[1..];
4329 while let [idx, spec, tail @ ..] = rest {
4330 rest = tail;
4331 if let Ok(index) = String::from_utf8_lossy(idx).parse::<u8>() {
4332 if *spec == b"?" {
4333 self.events.push(TermEvent::QueryPaletteColor { index });
4334 } else {
4335 self.events.push(TermEvent::SetPaletteColor {
4336 index,
4337 spec: String::from_utf8_lossy(spec).into_owned(),
4338 });
4339 }
4340 }
4341 }
4342 }
4343 // OSC 104 = reset palette entries (#122): no arg resets the whole
4344 // table, else one event per named index.
4345 b"104" => {
4346 if params.len() <= 1 {
4347 self.events.push(TermEvent::ResetPaletteColor(None));
4348 } else {
4349 for &idx in ¶ms[1..] {
4350 if let Ok(index) = String::from_utf8_lossy(idx).parse::<u8>() {
4351 self.events.push(TermEvent::ResetPaletteColor(Some(index)));
4352 }
4353 }
4354 }
4355 }
4356 // OSC 10/11 = set/query the default foreground/background, stacking
4357 // specs across the [fg, bg] slots (#122, #137). OSC 10 starts at fg,
4358 // OSC 11 at bg. The engine forwards raw specs (theme-agnostic).
4359 b"10" => self.special_color(params, 0),
4360 b"11" => self.special_color(params, 1),
4361 // OSC 110 / 111 = reset the default foreground / background (#122).
4362 b"110" => self.events.push(TermEvent::ResetForeground),
4363 b"111" => self.events.push(TermEvent::ResetBackground),
4364 _ => {} // other OSCs are later slices
4365 }
4366 }
4367}
4368
4369#[cfg(test)]
4370mod tests {
4371 use super::cap_scroll;
4372 use crate::Engine;
4373 use crate::damage::ScrollOp;
4374 use crate::serialize::MAX_SCROLL_COUNT;
4375
4376 /// #661 — the wire's `i16` bound, not the region-height one.
4377 ///
4378 /// In-crate on purpose, and the reason is cost rather than visibility: reaching
4379 /// this through `Engine` needs a screen taller than 32 767 rows *and* 32 768
4380 /// scrolls of it, each rotating a `line_damage` of that length. Measured at
4381 /// 15.8 s in a debug build for a single assertion — the whole `serialize` suite
4382 /// is 0.2 s without it. See `cap_scroll`'s note for how the coverage is split.
4383 #[test]
4384 fn a_region_taller_than_the_wire_field_truncates_rather_than_wraps() {
4385 // 40 000 rows: over i16::MAX, under MAX_ROWS (u16::MAX), so the region
4386 // height alone would let 35 000 through — and 35 000 as i16 is -30 536.
4387 let up = cap_scroll(ScrollOp {
4388 top: 0,
4389 bottom: 40_000,
4390 count: 35_000,
4391 });
4392 assert_eq!(up.count, MAX_SCROLL_COUNT, "capped, and still an up-scroll");
4393
4394 let down = cap_scroll(ScrollOp {
4395 top: 0,
4396 bottom: 40_000,
4397 count: -35_000,
4398 });
4399 assert_eq!(down.count, -MAX_SCROLL_COUNT, "sign survives the cap");
4400 }
4401
4402 /// The cap is a ceiling, not a rewrite: a count inside both bounds is reported
4403 /// exactly, and the region it names is untouched.
4404 #[test]
4405 fn a_scroll_inside_both_bounds_passes_through_unchanged() {
4406 let op = ScrollOp {
4407 top: 4,
4408 bottom: 9,
4409 count: -2,
4410 };
4411 assert_eq!(cap_scroll(op), op);
4412 }
4413
4414 /// #628 — a hyperlink's storage is released once no live row references it.
4415 ///
4416 /// In-crate on purpose: this defect has **no public observable**, which is why it
4417 /// survived from #46 until #621's completeness pass went looking. Pool indices never
4418 /// cross the wire (`Term::frame` remaps them to frame-local `link_table` positions),
4419 /// and the one public reader takes an index the caller already holds — so from
4420 /// outside the crate a pool of 5 entries and a pool of 50 000 are indistinguishable.
4421 /// The assertion has to stand where the storage does.
4422 ///
4423 /// The fixture is a buffer that cannot hold what it is fed: 2 rows plus 2 lines of
4424 /// scrollback is four lines total, so by the end all but the last four opens have
4425 /// been evicted and nothing on screen or in history refers to them.
4426 #[test]
4427 fn a_link_evicted_from_the_buffer_stops_being_stored() {
4428 let mut e = Engine::with_scrollback(20, 2, 2);
4429 for i in 0..50 {
4430 e.feed(format!("\x1b]8;;https://example.com/{i}\x07L{i}\x1b]8;;\x07\r\n").as_bytes());
4431 }
4432
4433 // The observable had to move with the storage — there is no pool left to count.
4434 // A `Weak` is the stronger form of the same claim anyway: a bounded count can be
4435 // bounded and still wrong, while a dead `Weak` says *this exact allocation* was
4436 // released.
4437 //
4438 // **`e2` must outlive the assertion, and that is the whole test.** The first
4439 // version of this scoped the engine to the block that built the `Weak`, so the
4440 // engine was dropped before the check and the `Weak` died for that reason
4441 // instead. Measured: with a deliberate leak reintroduced (a `Vec<Arc<str>>` on
4442 // `Term`, retaining every open), that version stayed **green** — a tautological
4443 // proof, confirming only that dropping an `Engine` frees its own memory. Keeping
4444 // the engine alive is what makes the assertion about reclamation.
4445 let mut e2 = Engine::with_scrollback(20, 2, 2);
4446 e2.feed(b"\x1b]8;;https://example.com/first\x07L\x1b]8;;\x07\r\n");
4447 let weak = {
4448 let arc = e2
4449 .term
4450 .grid
4451 .row_ref(0)
4452 .link_at(0)
4453 .expect("on screen")
4454 .clone();
4455 std::sync::Arc::downgrade(&arc)
4456 };
4457 // The live half first: a fix that simply never stored the URI would satisfy the
4458 // dead-`Weak` assertion below for the wrong reason.
4459 assert!(
4460 weak.upgrade().is_some(),
4461 "the URI must be alive while its cell is on screen",
4462 );
4463 for i in 0..50 {
4464 e2.feed(format!("filler {i}\r\n").as_bytes());
4465 }
4466 assert!(
4467 weak.upgrade().is_none(),
4468 "the first link scrolled out of a 4-line buffer and nothing should still \
4469 hold its URI — before #628 every OSC 8 open lived for the life of the Term",
4470 );
4471
4472 // The whole-buffer form of the same claim: 50 distinct opens through a buffer
4473 // that holds four lines leaves at most four entries *owned*.
4474 //
4475 // `owned_link_count` and not `link_at`, and that distinction is the test. The
4476 // first version summed the gated reader, which counts **linked cells** — measured
4477 // on an erased screen it read 0 while every URI was still allocated, so it could
4478 // not fail for the property this test exists to assert.
4479 // Deduped by allocation: one open covering three cells is three map entries and
4480 // one URI, so counting entries would fail at 9 for a buffer holding four links.
4481 let owned: std::collections::HashSet<*const u8> = e
4482 .term
4483 .scrollback
4484 .iter()
4485 .chain((0..2).map(|r| e.term.grid.row_ref(r)))
4486 .flat_map(|r| r.owned_links())
4487 .map(|u| std::sync::Arc::as_ptr(u) as *const u8)
4488 .collect();
4489 assert!(
4490 owned.len() <= 4,
4491 "a 4-line buffer cannot own more than 4 distinct URIs, found {}",
4492 owned.len(),
4493 );
4494 }
4495
4496 /// #628 — erasing a cell in place releases its URI, not just its presence bit.
4497 ///
4498 /// The sibling of the eviction test above, and the case that one structurally cannot
4499 /// see: `clear_cells` / `free_cell` blank a cell **without dropping its row**, so no
4500 /// row-lifetime event fires. Under `row-keyed-side-maps` rule 3 leaving the map entry
4501 /// is sanctioned — *"a write that clears the cell owes the bit, not the map"* — and
4502 /// that was exactly right while the value was a 4-byte index: a stale entry is
4503 /// unreadable through the gate and costs nothing.
4504 ///
4505 /// #628 changed what the entry *is*. The map now owns a heap string, so the same
4506 /// sanctioned line retains one. Rule 3 still holds as stated — purging is not the
4507 /// correctness step, and missing a site costs bounded retention rather than a wrong
4508 /// answer — but the optimisation it calls optional became worth taking here.
4509 /// All three references release at this point: alacritty's `Cell::reset` drops the
4510 /// `Option<Arc<CellExtra>>` outright, ghostty's ref-counted set frees at zero, and
4511 /// xterm.js's `_resetBufferLine` clears `_extendedAttrs` and disposes the line's
4512 /// markers so `OscLinkService` deletes the entry.
4513 #[test]
4514 fn an_erased_cell_releases_its_uri_not_only_its_bit() {
4515 let mut e = Engine::new(80, 24);
4516 e.feed(b"]8;;https://example.com/erasedL]8;;");
4517 let weak = {
4518 let a = e
4519 .term
4520 .grid
4521 .row_ref(0)
4522 .link_at(0)
4523 .expect("on screen")
4524 .clone();
4525 std::sync::Arc::downgrade(&a)
4526 };
4527 assert!(weak.upgrade().is_some(), "alive while on screen");
4528
4529 e.feed(b"[2J"); // ED 2 — erases in place; no row is dropped or reused
4530
4531 // The gated reader already says "no link", and so does the frame. Neither can
4532 // see the retention, which is why this assertion holds the `Weak` instead:
4533 // measured before the purge, both public views read 0 while the URI lived.
4534 assert!(e.link_at(0, 0).is_none(), "the presence bit is cleared");
4535 assert!(
4536 weak.upgrade().is_none(),
4537 "and the URI itself is released — before the purge the map kept owning it, so an erased screen retained every link it had shown",
4538 );
4539 }
4540
4541 /// `Arc`, not `Rc`, and this is what makes that a fact rather than a comment.
4542 ///
4543 /// #628 chose `Arc<str>` for the row's link map on the stated ground that `Engine` is
4544 /// `Send + Sync`; `Rc` would have removed both **silently** — no signature changes
4545 /// here, and a downstream `Mutex<Engine>` failing to compile instead. The claim was
4546 /// load-bearing and unpinned: a repo-wide grep for it found only prose.
4547 #[test]
4548 fn the_engine_stays_send_and_sync() {
4549 fn assert_send_sync<T: Send + Sync>() {}
4550 assert_send_sync::<Engine>();
4551 }
4552
4553 /// Two OSC 8 opens of an identical URI are **two links**, not one.
4554 ///
4555 /// Deliberate, and the reason is #635: merging them would override the grouping the
4556 /// application controls through `id=`, which is the one dedup xterm.js performs.
4557 /// Asserted by allocation identity through the in-crate observer rather than through
4558 /// a public accessor — the behaviour is real now, a consumer asking about it is not.
4559 #[test]
4560 fn two_opens_of_one_uri_are_two_links() {
4561 let mut e = Engine::new(40, 2);
4562 // One open covering two cells, then a *separate* open of the very same URI.
4563 e.feed(b"]8;;https://example.com/xAB]8;;");
4564 e.feed(b"]8;;https://example.com/xC]8;;");
4565
4566 let row = e.term.grid.row_ref(0);
4567 let ptr = |c: usize| std::sync::Arc::as_ptr(row.link_at(c).expect("linked")) as *const u8;
4568 assert_eq!(
4569 e.link_at(0, 0).map(|h| h.uri().to_owned()),
4570 e.link_at(0, 2).map(|h| h.uri().to_owned()),
4571 "the text is the same",
4572 );
4573 assert_eq!(ptr(0), ptr(1), "A and B are one open, so one allocation");
4574 assert_ne!(
4575 ptr(0),
4576 ptr(2),
4577 "…but C is a second open — merging the two would override the distinction `id=` exists to express (#635)",
4578 );
4579 }
4580
4581 /// The other half of the rule above: an `id=` the application declared **does** group
4582 /// (#635). One rule, not two — "never merge on URI alone, always merge on a declared
4583 /// id" is how xterm.js states it (`OscLinkService.ts:34`, `:51` at the pinned SHA), and
4584 /// justerm shipped the first half only because #26 ported `registerLink`'s id-minting
4585 /// and not its lookup.
4586 ///
4587 /// Grouping is asserted as **allocation identity**, which is not an implementation
4588 /// detail leaking into a test: since #628 the `Arc`'s address *is* link identity —
4589 /// `Term::frame` interns `link_table` by `Arc::as_ptr`, so one allocation is what makes
4590 /// two runs one link index on the wire, and that index is what a consumer groups by.
4591 #[test]
4592 fn the_same_id_and_uri_group_into_one_link() {
4593 let mut e = Engine::new(40, 2);
4594 // Two separate opens, same `id=` and same URI, on two different lines — the case
4595 // the parameter exists for (a link that cannot be one contiguous run).
4596 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07A\x1b]8;;\x07\r\n");
4597 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07B\x1b]8;;\x07");
4598
4599 let ptr = |r: usize, c: usize| {
4600 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
4601 };
4602 assert_eq!(
4603 ptr(0, 0),
4604 ptr(1, 0),
4605 "the application said these two runs are one link, so they share one allocation",
4606 );
4607
4608 // And the wire agrees, which is the half a consumer can actually see: one entry in
4609 // `link_table`, referenced by both spans. Two entries is the defect.
4610 let f = e.frame();
4611 assert_eq!(f.link_table.len(), 1, "one link ships once");
4612 }
4613
4614 /// Keyed on `id` **and** URI, not on `id` alone — xterm.js's `_getEntryIdKey` is
4615 /// `` `${id};;${uri}` `` (`OscLinkService.ts:87`). An application reusing an id for a
4616 /// different target has not said "same link"; treating it as one would follow a stale
4617 /// declaration to the wrong URI.
4618 #[test]
4619 fn the_same_id_with_a_different_uri_stays_two_links() {
4620 let mut e = Engine::new(40, 2);
4621 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07A\x1b]8;;\x07\r\n");
4622 e.feed(b"\x1b]8;id=xyz;https://example.com/b\x07B\x1b]8;;\x07");
4623
4624 let ptr = |r: usize, c: usize| {
4625 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
4626 };
4627 assert_ne!(
4628 ptr(0, 0),
4629 ptr(1, 0),
4630 "same id, different target — two links"
4631 );
4632 assert_eq!(e.frame().link_table.len(), 2, "and both ship");
4633 }
4634
4635 /// `id=` with an **empty value** is no id at all, so the no-id rule applies and each
4636 /// open is its own link. xterm.js reaches this by `parsedParams[i].slice(3) || undefined`
4637 /// (`InputHandler.ts:3130`) — the `||` is the whole behaviour, and reading `slice(3)`
4638 /// alone gives the opposite answer.
4639 ///
4640 /// Worth a test rather than a comment because the empty-string key is the one that
4641 /// would group *every* `id=`-with-no-value link in a session into one, across unrelated
4642 /// URIs — a wrong answer that grows with uptime.
4643 #[test]
4644 fn an_empty_id_value_is_no_id_at_all() {
4645 let mut e = Engine::new(40, 2);
4646 e.feed(b"\x1b]8;id=;https://example.com/a\x07A\x1b]8;;\x07\r\n");
4647 e.feed(b"\x1b]8;id=;https://example.com/a\x07B\x1b]8;;\x07");
4648
4649 let ptr = |r: usize, c: usize| {
4650 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
4651 };
4652 assert_ne!(
4653 ptr(0, 0),
4654 ptr(1, 0),
4655 "no id declared, so the reference-correct fresh-per-open rule still holds",
4656 );
4657 }
4658
4659 /// `params` is a **`:`-separated** key=value list (`id=xyz123:foo=bar:baz=quux`), and
4660 /// `id` may sit anywhere in it — xterm.js scans with `findIndex(e =>
4661 /// e.startsWith('id='))` (`InputHandler.ts:3129`). Testing only a leading `id=` would
4662 /// pass with a `starts_with` on the whole field, which is the wrong parse.
4663 #[test]
4664 fn the_id_param_is_found_among_other_params() {
4665 let mut e = Engine::new(40, 2);
4666 e.feed(b"\x1b]8;foo=bar:id=xyz:baz=quux;https://example.com/a\x07A\x1b]8;;\x07\r\n");
4667 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07B\x1b]8;;\x07");
4668
4669 let ptr = |r: usize, c: usize| {
4670 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
4671 };
4672 assert_eq!(
4673 ptr(0, 0),
4674 ptr(1, 0),
4675 "the id is the same whatever else rides beside it",
4676 );
4677 }
4678
4679 /// The grouping registry must not become the pool #628 deleted.
4680 ///
4681 /// Whatever maps an `id=` to its link has to hold it **weakly**: a strong reference
4682 /// would make every id'd link immortal for the life of the `Term` — the exact defect
4683 /// #628 removed, re-entering through the door #635 opens. xterm.js's equivalent map is
4684 /// reclaimed rather than weak (`_entriesWithId.delete` when the entry's last line
4685 /// marker is disposed, `OscLinkService.ts:98-100`); justerm has no disposal hook by
4686 /// design, so `Weak` is how the same lifetime is expressed here.
4687 ///
4688 /// This is the test that discriminates the two, and nothing public can: both spellings
4689 /// group correctly, and they differ only in what stays alive afterwards.
4690 #[test]
4691 fn the_id_registry_does_not_keep_a_link_alive() {
4692 let mut e = Engine::new(80, 24);
4693 e.feed(b"\x1b]8;id=xyz;https://example.com/grouped\x07L\x1b]8;;\x07");
4694 let weak = {
4695 let a = e
4696 .term
4697 .grid
4698 .row_ref(0)
4699 .link_at(0)
4700 .expect("on screen")
4701 .clone();
4702 std::sync::Arc::downgrade(&a)
4703 };
4704 assert!(weak.upgrade().is_some(), "alive while on screen");
4705
4706 e.feed(b"\x1b[2J"); // ED 2 — the in-place erase that releases the row's side maps
4707
4708 assert!(
4709 weak.upgrade().is_none(),
4710 "the id registry must hold a Weak — a strong entry would outlive the screen and rebuild #628's leak one id at a time",
4711 );
4712 }
4713}