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, UnderlineStyle};
11use crate::color::Color;
12use crate::cursor::{Cursor, CursorShape, Pen};
13use crate::damage::{LineBounds, LineDamage, ScrollOp, TermDamage};
14use crate::event::{ClipboardTarget, TermEvent, Terminator};
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.
50///
51/// **No `#[non_exhaustive]` (#844): nothing outside this crate has a reason to build one.** No
52/// public function accepts it — the engine hands it out — and there are zero out-of-crate literal
53/// sites, so the attribute would bind nothing it does not already bind.
54pub struct Term {
55 grid: Grid,
56 /// The inactive screen. Swapped with `grid` on alt-screen enter/leave; holds
57 /// whichever of primary/alternate is not currently shown. The alt screen has
58 /// no scrollback (#3 only rings the primary).
59 alt_grid: Grid,
60 cursor: Cursor,
61 /// Cursor saved on alt-screen enter (DEC 1049), restored on leave.
62 saved_cursor: Cursor,
63 /// Whether the alternate screen is currently active. Guards enter/leave so a
64 /// double-enter or double-leave is a no-op.
65 on_alt: bool,
66 /// One flag per column: is there a tab stop here? Explicit per-column state
67 /// (HTS sets, TBC clears), not a fixed modulo. Default = every 8th column.
68 tabs: Vec<bool>,
69 /// Which characters end a word for Word (semantic) selection — **consumer policy**,
70 /// not engine state (ADR-0017). Defaults to [`DEFAULT_WORD_SEPARATORS`]; replaced
71 /// through `set_word_separators`, which is also where the `' '` floor is enforced.
72 ///
73 /// Being *policy* is what puts it on the short list `full_reset` carries across RIS,
74 /// beside `replies` and `events`: `ESC c` resets the terminal's state, and a
75 /// consumer's configuration is not that. All three references survive RIS here by
76 /// construction rather than by remembering to — alacritty's `reset_state` never
77 /// touches `self.config`, xterm.js holds it in `OptionsService`, and ghostty passes
78 /// the set in per call.
79 word_separators: String,
80 /// The window title the application last set (OSC 0/2), retained so that a
81 /// title *pop* has something to restore (#823). Until XTWINOPS 22/23 landed
82 /// the engine forwarded the string and forgot it, which is exactly why a pop
83 /// could not be answered: a party that does not know what it is stacking
84 /// cannot maintain a stack, and the consumer cannot do it either — it holds
85 /// a frame and an event queue and never sees that a pop was requested.
86 ///
87 /// This is **terminal state the application owns**, so it dies on RIS. It
88 /// needs no entry in `full_reset`'s copy-back list — the wholesale rebuild
89 /// drops it, which is the behaviour alacritty spells out (`title_stack =
90 /// Vec::new()` in its `reset_state`). Note it is a *fifth* kind for the RIS
91 /// invariant note's table, which sorts fields into configuration / buffer
92 /// coordinate / pending obligation / id counter: a retained title is none of
93 /// those, and it dies because the application wrote it, not the embedder.
94 window_title: String,
95 /// The icon name, the second axis XTWINOPS addresses (#823). Narrower than
96 /// it looks: **OSC 1 is not parsed**, so the only thing that ever writes
97 /// this is OSC 0, which sets both axes at once. It is retained and stacked
98 /// anyway so that mixed push/pop sequences keep the two axes aligned — the
99 /// engine has no icon-name event, so restoring one has no observable output
100 /// today. That asymmetry is deliberate and stated rather than an oversight;
101 /// xterm.js takes the same route (`setIconName` fires nothing).
102 ///
103 /// **The obligation that outlives this comment: no test can observe this
104 /// field, so a fourth writer would disagree with the other three in
105 /// silence.** There are exactly three today, all in this file — `OSC 0` in
106 /// `osc_dispatch`, and the push and pop in [`Term::window_ops`] — and the
107 /// window axis funnels through [`Term::set_window_title`] precisely so its
108 /// retained string and its event cannot drift apart. This axis has no such
109 /// funnel because it has no event to keep in step with. **Adding `OSC 1` is
110 /// the foreseeable fourth writer** (it is the natural neighbour of the OSC
111 /// work in #47's tail), and whoever adds it should route every write through
112 /// one owner the way the window axis does — not because a test will fail,
113 /// but because none can.
114 icon_name: String,
115 /// The window-title stack (XTWINOPS `CSI 22 t` / `CSI 23 t`), bounded at
116 /// [`TITLE_STACK_DEPTH`]. Separate from `icon_name_stack` because the
117 /// sequence's second parameter selects an axis and real applications use it:
118 /// `vim` emits a fully nested `22;0;0t · 22;2t · 22;1t … 23;2t · 23;1t ·
119 /// 23;0;0t`.
120 ///
121 /// **This is a choice among three models, not two, and the spec does not
122 /// make it** — `ctlseqs.txt:1688-1693` names the two axes and never says how
123 /// many stacks there are. (a) One stack with the axis ignored: alacritty,
124 /// and it restores the wrong string on the sequence above. (b) Two
125 /// independent stacks: xterm.js, and this. (c) One stack of `{icon, window}`
126 /// **pairs**, where an axis-limited push leaves the other member empty and a
127 /// pop that finds an empty member walks *back* through older slots for one:
128 /// xterm (`ptyx.h:2361`, `misc.c:8011`). (c) handles the axis correctly by a
129 /// different mechanism, so the argument against (a) is not an argument
130 /// against it; what separates (b) from (c) is that they do not share a depth
131 /// budget — ten each here, ten *total* there — and that a repeated same-axis
132 /// pop goes silent under (b) while (c) re-emits from an older slot. Neither
133 /// shape is reachable by anything measured, and (b) is the one whose depth
134 /// accounting a reader can predict without simulating a ring.
135 window_title_stack: Vec<String>,
136 /// The icon-name stack — the other half of the pair above.
137 icon_name_stack: Vec<String>,
138 /// Origin mode (DECOM ?6): when set, cursor addressing is relative to the
139 /// scroll region's top margin (and clamped to it).
140 origin_mode: bool,
141 /// Autowrap (DECAWM ?7): default on. When off, a glyph past the right margin
142 /// pins the cursor to the last column and overwrites in place instead of
143 /// wrapping to the next line (matches xterm.js) (#63).
144 autowrap: bool,
145 /// Insert mode (IRM, the non-private SM/RM mode 4): default off (replace).
146 /// When on, a printed glyph shifts the row's tail right first (#64).
147 insert_mode: bool,
148 /// New-line mode (LNM, the non-private SM/RM mode 20): default off. When on,
149 /// a line feed also carriage-returns (`convertEol`). Output-only — the Enter
150 /// key still encodes CR, matching xterm.js (#71).
151 newline_mode: bool,
152 /// Reverse wraparound (DEC ?45): default off. When on, a step back at column 0
153 /// of a soft-wrapped row moves to the end of the previous row, and a step back
154 /// from a parked cursor spends the deferred wrap instead of moving. Both verbs
155 /// take that step — `BS` and `CSI D` alike, through `Term::step_back` (#80, #873).
156 /// Soft wraps only, and **both halves need `?7h` as well as this flag**: xterm reaches
157 /// them through one `rev`, which is `?45 AND ?7h` (`cursor.c:123-127`). The walk leaves
158 /// the wrap link alone — see the per-verb table on [`Term::end_wrap`].
159 reverse_wraparound: bool,
160 /// Bracketed-paste mode (DEC ?2004). The engine owns the flag; the input
161 /// encoder (#11) reads it to decide whether to wrap pasted text in markers.
162 bracketed_paste: bool,
163 /// Synchronized output (DEC ?2026): the app brackets a frame of output so the
164 /// renderer can paint it atomically. The engine only *tracks* the flag — the
165 /// consumer owns the paint-hold and the spec-mandated timeout (#73).
166 synchronized_output: bool,
167 /// Color-scheme-update notifications (DEC ?2031): the app asked to be told
168 /// when the light/dark scheme changes. The engine is theme-agnostic — it only
169 /// tracks the flag; the consumer (which knows the scheme) drives the ?997
170 /// notification via `report_color_scheme` (#85).
171 color_scheme_updates: bool,
172 /// Grapheme-cluster mode (DEC ?2027, default OFF): the app opted into UAX #29 grapheme-cluster
173 /// width — a ZWJ / skin-tone / flag / emoji+VS16 sequence is clustered into ONE cell instead of
174 /// one cell per scalar (#295). OFF keeps the per-char (wcwidth-compatible) behaviour so the
175 /// cursor stays in sync with wcwidth apps — clustering is opt-in for exactly that reason (#301).
176 grapheme_clustering: bool,
177 /// Where the last content-producing print landed — `(row, col)` of that cluster's
178 /// lead cell — or `None` when nothing has been printed since the last thing that
179 /// cleared it (#825).
180 ///
181 /// **One reader again — but the constraint the second one imposed is still binding.**
182 /// `REP` (CSI b) reads the grapheme back off this cell, and for a while
183 /// `Term::cursor_cluster_col` also asked *is the cursor standing on the cell the
184 /// print wrote*, because the deferred-wrap flag could not express a pin under `?7l`
185 /// (#865). #869 fixed the flag and that reader went back to it.
186 ///
187 /// **The anchor must still name a cell that holds the cluster, and the reason is
188 /// `REP`'s own, not the departed reader's.** A promotion at the last column
189 /// relocates the cluster to the next row (#303), so the join anchors on where it
190 /// landed rather than where it was joined; anchored on the vacated column, `REP`
191 /// repeats the blanks `vacate_for_wrap` left. Pinned by
192 /// `rep_after_a_promotion_relocated_the_cluster_repeats_the_cluster`. Stated here
193 /// because the rationale that arrived with it named the other reader, and removing
194 /// that reader must not read as permission to undo this.
195 ///
196 /// The grapheme itself is not stored: it is read back from this cell, which is what
197 /// keeps the repeated unit in step with what the cell model actually holds. The
198 /// **position** is recorded rather than re-derived, because re-deriving it from the
199 /// cursor cannot be done: with autowrap off the cursor reaches the last column both
200 /// by *filling* it (pinned, the cluster is under the cursor) and by *advancing onto*
201 /// it (the cluster is one to the left), and no cursor state distinguishes them. An
202 /// earlier version of this guessed with `pending_wrap || (!autowrap && col + 1 ==
203 /// cols)` and repeated whatever happened to sit in the last column — including, on
204 /// `?7l` + `ZZZZZ` + `CUP` + `abcd` + `CSI 1 b`, a `Z` from an unrelated earlier part
205 /// of the stream. Recording the site cannot be wrong about it.
206 ///
207 /// **Set** by the three sites that give a cell content, all reached through
208 /// `place_grapheme`, each returning where it wrote; **cleared** by every other
209 /// `Perform` callback and by [`Term::resize`], whose reflow moves the cell out from
210 /// under the anchor.
211 ///
212 /// That enumeration is xterm's rule (`charproc.c:6478` — assign the retained char
213 /// only when the parser is back in the ground state, and it is unset unless a
214 /// graphic character was printed) expressed the only way this crate can express it.
215 /// `vte`'s `Parser` publishes `new` / `new_with_size` / `advance` /
216 /// `advance_until_terminated` and **nothing about its state**, so the structural
217 /// formulation is unavailable and an enumeration is what is left.
218 ///
219 /// **The enumeration is incomplete, and cannot be completed against `vte` 0.15.**
220 /// Two parser states return to ground with no callback at all, so nothing here can
221 /// observe the sequence ending (measured by feeding `-`, the sequence, then
222 /// `CSI 3 b`; xterm gives one dash for every row):
223 ///
224 /// | input | reaches | dashes |
225 /// |---|---|---|
226 /// | `CSI 1 ? b`, `CSI SP 1 p`, `CSI ? ? m` | `State::CsiIgnore`, exiting at `vte-0.15.0/src/lib.rs:222` (`0x40..=0x7E => self.state = Ground`) | 4 |
227 /// | `DCS 1 ? q … ST` | `State::DcsIgnore`, which routes to `anywhere` and never calls `hook`/`unhook` | 4 |
228 ///
229 /// All of these are malformed sequences. The divergence is bounded by the anchor's
230 /// shape: with a *position* rather than a heuristic, a missed clear repeats the
231 /// genuinely last-printed grapheme where xterm repeats nothing — which is ghostty's
232 /// behaviour (`Terminal.zig:4467` clears only on full reset), not a wrong glyph.
233 ///
234 /// `Perform` methods that clear: `execute`, `esc_dispatch`, `osc_dispatch`, `unhook`,
235 /// and `csi_dispatch` (which takes it up-front and lets `REP` disarm itself —
236 /// xterm's behaviour, and not ghostty's, whose `printRepeat` re-arms through
237 /// `print`). `print` clears only on its zero-cell path; `hook` and `put` do not,
238 /// because nothing that could read this can arrive before `unhook` does.
239 repeat_anchor: Option<(usize, usize)>,
240 /// win32-input-mode (DEC ?9001): the app asked for keys as raw Windows
241 /// key-records. The engine only *tracks* the flag — the raw record encoding
242 /// (`CSI Vk;Sc;Uc;Kd;Cs;Rc _`) is a non-goal (raw passthrough, no semantic
243 /// conversion), left to the ConPTY consumer; `encode_key` is unchanged (#86).
244 win32_input_mode: bool,
245 /// Application cursor keys (DECCKM ?1): when set, cursor keys / Home / End
246 /// encode as SS3 rather than CSI (see `input.rs`).
247 app_cursor_keys: bool,
248 /// Application keypad mode (DECNKM ?66 / DECKPAM `ESC =` / DECKPNM `ESC >`):
249 /// tracked for protocol completeness + DECRQM, but NOT yet acted on in key
250 /// encoding — xterm.js tracks it the same way and never reads it (#74).
251 application_keypad: bool,
252 /// VT52 compatibility mode (DECANM ?2 *reset*): when set, `esc_dispatch` is
253 /// re-routed into the pre-ANSI VT52 dialect (`ESC A`-style sequences) instead
254 /// of the ANSI meaning. `ESC <` clears it. Default off (ANSI). (#84)
255 vt52_mode: bool,
256 /// VT52 `ESC Y row col` direct-addressing state (#84). vte tokenizes `ESC Y`
257 /// as a final and returns to ground, so the two coordinate bytes arrive as
258 /// `print()` calls — not part of the escape sequence. This counts them down
259 /// (2 → 1 → 0; 0 = not addressing) and `vt52_y_row` parks the first (row)
260 /// until the second (col) lands. Each byte decodes as `value - 0x20`.
261 vt52_y_pending: u8,
262 vt52_y_row: usize,
263 /// Mouse tracking mode — what events the app asked to be reported
264 /// (?1000/?1002/?1003). `Off` by default.
265 mouse_protocol: MouseProtocol,
266 /// Mouse coordinate encoding (default X10 vs ?1006 SGR).
267 mouse_encoding: MouseEncoding,
268 /// Focus in/out reporting (?1004): emit `CSI I`/`CSI O` on focus change.
269 focus_events: bool,
270 /// Kitty keyboard-protocol progressive-enhancement flags currently in effect
271 /// (bit0 disambiguate, bit1 report-events, bit2 alt-keys, bit3 all-as-escape,
272 /// bit4 associated-text). 0 = legacy. `encode_key` consults these (#23).
273 kitty_flags: u8,
274 /// Saved `kitty_flags` for the protocol's push/pop stack (`CSI > u` pushes,
275 /// `CSI < u` pops). Capped depth — overflow drops the oldest entry.
276 kitty_stack: Vec<u8>,
277 /// xterm's `modifyOtherKeys` at level 2 or above, asked for with
278 /// `CSI > 4 ; Pv m` (XTMODKEYS) and what `vim` turns on at startup (#890).
279 /// `encode_key` consults it *after* `kitty_flags`, because it belongs to the
280 /// legacy encoding rather than competing with the newer protocol.
281 ///
282 /// **Both resets clear it**, RIS by the wholesale rebuild in [`Self::full_reset`] and
283 /// DECSTR by a line of its own in [`Self::soft_reset`]. Which it is, and why the answer
284 /// is the reference's rather than a convenience, is in
285 /// `docs/map/invariant/ris-keeps-configuration-drops-coordinates.md`, whose table this
286 /// field is the fifth row of.
287 modify_other_keys_2: bool,
288 /// Consumer events (title / bell / cwd) accumulated since the last
289 /// `drain_events` (#12). Pull, not push — see `event.rs`.
290 events: Vec<TermEvent>,
291 /// Outbound reply bytes (DA/DSR/DECRQM query answers, #27) accumulated
292 /// during `feed` for the consumer to write back to the PTY. Raw bytes →
293 /// PTY, kept separate from typed `events` → UI.
294 replies: Vec<u8>,
295 /// The hyperlink currently open (OSC 8 with a URI), stamped onto every glyph
296 /// written until closed (OSC 8 with empty URI). Ambient pen-like state — not
297 /// part of the pen/SGR, and *not* cleared by an SGR reset.
298 ///
299 /// The URI itself, not a pool index — there is no pool (#628). The lead paragraph
300 /// here used to describe one (*"Hyperlink side-table … referenced by `Cell.link`
301 /// (1-based). Append-only (#26)"*), left behind when its field was deleted.
302 current_link: Option<std::sync::Arc<str>>,
303 /// Live OSC 8 `id=` groups: `"id;;uri"` → the allocation that key already named,
304 /// held **weakly** (#635).
305 ///
306 /// `Weak`, not `Arc`, is the whole lifetime story. A strong entry here would make
307 /// every id'd link immortal for the life of the `Term` — precisely the leak #628
308 /// deleted, re-entering through the door grouping opens. A dangling key is the
309 /// correct answer rather than a hole: the link it named has left the buffer, so a
310 /// later open of the same id is genuinely a new link. xterm.js expresses the same
311 /// lifetime by *deleting* its `_entriesWithId` entry when the last line marker
312 /// referencing it is disposed (`OscLinkService.ts:98-100`); justerm has no disposal
313 /// hook by design, and `Weak` is that lifetime without one.
314 link_ids: std::collections::HashMap<String, std::sync::Weak<str>>,
315 /// Map length at which [`Self::link_ids`] is swept for dangling keys, doubling each
316 /// time so the sweep is amortised O(1) per open and dead keys stay O(live).
317 ///
318 /// A sweep is affordable here for the reason #628's rejected option (c) was not:
319 /// staleness is observable in O(1) (`Weak::strong_count`), where (c) had to decide
320 /// "is the pool oversized" by counting live references — the O(buffer) walk it was
321 /// trying to avoid.
322 link_ids_sweep_at: usize,
323 /// Scroll region top/bottom margins (DECSTBM), 0-based inclusive. A
324 /// line-feed at `scroll_bottom` scrolls only rows `[scroll_top..=scroll_bottom]`.
325 /// Default = the full screen.
326 scroll_top: usize,
327 scroll_bottom: usize,
328 /// Lines that have scrolled off the top of the primary screen, oldest at the
329 /// front. Accrues only on a top-anchored, primary-screen scroll.
330 scrollback: VecDeque<Row>,
331 /// How many lines the viewport is scrolled up from the bottom. 0 = following
332 /// the live screen; clamped to `[0, scrollback.len()]`.
333 display_offset: usize,
334 /// Maximum scrollback lines retained; the oldest are evicted past this.
335 scrollback_limit: usize,
336 /// A spare row buffer recycled across full-screen scrolls: the cap-evicted
337 /// oldest line is parked here and reused as the next scroll's blank bottom,
338 /// so a steady-state flood allocates nothing (ADR-0009).
339 recycled_row: Option<Row>,
340 /// Per-line damage bounds since the last `reset_damage` (ack), one per row.
341 line_damage: Vec<LineBounds>,
342 /// A first-class scroll recorded since the last `reset_damage`.
343 scroll: Option<ScrollOp>,
344 /// The whole screen changed (alt switch / clear / later resize+flood) — the
345 /// renderer must redraw everything.
346 full_damage: bool,
347 /// The cursor `(row, col)` at the last `reset_damage` (ack) — where the
348 /// consumer last saw the caret. A pure cursor move records no content
349 /// damage, so `damage()` folds this *old* cell plus the current one into the
350 /// frame; without it a cell-invert caret ghosts at the old spot (mirrors
351 /// Alacritty's `last_cursor`). #38.
352 prev_cursor: (usize, usize),
353 /// The live selection, in absolute buffer coordinates. `None` when nothing
354 /// is selected. See `selection.rs`.
355 selection: Option<Selection>,
356 /// The search highlights the consumer asked to paint (#108). Search
357 /// matches are consumer-owned (it drives next/prev), so the engine holds only
358 /// the set handed back via `set_search_highlights`, and `frame()` projects it
359 /// onto the viewport — the same anchoring path as the selection.
360 search_highlights: Vec<Match>,
361 /// The *active* (current) search match (#428), stored as its absolute span
362 /// (#436) — designated by the consumer (next/prev is its policy) either as
363 /// an index into `search_highlights` (resolved to the span at call time) or
364 /// directly by span, which a capping backend uses for a past-cap match
365 /// (xterm creates its active decoration from the found result, OUTSIDE the
366 /// capped highlight list). A span is NOT structurally tied to the set, so
367 /// every path that voids the set must void this too: `set_search_highlights`
368 /// (hand-over reset, #428) and `invalidate_search_highlights` (the single
369 /// funnel for eviction / every region scroll incl. the accrual sub-region
370 /// branch (#449) / reflow / both alt swaps) — a stale span would otherwise
371 /// keep painting coordinates that now hold other text.
372 ///
373 /// **That list is the *motion* funnel, and it is complete only for motion.** An
374 /// in-place erase or overwrite stales this set too, and deliberately does not
375 /// funnel — read `invalidate_search_highlights`, which owns that decision and its
376 /// grounds. Stated here because this comment enumerating the callers reads as the
377 /// whole rule, and a reader who stops at it concludes the erase verbs were
378 /// forgotten (#750).
379 active_search_highlight: Option<Match>,
380 /// Engine-owned decoration markers (#118), split per buffer like xterm's
381 /// `BufferSet` (#177 S0): each a stable id bound to an absolute buffer line
382 /// that re-anchors through eviction/scroll/reflow like a selection anchor. The
383 /// active buffer's list is selected by `on_alt` — `markers`/`markers_mut`.
384 /// `alt_markers` stays empty while the alt guards (#158/#164) are in place; it
385 /// is disposed on alt-leave (xterm `clearAllMarkers`). `next_marker_id` hands
386 /// out monotonic ids across both buffers so ids never alias.
387 normal_markers: VecDeque<Marker>,
388 alt_markers: VecDeque<Marker>,
389 next_marker_id: u32,
390 /// The basis that keeps a *pulled* marker index valid without re-pulling
391 /// (#490). Both are reported by [`Term::marker_index`] and — from the wire
392 /// slice on — by the frame header, so a consumer can compare what it holds
393 /// against what is current.
394 ///
395 /// `evicted_total` counts lines popped off the front of scrollback since
396 /// startup or RIS. Eviction shifts **every** live marker by the same −1, so
397 /// that whole class of movement is one number rather than M facts, and a
398 /// consumer rebases a held line by the delta.
399 ///
400 /// `marker_epoch` covers everything the delta cannot express: a mutation
401 /// after which a held line is wrong for a reason no single offset repairs.
402 /// It says *"what you pulled no longer describes this buffer"* — not *"a verb
403 /// ran"*, which is why the movers bump it only when a surviving marker's line
404 /// actually moved. Disposal is deliberately **not** a bump: a consumer learns
405 /// of that through `TermEvent::MarkerDisposed` and can drop the entry without
406 /// asking for the rest again.
407 evicted_total: u64,
408 marker_epoch: u32,
409 /// Positions the engine keeps on their content for a holder that lives
410 /// *outside* it (#691). Split per buffer and re-anchored by the same fixups as
411 /// the markers beside them; the difference is that nothing here reaches a
412 /// frame — a tracked point is answered on request, never projected.
413 normal_tracked: Vec<TrackedPoint>,
414 alt_tracked: Vec<TrackedPoint>,
415 next_tracked_id: u32,
416 /// Cursor state saved by DECSC (ESC 7), restored by DECRC (ESC 8). A slot
417 /// separate from `saved_cursor` (which is the alt-screen save). Defaults to
418 /// home/default so a DECRC with no prior DECSC restores a sane state.
419 decsc: SavedCursor,
420 /// SCS-designated character sets G0..G3 (#62). `gl` indexes the active (GL)
421 /// set, switched by SI (→G0) / SO (→G1). First cut uses G0/G1.
422 charsets: [Charset; 4],
423 gl: usize,
424}
425
426/// A character set designated by SCS (#62). First cut: ASCII (default), DEC
427/// Special Graphics (line-drawing), and UK. G2/G3 and the GR half are later.
428#[derive(Clone, Copy, PartialEq, Eq, Default)]
429enum Charset {
430 #[default]
431 Ascii,
432 DecSpecialGraphics,
433 Uk,
434}
435
436impl Charset {
437 /// Map one GL byte (a `char` in the 7-bit range) through this set. ASCII and
438 /// any out-of-range char pass through; UK swaps `#`→£; DEC Special Graphics
439 /// translates `_`..`~` to the line-drawing / symbol glyphs.
440 fn map(self, c: char) -> char {
441 match self {
442 Charset::Ascii => c,
443 Charset::Uk if c == '#' => '£',
444 Charset::Uk => c,
445 Charset::DecSpecialGraphics => dec_special_graphics(c),
446 }
447 }
448}
449
450/// The VT100 DEC Special Graphics set: bytes `_`..`~` (0x5F..0x7E) map to the
451/// box-drawing and symbol glyphs. Matches xterm/alacritty; anything outside the
452/// range passes through unchanged.
453fn dec_special_graphics(c: char) -> char {
454 // Keys ``..`~` only — `_` (0x5F) is deliberately absent, matching xterm.js /
455 // alacritty (it passes through as a literal underscore), not the strict-DEC
456 // "0x5F = blank" reading.
457 match c {
458 '`' => '◆',
459 'a' => '▒',
460 'b' => '␉',
461 'c' => '␌',
462 'd' => '␍',
463 'e' => '␊',
464 'f' => '°',
465 'g' => '±',
466 'h' => '',
467 'i' => '␋',
468 'j' => '┘',
469 'k' => '┐',
470 'l' => '┌',
471 'm' => '└',
472 'n' => '┼',
473 'o' => '⎺',
474 'p' => '⎻',
475 'q' => '─',
476 'r' => '⎼',
477 's' => '⎽',
478 't' => '├',
479 'u' => '┤',
480 'v' => '┴',
481 'w' => '┬',
482 'x' => '│',
483 'y' => '≤',
484 'z' => '≥',
485 '{' => 'π',
486 '|' => '≠',
487 '}' => '£',
488 '~' => '·',
489 other => other,
490 }
491}
492
493/// Default scrollback retention when not specified.
494const DEFAULT_SCROLLBACK: usize = 10_000;
495
496/// The narrowest screen the engine represents: **two columns**.
497///
498/// A width-2 glyph occupies a `WIDE_CHAR` lead *and* the `WIDE_CHAR_SPACER` that
499/// stands for its second half, so one column cannot hold one — and a pair with only
500/// one half written is the malformed state every repair path in this crate keys off
501/// (ADR-0025 D4). `Term::with_scrollback` and [`Term::resize`] clamp `cols` up to
502/// this, which is what makes D4 (*both halves of a pair move together*)
503/// unconditionally satisfiable rather than true only above some unstated width.
504///
505/// Both references that a terminal *engine* can be compared to forbid one column for
506/// exactly this reason — alacritty's `MIN_COLUMNS = 2` and xterm.js's
507/// `MINIMUM_COLS = 2` — and the third (ghostty) permits it only by destroying the
508/// glyph.
509///
510/// The clamp is **silent and pull-only**: a `resize(1, rows)` during a pane drag is
511/// widened rather than rejected, and no event reports it. Both references instead
512/// make the clamped size the one that travels outward — alacritty derives its
513/// `WindowSize` from the clamped `SizeInfo`, xterm.js fires `onResize` with the
514/// clamped pair — so a justerm consumer must do that correlation itself: read the
515/// width back from [`Term::grid`] / the frame header and size the PTY from *that*,
516/// never from the value it requested. Sizing a PTY to one column leaves the
517/// application rendering for a width the buffer does not have (#547).
518pub const MIN_COLUMNS: usize = 2;
519
520/// The built-in word-boundary set for Word (semantic) selection — the default value of
521/// [`Term::set_word_separators`], and **policy the consumer may replace** (ADR-0017:
522/// mechanism in core, policy injected).
523///
524/// It is alacritty's `SEMANTIC_ESCAPE_CHARS` (`alacritty_terminal/src/term/mod.rs:45`
525/// @ `852e971`) verbatim — space, tab and a punctuation set that deliberately omits
526/// `.`, `/` and `-` so a path or URL stays one word — **plus U+3000 IDEOGRAPHIC
527/// SPACE**, which is justerm's one divergence from every reference default.
528///
529/// Two properties of this list are load-bearing and neither is obvious:
530///
531/// - **It is a literal set, not the Unicode `White_Space` property.** The predicate was
532/// `char::is_whitespace()` until #545, so every space-like codepoint ended a word —
533/// including the four `Line_Break=GL` (glue) ones U+00A0, U+2007, U+202F and U+205F,
534/// whose whole purpose is "do not break here". A locale-formatted `1<NNBSP>234`
535/// double-clicked as `1`. All three references are literal sets for the same reason.
536/// - **U+3000 is in it, and no reference's default has it.** It is the only
537/// East-Asian-Wide codepoint `White_Space` accepts (measured over U+0000–U+10FFFF),
538/// so on alacritty and xterm.js ` abc` is one word while justerm gives the useful
539/// answer. Keeping it was argued in #535 *on the grounds that core had no injection
540/// point*; that ground is gone, so it survives here as a **default**, and a consumer
541/// who wants reference-exact behaviour removes it.
542///
543/// [`Term::set_word_separators`] additionally forces `' '` into whatever it is given —
544/// see there for why that floor is not optional.
545pub const DEFAULT_WORD_SEPARATORS: &str = ",│`|:\"' ()[]{}<>\t\u{3000}";
546
547/// A declared OSC 8 hyperlink, as handed to a consumer.
548///
549/// **Owned, not borrowed**, and that is the point: the URI lives in a row's side map, so
550/// a `&str` into it would be tied to `&Engine` and a caller could not hold the link
551/// across the next `feed()` — which is precisely what a hover handler does. Measured on
552/// the alternative: reading a borrow costs 0.75 ns, but keeping it *does not compile*, so
553/// the caller copies the string instead at 62.6 ns. Handing back this handle is 17.9 ns
554/// — cheaper than the workaround it removes, on a call made once per hover.
555///
556/// Cloning is a refcount bump; the allocation is shared with every cell of the same OSC 8
557/// open and released when the last row holding it dies (#628).
558///
559/// **A struct rather than a bare `Arc<str>`** for two reasons: it keeps `Arc` out of the
560/// published signature, and OSC 8's `id=` parameter (#635) lands here as a field without
561/// changing the return type again. Same shape as alacritty's `Hyperlink`, for the same
562/// reasons (`alacritty_terminal/src/term/cell.rs`).
563///
564/// **Link *identity* is deliberately not exposed yet.** Two OSC 8 opens of an identical
565/// URI are two links here, so `uri() == uri()` cannot answer "is this cell part of the
566/// same link as that one?" — an `Arc::ptr_eq` accessor would. It is left out because no
567/// consumer asks it today (nothing outside this crate's tests calls `link_at` at all),
568/// and unlike this type's *shape*, adding a method later is not a breaking change. The
569/// asymmetry decides it: shipping an accessor nobody uses is hard to undo, adding one
570/// when a caller appears is free.
571///
572/// **No `#[non_exhaustive]` (#844): nothing outside this crate has a reason to build one.** No
573/// public function accepts it — the engine hands it out — and there are zero out-of-crate literal
574/// sites, so the attribute would bind nothing it does not already bind.
575#[derive(Clone, PartialEq, Eq, Debug)]
576pub struct Hyperlink {
577 uri: std::sync::Arc<str>,
578}
579
580impl Hyperlink {
581 pub(crate) fn new(uri: std::sync::Arc<str>) -> Self {
582 Hyperlink { uri }
583 }
584
585 /// The link target, exactly as the application declared it — never validated,
586 /// never resolved. Whether it is a URL a consumer is willing to open is that
587 /// consumer's policy (ADR-0017), the same way colour resolution is.
588 ///
589 /// **One exception to "exactly":** a URI containing 14 or more unencoded `;` arrives
590 /// cut short, because the parser this engine builds on passes at most 16 OSC fields.
591 /// The shorter URI is not marked as cut. A percent-encoded `%3B` is unaffected.
592 pub fn uri(&self) -> &str {
593 &self.uri
594 }
595}
596
597/// Length at which the `id=` group map is first swept for dangling keys, doubling from
598/// there. Small enough that a session declaring a handful of ids never pays a sweep,
599/// large enough that the sweep is not the common path.
600const LINK_IDS_FIRST_SWEEP: usize = 16;
601
602/// How deep an XTWINOPS title stack goes before a push starts dropping the
603/// oldest entry (#823).
604///
605/// Ten is **two implementations plus a spec inference**, not a clean sweep, and
606/// the difference is worth stating so nobody reads it as more than it is:
607/// xterm's `MAX_SAVED_TITLES` (`ptyx.h:2357`) and xterm.js's
608/// `Constants.STACK_LIMIT` both say ten, and the spec describes the
609/// direct-access parameter as taking a value *"in the range 1 through 10"*
610/// (`ctlseqs.txt:1698`), which only makes sense against a ten-slot stack.
611/// **alacritty is 4096** (`TITLE_STACK_MAX_DEPTH`), so the corpus is 2–1 on the
612/// number. Nothing observed nests deeper than three, so the bound is a
613/// robustness cap rather than a compatibility one, and ten is the value two
614/// references chose for exactly that job.
615///
616/// The **overflow rule**, unlike the number, is 4-for-4: drop the oldest and let
617/// the push succeed. xterm.js `shift()`s, alacritty `remove(0)`s, and xterm gets
618/// there by arithmetic rather than by saying so — `which = used++ %
619/// MAX_SAVED_TITLES` writes an eleventh push over slot 0, which is the oldest.
620/// Refusing the push instead would break the pairing for the *innermost*
621/// nesting levels — the ones a user unwinds first — and nobody does it.
622const TITLE_STACK_DEPTH: usize = 10;
623
624/// The `id=` value out of an OSC 8 `params` field, or `None` when it is absent or empty.
625///
626/// Three rules, each taken from xterm.js's `_createHyperlink` verbatim rather than from
627/// the spec prose, because each is a place a reasonable reading goes wrong
628/// (`src/common/InputHandler.ts:3128-3131` at the pinned SHA `699f5537b023`):
629///
630/// - **`:`-separated**, not `;` — `params` is one OSC argument holding a key=value list
631/// (`id=xyz123:foo=bar:baz=quux`), so the split is on colons (`params.split(':')`).
632/// - **`id` may sit anywhere in it** (`findIndex(e => e.startsWith('id='))`), so matching
633/// only a leading `id=` is the wrong parse and passes a single-parameter test.
634/// - **an empty value is not an id** (`slice(3) || undefined`). This is the one with teeth:
635/// an empty key would group every `id=`-with-no-value link in a session into one link
636/// across unrelated URIs, and it is a wrong answer that grows with uptime.
637///
638/// Only the first `id=` is consulted, matching `findIndex` — an empty first one yields
639/// `None` rather than searching on for a non-empty sibling.
640fn osc8_link_id(params: &[u8]) -> Option<&[u8]> {
641 params
642 .split(|b| *b == b':')
643 .find_map(|kv| kv.strip_prefix(b"id="))
644 .filter(|value| !value.is_empty())
645}
646
647/// The widest grid the engine will hold, and the mirror of [`MIN_COLUMNS`] — but derived
648/// from a different kind of constraint, which is why the two are not symmetric.
649///
650/// The floor is **semantic**: a width-2 glyph needs two cells, so one column is a screen
651/// no correct grid can be. The ceiling is **representational**: the frame header stores
652/// `cols` and `rows` as `u16` each, so a grid wider than `u16::MAX` cannot be *described*
653/// to a consumer even though the engine could hold it. Without the clamp that mismatch was
654/// silent — measured, `Engine::new(70_000, 2)` built a 70 000-column grid whose frame
655/// declared `cols = 4464` and decoded `Ok`, so a consumer laid out 4464 columns of a
656/// 70 000-column screen with nothing reporting the difference (#621).
657///
658/// No reference bounds a grid this way, and that is expected rather than a divergence:
659/// none of them serializes a grid, so none has a header field to overflow. This is the
660/// one axis where justerm's own wire is the only authority.
661///
662/// **A backstop, not a policy.** A 4K display at a very small font is roughly 550 columns;
663/// this is two orders of magnitude past any real terminal, so it should never be reached
664/// by a consumer that is not already doing something wrong. The clamp is silent and
665/// pull-only on the same terms as [`MIN_COLUMNS`] — read the size back from
666/// [`Term::grid`] rather than trusting the value you passed in.
667pub const MAX_COLUMNS: usize = u16::MAX as usize;
668
669/// The tallest grid the engine will hold. The row half of [`MAX_COLUMNS`] — same
670/// `u16` header field, same reasoning, same silent-clamp contract.
671pub const MAX_ROWS: usize = u16::MAX as usize;
672
673/// The most live markers one buffer will hold (#721).
674///
675/// Derived from the wire the same way [`MAX_COLUMNS`] is: the marker group's count
676/// are `u16`, so a population past `u16::MAX` encodes a wrapped count while writing
677/// every record, and `decode` then reads the next group's count out of the middle of
678/// a marker record and returns `Ok`. The field bounds the value; this constant only
679/// writes that bound down where the value is produced, because `encode` returns
680/// `Vec<u8>` and has no channel to refuse.
681///
682/// **Why a bound is needed at all**, rather than a wider field: markers are allocated
683/// by the *stream*. `add_command_mark` appends per OSC 133 sequence, several marks can
684/// share one line, and scrollback eviction only drops a marker when its line reaches
685/// absolute 0 — so a stream that never emits a newline accumulates marks in a 24-row
686/// buffer without bound (measured: 70 000, #721). [`crate::Engine::feed`] is an untrusted
687/// entry point (ADR-0007), and unbounded allocation behind it is a defect class that
688/// record exists to catch.
689///
690/// **A backstop, not a policy**, on the same terms as [`MAX_COLUMNS`]. Ordinary shell
691/// integration emits at most four marks per command and a command occupies at least one
692/// line, so a default-scrollback session tops out near 40 000 — this is not reached by a
693/// consumer that is not already being fed something hostile. Overflow disposes the
694/// *oldest* marker and announces it through `TermEvent::MarkerDisposed`, which is the
695/// channel scrollback eviction already uses for the same event.
696pub const MAX_MARKERS: usize = u16::MAX as usize;
697
698/// The longest command text an OSC-133 `OutputStart` mark will freeze, in `char`s
699/// (#750). A longer command is captured truncated to this many characters.
700///
701/// **Why a bound at all** is [`MAX_MARKERS`]'s argument one field over: the *stream*
702/// decides the size. The text spans `[B, C)`, and nothing bounds how far apart those
703/// two sequences are — a stream that emits `B`, dumps a full screen and then `C` names
704/// a command as long as the buffer. Re-extracting on demand made that a transient
705/// allocation; freezing it at `C` makes it resident, for as long as the mark lives, and
706/// [`crate::Engine::feed`] is an untrusted entry point (ADR-0007).
707///
708/// **A display bound, not a semantic one.** [`CommandLine::command`]'s consumer
709/// announces it and lists it; a prefix is a usable answer and an absent one is not, so
710/// overflow truncates rather than declining to capture. The truncation is at a `char`
711/// boundary, so the answer is always valid text. No ordinary command reaches it — this
712/// is not a limit a shell user can type into.
713pub const MAX_COMMAND_TEXT: usize = 4096;
714
715/// The longest `OSC 52` base64 payload the engine will decode, in bytes (#828).
716/// A longer one is **dropped whole**, never truncated.
717///
718/// **What this bounds is ours, not the parser's, and the difference was
719/// measured.** `vte` is built with its default features, so its OSC accumulator
720/// is a `Vec<u8>` rather than the `ArrayVec<_, 1024>` of its `no_std` path: a
721/// 4 MB payload arrives at `osc_dispatch` complete, 4 000 003 bytes across three
722/// fields. Anyone reading this bound as "the engine cannot be made to allocate"
723/// has the wrong model; `vte` already did, before the handler ran.
724///
725/// What it does refuse is the **second** allocation — the rejoin, which copies
726/// every field again — and everything downstream of it. That is why the check
727/// sums the field lengths rather than measuring the joined payload: a bound
728/// applied *after* the join would let a hostile stream buy the copy it was
729/// meant to prevent, which is what the first draft did. The decoded `Vec` is a
730/// third; the `String` is not a fourth, since `String::from_utf8` reuses the
731/// buffer it is given. The property all of it buys is the one worth naming: no
732/// unbounded string crosses the boundary into a consumer that then has to hold
733/// it.
734///
735/// **It does not bound the queue, and the queue is unbounded.** `drain_events`
736/// is pull-style with no back-pressure, so a consumer that does not drain
737/// accumulates stores at up to this size each — the pre-existing hole
738/// `docs/map/territory/events-and-replies.md` records, which this sequence
739/// enlarges by roughly three orders of magnitude over the next-largest payload
740/// (`MAX_COMMAND_TEXT`, 4096). Bounding a queue nobody drains is a different
741/// decision from bounding a payload, and it is not taken here.
742///
743/// **Dropped rather than truncated**, which is the opposite of
744/// [`MAX_COMMAND_TEXT`] one field up, and the asymmetry is the point: a prefix of
745/// a command is a usable answer, while a prefix of a clipboard is text the user
746/// pastes somewhere believing it is what they copied. An ignored copy is visible
747/// the moment they paste; a truncated one is not.
748///
749/// **A backstop, not a policy**, and sized so that no real copy reaches it: 16
750/// MiB of base64 is ~12 MiB of text, well past a whole scrollback buffer's worth
751/// of `tmux set-buffer`. Neither reference has a hard cap to import — alacritty
752/// has none at all and ghostty's `MAX_BUF = 2048` is an inline-buffer threshold
753/// with an allocator path past it (`src/terminal/osc.zig:298`) — so this number
754/// is justerm's own and is chosen by what it must not break rather than by what
755/// it permits.
756pub const MAX_CLIPBOARD_BASE64: usize = 16 * 1024 * 1024;
757
758/// The state DECSC (ESC 7) saves and DECRC (ESC 8) restores: position, pen/SGR,
759/// pending-wrap, and origin mode (per ADR-0004 — DECRC restores origin mode,
760/// which Alacritty omits). Cursor *visibility* is deliberately not part of this
761/// (DECTCEM is separate from DECSC).
762#[derive(Clone, Copy, Default)]
763struct SavedCursor {
764 row: usize,
765 col: usize,
766 pen: Pen,
767 pending_wrap: bool,
768 origin_mode: bool,
769 /// SCS charset state at save time — DECSC/DECRC round-trip the designated
770 /// sets and the active GL shift (#62).
771 charsets: [Charset; 4],
772 gl: usize,
773}
774
775/// An engine-owned decoration marker (#118): a stable id bound to an absolute
776/// buffer line. The line shifts in lockstep with eviction/region scroll/reflow
777/// (the same coordinate moves the selection anchor tracks); the marker is
778/// dropped when its line leaves the buffer — **or when `ED` blanks the whole row
779/// it stands on** (#750), which is the one death that is not the buffer moving.
780struct Marker {
781 id: MarkerId,
782 line: usize,
783 /// The cursor column at emit time (#166). Meaningful for OSC-133 command
784 /// marks — CommandStart(B)/OutputStart(C) columns bound the *typed command*
785 /// (excluding the prompt), like VSCode's `commandStartX`/`commandExecutedX`.
786 /// Plain `add_marker` decorations are row-granular and carry `col = 0`.
787 ///
788 /// **Domain is `[0, cols]`, not `[0, cols - 1]` (#562)** — a bound, not a cell.
789 /// A command that exactly fills its row ends *one past* the last column, and
790 /// that value is what `extract_lines` wants: it clips `[b_col, c_col)`, so the
791 /// exclusive end absorbs it through `.min(cells.len())`. Storing `cursor.col`
792 /// alone (the cursor is held at `cols - 1` with `pending_wrap`) cost such a
793 /// command its last character with no resize involved. The **inclusive** side
794 /// cannot absorb it, so `extract_lines` steps a `from` of `cells.len()` to the
795 /// next line rather than selecting an empty run and flushing a `\n`.
796 col: usize,
797 /// Plain for a `add_marker` decoration; a command-boundary role for an
798 /// OSC 133 mark (#158). All kinds share the anchor/eviction machinery.
799 kind: MarkerKind,
800 /// What an `OutputStart` mark froze about the command it closes (#750) —
801 /// `None` on every other kind, and the reason this is one boxed pointer rather
802 /// than two inline fields: three marks in four never carry it, and the
803 /// population is bounded at [`MAX_MARKERS`].
804 ///
805 /// It dies with the marker, which is the point: a side table keyed by
806 /// [`MarkerId`] would need its own purge at every disposal site, i.e. exactly
807 /// the missing-destruction-funnel defect this issue is about (ADR-0025 D1 —
808 /// a fact lives with its owner).
809 command: Option<Box<CommandRecord>>,
810}
811
812/// The part of a command that is **not** in the buffer, frozen on its `OutputStart`
813/// mark (#750).
814///
815/// Both fields are recorded at the instant they are first true, and neither can be
816/// recovered afterwards:
817///
818/// - `text` is complete and on screen exactly when `C` arrives. Re-reading it later
819/// through the recorded `[b_col, c_col)` clip names whatever now occupies those
820/// cells — measured for a plain overwrite, ICH, DCH and an erase, and only the last
821/// of those is a verb any mark-lifetime rule could reach.
822/// - `exit` arrives with `D`, one mark later, and lives in no cell at all. Resolving it
823/// at query time meant pairing over *survivors* (`out.last_mut()`), which re-parented
824/// a code onto the previous command as soon as a disposal broke the run. Written here
825/// when `D` is parsed, a disposal can only drop an answer, never move one.
826struct CommandRecord {
827 text: Box<str>,
828 exit: Option<i32>,
829}
830
831/// A stable handle to a tracked buffer position (#691), handed out by
832/// [`Term::track_point`].
833///
834/// It is deliberately **not** a [`MarkerId`]: a marker is a decoration anchor and
835/// rides two frame groups, so every marker a consumer registers is something the
836/// renderer paints. A tracked point is private to whoever asked for it.
837///
838/// **No `#[non_exhaustive]` (#844): the attribute is already implied.** The field is `pub(crate)`,
839/// so no literal is possible outside this crate however many fields it grows.
840#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
841pub struct TrackedId(pub(crate) u32);
842
843/// One tracked position: an absolute buffer `(line, col)` the write path keeps on
844/// its content (#691). The element type of `normal_tracked` / `alt_tracked`.
845struct TrackedPoint {
846 id: TrackedId,
847 line: usize,
848 col: usize,
849}
850
851/// One live marker, as the pull query reports it (#490): its stable id, its
852/// **absolute** `[scrollback ++ screen]` line, and the static facts a consumer
853/// would otherwise have to re-learn from every frame.
854///
855/// `kind` and `exit` ride here rather than on the frame because they never change
856/// after `push_marker` — re-sending them per frame is the same class of waste as
857/// re-sending the line.
858///
859/// **No `#[non_exhaustive]` (#844): nothing outside this crate has a reason to build one.** No
860/// public function accepts it — the engine hands it out — and there are zero out-of-crate literal
861/// sites, so the attribute would bind nothing it does not already bind.
862#[derive(Debug, Clone, PartialEq, Eq)]
863pub struct MarkerEntry {
864 pub id: MarkerId,
865 pub line: u32,
866 pub kind: MarkerKind,
867}
868
869/// The answer to [`Term::marker_index`] (#490) — every live marker of the *active*
870/// buffer, plus the basis that says how long the answer stays usable.
871///
872/// The consumer keeps this and rebases per frame:
873/// `current = line - (evicted_total_now - evicted_total)`, valid for exactly as long
874/// as `epoch` is unchanged. When the epoch moves, the held lines are wrong in a way
875/// no offset repairs and the consumer asks again.
876///
877/// It reports the active buffer because an absolute index means a different thing on
878/// each screen — the same reason `markers`/`markers_mut` route by `on_alt`. An
879/// alt-screen switch therefore bumps the epoch even though no line moved: what the
880/// answer *describes* changed.
881///
882/// **No `#[non_exhaustive]` (#844): nothing outside this crate has a reason to build one.** No
883/// public function accepts it — the engine hands it out — and there are zero out-of-crate literal
884/// sites, so the attribute would bind nothing it does not already bind.
885#[derive(Debug, Clone, PartialEq, Eq)]
886pub struct MarkerIndex {
887 pub markers: Vec<MarkerEntry>,
888 pub evicted_total: u64,
889 pub epoch: u32,
890}
891
892/// One executed shell command recovered from OSC-133 marks (#166), for
893/// screen-reader command navigation. The consumer jumps prompt-to-prompt over
894/// these and announces `command` + a success/fail signal from `exit`.
895///
896/// **No `#[non_exhaustive]` (#844): nothing outside this crate has a reason to build one.** No
897/// public function accepts it — the engine hands it out — and there are zero out-of-crate literal
898/// sites, so the attribute would bind nothing it does not already bind.
899#[derive(Debug, Clone, PartialEq, Eq)]
900pub struct CommandLine {
901 /// The command's jump anchor as a *document* line — the logical-line index of
902 /// the CommandStart(B) mark within [`Term::accessible_text`], so the consumer
903 /// reveals the right row of the accessible view (soft-wrapped rows collapse to
904 /// one logical line). This is core's analog of VSCode's
905 /// `bufferToEditorLineMapping`; the frame-mode web side has no wrap info to
906 /// map it itself.
907 ///
908 /// **It is an index into a document, so it is only meaningful together with the
909 /// document it indexes** — the one [`Term::accessible_text`] returns *at the same
910 /// instant, on the primary screen*. Neither half is expressible as a number on this
911 /// struct (#743), and they are the two that recur; they are not a proof of
912 /// sufficiency. The hedge was earned: a mark whose row is erased in place also
913 /// answers about content that is gone — on the primary screen, at one instant, and
914 /// a re-ask reproduces it, so neither half below reaches it. That was **#750**, a
915 /// defect in mark *lifetime* rather than in dating, and it is fixed at the
916 /// lifetime: `ED` now retires the marks on each whole row it blanks, and the
917 /// command's text and exit are frozen when the stream reveals them rather than
918 /// re-read from cells (see [`Term::command_lines`]). One residue is deliberate and
919 /// belongs to this field — `EL`/`ECH` retire nothing, so a mark can still name a
920 /// row they blanked, and this line then resolves onto it:
921 ///
922 /// - **the instant.** No scalar this engine publishes dates a document line, and
923 /// the reason is not one axis but two. Eviction moves it by the number of evicted
924 /// *line-ends*, which equals the row count except when an evicted row soft-wraps
925 /// into the next — measured, one eviction took the absolute lines
926 /// `[12, 12, 12, 13]` → `[11, 11, 11, 12]` while this line stayed at `11`, and the
927 /// very next eviction moved both. And flipping a row's wrap bit, which ordinary
928 /// output does, moves this line while the absolute lines, `evicted_total` and
929 /// `marker_epoch` all stay put — a motion the absolute space does not have.
930 /// Carrying the instant is therefore *buildable but expensive*: a line-end counter
931 /// **and** a generation of its own. ADR-0029 defers it (alternative D) and takes
932 /// the re-ask discharge, which D3 grants this surface on its own merits;
933 /// - **the screen.** The document is `[scrollback ++ primary]`, always. While the
934 /// alt screen is up [`Term::accessible_text`] returns the *alt* document, and this
935 /// line indexes the other one. When the alt screen is the taller of the two the
936 /// index still **resolves**, onto unrelated content — so this is not a bounds
937 /// problem a caller can check its way out of.
938 ///
939 /// So: ask for both together, keep them together, and re-ask rather than rebase.
940 pub line: usize,
941 /// The typed command text, prompt- and output-excluded (B→C columns).
942 ///
943 /// **Frozen at the `133;C` that closed the command (#750)**, not re-read from the
944 /// cells when you ask. Those cells are not reserved for it: a plain overwrite,
945 /// `ICH`, `DCH` and an erase were each measured making the recorded column range
946 /// name somebody else's content, and only the last of the four is a verb any
947 /// mark-lifetime rule could reach. Bounded at [`MAX_COMMAND_TEXT`] `char`s.
948 pub command: String,
949 /// The CommandFinished(D) exit code, if the shell reported one and the
950 /// command has finished.
951 ///
952 /// **Recorded when `133;D` is parsed (#750)**, onto the mark that closed the
953 /// command — not paired here at query time. It lives in no cell, so nothing on
954 /// screen can reconstruct it, and pairing over *survivors* re-parented a code onto
955 /// the previous command as soon as a disposal broke the run.
956 pub exit: Option<i32>,
957}
958
959/// Collect per-line damage bounds into damaged `LineDamage` spans (undamaged
960/// lines dropped). Shared by `damage` (content-only) and `frame_damage`
961/// (content + cursor cells).
962fn bounds_to_lines(bounds: &[LineBounds]) -> Vec<LineDamage> {
963 bounds
964 .iter()
965 .enumerate()
966 .filter(|(_, b)| b.is_damaged())
967 .map(|(line, b)| {
968 let (left, right) = b.span();
969 LineDamage { line, left, right }
970 })
971 .collect()
972}
973
974impl Term {
975 pub fn new(cols: usize, rows: usize) -> Self {
976 Self::with_scrollback(cols, rows, DEFAULT_SCROLLBACK)
977 }
978
979 pub fn with_scrollback(cols: usize, rows: usize, scrollback_limit: usize) -> Self {
980 // Both clamps mirror `resize` exactly, so a screen cannot be born at a size a
981 // resize would refuse. They are not the same *kind* of rule, though: the width
982 // floor is a published contract (#547 — one column was supported and no longer
983 // is), while the row floor is `resize`'s own long-standing "a terminal is never
984 // 0-tall" that this constructor merely failed to enforce while carrying the
985 // same `scroll_bottom: rows - 1` below. That gap was a subtract-overflow panic
986 // on `rows == 0`, not a degenerate screen.
987 // …and the ceiling is the header's, not the glyph's: `frame.cols`/`rows` are u16,
988 // so a wider grid would be built and then misdescribed on the wire (#621).
989 let cols = cols.clamp(MIN_COLUMNS, MAX_COLUMNS);
990 let rows = rows.clamp(1, MAX_ROWS);
991 Term {
992 grid: Grid::new(cols, rows),
993 alt_grid: Grid::new(cols, rows),
994 cursor: Cursor::default(),
995 saved_cursor: Cursor::default(),
996 on_alt: false,
997 origin_mode: false,
998 autowrap: true,
999 insert_mode: false,
1000 newline_mode: false,
1001 reverse_wraparound: false,
1002 bracketed_paste: false,
1003 synchronized_output: false,
1004 color_scheme_updates: false,
1005 grapheme_clustering: false,
1006 repeat_anchor: None,
1007 win32_input_mode: false,
1008 app_cursor_keys: false,
1009 application_keypad: false,
1010 vt52_mode: false,
1011 vt52_y_pending: 0,
1012 vt52_y_row: 0,
1013 mouse_protocol: MouseProtocol::Off,
1014 mouse_encoding: MouseEncoding::Default,
1015 focus_events: false,
1016 kitty_flags: 0,
1017 kitty_stack: Vec::new(),
1018 modify_other_keys_2: false,
1019 events: Vec::new(),
1020 replies: Vec::new(),
1021 current_link: None,
1022 link_ids: std::collections::HashMap::new(),
1023 link_ids_sweep_at: LINK_IDS_FIRST_SWEEP,
1024 tabs: default_tabs(cols),
1025 word_separators: DEFAULT_WORD_SEPARATORS.to_owned(),
1026 window_title: String::new(),
1027 icon_name: String::new(),
1028 window_title_stack: Vec::new(),
1029 icon_name_stack: Vec::new(),
1030 scroll_top: 0,
1031 scroll_bottom: rows - 1,
1032 scrollback: VecDeque::new(),
1033 display_offset: 0,
1034 scrollback_limit,
1035 recycled_row: None,
1036 line_damage: vec![LineBounds::undamaged(cols); rows],
1037 scroll: None,
1038 full_damage: false,
1039 prev_cursor: (0, 0), // matches the default cursor's home position
1040 selection: None,
1041 search_highlights: Vec::new(),
1042 active_search_highlight: None,
1043 normal_markers: VecDeque::new(),
1044 alt_markers: VecDeque::new(),
1045 next_marker_id: 0,
1046 evicted_total: 0,
1047 marker_epoch: 0,
1048 normal_tracked: Vec::new(),
1049 alt_tracked: Vec::new(),
1050 next_tracked_id: 0,
1051 decsc: SavedCursor::default(),
1052 charsets: [Charset::Ascii; 4],
1053 gl: 0,
1054 }
1055 }
1056
1057 /// What changed since the last `reset_damage()` — line ranges, each with a
1058 /// changed column span. See ADR-0003.
1059 pub fn damage(&self) -> TermDamage {
1060 if self.full_damage {
1061 return TermDamage::Full;
1062 }
1063 // Scrolled up under follow-bottom "stay": the viewport is frozen, so
1064 // screen changes below it are not visible — report nothing. (A user
1065 // scroll that moves the viewport sets full_damage above.)
1066 if self.display_offset > 0 {
1067 return TermDamage::Partial(Vec::new());
1068 }
1069 TermDamage::Partial(bounds_to_lines(&self.line_damage))
1070 }
1071
1072 /// Render damage: content damage plus the cursor cells, for [`Term::frame`].
1073 ///
1074 /// A pure cursor move changes no cell *content*, so [`Term::damage`] (which
1075 /// stays content-only, the cadence/flow-control primitive) would miss it —
1076 /// yet a cell-invert caret must clear its old spot and ink the new one. So
1077 /// the frame producer folds the old (last-acked) + current cursor cells in,
1078 /// but only when the cursor actually moved: a still cursor needs no redraw,
1079 /// keeping an idle frame empty. Mirrors Alacritty's `last_cursor`. #38.
1080 fn frame_damage(&self) -> TermDamage {
1081 if self.full_damage {
1082 return TermDamage::Full;
1083 }
1084 if self.display_offset > 0 {
1085 return TermDamage::Partial(Vec::new());
1086 }
1087 let cur = self.cursor.point();
1088 if cur == self.prev_cursor {
1089 return TermDamage::Partial(bounds_to_lines(&self.line_damage));
1090 }
1091 let mut bounds = self.line_damage.clone();
1092 bounds[cur.0].expand(cur.1, cur.1);
1093 let pr = self.prev_cursor.0.min(self.grid.rows() - 1);
1094 let pc = self.prev_cursor.1.min(self.grid.cols() - 1);
1095 bounds[pr].expand(pc, pc);
1096 TermDamage::Partial(bounds_to_lines(&bounds))
1097 }
1098
1099 /// Clear accumulated damage. The consumer calls this after applying a frame
1100 /// (the ack); the next `damage()` reflects only changes since.
1101 pub fn reset_damage(&mut self) {
1102 for b in &mut self.line_damage {
1103 b.reset();
1104 }
1105 self.scroll = None;
1106 self.full_damage = false;
1107 // The consumer has now seen the caret at the current position; the next
1108 // frame's cursor-move damage is measured from here (#38).
1109 self.prev_cursor = self.cursor.point();
1110 }
1111
1112 /// Mark the whole screen damaged (alt switch / clear / flood, and a consumer
1113 /// reattach that needs a full re-sync — see [`crate::Engine::mark_fully_damaged`]).
1114 pub fn mark_fully_damaged(&mut self) {
1115 self.full_damage = true;
1116 }
1117
1118 /// Record that columns `[left, right]` of `row` changed.
1119 ///
1120 /// Both columns are **clamped to the last column, and asserted in debug** (#536).
1121 ///
1122 /// Ten of the fourteen call sites derive their bound from a cursor column or from `cols`.
1123 /// **Four derive it from a wide pair's width**, and that is the shape worth centralising:
1124 /// `write_glyph`'s `col + width - 1` (which had no guard — this issue), `promote_cluster_to_wide`'s
1125 /// `col + 1` (guarded by its own `col + 1 >= cols` early return), `demote_cluster_to_narrow`'s
1126 /// `(col + 1).min(cols - 1)` (self-clamped), and `relocate_cluster_wide`'s literal `(0, 1)`
1127 /// (valid only because `MIN_COLUMNS = 2`, #547). Three carried a private guard and one did not.
1128 ///
1129 /// No reference has this shape to port a clamp from: alacritty computes damage ranges too
1130 /// (`term/mod.rs:1406`, `:1649` @ `852e971`) but always from a column or `columns()` — its print
1131 /// path records no damage at all, relying on the previous and current cursor *points* to bracket
1132 /// the line — while xterm.js tracks whole rows (`markDirty(y)`) and ghostty a per-row
1133 /// `dirty: bool`. alacritty's `LineDamageBounds::expand`, which this one is a copy of, is equally
1134 /// unguarded.
1135 ///
1136 /// The two halves do different jobs:
1137 ///
1138 /// - the **`debug_assert` is the detector**. An out-of-range bound is stored silently and
1139 /// detonates later, when `frame()` slices the row, so the stack trace accuses the reader
1140 /// rather than the writer. That delay is what #536 was filed about, and the assert collapses
1141 /// it — a bad caller dies here, at the site that recorded it (measured: an injected off-by-one
1142 /// moved the panic from `frame()`'s slice to this line).
1143 /// - the **clamp is the release backstop**, and it clamps *toward a false positive*. justerm is
1144 /// a library, so a panic crosses into the consumer's process; over-damaging repaints a cell
1145 /// that did not change, which costs nothing a consumer can see. ghostty states the asymmetry
1146 /// as a rule: *"Dirty tracking may have false positives but should never have false negatives.
1147 /// A false negative would result in a visual artifact on the screen."* (`page.zig:1993-1995`).
1148 ///
1149 /// **`left` is guarded for that reason, and it is the axis that can actually lose a cell.**
1150 /// Clamping `right` cannot under-report — columns past the last do not exist. But `LineBounds`
1151 /// marks a line undamaged with `left = cols, right = 0` and `is_damaged()` is `left <= right`,
1152 /// so a single `expand` with `left > right` on an otherwise-clean line leaves the line reading
1153 /// as undamaged and **drops its whole span silently**. Unreachable from the ten column-derived
1154 /// sites today; guarded because that is precisely the failure ghostty's rule forbids.
1155 ///
1156 /// `row` is deliberately left to panic on the index, and that is **not** in tension with
1157 /// `frame_damage` clamping a row fifty lines below (`prev_cursor.0.min(rows - 1)`). The two
1158 /// rows are different kinds of thing under the same rule: `prev_cursor` is a *stale remembered*
1159 /// coordinate that a shrinking resize may have put out of range, so clamping it repaints the
1160 /// nearest surviving cell — a false positive. `row` here is a *live computed* index for the
1161 /// mutation just made, so clamping it would damage a different line than the one that changed:
1162 /// a false negative on the real line, which is the outcome the rule forbids.
1163 fn damage_span(&mut self, row: usize, left: usize, right: usize) {
1164 let last = self.grid.cols().saturating_sub(1);
1165 debug_assert!(
1166 left <= right && right <= last,
1167 "damage_span({row}, {left}, {right}) is not a span inside [0, {last}]"
1168 );
1169 self.line_damage[row].expand(left.min(last), right.min(last));
1170 }
1171
1172 /// The first-class scroll recorded since the last `reset_damage`, if any.
1173 /// Suppressed while scrolled up — a content scroll must not shift the frozen
1174 /// viewport.
1175 ///
1176 /// **The count is capped at the region's own height (#661).** Shifting a region
1177 /// by more than its height moves every source row outside it, so the surplus
1178 /// names nothing a consumer can act on — while it does overflow the wire's
1179 /// `i16` and turn an up-scroll into a down-scroll: measured, a single
1180 /// 32 770-byte `feed()` of newlines, no slow consumer required. Both references
1181 /// that state a quantity at their own scroll sites clamp it to the same bound
1182 /// (alacritty `term/mod.rs:773`, ghostty `Terminal.zig:2703`).
1183 ///
1184 /// The cap is here, on the **read**, and not on the accumulator in
1185 /// `record_scroll`: a region that scrolls far and comes back then still reports
1186 /// its true small net, instead of one walked down from a saturated value.
1187 ///
1188 /// A second, crate-internal bound backs it up, and it is representational rather
1189 /// than semantic: [`MAX_ROWS`] is `u16::MAX` while the wire field is `i16`, so a
1190 /// region can legally be taller than any count that field can hold. In that
1191 /// corner the magnitude truncates. What it never does is wrap — a wrapped count
1192 /// arrives with the opposite sign and the consumer shifts the wrong way, which is
1193 /// the whole of #661.
1194 pub fn scroll_delta(&self) -> Option<ScrollOp> {
1195 if self.display_offset > 0 {
1196 return None;
1197 }
1198 self.scroll.map(cap_scroll)
1199 }
1200
1201 /// Build a serializable [`Frame`] from the current damage + grid + grapheme
1202 /// pool (#6). `Full` ships every row; `Partial` ships the damaged spans. The
1203 /// global side-table is remapped to **frame-local** indices — the engine pool
1204 /// is append-only and leaky, so a frame carries only the clusters its cells
1205 /// reference, renumbered, with each cell's `extra` rewritten to the local id.
1206 pub fn frame(&self) -> Frame {
1207 let cols = self.grid.cols();
1208 let rows = self.grid.rows();
1209 let (kind, line_spans): (FrameKind, Vec<(usize, usize, usize)>) = match self.frame_damage()
1210 {
1211 TermDamage::Full => (
1212 FrameKind::Full,
1213 (0..rows).map(|l| (l, 0, cols - 1)).collect(),
1214 ),
1215 TermDamage::Partial(lines) => (
1216 FrameKind::Partial,
1217 lines
1218 .into_iter()
1219 .map(|d| (d.line, d.left, d.right))
1220 .collect(),
1221 ),
1222 };
1223
1224 // Frame-local numbering for the hyperlink table (#26). Keyed by the URI's
1225 // *identity* — the `Arc` pointer — so two cells sharing one open share one entry
1226 // and a distinct open gets its own, which is exactly the semantics the pool
1227 // index used to carry.
1228 //
1229 // Sized by this frame, not by session history (#628). It was
1230 // `vec![0u32; hyperlink_pool.len() + 1]`, allocated and zeroed on **every**
1231 // frame against every OSC 8 the session had ever seen — measured at 10 µs per
1232 // frame with 100 000 opens retained. With the pool gone there is nothing left to
1233 // size it by, and the cost disappears rather than being reduced.
1234 let mut link_table: Vec<String> = Vec::new();
1235 let mut link_remap: std::collections::HashMap<*const u8, u32> =
1236 std::collections::HashMap::new();
1237 // Cells come from the viewport at `display_offset`, not the live grid:
1238 // viewport row `line` is absolute buffer line `top + line` (scrollback
1239 // when scrolled up, the live grid when `display_offset == 0`, where
1240 // `top == scrollback.len()` and this is identical to reading the grid).
1241 // Without this, a wire consumer — cells reach it only through `frame()` —
1242 // could never display scrollback (#48).
1243 let top = self.scrollback.len() - self.display_offset;
1244 let mut spans = Vec::with_capacity(line_spans.len());
1245 for (line, left, right) in line_spans {
1246 let mut cells = Vec::with_capacity(right - left + 1);
1247 let mut combining = std::collections::BTreeMap::new();
1248 let mut links = std::collections::BTreeMap::new();
1249 let mut ucolors = std::collections::BTreeMap::new();
1250 let row = self.abs_row(top + line);
1251 let last_col = row.len().saturating_sub(1);
1252 for col in left..=right {
1253 let mut cell = row[col];
1254 // Soft-wrap is a row property (#538), but the wire has no per-row slot — so it is
1255 // *derived* back onto the last cell's WRAPLINE bit here, which keeps the format
1256 // byte-identical and is why moving the storage needed no VERSION bump. The bit is
1257 // therefore wire-only: on a live grid it is never set, and `Row::is_wrapped` is
1258 // the question to ask.
1259 if col == last_col && row.is_wrapped() {
1260 cell.insert_flags(CellFlags::WRAPLINE);
1261 }
1262 // Combining clusters and hyperlinks live in the row's maps; each
1263 // tagged cell contributes its reference to the frame, recorded on
1264 // the span by span-relative column (the cell holds only the bit).
1265 if let Some(marks) = row.combining_at(col) {
1266 // The cluster itself, at its column — no side table and no index
1267 // since v14 (#621). Nothing interned these (this push was
1268 // unconditional), so the index only ever bought indirection.
1269 combining.insert(col - left, marks.to_vec());
1270 }
1271 if let Some(uri) = row.link_at(col) {
1272 // Number each distinct open once per frame (only referenced URIs
1273 // ship). The wire keeps its interning — #621 measured inlining a URI
1274 // per linked cell at +171…403% — so this stays an index into
1275 // `link_table`; only the *engine* side stopped being a table.
1276 let key = std::sync::Arc::as_ptr(uri) as *const u8;
1277 let next = link_table.len() as u32 + 1;
1278 let fidx = *link_remap.entry(key).or_insert_with(|| {
1279 link_table.push(uri.to_string());
1280 next
1281 });
1282 let fidx = core::num::NonZeroU32::new(fidx)
1283 .expect("frame-local link indices are 1-based");
1284 links.insert(col - left, fidx);
1285 }
1286 // Underline colour (SGR 58, #520): a colour reference, not a
1287 // side-table index, so it rides the span inline. `ucolor_at` is
1288 // flag-gated + already Default-filtered (the stamp only fires on an
1289 // underlined cell), so a present entry is a real non-default colour.
1290 if let Some(color) = row.ucolor_at(col) {
1291 ucolors.insert(col - left, color);
1292 }
1293 cells.push(cell);
1294 }
1295 spans.push(Span {
1296 line: line as u16,
1297 left: left as u16,
1298 right: right as u16,
1299 cells,
1300 combining,
1301 links,
1302 ucolors,
1303 });
1304 }
1305
1306 Frame {
1307 cols: cols as u16,
1308 rows: rows as u16,
1309 kind,
1310 // The live cursor: position in screen coords + DECTCEM visibility.
1311 // Reported, not drawn — the consumer renders the caret (#38).
1312 cursor_row: self.cursor.row as u16,
1313 cursor_col: self.cursor.col as u16,
1314 // Hidden while scrolled up: the live cursor is off the frozen
1315 // viewport, and a cell-invert caret would otherwise ink over
1316 // scrollback. Consistent with the frozen-damage policy (no cursor
1317 // damage is emitted while scrolled) and with xterm.js / alacritty,
1318 // which hide the caret when it falls outside the visible rows (#48).
1319 cursor_visible: self.cursor.visible && self.display_offset == 0,
1320 cursor_shape: self.cursor.shape,
1321 cursor_blink: self.cursor.blink,
1322 // Viewport scroll position for the consumer's scrollbar (ADR-0013).
1323 display_offset: self.display_offset as u32,
1324 scrollback_len: self.scrollback.len() as u32,
1325 evicted_total: self.evicted_total,
1326 marker_epoch: self.marker_epoch,
1327 // The active buffer's population, which is what `marker_index` reports and
1328 // therefore what a consumer's held index is compared against (#490).
1329 marker_count: self.markers().len() as u32,
1330 // The mouse tracking mode as a routing mask (#129): which mouse events
1331 // the app wants, derived from the protocol by the single source
1332 // `encode_mouse` shares. The consumer routes app-vs-local on it.
1333 mouse_events: self.mouse_protocol.wanted_events(),
1334 // Alt-screen flag (#149): buffer-global state the consumer can't
1335 // derive from viewport damage; the a11y announce policy gates on it.
1336 alt_screen: self.on_alt,
1337 scroll: self.scroll_delta(),
1338 spans,
1339 link_table,
1340 // Interaction overlays projected onto this viewport (#108): the
1341 // engine-owned selection and the consumer-supplied search highlights,
1342 // each re-projected here so the scroll offset is applied once, by the
1343 // same authority that projects the cells.
1344 overlay: Overlay {
1345 selection: self.selection_range(),
1346 matches: self
1347 .search_highlights
1348 .iter()
1349 .flat_map(|m| self.match_spans(m))
1350 .collect(),
1351 // The consumer-designated active match (#428), projected through
1352 // the same `match_spans` math — usually also present in `matches`
1353 // above (the renderer's ranking resolves the overlap, #424), but
1354 // a span designation may sit OUTSIDE a capped hand-over (#436).
1355 active_match: self
1356 .active_search_highlight
1357 .as_ref()
1358 .map(|m| self.match_spans(m))
1359 .unwrap_or_default(),
1360 markers: self.marker_positions(),
1361 },
1362 }
1363 }
1364
1365 /// Record a scroll of rows `[top, bottom]` by `count` (positive = up).
1366 ///
1367 /// Damage is indexed by row position, so it must follow the content the
1368 /// scroll just moved: rotate the bounds the same way and mark the newly
1369 /// exposed line fully damaged (it is new blank content for the consumer).
1370 fn record_scroll(&mut self, top: usize, bottom: usize, count: isize) {
1371 let cols = self.grid.cols();
1372 match count {
1373 1 => {
1374 self.line_damage[top..=bottom].rotate_left(1);
1375 self.line_damage[bottom] = LineBounds::fully_damaged(cols);
1376 }
1377 -1 => {
1378 self.line_damage[top..=bottom].rotate_right(1);
1379 self.line_damage[top] = LineBounds::fully_damaged(cols);
1380 }
1381 _ => {}
1382 }
1383 // Accumulate repeated scrolls of the same region into one op (flow
1384 // control). A *different* region cannot be expressed as one op, so
1385 // degrade to full rather than silently dropping the earlier scroll.
1386 match self.scroll {
1387 Some(op) if op.top == top && op.bottom == bottom => {
1388 self.scroll = Some(ScrollOp {
1389 top,
1390 bottom,
1391 count: op.count + count,
1392 });
1393 }
1394 None => self.scroll = Some(ScrollOp { top, bottom, count }),
1395 Some(_) => {
1396 self.scroll = None;
1397 self.mark_fully_damaged();
1398 }
1399 }
1400 }
1401
1402 /// Number of lines currently held in scrollback history.
1403 /// Replace the word-boundary set used by Word (semantic) selection — the policy half
1404 /// of `selection_begin(.., SelectionType::Word)`, injected per ADR-0017 (core owns
1405 /// the buffer walk, the consumer owns which characters separate words). The default
1406 /// is [`DEFAULT_WORD_SEPARATORS`].
1407 ///
1408 /// **`' '` is forced into whatever you pass**, and that is not a convenience. A
1409 /// blank cell packs `' '`, so the space terminates the walk at the end of a row's
1410 /// written text *and* backstops the wide-pair rule: without it, double-clicking next
1411 /// to a wide separator starts the highlight on that separator's trailing spacer,
1412 /// bisecting the glyph, and the walk then runs to the row's end through the padding.
1413 /// Enforcing it here rather than in the walk is ghostty's shape — it prepends its own
1414 /// blank codepoint to every parsed set at the config intake (`config/Config.zig`,
1415 /// *"Always include null as first boundary"*), so `selectWord` never has to.
1416 ///
1417 /// A consequence worth knowing before you narrow the set: this predicate is the only
1418 /// thing bounding the walk, so a set that omits the separators actually present in
1419 /// the buffer makes one double-click walk the whole soft-wrap run — measured at 11.7 ms
1420 /// (release) selecting 801,920 chars (#206, closed with the reach at zero).
1421 ///
1422 /// If a length bound is ever wanted, **it is a field beside this one, not an argument**:
1423 /// `word_start` / `word_end` are `pub(super)`, reached through
1424 /// [`Term::selection_begin`], so there is no call site for a consumer to inject into.
1425 /// This setter is the shape it would take (#545's, injected policy over a core
1426 /// mechanism, ADR-0017).
1427 pub fn set_word_separators(&mut self, separators: &str) {
1428 let mut set: String = separators.to_owned();
1429 if !set.contains(' ') {
1430 set.push(' ');
1431 }
1432 self.word_separators = set;
1433 }
1434
1435 /// The word-boundary set currently in force — what was passed to
1436 /// [`Term::set_word_separators`] plus the forced `' '`, or
1437 /// [`DEFAULT_WORD_SEPARATORS`] if it was never called.
1438 pub fn word_separators(&self) -> &str {
1439 &self.word_separators
1440 }
1441
1442 pub fn scrollback_len(&self) -> usize {
1443 self.scrollback.len()
1444 }
1445
1446 /// Whether the app has an open synchronized-output block (DEC ?2026, #73).
1447 pub fn synchronized_output(&self) -> bool {
1448 self.synchronized_output
1449 }
1450
1451 /// Whether the app enabled color-scheme-update notifications (DEC ?2031, #85).
1452 pub fn color_scheme_updates(&self) -> bool {
1453 self.color_scheme_updates
1454 }
1455
1456 /// Whether the app enabled grapheme-cluster mode (DEC ?2027, #295): emoji ZWJ / skin-tone /
1457 /// flag / VS16 sequences are clustered into one cell. OFF (default) is per-char, wcwidth-compat.
1458 pub fn grapheme_clustering(&self) -> bool {
1459 self.grapheme_clustering
1460 }
1461
1462 /// Whether the app enabled win32-input-mode (DEC ?9001, #86). The engine does
1463 /// not encode the raw key-records itself (a non-goal); a ConPTY consumer reads
1464 /// this to decide whether to emit them.
1465 pub fn win32_input_mode(&self) -> bool {
1466 self.win32_input_mode
1467 }
1468
1469 /// Queue a color-scheme report (`CSI ? 997 ; 1 n` dark / `; 2 n` light) on the
1470 /// reply channel. The consumer calls this to answer a `ColorSchemeQuery` event
1471 /// or, when its scheme changes and `color_scheme_updates()` is set, to send the
1472 /// unsolicited notification. The engine never stores or interprets the scheme
1473 /// (#85).
1474 pub fn report_color_scheme(&mut self, dark: bool) {
1475 let ps = if dark { 1 } else { 2 };
1476 self.replies
1477 .extend_from_slice(format!("\x1b[?997;{ps}n").as_bytes());
1478 }
1479
1480 /// OSC 10/11/12 set/query the default fg/bg/cursor colour, stacking the
1481 /// `;`-separated specs across the `[foreground, background, cursor]` slots —
1482 /// xterm's `ChangeColorsRequest` offset loop (`misc.c:3679`, walking
1483 /// `OSC_TEXT_FG` → `OSC_TEXT_BG` → `OSC_TEXT_CURSOR`, `ptyx.h:1018-1020`).
1484 /// OSC 10 starts at slot 0, OSC 11 at slot 1, OSC 12 at slot 2 (#137, #832).
1485 /// A `?` spec is a query.
1486 ///
1487 /// **An empty spec addresses its slot and leaves it alone** — neither a set
1488 /// nor a reset — and the stack still advances past it, so `OSC 10 ; ; <bg>`
1489 /// is how xterm reaches the background alone. That skip-and-advance is xterm's
1490 /// *implementation*, not documented behaviour: `ctlseqs.txt:2082` documents only
1491 /// the stack (*"each successive parameter changes the next color in the list"*)
1492 /// and expects at least one parameter. The two empty
1493 /// cases are the same rule from both ends: nothing left in the string yields
1494 /// no name (`misc.c:3684-3685`), and a separator where a name should be yields no
1495 /// name either (`misc.c:3687`) before the parse steps past it.
1496 ///
1497 /// That rule is not a hardening detail here, it is a precondition: the empty
1498 /// form is the *only* one real applications emit for OSC 12 (`nvim` sends
1499 /// `ESC ] 12 ; BEL` four to five times per session), so a cursor slot without
1500 /// it would relay a burst of empty-string colour changes every time a user
1501 /// opens an editor (#832).
1502 ///
1503 /// The stack ends after the cursor. xterm's next slots are the pointer
1504 /// colours (`OSC_MOUSE_FG` = 13, `OSC_MOUSE_BG` = 14), which justerm does not
1505 /// model — dropping a fourth spec is better than mis-addressing it.
1506 fn special_color(&mut self, params: &[&[u8]], start: usize, terminator: Terminator) {
1507 for (i, &spec) in params[1..].iter().enumerate() {
1508 if spec.is_empty() {
1509 continue; // skip this slot, but still advance to the next
1510 }
1511 let event = match start + i {
1512 0 if spec == b"?" => TermEvent::QueryForeground { terminator },
1513 0 => TermEvent::SetForeground(String::from_utf8_lossy(spec).into_owned()),
1514 1 if spec == b"?" => TermEvent::QueryBackground { terminator },
1515 1 => TermEvent::SetBackground(String::from_utf8_lossy(spec).into_owned()),
1516 2 if spec == b"?" => TermEvent::QueryCursorColor { terminator },
1517 2 => TermEvent::SetCursorColor(String::from_utf8_lossy(spec).into_owned()),
1518 _ => break, // past [fg, bg, cursor] — the pointer colours are unmodelled
1519 };
1520 self.events.push(event);
1521 }
1522 }
1523
1524 /// OSC 52 (`OSC 52 ; Pc ; Pd`) — an application asking to put text on a
1525 /// selection, or to read one back (#828).
1526 ///
1527 /// The engine's half is *mechanism* and nothing else: recognise the
1528 /// sequence, resolve `Pc` to a [`ClipboardTarget`], decode `Pd`, and relay.
1529 /// It never touches a clipboard, never holds one, and carries no allow/deny
1530 /// knob — under ADR-0017 that gate is the consumer's, and a consumer that
1531 /// drops the event has refused the request. alacritty puts a gate at the
1532 /// equivalent site (`alacritty_terminal/src/term/mod.rs:1706`) — **not because
1533 /// it is the whole terminal, which is what this comment used to say and is
1534 /// not the distinction (#841)**: that gate is in alacritty's *engine* crate
1535 /// too, reading a policy the application injects through `Config`
1536 /// (`:353`, written at `alacritty/src/config/ui_config.rs:125`). The reason
1537 /// this crate has none is that it holds no clipboard at all, so a gate in
1538 /// front of a relay refuses nothing a dropped event does not already refuse.
1539 ///
1540 /// **An absent target field means the clipboard, and that is a divergence
1541 /// from the spec taken deliberately.** `ctlseqs.txt:2161` says *"If the
1542 /// parameter is empty, xterm uses s 0, to specify the configurable
1543 /// primary/clipboard selection and cut-buffer 0"*, and `misc.c:3359` is that
1544 /// sentence in code. Neither half is representable here: `s` is whichever
1545 /// selection a *user resource* has configured — policy, which ADR-0017 puts
1546 /// in the consumer — and cut buffers are not modelled at all. So "follow the
1547 /// spec" is not a well-defined instruction, exactly as it was not for #834's
1548 /// empty colour spec, where xterm's trigger (*a colour that failed to parse*)
1549 /// is a condition this engine structurally cannot observe.
1550 ///
1551 /// Two qualifications, because the short version of this argument overclaims
1552 /// in both directions. **The cut buffer is what is unrepresentable; `s` is
1553 /// merely unmodelled** — xterm resolves it through the `selectToClipboard`
1554 /// resource (`button.c:2081`), and DECSET 1041 sets that same resource *from
1555 /// the stream* (`ctlseqs.txt:1008`), so an engine tracking 1041 could
1556 /// resolve it. justerm declines to model 1041; that is a choice, not an
1557 /// impossibility. And **xterm-as-shipped reads the empty field as PRIMARY**,
1558 /// since the resource defaults to false — so this diverges from what the
1559 /// reference does by default, not merely from a sentence in its manual.
1560 ///
1561 /// What decides it is the other two lines of evidence. **Independent
1562 /// lineages, and there are fewer than a naive count gives**: alacritty never
1563 /// sees an empty field at all, because `vte` substitutes `b'c'` first
1564 /// (`vte-0.15.0/src/ansi.rs:1488`) — those two are *one* lineage, not two.
1565 /// The genuinely separate ones are ghostty, by an explicit byte-scan branch
1566 /// pinned under a test (`clipboard_operation.zig:24`, `:64`), and xterm.js's
1567 /// clipboard addon, whose browser provider ignores the selector entirely and
1568 /// always writes `navigator.clipboard`
1569 /// (`addons/addon-clipboard/src/ClipboardAddon.ts:77`). Three lineages, one
1570 /// answer. **And the emitter's own documentation agrees**: `tmux`'s
1571 /// `set-clipboard` is documented as setting *the terminal clipboard* — never
1572 /// the primary selection — and `tmux` 3.2a is measured sending exactly this
1573 /// empty form.
1574 ///
1575 /// **A missing payload *field* is not an empty payload.** `OSC 52 ; c`
1576 /// arrives as two fields and does nothing; `OSC 52 ; c ;` arrives as three,
1577 /// the third empty, and is a store of the empty string — which is how the
1578 /// sequence clears a selection. xterm makes the same split by construction,
1579 /// its whole handler sitting inside `if (*buf == ';')` (`misc.c:3353`), and
1580 /// ghostty rejects the payload-less form for the same reason
1581 /// (`clipboard_operation.zig:20`).
1582 ///
1583 /// **The payload is `params[2..]` rejoined**, the rule #650 established for
1584 /// OSC 8: `vte` splits the whole OSC body on `;`, so reading `params[2]`
1585 /// alone would take a payload containing a `;` and decode its first piece —
1586 /// which for a well-formed prefix is a *successful* decode of a truncated
1587 /// clipboard, the one failure mode this handler must not have. Rejoined, the
1588 /// stray `;` reaches the decoder and is refused there.
1589 ///
1590 /// **Malformed in, nothing out**, which is the second deliberate divergence
1591 /// — and it is narrower than the spec sentence makes it look. The spec ends
1592 /// a payload that is *"neither a base64 string nor ?"* by clearing the
1593 /// selection (`ctlseqs.txt:2174`); this drops it silently. Clearing is
1594 /// destructive, and inferring one from bytes the engine could not parse
1595 /// means corruption on the wire wipes what the user copied by hand.
1596 ///
1597 /// The family, counted rather than asserted: **three drop** — alacritty
1598 /// (`alacritty_terminal/src/term/mod.rs:1717`), ghostty, which returns on a
1599 /// decode failure (`src/Surface.zig:2186`) and states the rule beside its
1600 /// test as *"Read requests and malformed base64 must never reach the
1601 /// callback"* (`src/terminal/c/terminal.zig:2961`), and this. **One clears**
1602 /// — xterm.js's addon, deliberately: *"Clear clipboard if text is not a
1603 /// base64 encoded string"* (`addons/addon-clipboard/src/ClipboardAddon.ts:55`).
1604 /// **And one neither** — xterm, below.
1605 ///
1606 /// What the divergence actually is, stated precisely because reading the
1607 /// spec alone gets it wrong: **xterm has no validator to disagree with.**
1608 /// `AppendToSelectionBuffer` (`button.c:4679`) decodes one character at a
1609 /// time and `return`s on any byte outside the alphabet (`:4698`), so xterm
1610 /// *filters* rather than rejects — `Zm9v-Zm9v` yields `foofoo` there — and
1611 /// since the store path clears the buffer first (`misc.c:3410`), the spec's
1612 /// "cleared" is what falls out when the filter finds nothing to keep. So the
1613 /// disagreement is about what to **accept**, not about what to do on
1614 /// refusal, and this engine is the stricter of the two on purpose: a filter
1615 /// hands the consumer text assembled from bytes the application did not
1616 /// send.
1617 ///
1618 /// Non-UTF-8 is refused on the same principle one level up: every text
1619 /// surface this crate publishes is UTF-8, and a lossy conversion would hand
1620 /// the consumer characters the application never sent.
1621 fn clipboard(&mut self, params: &[&[u8]], terminator: Terminator) {
1622 let Some(&field) = params.get(1) else {
1623 return;
1624 };
1625 let target = match field {
1626 // Empty and `c` are the same answer; see the divergence note above.
1627 b"" | b"c" => ClipboardTarget::Clipboard,
1628 // `p` and `s` are NOT the same answer, and the first draft made them
1629 // one. See `ClipboardTarget`: a collapse here would put a selector
1630 // the application never wrote into the reply.
1631 b"p" => ClipboardTarget::Primary,
1632 b"s" => ClipboardTarget::Selection,
1633 // Anything else — an unmodelled target like `q` or a cut buffer, and
1634 // also a *multi*-target list like `pc`, which the spec permits
1635 // (`ctlseqs.txt:2156`) and this engine cannot express. Both are
1636 // dropped rather than approximated: honouring one target of two is
1637 // the same defect as truncating a payload, one axis over, and
1638 // `vte`/alacritty's first-byte-wins would do exactly that. ghostty
1639 // rejects a multi-byte field too (`clipboard_operation.zig:36`).
1640 _ => return,
1641 };
1642 // Two fields is `OSC 52 ; c` — no payload field at all, not an empty one.
1643 if params.len() < 3 {
1644 return;
1645 }
1646 // The bound is checked on the fields, BEFORE the join — `join` is itself
1647 // an unconditional full copy, so checking after it would let a hostile
1648 // payload buy a second allocation the size of the first. `+ len - 3` is
1649 // the separators the join puts back.
1650 let fields = ¶ms[2..];
1651 if fields.iter().map(|f| f.len()).sum::<usize>() + fields.len() - 1 > MAX_CLIPBOARD_BASE64 {
1652 return;
1653 }
1654 let payload: Vec<u8> = fields.join(&b';');
1655 if payload == b"?" {
1656 self.events
1657 .push(TermEvent::QueryClipboard { target, terminator });
1658 return;
1659 }
1660 if let Some(bytes) = crate::base64::decode(&payload)
1661 && let Ok(text) = String::from_utf8(bytes)
1662 {
1663 self.events.push(TermEvent::ClipboardStore { target, text });
1664 }
1665 }
1666
1667 /// Answer an OSC 52 [`TermEvent::QueryClipboard`] (#828): base64-encode the
1668 /// consumer's text into the OSC 52 reply envelope, ST-terminated.
1669 ///
1670 /// The consumer hands the target back rather than the engine remembering
1671 /// which one was asked about — the same shape as
1672 /// [`Term::report_palette_color`], which takes its `index` back for the same
1673 /// reason. alacritty is the alternative: its query captures the target and
1674 /// the terminator in a closure the consumer later calls
1675 /// (`alacritty_terminal/src/term/mod.rs:1740`), which is one more piece of
1676 /// hidden state and one more question ("what if replies interleave?") bought
1677 /// for nothing the consumer does not already hold.
1678 ///
1679 /// **Answering is optional, and that is the security property.** The engine
1680 /// holds no clipboard, so a query it is never asked to answer reveals
1681 /// nothing; a consumer refuses a *read* simply by not calling this, whatever
1682 /// it does about *writes*.
1683 ///
1684 /// **The selector round-trips.** `c` / `p` / `s` in, the same one out, which
1685 /// is why [`ClipboardTarget`] keeps `p` and `s` apart: every reference echoes
1686 /// the field the application wrote — xterm the recognised list
1687 /// (`misc.c:3384`), alacritty the raw byte (`…/term/mod.rs:1744`), ghostty
1688 /// its three locations (`src/Surface.zig:5954`) — and it is the one field a
1689 /// client can pair a reply on. The single exception is an **empty** field,
1690 /// answered naming `c`, which is what alacritty also sends once `vte` has
1691 /// defaulted it: the reply says what the engine understood, and there is no
1692 /// selector to echo.
1693 ///
1694 /// The reply echoes the terminator the query arrived with, like every other
1695 /// reply this crate queues — settled for the whole channel rather than for
1696 /// this sequence, which is where #828 left it (#836).
1697 pub fn report_clipboard(
1698 &mut self,
1699 target: ClipboardTarget,
1700 text: &str,
1701 terminator: Terminator,
1702 ) {
1703 let field = match target {
1704 ClipboardTarget::Clipboard => 'c',
1705 ClipboardTarget::Primary => 'p',
1706 ClipboardTarget::Selection => 's',
1707 };
1708 let data = crate::base64::encode(text.as_bytes());
1709 self.replies
1710 .extend_from_slice(format!("\x1b]52;{field};{data}").as_bytes());
1711 self.replies.extend_from_slice(terminator.bytes());
1712 }
1713
1714 /// Answer an OSC 4 palette query (#122): wrap the consumer-supplied spec for
1715 /// `index` in the OSC 4 reply envelope.
1716 ///
1717 /// The reply echoes the terminator the query arrived with, which the
1718 /// consumer takes off the `Query…` event and hands back here (#836): the
1719 /// spec says a terminal *"uses the same terminator used in a query"*
1720 /// (`ctlseqs.txt:2020`), and the engine cannot choose on the consumer's
1721 /// behalf because only the parser ever saw which byte arrived.
1722 pub fn report_palette_color(&mut self, index: u8, spec: &str, terminator: Terminator) {
1723 self.replies
1724 .extend_from_slice(format!("\x1b]4;{index};{spec}").as_bytes());
1725 self.replies.extend_from_slice(terminator.bytes());
1726 }
1727
1728 /// Answer an OSC 10 foreground query (#122): wrap the consumer-supplied spec
1729 /// in the OSC 10 reply envelope.
1730 ///
1731 /// The reply echoes the terminator the query arrived with, which the
1732 /// consumer takes off the `Query…` event and hands back here (#836): the
1733 /// spec says a terminal *"uses the same terminator used in a query"*
1734 /// (`ctlseqs.txt:2020`), and the engine cannot choose on the consumer's
1735 /// behalf because only the parser ever saw which byte arrived.
1736 pub fn report_foreground(&mut self, spec: &str, terminator: Terminator) {
1737 self.replies
1738 .extend_from_slice(format!("\x1b]10;{spec}").as_bytes());
1739 self.replies.extend_from_slice(terminator.bytes());
1740 }
1741
1742 /// Answer an OSC 11 background query (#122): wrap the consumer-supplied spec
1743 /// (it knows its palette) in the OSC 11 reply envelope. The engine formats
1744 /// the envelope only — it never knows the colour.
1745 ///
1746 /// The reply echoes the terminator the query arrived with, which the
1747 /// consumer takes off the `Query…` event and hands back here (#836): the
1748 /// spec says a terminal *"uses the same terminator used in a query"*
1749 /// (`ctlseqs.txt:2020`), and the engine cannot choose on the consumer's
1750 /// behalf because only the parser ever saw which byte arrived.
1751 pub fn report_background(&mut self, spec: &str, terminator: Terminator) {
1752 self.replies
1753 .extend_from_slice(format!("\x1b]11;{spec}").as_bytes());
1754 self.replies.extend_from_slice(terminator.bytes());
1755 }
1756
1757 /// Answer an OSC 12 cursor-colour query (#832): the same envelope one slot
1758 /// over, terminated like its siblings. The consumer supplies the spec — it
1759 /// owns the palette, and the engine never learns the colour.
1760 ///
1761 /// The reply echoes the terminator the query arrived with, which the
1762 /// consumer takes off the `Query…` event and hands back here (#836): the
1763 /// spec says a terminal *"uses the same terminator used in a query"*
1764 /// (`ctlseqs.txt:2020`), and the engine cannot choose on the consumer's
1765 /// behalf because only the parser ever saw which byte arrived.
1766 pub fn report_cursor_color(&mut self, spec: &str, terminator: Terminator) {
1767 self.replies
1768 .extend_from_slice(format!("\x1b]12;{spec}").as_bytes());
1769 self.replies.extend_from_slice(terminator.bytes());
1770 }
1771
1772 /// The cells of visible row `i` (0..rows) at the current scroll position.
1773 /// The viewport windows into `[history.. ; screen..]`: rows above
1774 /// `scrollback.len()` come from history, the rest from the live screen.
1775 pub fn viewport_line(&self, i: usize) -> &[Cell] {
1776 let top = self.scrollback.len() - self.display_offset;
1777 let idx = top + i;
1778 if idx < self.scrollback.len() {
1779 &self.scrollback[idx]
1780 } else {
1781 self.grid.row(idx - self.scrollback.len())
1782 }
1783 }
1784
1785 /// Scroll the viewport up by `n` lines into history (clamped to the oldest).
1786 pub fn scroll_up(&mut self, n: usize) {
1787 let target = (self.display_offset + n).min(self.scrollback.len());
1788 self.set_display_offset(target);
1789 }
1790
1791 /// Scroll the viewport down by `n` lines toward the live screen.
1792 pub fn scroll_down(&mut self, n: usize) {
1793 let target = self.display_offset.saturating_sub(n);
1794 self.set_display_offset(target);
1795 }
1796
1797 /// Jump the viewport back to the live screen (follow the bottom).
1798 pub fn scroll_to_bottom(&mut self) {
1799 self.set_display_offset(0);
1800 }
1801
1802 /// Move the viewport. A user scroll changes which lines are visible, so the
1803 /// whole viewport is repainted (full damage) when the offset actually moves.
1804 fn set_display_offset(&mut self, offset: usize) {
1805 // The alt screen has no scrollback to view; scroll intents are no-ops.
1806 if self.on_alt {
1807 return;
1808 }
1809 if offset != self.display_offset {
1810 self.display_offset = offset;
1811 self.mark_fully_damaged();
1812 }
1813 }
1814
1815 // ---- selection -----------------------------------------------------------
1816
1817 /// Map a viewport cell `(row, col)` to an absolute buffer point. The top
1818 /// visible row is `scrollback.len() - display_offset`, so viewport row `i`
1819 /// is that plus `i`.
1820 ///
1821 /// **`row` is clamped to the last visible row, and that is the anchor's whole defence
1822 /// against a caller that hands it one past the end (#660).** The row arrives from a
1823 /// pointer position, so it is off the end whenever a drag leaves the grid — including
1824 /// the ordinary case where the container is a sub-cell remainder taller than
1825 /// `rows × cell_height` and a click lands in that strip. Stored unclamped it does not
1826 /// fail here: it detonates later, in whichever read walks the selection
1827 /// (`selection_range`, `selection_text`, the word extents), so the stack trace accuses
1828 /// the reader rather than the caller — the delay `damage_span`'s doc describes and
1829 /// #536 was filed about.
1830 ///
1831 /// **Clamped, and deliberately *not* `debug_assert`ed** — which is where this differs
1832 /// from `damage_span`, whose split it otherwise mirrors. That function is engine-
1833 /// internal, so an out-of-range span there is a justerm bug and the assert names its
1834 /// producer. This one is reached from `Engine::selection_begin` / `selection_extend`,
1835 /// whose documented input is *"what a mouse event carries"* — and a pointer leaves the
1836 /// grid whenever a drag does, so a row past the end is **ordinary input, not a defect**.
1837 /// Asserting on it would panic a consumer's debug build for a legal gesture.
1838 ///
1839 /// Clamping is also what every producer already wants: a drag past the bottom edge
1840 /// selects to the edge. alacritty clamps at the same boundary (`Point::grid_clamp`);
1841 /// ghostty's pins cannot express an out-of-range row at all.
1842 ///
1843 /// **This is a backstop, and since #667 nothing in the family relies on it.** The
1844 /// sentence here used to read that justerm-web's selection converter did *not* clamp,
1845 /// which was what made an unclamped row reachable in the shipped stack rather than
1846 /// only in theory; that converter now bounds both axes at its own seam, as all three
1847 /// references do at theirs. The claim is retracted rather than deleted because it was
1848 /// the record of why this clamp was worth adding.
1849 ///
1850 /// **`col` is bounded the same way, and against the grid rather than the line
1851 /// (#671).** #660 reasoned about the row alone and this function passed the column
1852 /// through, which was not a smaller version of the same gap — it was a *different*
1853 /// one, because the two axes are consumed differently downstream. A column reaches
1854 /// `resolve`, where the `Side` decides whether it gets a `+ 1`, and the two readers
1855 /// then bound only one end each: `selection_range`'s Linear arm clips `right_excl`
1856 /// and not `left`, `selection_text`'s Block arm clips `hi` and not `from`. So
1857 /// `Side::Right` was already safe by accident (its `+ 1` lands past the end and the
1858 /// clip catches it) while **`Side::Left` had no `+ 1` to clip**, and the raw column
1859 /// survived into `left` — silently deleting the anchor's own row from both the
1860 /// projection and the copy. `usize::MAX` was the one value that panicked instead,
1861 /// on the `+ 1`.
1862 ///
1863 /// Bounding here rather than in `resolve` keeps one site answering "what does a
1864 /// viewport coordinate mean", and makes both axes total for the same reason; the
1865 /// alternative — clamping at each `+ 1` — is five sites for one rule. alacritty
1866 /// bounds both endpoints' columns in `Selection::to_range` *before* its own side
1867 /// arithmetic and pairs the `+ 1` with an explicit *"column == columns → wrap to the
1868 /// next line"*; justerm reaches that same outcome through the reader's
1869 /// `right_excl > left`, which is why an **in-range** `Side::Right` on the last column
1870 /// still starts the selection on the following row and is pinned as unchanged.
1871 ///
1872 /// The grid, not `abs_line(..).len()`, is the bound: `SelectionType::Line` already
1873 /// resolves `to` as `grid.cols()`, so the whole type works in grid coordinates and a
1874 /// short line must not shrink a selection that reaches past it.
1875 ///
1876 /// **`resolve`'s five `+ 1`s stay unguarded, and that is sound only while every stored
1877 /// anchor arrives through here.** The completeness pass enumerated the writers: the
1878 /// three coordinate fixups move `.line` or write columns that are in range by
1879 /// construction, `resize`'s primary branch re-clamps the reflowed points (#562) and its
1880 /// alt branch drops the selection outright (#660), and `Term::resize` is the only writer
1881 /// of `grid.cols()`. So no path strands a column that was clamped here. The condition is
1882 /// **a fourth writer of `self.selection`** — one that builds an `Anchor` without this
1883 /// function would put `resolve` back in reach of its own arithmetic.
1884 fn viewport_to_abs(&self, row: usize, col: usize) -> BufferPoint {
1885 let top = self.scrollback.len() - self.display_offset;
1886 let last = self.grid.rows().saturating_sub(1);
1887 BufferPoint {
1888 line: top + row.min(last),
1889 col: col.min(self.grid.cols().saturating_sub(1)),
1890 }
1891 }
1892
1893 /// The hyperlink **URI** at **screen** `(row, col)` (the live grid), or `None` —
1894 /// flag-gated through the row's link map. Since #628 the map holds the URI itself,
1895 /// so there is no index and no second call to resolve one.
1896 /// Mirrors `grid().cell(row, col)`.
1897 pub(crate) fn screen_link_at(&self, row: usize, col: usize) -> Option<Hyperlink> {
1898 self.grid
1899 .row_ref(row)
1900 .link_at(col)
1901 .cloned()
1902 .map(Hyperlink::new)
1903 }
1904
1905 /// The underline colour (SGR 58, #520) at screen `(row, col)`, as a theme-agnostic
1906 /// reference. `Color::Default` means "follow the fg" — the common case, and what an
1907 /// unset cell returns. Mirror of [`Term::screen_link_at`].
1908 pub(crate) fn screen_underline_color_at(&self, row: usize, col: usize) -> Color {
1909 self.grid.row_ref(row).ucolor_at(col).unwrap_or_default()
1910 }
1911
1912 /// The hyperlink URI at **viewport** `(row, col)` (visible window, history
1913 /// included at the current scroll), or `None`. Mirrors `viewport_line(row)`.
1914 pub(crate) fn viewport_link_at(&self, row: usize, col: usize) -> Option<Hyperlink> {
1915 let idx = self.scrollback.len() - self.display_offset + row;
1916 self.abs_row(idx).link_at(col).cloned().map(Hyperlink::new)
1917 }
1918
1919 /// Resize the screen to `cols` x `rows`. Rows dropped off the top (on shrink)
1920 /// enter scrollback. Column reflow of soft-wrapped lines is layered on top
1921 /// separately (#7). The whole screen is damaged.
1922 ///
1923 /// `cols` is widened to [`MIN_COLUMNS`] — a narrower screen cannot hold a
1924 /// width-2 glyph, so it is clamped rather than represented (#547).
1925 pub fn resize(&mut self, cols: usize, rows: usize) {
1926 // Not a print — and not a parser callback either, which is the whole reason
1927 // [`Term::repeat_anchor`] is stated as a rule rather than as a list of
1928 // `Perform` methods. A reflow rewrites cells and moves the cursor, so the cell
1929 // `REP` would read back is no longer the one the arming print wrote (#825).
1930 self.repeat_anchor = None;
1931 // A terminal is never 0-tall; clamp so the math below (rows - 1) can't
1932 // underflow. Columns clamp to MIN_COLUMNS, not 1: chunking by cols needs a
1933 // non-zero width, but a *wide glyph* needs two (#547). The ceiling is the frame
1934 // header's u16, clamped here as well as in the constructor — a ceiling that held
1935 // only until the first resize is the gap `new` had against this function's own row
1936 // floor before #547 (#621).
1937 let cols = cols.clamp(MIN_COLUMNS, MAX_COLUMNS);
1938 let rows = rows.clamp(1, MAX_ROWS);
1939 let old_cols = self.grid.cols();
1940 let old_rows = self.grid.rows();
1941 let limit = self.scrollback_limit;
1942
1943 // A reflow rewrites marker lines outright, at three separate sites below and in
1944 // two different frames of reference — so a held index goes stale in a way no
1945 // offset repairs (#490). Bumped **here**, once, rather than beside each rewrite:
1946 // this function is the only way any of them runs, and a per-site obligation is
1947 // the shape `docs/map/territory/marker.md` already records as a known hole for
1948 // the alt guard. Gated on a *dimension change* as well as on there being a marker:
1949 // `resize` has no early return for unchanged geometry and `ResizePort` states no
1950 // idempotency guarantee, so a consumer may call this with the size it already has —
1951 // `justerm-web`'s fit does exactly that when the *cell* moves and the proposed grid
1952 // does not, since it dedupes on cell and grid together. An ungated bump would then be
1953 // a full re-pull for a resize that changed nothing — measured at 100 bumps for 100
1954 // no-op resizes.
1955 //
1956 // This comment said the fit loop *"re-asserts the size every frame"*, which stopped being true
1957 // when #632 gave `FitController` its four-field dedupe. The gate is unaffected: what it
1958 // rests on is the missing early return, and that is still measured.
1959 if (cols != old_cols || rows != old_rows)
1960 && (!self.normal_markers.is_empty() || !self.alt_markers.is_empty())
1961 {
1962 self.bump_marker_epoch();
1963 }
1964
1965 // A reflow moves match coordinates (and can change the match set), so the
1966 // query-derived highlights are invalidated; the consumer re-searches at
1967 // the new width. The selection re-anchors below — it is user-authored.
1968 self.invalidate_search_highlights();
1969
1970 // ...except on the alt screen, where a *shrink* drops the selection (#660). The
1971 // primary pane carries user-authored points through `reflow_pane` and gets them back
1972 // mapped to the new geometry; on alt the selection is dropped instead.
1973 //
1974 // **This is a policy choice, not a capability limit, and the difference matters
1975 // because the first version of this comment got it wrong.** It claimed the alt pane
1976 // has "nothing to re-anchor through" — measurably false: the alt branch below makes
1977 // its own `reflow_pane` call with tracked points and already uses the returned
1978 // `extras` / `evicted` to rotate and dispose alt *markers*. `reflow: false` disables
1979 // the column re-split, not the point tracking. Installing a false "cannot" as the
1980 // justification for fixing a false "cannot" is precisely the failure #660 is.
1981 //
1982 // What actually makes rotation the wrong trade here is that a marker and a selection
1983 // are different shapes. A marker is one point with a binary fate — survive, or be
1984 // disposed with an event. A selection is two *ordered* endpoints, so when a shrink
1985 // destroys the row under one of them and not the other, "dispose" has no meaning and
1986 // the correct behaviour is the clamp-and-overtake policy `selection_rotate_region`
1987 // implements for scrolls. Reusing the marker path would give a selection whose ends
1988 // moved by different rules; writing the second policy is a feature, not this fix.
1989 // And on a column shrink an alt anchor would additionally need the `.min(cols - 1)`
1990 // the primary branch applies, which alt markers deliberately do *not* take.
1991 //
1992 // Both references drop rather than rotate on the axis they consider unsafe —
1993 // alacritty on a width change (`term/mod.rs:680-682`), xterm.js on a height change,
1994 // its comment naming this bug class outright (`SelectionService.ts:156-160`).
1995 //
1996 // **Any geometry change, not just a shrink — and the `!=` is load-bearing in the
1997 // direction that looks wasteful.** The obvious refinement is to keep the selection on
1998 // a *grow*, since the alt pane pads rather than moving content, so no anchor looks
1999 // invalidated. That was tried and a randomised sweep refuted it in one run: an alt
2000 // resize also reflows the **primary** pane below, and on the alt screen `scrollback`
2001 // *is* that primary history — so `scrollback.len()` moves under an anchor whose
2002 // absolute line was measured from the old base, even when the alt grid itself does not
2003 // move at all. `selection_text` then walks off the end. The branch below already knows
2004 // this and converts alt *markers* through `old_base` → new base for exactly that
2005 // reason ("the primary scrollback below may rewrap and change length even when the alt
2006 // grid does not move"); the selection has no such conversion, so the geometry change
2007 // is the honest trigger.
2008 //
2009 // Rebasing instead of dropping is the better answer and is not done here: a grow has
2010 // no destroyed row, so both endpoints could shift by the base delta unambiguously —
2011 // but a *shrink* still needs the two-endpoint policy below, and shipping half of it
2012 // would leave the two axes behaving differently for no stated reason.
2013 //
2014 // The exact no-op is still not a resize: nothing reflows when neither axis moves, so
2015 // the base cannot shift, and a consumer that re-asserts its size every frame (a
2016 // `fit()` loop) must not make selecting on the alt screen impossible.
2017 if self.on_alt && (cols != old_cols || rows != old_rows) {
2018 self.selection = None;
2019 }
2020
2021 // Both screens are resized. Scrollback pairs with the PRIMARY screen
2022 // (whichever is active) — the alt screen has no history of its own.
2023 // `reflow: true` is the *primary* pane's setting and is deliberately a constant, **not**
2024 // `self.autowrap`. ghostty gates its equivalent on DECAWM — `.reflow =
2025 // self.modes.get(.wraparound)` (`terminal/Terminal.zig` `resize`) — and the reading that
2026 // makes that coherent is the one this file just accepted for the alt screen: an application
2027 // that turns autowrap off is placing lines itself, so its content is a layout rather than a
2028 // flow, and re-wrapping it changes what it drew.
2029 //
2030 // Not followed here, for three reasons, and they are recorded rather than filed because
2031 // nothing observable is known to break either way (measured: with DECAWM off, a full
2032 // 6-column row still re-splits into two rows at width 3 exactly as it does with DECAWM on;
2033 // the difference against ghostty is that ghostty truncates that row instead).
2034 //
2035 // - **The wrap flag is not a lie.** `Row::is_wrapped` means "this row continues into the
2036 // next", which after a re-split is simply true. DECAWM governs the **write** path — where
2037 // a glyph goes when the cursor is at the last column — not how stored content is laid out
2038 // again later. Dropping the flag would make `"abcdef"` extract as `"abc\ndef"`.
2039 // - **The mode is global and momentary; the buffer is neither.** DECAWM is read at resize
2040 // time and would decide the fate of history written under the opposite setting. A TUI that
2041 // turns it off while drawing would, on a resize landing in that window, leave every
2042 // properly wrapped line in scrollback un-reflowed.
2043 // - **It costs content.** Not reflowing truncates each row to the new width, so the tail of
2044 // a long line leaves the grid. justerm keeps it.
2045 //
2046 // There is no per-row signal to be finer with: a row written under DECAWM off and a row that
2047 // merely ended early are both simply unwrapped. "Do not re-split an unwrapped logical line"
2048 // would break ordinary reflow, since a line that exactly fills its width carries no wrap
2049 // flag either.
2050 let dims = ReflowDims {
2051 old_cols,
2052 cols,
2053 rows,
2054 limit,
2055 reflow: true,
2056 };
2057 let scrollback = std::mem::take(&mut self.scrollback);
2058 if self.on_alt {
2059 // Active = alt (cursor, no scrollback); inactive = primary. No selection anchors
2060 // to track here — but *because the geometry change above dropped them* (#660),
2061 // not because there cannot be any. This comment used to read "selection is
2062 // primary-only and cleared on alt enter": the clearing is real
2063 // (`enter_alt_screen` / `leave_alt_screen`, "a selection cannot survive a screen
2064 // swap") and says nothing about a selection made *while* the alt screen is up,
2065 // which is the ordinary act of copying out of vim. A premise that held at one
2066 // instant was read as an invariant holding for the screen's lifetime.
2067 // Alt markers still ride this pane, but **not because it reflows** — since #567 it does
2068 // not, so a marker's content no longer moves under it and the old reason here ("justerm
2069 // column-reflows the alt grid, so a marker must follow its content") is retracted. What
2070 // they ride it for is the row *fit*: a shrink still drops rows off the top, and a marker
2071 // on one of those has left a screen with no history to hold it. Their stored line is
2072 // `base + alt_row` (base = primary scrollback len), so convert to alt-local rows here
2073 // and re-anchor on the new base afterward — the primary scrollback below may rewrap and
2074 // change length even when the alt grid does not move at all.
2075 let old_base = scrollback.len();
2076 let mut alt_pts: Vec<(usize, usize)> = self
2077 .alt_markers
2078 .iter()
2079 .map(|m| (m.line - old_base, m.col))
2080 .collect();
2081 // Alt-scoped tracked points are stored on the same `base + alt_row`
2082 // frame as the alt markers, so they convert and come back the same way
2083 // (#691).
2084 let alt_tracked_off = alt_pts.len();
2085 alt_pts.extend(
2086 self.alt_tracked
2087 .iter()
2088 .map(|p| (p.line.saturating_sub(old_base), p.col)),
2089 );
2090 let alt = self.grid.take_lines();
2091 let r_alt = reflow_pane(
2092 alt,
2093 VecDeque::new(),
2094 self.cursor.point(),
2095 &alt_pts,
2096 ReflowDims {
2097 limit: 0,
2098 reflow: false,
2099 ..dims
2100 },
2101 );
2102 self.grid.set_screen(r_alt.screen, cols, rows);
2103 self.cursor.set_point(r_alt.cursor, rows, cols);
2104
2105 // Primary is inactive here, but markers anchor *primary* content, so
2106 // they reflow with it. There is no *primary* selection to carry alongside them —
2107 // `switch_to_alt` nulls it before the alt screen exists, so one cannot coexist
2108 // with `on_alt` — which is a different statement from the "cleared on alt enter"
2109 // this comment used to make, and the difference is #660: that clearing says
2110 // nothing about the *alt* selection the branch above now drops.
2111 // `(line, col)`, not `(line, 0)`: the column is what bounds OSC-133 command-text
2112 // extraction (#166), and discarding it here truncated the recorded command for any
2113 // resize taken while a full-screen app was up. The primary branch below has always
2114 // passed and restored both; this one is the sibling that did not.
2115 let mut marker_pts: Vec<(usize, usize)> = self
2116 .normal_markers
2117 .iter()
2118 .map(|m| (m.line, m.col))
2119 .collect();
2120 // Primary-scoped tracked points anchor primary content too, so they
2121 // reflow with this pane even though the alt screen is the active one
2122 // (#691) — the same reason the markers above do.
2123 let tracked_off = marker_pts.len();
2124 marker_pts.extend(self.normal_tracked.iter().map(|p| (p.line, p.col)));
2125 let primary = self.alt_grid.take_lines();
2126 let r = reflow_pane(
2127 primary,
2128 scrollback,
2129 self.saved_cursor.point(),
2130 &marker_pts,
2131 dims,
2132 );
2133 self.alt_grid.set_screen(r.screen, cols, rows);
2134 self.scrollback = r.scrollback;
2135 self.saved_cursor.set_point(r.cursor, rows, cols);
2136 for (i, m) in self.normal_markers.iter_mut().enumerate() {
2137 m.line = r.extras[i].0.saturating_sub(r.evicted);
2138 m.col = r.extras[i].1;
2139 }
2140 // Released rather than clamped when the reflow evicted its line — see
2141 // the primary-active branch for why the two loops differ (#691).
2142 let mut ti = 0;
2143 let evicted = r.evicted;
2144 let extras = &r.extras;
2145 self.normal_tracked.retain_mut(|p| {
2146 let (line, col) = extras[tracked_off + ti];
2147 ti += 1;
2148 match line.checked_sub(evicted) {
2149 Some(line) => {
2150 p.line = line;
2151 p.col = col;
2152 true
2153 }
2154 None => false,
2155 }
2156 });
2157 // The alt half lives in a different frame from the primary one above, and adding the
2158 // two was the defect: `extras` count from the top of the alt pane's own history, and
2159 // the alt screen **has** no history — every row the shrink pushed off the top is gone,
2160 // not archived. Passing the primary's scrollback limit made `reflow_pane` keep them,
2161 // so a rows-only resize (no reflow at all) reported a marker four lines past the end of
2162 // the buffer. The limit is `0` here because that is what an alt screen's history is.
2163 //
2164 // A marker whose row went with it is **disposed**, matching what the alt screen already
2165 // does when a row leaves by scrolling (`markers_rotate_region` fires `MarkerDisposed`
2166 // for the marker on the departing edge). Silently relocating it to row 0 would put a
2167 // decoration on content it was never attached to.
2168 let new_base = self.scrollback.len();
2169 let mut alt_disposed = Vec::new();
2170 let mut i = 0;
2171 self.alt_markers.retain_mut(|m| {
2172 let (line, col) = r_alt.extras[i];
2173 i += 1;
2174 match line.checked_sub(r_alt.evicted) {
2175 Some(row) if row < rows => {
2176 m.line = new_base + row;
2177 // The column rides along for the same reason as the primary half, but
2178 // **unpinned**: `add_marker` always passes column 0, and I could not get an
2179 // OSC-133 mark (the only column-bearing kind) to appear in `alt_markers` at
2180 // all. That is a gap in my knowledge, not evidence the column is
2181 // structurally zero — `push_marker` takes a column and `markers_mut` routes
2182 // by active buffer, so the field is reachable in principle. Carrying it
2183 // keeps the two halves stating one invariant; if the alt path really is
2184 // marker-column-free, this line is a no-op.
2185 m.col = col;
2186 true
2187 }
2188 _ => {
2189 alt_disposed.push(m.id);
2190 false
2191 }
2192 }
2193 });
2194 for id in alt_disposed {
2195 self.events.push(TermEvent::MarkerDisposed(id));
2196 }
2197 // The alt half's tracked points, on the alt marker's rule: a row the
2198 // shrink pushed off an unarchived screen is gone, so the point is
2199 // released rather than relocated (#691).
2200 //
2201 // The `row < rows` half of that guard is **unproven, deliberately kept**.
2202 // A mutation dropping it stays green, and a sweep of 324 alt resizes
2203 // (rows 1..6 x cols {4,10,30}, both directions, a point on every alt row
2204 // at columns 0 / 1 / cols-1 / cols plus one past the pane) never reached
2205 // it — the alt fit runs with `reflow: false`, so a surviving row always
2206 // maps below the new row count. That is a measured *validity condition*,
2207 // not a proof of unreachability, and the marker loop above carries the
2208 // same bound: parity is the reason it stays.
2209 let mut ai = 0;
2210 let alt_extras = &r_alt.extras;
2211 let alt_evicted = r_alt.evicted;
2212 self.alt_tracked.retain_mut(|p| {
2213 let (line, col) = alt_extras[alt_tracked_off + ai];
2214 ai += 1;
2215 match line.checked_sub(alt_evicted) {
2216 Some(row) if row < rows => {
2217 p.line = new_base + row;
2218 p.col = col;
2219 true
2220 }
2221 _ => false,
2222 }
2223 });
2224 } else {
2225 // Active = primary (cursor, scrollback); inactive = alt. The selection
2226 // anchors (absolute) reflow alongside the cursor so they keep their
2227 // content across a column change.
2228 let sel_pts: Vec<(usize, usize)> = self
2229 .selection
2230 .as_ref()
2231 .map(|s| {
2232 vec![
2233 (s.anchor.point.line, s.anchor.point.col),
2234 (s.focus.point.line, s.focus.point.col),
2235 ]
2236 })
2237 .unwrap_or_default();
2238 // Markers reflow on the same pane by (line, col) — the column matters
2239 // for OSC-133 command marks, whose B/C columns bound the extracted
2240 // command text (#166). They ride after the selection points so each
2241 // reads its own reflowed slot back from `extras` (#118).
2242 let mut pts = sel_pts.clone();
2243 pts.extend(self.normal_markers.iter().map(|m| (m.line, m.col)));
2244 // Tracked points ride after the markers, reading their own slots back
2245 // by the same offset idiom (#691).
2246 let tracked_off = pts.len();
2247 pts.extend(self.normal_tracked.iter().map(|p| (p.line, p.col)));
2248
2249 let primary = self.grid.take_lines();
2250 let r = reflow_pane(primary, scrollback, self.cursor.point(), &pts, dims);
2251 self.grid.set_screen(r.screen, cols, rows);
2252 self.scrollback = r.scrollback;
2253 self.cursor.set_point(r.cursor, rows, cols);
2254 if let Some(sel) = &mut self.selection {
2255 // A selection endpoint is **UI** state, so its reading of `col == cols` (#562) is
2256 // neither the cursor's nor a mark's: it is clamped into the grid. UI state may not
2257 // move the application's content to make room for itself — the criterion that
2258 // decided this, and the one ghostty encodes by clamping every non-cursor pin before
2259 // it can widen a row (`terminal/PageList.zig:1576-1585` @ `e6e26e1`) while leaving
2260 // the cursor pin unclamped (`:1602-1606`).
2261 sel.anchor.point = BufferPoint {
2262 line: r.extras[0].0.saturating_sub(r.evicted),
2263 col: r.extras[0].1.min(cols - 1),
2264 };
2265 sel.focus.point = BufferPoint {
2266 line: r.extras[1].0.saturating_sub(r.evicted),
2267 col: r.extras[1].1.min(cols - 1),
2268 };
2269 }
2270 let marker_off = sel_pts.len();
2271 for (i, m) in self.normal_markers.iter_mut().enumerate() {
2272 m.line = r.extras[marker_off + i].0.saturating_sub(r.evicted);
2273 m.col = r.extras[marker_off + i].1;
2274 }
2275 // A point whose reflowed line fell inside the evicted prefix has left
2276 // the buffer, so it is released rather than clamped to line 0 (#691) —
2277 // deliberately unlike the marker loop above, which saturates. A marker
2278 // that lands on the wrong line still paints something the consumer can
2279 // see and correct; a tracked point is *asked* for a position, and
2280 // answering with content the caller never anchored to is the exact
2281 // failure this whole module exists to remove.
2282 let mut i = 0;
2283 let evicted = r.evicted;
2284 let extras = &r.extras;
2285 self.normal_tracked.retain_mut(|p| {
2286 let (line, col) = extras[tracked_off + i];
2287 i += 1;
2288 match line.checked_sub(evicted) {
2289 Some(line) => {
2290 p.line = line;
2291 p.col = col;
2292 true
2293 }
2294 None => false,
2295 }
2296 });
2297
2298 let alt = self.alt_grid.take_lines();
2299 let r = reflow_pane(
2300 alt,
2301 VecDeque::new(),
2302 (0, 0),
2303 &[],
2304 ReflowDims {
2305 limit: 0,
2306 reflow: false,
2307 ..dims
2308 },
2309 );
2310 self.alt_grid.set_screen(r.screen, cols, rows);
2311 }
2312
2313 // Carry the deferred wrap across the resize — it is *cursor* state, and it used to be
2314 // reset here alongside the scroll margins. Losing it meant the next byte overwrote the
2315 // last glyph instead of wrapping past it, on a column resize *and* on a rows-only one
2316 // where no reflow runs at all.
2317 //
2318 // This comment also named the tab stops beside the margins, as state that "does
2319 // legitimately reset". That was wrong, and #849 measured it: the table is indexed by
2320 // *columns* and written by the *application*, so rebuilding it on a rows-only resize
2321 // destroyed it on an axis it does not name. The margins still reset; the table does not,
2322 // and the extension below is why.
2323 //
2324 // The flag means "the cursor is logically one past the column it sits on". Where the
2325 // reflow leaves it somewhere other than the last column that logical position **is**
2326 // representable, so the flag is cleared and the cursor takes it instead — ghostty's rule,
2327 // stated in its own words for the saved cursor: *"If we had pending wrap set and we're no
2328 // longer at the end of the line, we unset the pending wrap and move the cursor to reflect
2329 // the correct next position"* (`terminal/Screen.zig:2092-2098` @ `e6e26e1`). alacritty
2330 // reaches the same place from the other side, lifting the cursor outside the grid before
2331 // reflowing and clamping it back afterwards (`grid/resize.rs:113-116`, `:248-251`,
2332 // `:173-177` @ `852e971`); xterm.js needs no rule because `x === cols` is representable.
2333 //
2334 // `col + 1` cannot overflow the row: the branch requires `col != cols - 1`, and `col` is
2335 // already clamped below `cols` by `Cursor::set_point`.
2336 if self.cursor.pending_wrap && self.cursor.col != cols - 1 {
2337 self.cursor.pending_wrap = false;
2338 self.cursor.col += 1;
2339 }
2340 // The scroll region is a *range over the current screen*, so a geometry change discards
2341 // it: at a new row count the range names rows that are not the ones it was set for. Every
2342 // reference does the same, and the spec's own width change says so in an enumeration —
2343 // xterm's DECCOLM handler calls `resetMargins` under a `DEC 070, pp 5-71 to 5-72`
2344 // citation (`charproc.c:7446`, `:7463` @ `6380a3e`).
2345 //
2346 // What is **not** a geometry change is a resize to the size the terminal already has, and
2347 // until this gate the two were the same call. `resize` has no early return, so a consumer
2348 // re-asserting its size destroyed a region only the *application* could restore — and the
2349 // application is never told, so nothing restores it. Every reference is guarded against
2350 // that by an early return this function does not have (`alacritty_terminal/src/term/
2351 // mod.rs:662` @ `852e971`, `src/terminal/Terminal.zig:3753` @ `e6e26e1`,
2352 // `src/browser/CoreBrowserTerminal.ts:1055` @ `699f553`); the gate is the narrow form of
2353 // the same guard, and it is the predicate this function already uses twice above.
2354 if cols != old_cols || rows != old_rows {
2355 self.scroll_top = 0;
2356 self.scroll_bottom = rows - 1;
2357 }
2358 // Extend, never rebuild and never trim (#849). A resize changes the *grid*; the
2359 // tab-stop table is state the application wrote through the stream. The line this
2360 // replaces rebuilt it from defaults on every call, so a window dragged one row
2361 // taller — or a consumer merely re-asserting its size, which reaches here because
2362 // this function has no early return for unchanged geometry — silently replaced an
2363 // application's stops with multiples of eight, on an axis the table is not even
2364 // indexed by.
2365 //
2366 // New columns take the default ladder at their **absolute** index, which is why the
2367 // closure carries `index` instead of counting from zero: filling them with `false`
2368 // keeps the length right and loses every default stop past the old width.
2369 //
2370 // Nothing is trimmed, so `tabs.len()` is the widest this terminal has ever been and
2371 // the invariant the two walks need is `len() >= cols` rather than equality — every
2372 // index site is bounded by `cols` or by `cursor.col`. A stop pushed outside the grid
2373 // by a narrowing is unreachable while narrow and returns when the grid widens again.
2374 // The corpus splits 2-2 on that half: xterm keeps it structurally (MAX_TABS is 1024,
2375 // independent of the screen, `ptyx.h:3611` @ `6380a3e`) and xterm.js keeps it in a
2376 // sparse map, while alacritty truncates through `Vec::resize_with`
2377 // (`alacritty_terminal/src/term/mod.rs:2341` @ `852e971`) and ghostty rebuilds the
2378 // table outright when the column count moves (`src/terminal/Terminal.zig:3759` @
2379 // `e6e26e1`). No tie-breaker row covers the axis, so the call is the maintainer's,
2380 // recorded on #849.
2381 //
2382 // Only the *rebuild* is wrong here, not every reset: RIS still restores the default
2383 // ladder, because `full_reset` replaces the whole struct and takes the table from
2384 // the constructor — the right answer for state the application wrote and `ESC c`
2385 // resets.
2386 if cols > self.tabs.len() {
2387 let mut index = self.tabs.len();
2388 self.tabs.resize_with(cols, || {
2389 let is_stop = is_default_tab_stop(index);
2390 index += 1;
2391 is_stop
2392 });
2393 }
2394 self.display_offset = self.display_offset.min(self.scrollback.len());
2395
2396 // Damage tracking is sized to the screen; a resize repaints everything,
2397 // so drop any pending scroll op (it points at the old rows).
2398 self.line_damage = vec![LineBounds::undamaged(cols); rows];
2399 self.scroll = None;
2400 self.mark_fully_damaged();
2401 }
2402
2403 pub fn grid(&self) -> &Grid {
2404 &self.grid
2405 }
2406
2407 pub fn cursor(&self) -> &Cursor {
2408 &self.cursor
2409 }
2410
2411 /// Whether bracketed-paste mode (DEC ?2004) is enabled. The input encoder
2412 /// (#11) reads this to decide whether to wrap pasted text in markers.
2413 pub fn bracketed_paste(&self) -> bool {
2414 self.bracketed_paste
2415 }
2416
2417 // ---- input encoding (#11) ------------------------------------------------
2418
2419 /// Encode a key event to bytes using every mode that decides one: the active
2420 /// cursor-key mode (DECCKM), application keypad, the kitty keyboard-protocol
2421 /// flags and `modifyOtherKeys` level 2 (#890). `encode_key` consults all four,
2422 /// and asks kitty first.
2423 pub fn encode_key(&self, ev: KeyEvent) -> Option<Vec<u8>> {
2424 encode_key(
2425 &ev,
2426 self.app_cursor_keys,
2427 self.application_keypad,
2428 self.kitty_flags,
2429 self.modify_other_keys_2,
2430 )
2431 }
2432
2433 /// Encode a mouse event using the active tracking mode + encoding. `None`
2434 /// when reporting is off or the event is filtered by the mode.
2435 pub fn encode_mouse(&self, ev: MouseEvent) -> Option<Vec<u8>> {
2436 encode_mouse(&ev, self.mouse_protocol, self.mouse_encoding)
2437 }
2438
2439 /// Encode pasted text, wrapping it in bracketed-paste markers when ?2004 is
2440 /// on.
2441 pub fn encode_paste(&self, text: &str) -> Vec<u8> {
2442 encode_paste(text, self.bracketed_paste)
2443 }
2444
2445 /// Encode a focus change (`CSI I`/`CSI O`), or `None` when focus reporting
2446 /// (?1004) is off.
2447 pub fn encode_focus(&self, focused: bool) -> Option<Vec<u8>> {
2448 encode_focus(focused, self.focus_events)
2449 }
2450
2451 /// Take the consumer events queued since the last drain, emptying the queue.
2452 pub fn drain_events(&mut self) -> Vec<TermEvent> {
2453 std::mem::take(&mut self.events)
2454 }
2455
2456 /// Take the reply bytes queued since the last drain (DA/DSR/DECRQM answers),
2457 /// emptying the buffer. The consumer writes them back to the PTY.
2458 pub fn drain_replies(&mut self) -> Vec<u8> {
2459 std::mem::take(&mut self.replies)
2460 }
2461
2462 /// Device Status Report (CSI Ps n): 6 = cursor position, 5 = operating
2463 /// status. Queues the reply for `drain_replies` (#27).
2464 fn device_status_report(&mut self, param: u16) {
2465 match param {
2466 6 => {
2467 // CSI row;col R, 1-based — region-relative under origin mode
2468 // (the coordinate system the app is addressing in).
2469 let row = if self.origin_mode {
2470 self.cursor.row.saturating_sub(self.scroll_top)
2471 } else {
2472 self.cursor.row
2473 } + 1;
2474 let col = self.cursor.col + 1;
2475 self.replies
2476 .extend_from_slice(format!("\x1b[{row};{col}R").as_bytes());
2477 }
2478 5 => self.replies.extend_from_slice(b"\x1b[0n"), // status: OK
2479 _ => {}
2480 }
2481 }
2482
2483 /// Kitty keyboard-protocol negotiation (#23). `lead` is the leading CSI
2484 /// intermediate: `?` query, `>` push, `=` set, `<` pop.
2485 fn kitty_dispatch(&mut self, lead: u8, params: &Params) {
2486 match lead {
2487 // Query → report the current flags as `CSI ? flags u` (#27 channel).
2488 b'?' => self
2489 .replies
2490 .extend_from_slice(format!("\x1b[?{}u", self.kitty_flags).as_bytes()),
2491 // Push: save the current flags, then set the new ones (default 0).
2492 b'>' => {
2493 const KITTY_STACK_CAP: usize = 16;
2494 if self.kitty_stack.len() >= KITTY_STACK_CAP {
2495 self.kitty_stack.remove(0); // drop the oldest on overflow
2496 }
2497 self.kitty_stack.push(self.kitty_flags);
2498 self.kitty_flags = param_or(params, 0, 0) as u8;
2499 }
2500 // Pop `n` (default 1): restore from the stack, 0 once empty.
2501 b'<' => {
2502 for _ in 0..param_or(params, 0, 1) {
2503 self.kitty_flags = self.kitty_stack.pop().unwrap_or(0);
2504 }
2505 }
2506 // Set in place (no push): mode 1 replace, 2 or-in, 3 and-not.
2507 b'=' => {
2508 let flags = param_or(params, 0, 0) as u8;
2509 self.kitty_flags = match param_or(params, 1, 1) {
2510 1 => flags,
2511 2 => self.kitty_flags | flags,
2512 3 => self.kitty_flags & !flags,
2513 _ => self.kitty_flags,
2514 };
2515 }
2516 _ => {}
2517 }
2518 }
2519
2520 /// DECRQM (CSI ? Ps $ p): report whether DEC private mode `Ps` is set —
2521 /// `CSI ? Ps ; val $ y` with val 1=set, 2=reset, 0=not recognized (#27).
2522 fn decrqm(&mut self, mode: u16) {
2523 let state = match mode {
2524 1 => Some(self.app_cursor_keys),
2525 // DECANM (#84): set = ANSI mode (the normal state), reset = VT52.
2526 2 => Some(!self.vt52_mode),
2527 6 => Some(self.origin_mode),
2528 // DECCOLM: derived from the actual width, never a tracked flag — a
2529 // flag would lie if the consumer ignored the resize request (#82).
2530 3 => Some(self.grid.cols() == 132),
2531 7 => Some(self.autowrap),
2532 45 => Some(self.reverse_wraparound),
2533 9 => Some(self.mouse_protocol == MouseProtocol::X10),
2534 66 => Some(self.application_keypad),
2535 12 => Some(self.cursor.blink),
2536 25 => Some(self.cursor.visible),
2537 // Mouse tracking is a single-state enum (the levels are mutually
2538 // exclusive — an app enables one), so querying ?1000 while ?1002 is
2539 // active reports "reset". Faithful to that model.
2540 1000 => Some(self.mouse_protocol == MouseProtocol::Normal),
2541 1002 => Some(self.mouse_protocol == MouseProtocol::ButtonEvent),
2542 1003 => Some(self.mouse_protocol == MouseProtocol::AnyEvent),
2543 1004 => Some(self.focus_events),
2544 1006 => Some(self.mouse_encoding == MouseEncoding::Sgr),
2545 1015 => Some(self.mouse_encoding == MouseEncoding::Urxvt),
2546 1005 => Some(self.mouse_encoding == MouseEncoding::Utf8),
2547 1016 => Some(self.mouse_encoding == MouseEncoding::SgrPixels),
2548 47 | 1047 | 1049 => Some(self.on_alt),
2549 2004 => Some(self.bracketed_paste),
2550 2026 => Some(self.synchronized_output),
2551 2027 => Some(self.grapheme_clustering),
2552 2031 => Some(self.color_scheme_updates),
2553 9001 => Some(self.win32_input_mode),
2554 _ => None,
2555 };
2556 let val = match state {
2557 Some(true) => 1,
2558 Some(false) => 2,
2559 None => 0,
2560 };
2561 self.replies
2562 .extend_from_slice(format!("\x1b[?{mode};{val}$y").as_bytes());
2563 }
2564
2565 // ---- cursor / scroll primitives ------------------------------------------
2566
2567 /// Move down one line. At the bottom margin, scroll the region instead;
2568 /// below the region, just descend (no scroll). Column is unchanged (raw LF;
2569 /// CR is what returns to column 0).
2570 /// An ordinary line feed — `LF`/`VT`/`FF`, `IND` and `NEL`. None of them serves a wrap.
2571 ///
2572 /// It clears the deferred wrap, as every acting positioner does — see
2573 /// [`Cursor::pending_wrap`]. The clear sits here rather than in
2574 /// [`Term::linefeed_inner`] because the wrap machinery drives that same
2575 /// primitive and *consumes* the flag rather than clearing it; folding the two
2576 /// together would put one property's arm and its clear in one statement.
2577 /// Leaving it armed made the print after an `LF` wrap a second time, landing a
2578 /// row further down and leaving the row the feed had reached blank (#848).
2579 fn linefeed(&mut self) {
2580 self.linefeed_inner(false);
2581 self.cursor.pending_wrap = false;
2582 }
2583
2584 /// A line feed, carrying the one fact the shift itself cannot see: whether the auto-wrap asked
2585 /// for it.
2586 ///
2587 /// `serves_wrap` is the **bottom** seam's exemption in `shift_region`, the mirror of
2588 /// `evicts_to_scrollback` for the top one. When `wrapline` drives this, the blank that lands at
2589 /// the region's bottom *is* where the wrapped text is about to go — so the row that #540 would
2590 /// call "the one that lost its continuation to the blank" is in fact the row whose continuation
2591 /// that blank **is** (#557).
2592 ///
2593 /// xterm.js threads the identical fact through the identical seam, in the opposite direction:
2594 /// `BufferService.scroll(eraseAttr, isWrapped)` stamps the *destination* row
2595 /// (`common/services/BufferService.ts:68`/`:77` @ `699f553`), and exactly one of its four
2596 /// non-test callers passes `true` — the auto-wrap branch of `_print` (`InputHandler.ts:588`),
2597 /// not `lineFeed`, `index` or the ED-2 loop.
2598 fn linefeed_inner(&mut self, serves_wrap: bool) {
2599 // New-line mode (LNM ?20): a line feed also returns to column 0 (#71).
2600 if self.newline_mode {
2601 self.carriage_return();
2602 }
2603 if self.cursor.row == self.scroll_bottom {
2604 // A top-anchored primary-screen scroll pushes the evicted top line
2605 // into scrollback history.
2606 if self.scroll_top == 0 && !self.on_alt {
2607 // Scrollback accrues whenever the scroll is top-anchored on the
2608 // primary screen (`scroll_top == 0`) — but the O(1) ring handshake
2609 // only applies to a *full-screen* scroll (`scroll_bottom` at the
2610 // last row). A top-anchored *sub-region* (`[0..k]`, k < rows-1)
2611 // still accrues, yet must scroll only its region, so it keeps the
2612 // copy + region scroll. These are distinct predicates (ADR-0009).
2613 let evicted = if self.scroll_bottom == self.grid.rows() - 1 {
2614 // Full-screen hot path: move the evicted top row out, install
2615 // a recycled blank as the new bottom (zero-alloc steady state).
2616 let blank = self
2617 .recycled_row
2618 .take()
2619 .unwrap_or_else(|| Row::from_cells(Vec::with_capacity(self.grid.cols())));
2620 let evicted = self.grid.scroll_up_recycle(blank);
2621 // The one row-shifting path that does not route through `shift_region` (it
2622 // needs the primitive that *returns* the evicted row), so it records its own
2623 // scroll op — and owes no seam clear, which is now an argument rather than a
2624 // coincidence: the top seam is exempt because this evicts into scrollback
2625 // (adjacency is preserved one row back), and the bottom seam is exempt because
2626 // this branch only runs at `scroll_bottom == rows - 1`, where a wrap on the
2627 // last row is the state the scroll exists to serve.
2628 self.record_scroll(self.scroll_top, self.scroll_bottom, 1);
2629 evicted
2630 } else {
2631 // Top-anchored sub-region: copy row 0, then region-scroll
2632 // `[0..=scroll_bottom]` (rows below stay fixed).
2633 //
2634 // #449: the fixed rows keep their GRID position while
2635 // scrollback grows, so their content's concatenated absolute
2636 // index shifts +1 — re-anchor the content-tracking anchors
2637 // (selection, markers; alacritty's swap-back of the fixed
2638 // bottom lines is the screen-relative equivalent of this)
2639 // and invalidate the query-derived highlights
2640 // (drop-not-re-anchor policy, #108). In-region and
2641 // scrollback content keeps stable indices — untouched.
2642 let below = self.scrollback.len() + self.scroll_bottom + 1;
2643 self.selection_shift_below_margin(below);
2644 self.markers_shift_below_margin(below);
2645 self.tracked_shift_below_margin(below);
2646 self.invalidate_search_highlights();
2647 let evicted = self.grid.row_owned(0);
2648 self.shift_region(
2649 self.scroll_top,
2650 self.scroll_bottom,
2651 false,
2652 true,
2653 serves_wrap,
2654 );
2655 evicted
2656 };
2657 self.scrollback.push_back(evicted);
2658 // Follow-bottom = stay: if the user is scrolled up, bump the
2659 // offset so the same lines stay in view instead of being yanked
2660 // to the bottom.
2661 if self.display_offset > 0 {
2662 self.display_offset = (self.display_offset + 1).min(self.scrollback.len());
2663 }
2664 // Cap: evict the oldest line past the limit. The view is anchored
2665 // to history, so dropping the front shifts the offset down too
2666 // (xterm.js trims ybase and ydisp together) — also keeps the
2667 // offset within `[0, len]`. The evicted row is parked for reuse.
2668 if self.scrollback.len() > self.scrollback_limit {
2669 self.recycled_row = self.scrollback.pop_front();
2670 // Every absolute index below just shifted by exactly one, which is
2671 // what makes this class of movement expressible as a scalar (#490).
2672 // Counted here rather than in `markers_evict_oldest` because the fact
2673 // is about the *buffer*, not about markers.
2674 //
2675 // **Scope, because the name over-promises.** This counts the
2676 // scrollback *cap* evicting one line. Reflow also drops lines off the
2677 // front (`PaneReflow::evicted`, installed by replacing the deque) and
2678 // is deliberately not counted: it moves the survivors non-uniformly,
2679 // so no delta repairs them and `marker_epoch` signals it instead. A
2680 // holder rebasing off this number *without* also watching the epoch
2681 // gets a wrong answer across every resize.
2682 self.evicted_total += 1;
2683 // Every absolute index just shifted down by one; move the
2684 // selection with it so its anchors keep their content.
2685 self.selection_evict_oldest();
2686 // Query-derived highlights can't survive the index shift (see
2687 // the method doc); selection re-anchors, highlights invalidate.
2688 self.invalidate_search_highlights();
2689 // Markers are persistent anchors: shift them down with the
2690 // index, disposing any whose line was the evicted one (#118).
2691 self.markers_evict_oldest();
2692 // Same obligation for a position held outside the engine — the
2693 // one holder in this space that had no fixup at all (#691).
2694 self.tracked_evict_oldest();
2695 if self.display_offset > 0 {
2696 // Scrolled up: evicting the oldest line advanced the
2697 // viewport, so it must be repainted (the "frozen while
2698 // scrolled" rule does not apply when the view itself moved).
2699 self.display_offset -= 1;
2700 self.mark_fully_damaged();
2701 }
2702 }
2703 } else {
2704 // Region (top margin > 0) or alt-screen scroll: the evicted line
2705 // does NOT enter scrollback, so content moves *within* the screen
2706 // and absolute indices in the region shift. Rotate the selection
2707 // up so it follows; an endpoint on the dropped line clears it.
2708 let base = self.scrollback.len();
2709 self.selection_rotate_region(
2710 base + self.scroll_top,
2711 base + self.scroll_bottom,
2712 true,
2713 );
2714 // Rotate the active buffer's markers with the content (#187):
2715 // per-buffer storage (#186) scopes them, so an alt scroll rotates
2716 // *alt* marks and leaves the frozen primary list untouched — no
2717 // guard needed. `markers_rotate_region` routes via `markers_mut`.
2718 self.markers_rotate_region(base + self.scroll_top, base + self.scroll_bottom, true);
2719 self.tracked_rotate_region(base + self.scroll_top, base + self.scroll_bottom, true);
2720 self.invalidate_search_highlights();
2721 self.shift_region(
2722 self.scroll_top,
2723 self.scroll_bottom,
2724 false,
2725 false,
2726 serves_wrap,
2727 );
2728 }
2729 } else if self.cursor.row + 1 < self.grid.rows() {
2730 self.cursor.row += 1;
2731 }
2732 }
2733
2734 /// DECSTBM (CSI r): set the top/bottom scroll margins (1-based inclusive).
2735 /// An invalid region (top ≥ bottom) is ignored.
2736 fn set_scroll_region(&mut self, top: usize, bottom: usize) {
2737 let bottom = bottom.min(self.grid.rows());
2738 if top >= bottom {
2739 return;
2740 }
2741 self.scroll_top = top - 1;
2742 self.scroll_bottom = bottom - 1;
2743 self.goto(0, 0); // DECSTBM homes the cursor (absolute)
2744 }
2745
2746 // ---- alt screen (DEC 1049) -----------------------------------------------
2747
2748 /// Enter the alternate screen: save the cursor, swap in the other grid, and
2749 /// clear it.
2750 /// Save the cursor into the alt-screen slot — `?1048` set, and the first
2751 /// half of `?1049` enter (#72).
2752 fn save_alt_cursor(&mut self) {
2753 self.saved_cursor = self.cursor;
2754 }
2755
2756 /// Restore the cursor from the alt-screen slot — `?1048` reset, and the
2757 /// second half of `?1049` leave. DECTCEM visibility is a standalone mode, not
2758 /// part of the save, so preserve it across the restore (#38/#72).
2759 fn restore_alt_cursor(&mut self) {
2760 let visible = self.cursor.visible;
2761 self.cursor = self.saved_cursor;
2762 self.cursor.visible = visible;
2763 self.settle_restored_wrap();
2764 }
2765
2766 /// Switch to the (cleared) alternate buffer without touching the cursor —
2767 /// `?47`/`?1047` set, and the second half of `?1049` enter (#72).
2768 fn switch_to_alt(&mut self) {
2769 if self.on_alt {
2770 return;
2771 }
2772 // The pulled index reports the ACTIVE buffer, so a swap changes what the
2773 // consumer's held answer even describes — with no line having moved (#490).
2774 // Gated on a marker existing on either side, since an empty index is already
2775 // correct for both buffers.
2776 if !self.normal_markers.is_empty() || !self.alt_markers.is_empty() {
2777 self.bump_marker_epoch();
2778 }
2779 std::mem::swap(&mut self.grid, &mut self.alt_grid);
2780 self.grid.clear();
2781 self.on_alt = true;
2782 self.display_offset = 0; // the alt screen has no scrollback to view
2783 self.selection = None; // a selection cannot survive a screen swap
2784 self.invalidate_search_highlights(); // matches index the primary buffer
2785 self.mark_fully_damaged();
2786 }
2787
2788 /// Switch back to the primary buffer without touching the cursor —
2789 /// `?47`/`?1047` reset, and the first half of `?1049` leave (#72).
2790 fn switch_to_primary(&mut self) {
2791 if !self.on_alt {
2792 return;
2793 }
2794 // Dispose the alt buffer's markers on leave — xterm `activateNormalBuffer`
2795 // → `clearAllMarkers` (#177 S0). Empty while the alt guards stand, so this
2796 // fires nothing today; it's the seam the alt-marker slices (#187) build on.
2797 for m in self.alt_markers.drain(..) {
2798 self.events.push(TermEvent::MarkerDisposed(m.id));
2799 }
2800 // Same fate for alt-scoped tracked points, and for the same reason: the alt
2801 // buffer is not archived, so leaving it destroys what they named (#691).
2802 // No announcement — `tracked_point` answers `None` on the next ask.
2803 // The pulled index reports the ACTIVE buffer, so a swap changes what the
2804 // consumer's held answer even describes — with no line having moved (#490).
2805 // Only `normal_markers` is asked: the drain above just emptied `alt_markers`, so
2806 // an `|| !alt_markers.is_empty()` disjunct would be dead code carrying a comment
2807 // that claims it reads "either side". What was alt-scoped left through
2808 // `MarkerDisposed`; what can still be stale is the primary population.
2809 if !self.normal_markers.is_empty() {
2810 self.bump_marker_epoch();
2811 }
2812 self.alt_tracked.clear();
2813 std::mem::swap(&mut self.grid, &mut self.alt_grid);
2814 self.on_alt = false;
2815 self.display_offset = 0; // return to the primary at its bottom
2816 self.selection = None; // a selection cannot survive a screen swap
2817 self.invalidate_search_highlights(); // matches index the swapped-out buffer
2818 self.mark_fully_damaged();
2819 }
2820
2821 fn enter_alt_screen(&mut self) {
2822 if self.on_alt {
2823 return;
2824 }
2825 self.save_alt_cursor();
2826 self.switch_to_alt();
2827 }
2828
2829 /// Leave the alternate screen: swap the primary grid back in and restore the
2830 /// saved cursor.
2831 fn leave_alt_screen(&mut self) {
2832 if !self.on_alt {
2833 return;
2834 }
2835 self.switch_to_primary();
2836 self.restore_alt_cursor();
2837 }
2838
2839 /// RI (ESC M): move up one line. At the top margin, scroll the region down
2840 /// instead.
2841 fn reverse_index(&mut self) {
2842 if self.cursor.row == self.scroll_top {
2843 // RI never enters scrollback; the region scrolls down within the
2844 // screen, so absolute indices in it shift down. Rotate the selection.
2845 let base = self.scrollback.len();
2846 self.selection_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2847 // Rotate the active buffer's markers (#187) — alt-scoped on the alt
2848 // screen, so no guard (see `linefeed`).
2849 self.markers_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2850 self.tracked_rotate_region(base + self.scroll_top, base + self.scroll_bottom, false);
2851 self.invalidate_search_highlights();
2852 self.shift_region(self.scroll_top, self.scroll_bottom, true, false, false);
2853 } else if self.cursor.row > 0 {
2854 self.cursor.row -= 1;
2855 }
2856 // Cleared in both branches, because both are the verb acting: one moves the
2857 // cursor, the other scrolls the content under it. Branching on which would
2858 // reintroduce the per-verb special-casing [`Cursor::pending_wrap`] exists to
2859 // remove, and xterm and ghostty both clear unconditionally here (`cursor.c:284`
2860 // via `CursorUp`; `Terminal.zig:2174` in `index`, under a comment saying so).
2861 self.cursor.pending_wrap = false;
2862 }
2863
2864 // ---- cursor save/restore (DECSC / DECRC) ---------------------------------
2865
2866 /// DECSC (ESC 7): save the cursor position, pen, pending-wrap, and origin
2867 /// mode. Visibility is not saved (DECTCEM is separate).
2868 fn save_cursor(&mut self) {
2869 self.decsc = SavedCursor {
2870 row: self.cursor.row,
2871 col: self.cursor.col,
2872 pen: self.cursor.pen,
2873 pending_wrap: self.cursor.pending_wrap,
2874 origin_mode: self.origin_mode,
2875 charsets: self.charsets,
2876 gl: self.gl,
2877 };
2878 }
2879
2880 /// DECRC (ESC 8): restore what DECSC saved. Origin mode is restored (per
2881 /// ADR-0004); visibility is left as-is. The position is clamped to the
2882 /// current screen in case it shrank since the save.
2883 fn restore_cursor(&mut self) {
2884 let s = self.decsc;
2885 self.cursor.row = s.row.min(self.grid.rows() - 1);
2886 self.cursor.col = s.col.min(self.grid.cols() - 1);
2887 self.cursor.pen = s.pen;
2888 self.cursor.pending_wrap = s.pending_wrap;
2889 self.origin_mode = s.origin_mode;
2890 self.charsets = s.charsets;
2891 self.gl = s.gl;
2892 self.settle_restored_wrap();
2893 }
2894
2895 /// A restored deferred wrap is only meaningful at the last column; anywhere
2896 /// else the logical position is representable and the cursor takes it.
2897 ///
2898 /// The same translation `Term::resize` applies to the **live** cursor, applied
2899 /// to the two saved slots — which is where ghostty puts it, on the saved cursor
2900 /// it has just reflowed (`terminal/Screen.zig:2094`: *"If we had pending wrap
2901 /// set and we're no longer at the end of the line, we unset the pending wrap and
2902 /// move the cursor to reflect the correct next position"*).
2903 ///
2904 /// justerm's slots are not reflowed, so the repair belongs at the restore rather
2905 /// than at the resize: `decsc` is untouched by `Term::resize` and clamped here,
2906 /// and the alt slot is copied whole. Measured before the fix: 4 columns, `abcd`,
2907 /// `DECSC`, `resize(8, 3)`, `DECRC` left the flag armed at column 3 of an
2908 /// 8-column grid — five columns from the edge — and the next print wrapped
2909 /// instead of landing at column 4 (#848).
2910 fn settle_restored_wrap(&mut self) {
2911 if self.cursor.pending_wrap && self.cursor.col + 1 < self.grid.cols() {
2912 self.cursor.pending_wrap = false;
2913 self.cursor.col += 1;
2914 }
2915 }
2916
2917 /// Set the window title and tell the consumer, in one place.
2918 ///
2919 /// Both writers come through here — the OSC 0/2 path and the XTWINOPS pop
2920 /// path — so the retained string and the event a consumer sees cannot
2921 /// disagree. A pop deliberately fires the **same** `TermEvent::Title` an
2922 /// ordinary title change does: both implementations that carry the stack do
2923 /// exactly this (xterm.js's `setTitle` fires `_onTitleChange`, alacritty's
2924 /// `pop_title` routes through `set_title`), and a second event would ask
2925 /// every consumer to learn a distinction it has no use for. The consequence
2926 /// worth stating: `Title` now means *"the title is this"*, not *"the
2927 /// application just set this"*.
2928 fn set_window_title(&mut self, title: String) {
2929 self.window_title.clone_from(&title);
2930 self.events.push(TermEvent::Title(title));
2931 }
2932
2933 /// XTWINOPS (`CSI Ps ; Ps ; Ps t`) — window manipulation, of which this
2934 /// engine implements exactly two operations (#823).
2935 ///
2936 /// It owns no window, so most of the family is meaningless here: 14/16 ask
2937 /// about pixels the engine has no concept of, and the resize/move/iconify
2938 /// operations are requests about a window the consumer owns. 22 (push
2939 /// title) and 23 (pop title) are different — they are pure VT state, and
2940 /// they were the single most-emitted unimplemented sequence in the capture
2941 /// sweep that produced #823. **This does not make `CSI t` a handled final**;
2942 /// every other first parameter still falls through and is ignored.
2943 ///
2944 /// The second parameter selects the axis: absent or `0` both, `1` the icon
2945 /// name, `2` the window title, anything else no axis at all. It is honoured
2946 /// rather than assumed away because real applications use it — `vim` emits
2947 /// a fully nested `22;0;0t · 22;2t · 22;1t … 23;2t · 23;1t · 23;0;0t`,
2948 /// which a single shared stack gets wrong.
2949 ///
2950 /// **The optional third parameter is deliberately ignored**, and that is a
2951 /// divergence from the spec rather than a simplification of it:
2952 /// `ctlseqs.txt:1698` gives a value in 1..10 *direct access to the stack*,
2953 /// storing or retrieving without pushing or popping, and xterm implements
2954 /// it (`charproc.c:9272`). Measured reach of that form is zero on every
2955 /// axis checked — no occurrence across seven programs recorded under real
2956 /// ptys, no file under `/usr/bin` or `/usr/lib64` containing it, no
2957 /// terminfo capability that emits `CSI 22/23 t` at all under any candidate
2958 /// `TERM`, and no other implementation honouring it (xterm.js ignores it,
2959 /// alacritty's dispatch never reads past the first parameter, ghostty
2960 /// carries the index and then drops the command). It entered xterm in patch
2961 /// #385 (2023-10-01) for symmetry with XTPUSHCOLORS, not because an
2962 /// application asked. So `CSI 22;2;3t` is an ordinary push here.
2963 fn window_ops(&mut self, params: &Params) {
2964 // `param_or` folds an explicit 0 to the default, which is what both
2965 // axis and operation want: absent and `0` mean the same thing in each.
2966 let axis = param_or(params, 1, 0);
2967 let (window, icon) = (axis == 0 || axis == 2, axis == 0 || axis == 1);
2968 match param_or(params, 0, 0) {
2969 22 => {
2970 if window {
2971 let title = self.window_title.clone();
2972 push_title(&mut self.window_title_stack, title);
2973 }
2974 if icon {
2975 let name = self.icon_name.clone();
2976 push_title(&mut self.icon_name_stack, name);
2977 }
2978 }
2979 23 => {
2980 if window && let Some(title) = self.window_title_stack.pop() {
2981 self.set_window_title(title);
2982 }
2983 // Restoring the icon name has no observable output: the engine
2984 // has no icon-name event. The stack is still popped so the two
2985 // axes stay aligned across mixed push/pop sequences.
2986 if icon && let Some(name) = self.icon_name_stack.pop() {
2987 self.icon_name = name;
2988 }
2989 }
2990 _ => {}
2991 }
2992 }
2993
2994 /// RIS (ESC c) — full reset to the power-on state (#53). Reconstruct every
2995 /// screen/mode field to its construction default (preserving only the
2996 /// dimensions and the scrollback cap), but keep the consumer-bound output
2997 /// queues (`replies`/`events`) that accrued earlier in this `feed`, and
2998 /// signal a full repaint. The vte parser lives outside `Term`, so replacing
2999 /// `self` does not disturb in-progress parsing. Mirrors xterm.js fullReset.
3000 ///
3001 /// The XTWINOPS title stacks and the retained title/icon strings (#823) are
3002 /// **not** on the copy-back list and must not be: they are terminal state the
3003 /// application wrote, so *justerm's own* RIS invariant drops them, and the
3004 /// wholesale rebuild does that for free.
3005 ///
3006 /// Read "justerm's own" literally — this is a **minority position, 1–2**, and
3007 /// no spec text settles it. Only alacritty agrees (`title_stack =
3008 /// Vec::new()` in `reset_state`); xterm.js's `reset()` touches nothing but
3009 /// attribute data, and xterm's only bulk free of `saved_titles` is inside
3010 /// `VTDestroy`, i.e. widget teardown rather than `ESC c`. So the two
3011 /// references whose *model* this slice copied — two stacks, the bound, the
3012 /// drop-oldest rule — are the two that keep the stack across a reset. The
3013 /// grounds are the invariant note next door, which already records that no
3014 /// reference can be cited here because none of them holds the embedder's
3015 /// configuration in the object its reset replaces.
3016 ///
3017 /// **That "1–2" is right for the stacks and wrong for the retained strings**, and
3018 /// the sentence above ran the two together (corrected 2026-09-08, #835). Ghostty
3019 /// drops the title on a reset exactly as this does — `self.title` and `self.pwd`
3020 /// are both `clearRetainingCapacity()`d in `fullReset` (`Terminal.zig:4468-4469`)
3021 /// — so on the **retained string** the tally is 2–2, not 1–2, and justerm is not
3022 /// in a minority. It cannot be counted on the *stack* half at all, because it
3023 /// holds no title stack in `Terminal` to have an opinion about; there the 1–2
3024 /// stands. The correction matters because "minority position" is a standing
3025 /// invitation to revisit, and half of what it was pointing at is a tie.
3026 ///
3027 /// **Dropping the title is also not announced, and that too matches both
3028 /// references that drop it.** A consumer keeps the exited application's window
3029 /// title after `ESC c` — the same shape as the palette below, and *worse* on its
3030 /// face, since here the engine does hold the string and does discard it, so the
3031 /// two sides actually diverge. It is nonetheless not a defect by any available
3032 /// standard: alacritty clears `title`/`title_stack` in `reset_state` with no
3033 /// event on its proxy, and ghostty's `StreamHandler.fullReset` sends a mouse
3034 /// shape, a mode-2031 report and a progress clear — and nothing about the title.
3035 /// 2–0 among the references that face the question. Measured on #835 rather than
3036 /// assumed; if it is ever revisited, the first thing to re-measure is whether
3037 /// dropping at all is right, since xterm and xterm.js simply keep the title.
3038 ///
3039 /// **The palette is deliberately *not* announced here, and the silence is a
3040 /// decision rather than an omission (#835).** An application that redefined
3041 /// entries with `OSC 4`, or the foreground/background/cursor with
3042 /// `OSC 10`/`11`/`12`, keeps them across `ESC c`: the engine is theme-agnostic
3043 /// and holds no palette, so the consumer's copy is the only one, and this path
3044 /// pushes no `ResetPaletteColor` / `ResetForeground` / `ResetBackground` /
3045 /// `ResetCursorColor` onto the queue above. xterm is the one reference that
3046 /// resets its own palette on **both** strengths (`charproc.c:14366`, in the
3047 /// `if_OPT_ISO_COLORS` block *above* the `if (full)` split); three things
3048 /// decided against following it, none of them the head-count:
3049 ///
3050 /// * **The tie-breaker does not reach it.** ADR-0004 defers to xterm where
3051 /// *the spec* mandates something alacritty merely omits. `OSC 4`/`104` are
3052 /// xterm's own invention and DEC never defined a palette, so no spec text
3053 /// says what `RIS` does to one — a genuine ambiguity, which ADR-0004 routes
3054 /// to alacritty. ("The inventor owns the semantics", which settled
3055 /// `XTREVWRAP` on [`Self::step_back`], does not transfer: that was the
3056 /// invented sequence's *own* meaning, and this is what a **DEC** sequence
3057 /// does to state the invented one left behind.)
3058 /// * **terminfo says the palette reset is not part of `RIS`.**
3059 /// `xterm-256color` spells its reset string `rs1=\Ec\E]104\007` and `linux`
3060 /// spells it `rs1=\Ec\E]R`: both append an explicit palette reset *after*
3061 /// `RIS`, which xterm's own entry would not need if `\Ec` implied one. So
3062 /// `tput reset` already emits `OSC 104` — measured, not read — and the
3063 /// engine already relays it. The reachable case is covered without adding
3064 /// anything, which is what `ris_then_osc104_is_the_reset_string_that_ships`
3065 /// pins.
3066 /// * **The reference that shares this shape declines.** ghostty holds the
3067 /// palette *and* announces every change across a consumer boundary, and its
3068 /// override mask tells it exactly which entries are dirty — so a selective
3069 /// announcement would be free there, and its `fullReset` still sends none.
3070 /// justerm cannot even be selective: holding no palette, it would have to
3071 /// fire unconditionally on every `ESC c`.
3072 ///
3073 /// What xterm resets on both strengths is **two** things, and the engine
3074 /// already does one: the pen is covered by this rebuild and by
3075 /// [`Self::soft_reset`]. The *dynamic* colours are restored by nobody, xterm
3076 /// included — `ReallyReset` never touches them. Rows in
3077 /// `docs/agents/reference-facts.md`; reversal criterion on #835.
3078 fn full_reset(&mut self) {
3079 let replies = std::mem::take(&mut self.replies);
3080 let mut events = std::mem::take(&mut self.events);
3081 // RIS wipes the buffer, so every marker's line is gone — announce each
3082 // disposal so the consumer drops its decorations (and isn't confused when
3083 // the reset id counter reissues the same ids). The events survive the
3084 // reset below (#118).
3085 events.extend(
3086 self.normal_markers
3087 .iter()
3088 .chain(&self.alt_markers)
3089 .map(|m| TermEvent::MarkerDisposed(m.id)),
3090 );
3091 let (cols, rows) = (self.grid.cols(), self.grid.rows());
3092 // The word-boundary set is consumer *policy* (ADR-0017), not terminal state, so
3093 // RIS does not own it — an application printing `reset` must not silently revert
3094 // a setting the embedder chose. It rides across with `replies`/`events` because
3095 // this reset rebuilds `Term` wholesale; the references never face the question,
3096 // holding the equivalent outside the object RIS clears (#545).
3097 let word_separators = std::mem::take(&mut self.word_separators);
3098 // Tracked points die here with everything else, but their *id counter*
3099 // rides across (#691). They have no disposal event — a holder learns its
3100 // point is gone by being told `None` — so a reissued id would answer a
3101 // stale ask with a *different* point's position, silently. The markers
3102 // above take the other route and announce; the counter is what a pull-only
3103 // handle has instead.
3104 let next_tracked_id = self.next_tracked_id;
3105 // The marker epoch rides across too, and then moves — for the reason one
3106 // paragraph up, now that a marker index is *pulled* as well as announced (#490).
3107 // A consumer re-pulls when the epoch differs; resetting it to 0 leaves it equal
3108 // to the value a quiet session already holds, so the one signal it watches would
3109 // not fire for the mutation that invalidates everything. `evicted_total`
3110 // legitimately restarts — the buffer it counted is gone — and the epoch change is
3111 // what stops the consumer rebasing against the old basis.
3112 let marker_epoch = self.marker_epoch;
3113 // Marker ids ride across for the *same* reason as `next_tracked_id`, which this
3114 // slice makes true of markers: a pulled handle outlives the announcement that
3115 // killed it, so a reissued id lets a stale `MarkerDisposed(7)` drop the live
3116 // post-RIS marker 7.
3117 let next_marker_id = self.next_marker_id;
3118 *self = Term::with_scrollback(cols, rows, self.scrollback_limit);
3119 self.replies = replies;
3120 self.events = events;
3121 self.word_separators = word_separators;
3122 self.next_tracked_id = next_tracked_id;
3123 self.next_marker_id = next_marker_id;
3124 self.marker_epoch = marker_epoch;
3125 self.bump_marker_epoch();
3126 self.mark_fully_damaged();
3127 }
3128
3129 /// DECSTR (CSI ! p) — soft reset (#53). Resets a defined subset of modes to
3130 /// their defaults *without* destroying screen content or scrollback, moving
3131 /// the active cursor, or touching the mouse/focus reporting subsystem. Per
3132 /// xterm.js softReset, autowrap returns to ON (the xterm default), not off.
3133 ///
3134 /// The pen returning to [`Pen::default`] is this path's half of xterm's
3135 /// `reset_SGR_Colors`, which runs on **both** reset strengths. The other half
3136 /// of that block — resetting the indexed palette — is deliberately not
3137 /// mirrored, here or in [`Self::full_reset`], where the grounds are written
3138 /// out (#835).
3139 fn soft_reset(&mut self) {
3140 self.cursor.visible = true;
3141 self.cursor.pen = Pen::default();
3142 self.cursor.shape = None; // the application's caret shape and blink mode (#927)
3143 self.cursor.blink = false;
3144 self.scroll_top = 0;
3145 self.scroll_bottom = self.grid.rows() - 1;
3146 self.origin_mode = false;
3147 self.app_cursor_keys = false;
3148 self.bracketed_paste = false;
3149 self.modify_other_keys_2 = false; // xterm clears the modify resources on DECSTR too (#890)
3150 self.grapheme_clustering = false; // ?2027 back to the wcwidth-compat default (#295)
3151 self.autowrap = true; // xterm default is ON (not the VT100 "off")
3152 self.insert_mode = false;
3153 self.charsets = [Charset::Ascii; 4];
3154 self.gl = 0;
3155 self.decsc = SavedCursor::default();
3156 }
3157
3158 fn carriage_return(&mut self) {
3159 self.cursor.col = 0;
3160 self.cursor.pending_wrap = false;
3161 }
3162
3163 /// DECSCUSR (CSI Ps SP q): set the caret shape + blink (#89). 1/2 =
3164 /// blinking/steady block; 3/4 = blinking/steady underline; 5/6 =
3165 /// blinking/steady bar (odd = blink). 0 clears the shape to `None` — the
3166 /// consumer's default shape (#927) — and turns the blink mode off. An unknown
3167 /// param leaves the style unchanged.
3168 fn set_cursor_style(&mut self, param: u16) {
3169 let (shape, blink) = match param {
3170 0 => (None, false),
3171 1 => (Some(CursorShape::Block), true),
3172 2 => (Some(CursorShape::Block), false),
3173 3 => (Some(CursorShape::Underline), true),
3174 4 => (Some(CursorShape::Underline), false),
3175 5 => (Some(CursorShape::Bar), true),
3176 6 => (Some(CursorShape::Bar), false),
3177 _ => return,
3178 };
3179 self.cursor.shape = shape;
3180 self.cursor.blink = blink;
3181 }
3182
3183 /// Backspace (BS, 0x08): one step back.
3184 fn backspace(&mut self) {
3185 self.step_back();
3186 }
3187
3188 /// One step back, shared by `BS` and by `CSI D` (#873).
3189 ///
3190 /// **Both verbs take this step, and that is the decision rather than a convenience.**
3191 /// xterm reaches one `CursorBack` from `CASE_BS` (`charproc.c:3703`) and `CASE_CUB`
3192 /// (`:3933`) alike; ghostty's `backspace` is `cursorLeft(1)` (`Terminal.zig:1696`).
3193 /// xterm.js is the one reference that separates them, and does so **on purpose** —
3194 /// *"Our implementation deviates from xterm on purpose"*, one of whose four bullets is
3195 /// *"any cursor movement sequence keeps working as expected"* (`InputHandler.ts:810-818`).
3196 /// The tie was broken for xterm by ADR-0004 and by `XTREVWRAP` being xterm's own
3197 /// invention (`ctlseqs.txt:952`), with no DEC text above it to appeal to. Maintainer's
3198 /// call, 2026-09-08, and theirs to reverse; the tally and the reach measurement behind
3199 /// it are on `tests/reverse_wrap.rs::cursor_left_spends_a_park`.
3200 ///
3201 /// With reverse wraparound (?45) a step at column 0 of a *soft-wrapped* row moves back
3202 /// to the last column of the previous row — undoing one autowrap. Only soft wraps
3203 /// reverse (the previous row carries `WRAPLINE`), and that is xterm's rule too rather
3204 /// than an xterm.js import: its walk gives up on `!LineTstWrapped(ld)` (`cursor.c:178`).
3205 /// A hard CR/LF line does not reverse.
3206 fn step_back(&mut self) {
3207 // A parked cursor is logically one past the column it sits on, so under `?45`
3208 // the first step back lands *on* that column — which is where it already is.
3209 // The park is therefore **spent** as the first unit of the move rather than
3210 // cleared alongside it: clearing and decrementing discards the logical `+1` and
3211 // collapses the parked and unparked states onto the same landing (#80).
3212 //
3213 // **The gate needs autowrap as well as the mode**, and reading only the
3214 // conditional at xterm's spend site says otherwise — which is how a first
3215 // version of this got it backwards. `cursor.c:153` reads
3216 // `if ((rev || rev2) && screen->do_wrap) { --count; } else { --col; }`, but
3217 // `rev` is not the mode flag: `:123-127` define
3218 // `WRAP_MASK (REVERSEWRAP | WRAPAROUND)` and `rev = ((flags & WRAP_MASK) ==
3219 // WRAP_MASK)`, so `rev` means *`?45` **and** `?7h`* and the whole branch is dead
3220 // under `?7l`. ghostty gates the same way and earlier —
3221 // `if (!self.modes.get(.wraparound)) break :wrap_mode .none;`
3222 // (`Terminal.zig:1756`), returning through the plain decrement at `:1766-1769`
3223 // before it can reach the spend at `:1774`. xterm.js never reaches the state at
3224 // all, since its `?7l` print pins `x = cols - 1` (`InputHandler.ts:612`). So a
3225 // park taken under `?7l` is **spent by moving**, 3-0, and the park #869 arms
3226 // there is not this rule's to consume.
3227 if self.reverse_wraparound && self.autowrap && self.cursor.pending_wrap {
3228 self.cursor.pending_wrap = false;
3229 return;
3230 }
3231 self.cursor.pending_wrap = false;
3232 if self.cursor.col > 0 {
3233 self.cursor.col -= 1;
3234 return;
3235 }
3236 // **The walk needs autowrap too, and for the same reason the spend does.** xterm
3237 // reaches both arms through one `rev`, so `:165` is as dead under `?7l` as `:153`
3238 // is, and ghostty returns through the plain decrement at `:1766-1769` before it
3239 // can reach either. This engine gated only the spend, so `?45h` + `?7l` walked a
3240 // row where both references clamp — found while sharing this step with `CSI D`.
3241 if self.reverse_wraparound
3242 && self.autowrap
3243 && self.cursor.row > self.scroll_top
3244 && self.cursor.row <= self.scroll_bottom
3245 {
3246 let prev = self.cursor.row - 1;
3247 let last = self.grid.cols() - 1;
3248 if self.grid.row_ref(prev).is_wrapped() {
3249 // **The wrap link survives the walk.** Undoing the *cursor's* trip across
3250 // the boundary does not undo the boundary: the rows still hold one logical
3251 // line, and every public reader of that — logical lines, link detection,
3252 // command extraction, reflow — asks this flag. Clearing it (xterm.js's
3253 // `line.isWrapped = false`) made two buffers with identical visible content
3254 // answer differently depending on how the cursor got there, and a resize
3255 // kept them apart. xterm writes no wrap flag anywhere in `CursorBack`;
3256 // ghostty only *reads* `prev_row.wrap` (`Terminal.zig:1842-1843`).
3257 self.cursor.row = prev;
3258 self.cursor.col = last;
3259 }
3260 }
3261 }
3262
3263 /// Auto-wrap at end of line: line-feed then return to column 0.
3264 fn wrapline(&mut self) {
3265 self.linefeed_inner(true);
3266 self.cursor.col = 0;
3267 self.cursor.pending_wrap = false;
3268 }
3269
3270 // ---- tab stops (HT / HTS / TBC) ------------------------------------------
3271
3272 /// HT: advance to the next set tab stop, or the last column if none remain
3273 /// (no wrap).
3274 ///
3275 /// **The deferred wrap is cleared only when the walk actually moves** — see
3276 /// [`Cursor::pending_wrap`], which owns the rule. At the last column there is
3277 /// no stop to the right, so this verb changes nothing and must leave the flag
3278 /// armed; clearing it there discarded the parked position and let the next
3279 /// print overwrite the character already in that column (#848).
3280 ///
3281 /// Three of the four references keep it here, by three different mechanisms:
3282 /// xterm's `TabToNextStop` clamps to `LineMaxCol` and never touches `do_wrap`
3283 /// (`tabs.c:142-158`; the one `ResetWrap` on this path is in `TabNext`, gated
3284 /// on the `curses` resource at `tabs.c:113`, off by default), ghostty's loop
3285 /// condition `cursor.x < scrolling_region.right` is already false
3286 /// (`Terminal.zig:2111`), and xterm.js returns early on `x >= cols` because
3287 /// that *is* its parked state (`InputHandler.ts:850`). alacritty is the
3288 /// outlier and consumes the wrap instead (`term/mod.rs:1366`); it preserves
3289 /// the character too, and differs only on which row the next one lands in.
3290 fn put_tab(&mut self) {
3291 let cols = self.grid.cols();
3292 let mut col = self.cursor.col;
3293 while col + 1 < cols {
3294 col += 1;
3295 if self.tabs[col] {
3296 break;
3297 }
3298 }
3299 if col != self.cursor.col {
3300 self.cursor.col = col;
3301 self.cursor.pending_wrap = false;
3302 }
3303 }
3304
3305 /// CHT (CSI Ps I): [`Term::put_tab`] repeated `n` times, stopping at the first
3306 /// one that does not move — so the deferred-wrap rule is `put_tab`'s, and the
3307 /// work is bounded by the row rather than by the parameter (#898). The break
3308 /// is defensive only: a `put_tab` that did not move will not move on a repeat,
3309 /// so removing it changes no outcome and no test can redden it.
3310 fn put_forward_tabs(&mut self, n: usize) {
3311 for _ in 0..n {
3312 let col = self.cursor.col;
3313 self.put_tab();
3314 if self.cursor.col == col {
3315 break;
3316 }
3317 }
3318 }
3319
3320 /// CBT (CSI Ps Z): step back `n` tab stops, or to column one if fewer
3321 /// remain.
3322 ///
3323 /// The mirror of [`Term::put_tab`] over the *same* table, walked in the
3324 /// other direction. Writing it as a mirror rather than as arithmetic is
3325 /// what keeps the two from drifting: an application that moved a stop with
3326 /// HTS has moved it for both directions, and a modulo here would disagree
3327 /// with the forward walk the moment it did.
3328 ///
3329 /// The count repeats the walk — `n` stops, not one stop `n` columns away —
3330 /// which is what makes a multi-field jump land correctly when the stops are
3331 /// unevenly spaced.
3332 ///
3333 /// Backward tabulation is defined *within the line*: it clamps at column
3334 /// one and never wraps to the row above, which would make it a
3335 /// cursor-relocating operation across rows and give it interactions with
3336 /// the wrap state it should not have. The outer loop breaks at column zero
3337 /// for that reason and for a second one — it bounds the work by the grid
3338 /// rather than by the parameter, so a hostile `CSI 65535 Z` costs one walk
3339 /// of the row. That second reason is **defensive only**: `vte` saturates a
3340 /// parameter at `u16::MAX`, so the unbounded form would cost 65535 no-op
3341 /// iterations, and no test can redden the guard.
3342 ///
3343 /// The **count** converges 4/4 — every reference repeats the *walk* rather
3344 /// than computing a column: alacritty `term/mod.rs:1571-1585` @ `852e971`,
3345 /// ghostty `stream_terminal.zig:593-599` + `Terminal.zig:2124-2136` @
3346 /// `e6e26e1`, xterm `charproc.c:3745-3752` + `tabs.c:131-180` @ `6380a3e`,
3347 /// xterm.js `InputHandler.ts:1141-1151` + `Buffer.ts:599-603` @ `699f553`.
3348 ///
3349 /// The **clamp is 3/4**, and the outlier is alacritty — the one whose loop
3350 /// shape this most resembles, which is why the resemblance is worth
3351 /// distrusting. It seeds `col` with the cursor's current column and
3352 /// overwrites it only inside `if self.tabs[i]` (`term/mod.rs:1578-1583`),
3353 /// so with **no stop to the left it writes the cursor back unchanged** — a
3354 /// no-op where the walk below runs to column zero. Reachable after
3355 /// `CSI 3 g`, since clearing all stops clears column zero too in both
3356 /// engines. xterm (`TabPrev` returns 0), ghostty (returns at
3357 /// `x <= left_limit`) and xterm.js (`x < 0 ? 0 : x`) all clamp, and
3358 /// `back_tab_with_no_stops_lands_at_column_one` is the test that pins which
3359 /// side justerm is on.
3360 ///
3361 /// **Clearing the deferred wrap diverges from all four, deliberately.**
3362 /// None of them clears it here: alacritty's `move_backward_tabs` writes no
3363 /// `input_needs_wrap` though its own CUB does (`term/mod.rs:1253`);
3364 /// ghostty's `horizontalTabBack` calls the *screen*-level `cursorLeft`,
3365 /// which does not touch `pending_wrap`, where its terminal-level one does
3366 /// (`Terminal.zig:1768`); xterm's `TabToPrevStop` has no `ResetWrap` at all
3367 /// — the only one in `tabs.c` is in the *forward* walk and is gated on the
3368 /// `curses` resource (`tabs.c:113`), off by default; and xterm.js has no
3369 /// flag, representing the state as `x == cols` and returning early on it,
3370 /// so its CBT from the right margin moves *nothing*.
3371 ///
3372 /// ADR-0004's spec-first rule has nothing to award here, and the reason is
3373 /// stronger than "the spec is quiet". `ctlseqs.txt:755` is one line, but
3374 /// that file is xterm's documentation *of xterm* rather than the normative
3375 /// text; CBT's normative home is ECMA-48, which no pinned tree carries. The
3376 /// argument that does not depend on a document nobody here can open: the
3377 /// deferred wrap is an **implementation device** for "the cursor is parked
3378 /// at the last column", not an ECMA-48 concept, so no version of that spec
3379 /// can rule on it in principle.
3380 ///
3381 /// So the grounds are this engine's own coherence: **every horizontal-positioning
3382 /// verb here clears the flag** — `move_forward`, `move_back`, `set_col`,
3383 /// `set_row`, `goto`, `move_up`, `move_down`, `backspace`,
3384 /// `carriage_return`, `put_tab` — so a back-tab that did not would be the
3385 /// sole exception. Leaving it armed also reproduces the very bug #826
3386 /// exists to fix, from the other side: the next character would land on the
3387 /// *following row* rather than in the column the back-tab chose.
3388 ///
3389 /// The unanimity is over that population and not over every writer of
3390 /// `cursor.col`. `linefeed_inner` and `reverse_index` do **not** clear it,
3391 /// which is a separate and unsettled question — justerm is the outlier 3-1
3392 /// there — and deliberately outside this change. `put_tab` is in that
3393 /// population only where it moves: at the right edge of a full row it finds
3394 /// no stop and leaves the flag armed (#848), which is the same rule — clear
3395 /// where the verb moves the cursor — and CBT always moves. See
3396 /// `docs/agents/reference-facts.md`.
3397 ///
3398 /// **What the divergence actually costs, stated as behaviour rather than as
3399 /// a flag.** On a full row, `CSI Z` then a print puts the character where
3400 /// the back-tab landed; every reference puts it on the *following row*,
3401 /// having in effect discarded the back-tab. Pinned by
3402 /// `back_tab_on_a_full_row_prints_where_it_landed_not_on_the_next_row`.
3403 ///
3404 /// **Cleared concern, with its validity condition.** xterm and ghostty
3405 /// clamp a back-tab to the **left margin** under origin mode
3406 /// (`tabs.c:171-175`; `Terminal.zig:2126`), not to column zero. That is
3407 /// inert here only because this engine implements no DECSLRM, so both
3408 /// reduce to zero. **If DECSLRM ever lands, this function is a site**, and
3409 /// nothing else in the tree points at it.
3410 fn put_back_tab(&mut self, n: usize) {
3411 let mut col = self.cursor.col;
3412 for _ in 0..n {
3413 if col == 0 {
3414 break;
3415 }
3416 while col > 0 {
3417 col -= 1;
3418 if self.tabs[col] {
3419 break;
3420 }
3421 }
3422 }
3423 self.cursor.col = col;
3424 self.cursor.pending_wrap = false;
3425 }
3426
3427 /// HTS (ESC H): set a tab stop at the cursor column.
3428 fn set_tab_stop(&mut self) {
3429 let col = self.cursor.col;
3430 self.tabs[col] = true;
3431 }
3432
3433 /// TBC (CSI g): clear the tab stop at the cursor (mode 0) or all stops
3434 /// (mode 3).
3435 fn clear_tab_stop(&mut self, mode: u16) {
3436 match mode {
3437 0 => {
3438 let col = self.cursor.col;
3439 self.tabs[col] = false;
3440 }
3441 3 => self.tabs.iter_mut().for_each(|t| *t = false),
3442 _ => {}
3443 }
3444 }
3445
3446 // ---- printing ------------------------------------------------------------
3447
3448 /// The extended attributes the pen currently stamps onto a cell it writes: the open OSC 8
3449 /// hyperlink (#26/#46) and a non-default underline colour (SGR 58, #520).
3450 ///
3451 /// The colour is gated on the UNDERLINE attribute — an underline colour is meaningless on a
3452 /// cell that draws no underline, and xterm likewise does not persist it there
3453 /// (`AttributeData isEmpty()` ignores the colour; `InputHandler.test.ts:2084`). That keeps
3454 /// it off the wire for cells that never draw it (ADR-0020: no inert per-cell payload). SGR 58
3455 /// is the *underline* colour, so STRIKETHROUGH alone does not arm it.
3456 ///
3457 /// One place, because three sites take their extended attrs from the PEN — the glyph, its wide
3458 /// spacer, and the vacated wrap column — mirroring the pen half of `Row::ext_attrs_at`, so a
3459 /// later rider is added here rather than at each of them (#521/#528).
3460 ///
3461 /// **Five sites build a cell from the pen, not three, and the other two deliberately do not
3462 /// come here**: `promote_cluster_to_wide` and `relocate_cluster_wide` synthesise a pair's
3463 /// spacer, whose attrs are the LEAD's rather than the pen's (ADR-0025 D4), so they read
3464 /// `Row::ext_attrs_at` and the lead's underline style directly. Counting them in is how a
3465 /// rider gets added here and silently misses them — which is exactly what #829's underline
3466 /// style did until a refuting pass measured it.
3467 fn pen_ext_attrs(&self) -> ExtAttrs {
3468 let ucolor = self.cursor.pen.underline_color;
3469 let armed =
3470 ucolor != Color::Default && self.cursor.pen.flags.contains(CellFlags::UNDERLINE);
3471 ExtAttrs::from_pen(self.current_link.clone(), armed.then_some(ucolor))
3472 }
3473
3474 /// Free a cell that has stopped being part of a glyph — the *structural repair* every
3475 /// overwrite, erase and row-shift owes the no-orphan invariant when it destroys one half of
3476 /// a width-2 glyph, plus the spacer a mode-2027 demotion no longer needs.
3477 ///
3478 /// This is **not** an erase. The app asked for something at a *different* column; freeing
3479 /// this one is the engine keeping its own invariant. But it is still a mutation, so it
3480 /// **damages** — and that is the half every site used to forget, because each function
3481 /// damaged its own range and the repaired cell lies outside it by construction (that is what
3482 /// makes it a repair). A frame-mode consumer therefore kept painting the destroyed glyph.
3483 /// Bundling the reset with its damage is the point of this helper: a repair site added later
3484 /// cannot forget the half that has no compiler behind it (#530).
3485 ///
3486 /// The cell it leaves is a **blank carrying the current background** — the same rule
3487 /// `clear_cells` already applies to a BCE erase, extended to the repair, so one sentence
3488 /// covers both: *a blank cell carries the current background.* A bare `Cell::default()`
3489 /// would punch an uncoloured notch into a coloured run, which no reference implementation
3490 /// does.
3491 ///
3492 /// Deliberately the pen's **background only** — not its full attributes, and this is not a
3493 /// compromise between references: it is byte-for-byte xterm.js's `_eraseAttrData()`
3494 /// (`DEFAULT_ATTR_DATA` + `curAttr.bg & ~0xFC000000`, i.e. default everything plus the pen's
3495 /// background colour), which is what its `replaceCells` / `insertCells` / `deleteCells`
3496 /// repairs are handed — eight of the twelve sites here. Only xterm's *print* path uses the
3497 /// whole pen. Taking the whole pen
3498 /// (xterm.js `setCellFromCodepoint(x, 0, 1, curAttr)`) would plant the pen's hyperlink and,
3499 /// worse, its DECSCA protection onto a cell the app never wrote — a cell no later erase could
3500 /// clear. Taking the *cell's own* attributes (alacritty `clear_wide`, which keeps `extra`)
3501 /// would leave the destroyed glyph's hyperlink alive and clickable, the defect #529 is filed
3502 /// against. Both were considered and rejected; the maintainer chose this on 2026-07-24 and it
3503 /// is theirs to reverse (see #530 for what they were shown).
3504 ///
3505 /// What used to be recorded here as a known limitation is **resolved** (#538, ADR-0025 D1):
3506 /// `reset()` still clears the whole content word, but the soft-wrap link is no longer part of
3507 /// it. The live flag is on the `Row`, so freeing the last column — here or on the erase path —
3508 /// cannot break a wrap; `CellFlags::WRAPLINE` is wire-only, derived onto the last cell at
3509 /// encode time and never read back (`cell.rs`). Ending a wrap is now an explicit per-verb call
3510 /// (`end_wrap`), which is the shape both references already had and the reason the move was
3511 /// made: ghostty and xterm.js hold the flag on the row/line, and xterm.js takes `clearWrap` as
3512 /// an explicit argument on its erase helper (`_eraseInBufferLine`, `InputHandler.ts:1175`)
3513 /// rather than letting a cell clear decide it.
3514 ///
3515 /// Known cost, accepted rather than overlooked: with DECSCA the freed cell loses its
3516 /// protection. ghostty has the same hole and flags it in its own source; justerm does not
3517 /// implement DECSCA today, so revisit if it lands.
3518 fn free_cell(&mut self, row: usize, col: usize) {
3519 let bg = self.cursor.pen.bg;
3520 let cell = self.grid.cell_mut(row, col);
3521 cell.reset();
3522 cell.set_bg(bg);
3523 // As in `clear_cells`: the bits are gone, so release what they gated (#628).
3524 self.grid.row_mut(row).purge_side_maps(col..col + 1);
3525 self.damage_span(row, col, col);
3526 }
3527
3528 /// Will the next `wrapline()` actually reach another row?
3529 ///
3530 /// `wrapline` → `linefeed` advances in exactly two cases: the cursor sits at the scroll
3531 /// region's bottom (so the region scrolls under it), or it has a row below it on screen.
3532 /// Parked *below* a DECSTBM region on the last row it does neither — it silently stays put.
3533 ///
3534 /// Both wide-at-boundary paths must ask before they commit anything, because both destroy
3535 /// content on the assumption that the row is about to change: `write_glyph` blanks the column
3536 /// it is leaving, and `relocate_cluster_wide` writes its cluster to `(cursor.row, 0..=1)`
3537 /// *after* the wrap — which is the same row when nothing advanced, so it lands on live cells.
3538 /// Reasoning only about the vacated source column misses that second case entirely.
3539 ///
3540 /// This mirrors `linefeed`'s own condition; the two must be read together.
3541 fn wrapline_advances(&self) -> bool {
3542 self.cursor.row == self.scroll_bottom || self.cursor.row + 1 < self.grid.rows()
3543 }
3544
3545 /// Blank the last column as the soft-wrap artefact it is, when a width-2 glyph could not fit
3546 /// there (#528). Shared by the two paths that reach this state: `write_glyph`'s wide-at-boundary
3547 /// wrap and `relocate_cluster_wide`'s promoted cluster.
3548 ///
3549 /// The column is **written**, not merely flagged: a blank built from the current pen, exactly
3550 /// as every reference does it — xterm.js `setCellFromCodepoint(col, 0, 1, curAttr)`
3551 /// (`InputHandler.ts:609-611`; `BufferLine.ts:244-251` takes the pen's fg/bg *and* its
3552 /// `extended` link/colour), ghostty `printCell(0, .spacer_head)` (`Terminal.zig:1410-1412`,
3553 /// whose `printCell` stamps the cursor's hyperlink), alacritty `write_at_cursor(' ')` under a
3554 /// `LEADING_WIDE_CHAR_SPACER` template (`mod.rs:1108-1113`, assigning `extra` from it).
3555 ///
3556 /// Flagging in place instead left the previous occupant's glyph, hyperlink and underline colour
3557 /// alive in a cell every text reader skips — so a renderer drew a character that could not be
3558 /// copied, searched or announced (#528). Building from `Pen::cell` also clears the presence
3559 /// bits, so no stale side-map entry can be read back through the new cell.
3560 ///
3561 /// WRAPLINE marks the row a continuation rather than a hard line-end (search, logical lines
3562 /// #113 and reflow #7 all read it); the leading-spacer marker makes the text extractors skip
3563 /// the blank instead of joining `"ab한"` → `"ab 한"`.
3564 ///
3565 /// The marker is **alacritty's** `LEADING_WIDE_CHAR_SPACER` (`term/cell.rs`) — ghostty calls
3566 /// the same thing `.spacer_head`. It is *not* xterm's: xterm.js has no marker at all, writing
3567 /// a bare null cell and re-inferring the artefact at reflow time from "ends in null and the
3568 /// following line starts with a wide char". That difference has a consequence here — in
3569 /// xterm.js a lost marker degrades to an empty cell that trimming drops anyway, whereas
3570 /// justerm writes `' '`, so the marker is the *only* thing keeping this column out of the
3571 /// extracted text.
3572 fn vacate_for_wrap(&mut self, row: usize, col: usize) {
3573 // Writing this column makes the vacate an overwrite like any other, so it inherits the
3574 // no-orphan obligation every other overwrite site carries (`write_glyph`,
3575 // `promote_cluster_to_wide`, `insert_chars`, `delete_chars`, the erase path): if the
3576 // column was the *spacer* of a wide glyph, blanking it destroys the spacer marker and
3577 // strands the lead. That is unrecoverable rather than merely untidy — every repair path
3578 // keys off `is_wide_spacer()`, so once the marker is gone no later write, ECH, EL, ICH
3579 // or DCH can ever clear the orphan.
3580 if col > 0 && self.grid.cell(row, col).is_wide_spacer() {
3581 self.free_cell(row, col - 1);
3582 }
3583 let mut vacated = self.cursor.pen.cell(' ');
3584 vacated.set_leading_spacer();
3585 *self.grid.cell_mut(row, col) = vacated;
3586 self.begin_wrap(row);
3587 let ext = self.pen_ext_attrs();
3588 self.grid.row_mut(row).set_ext_attrs(col, ext);
3589 // The cell's contents changed, so a frame-mode consumer must be told or it keeps painting
3590 // the old glyph (ADR-0003: every mutation site records damage). The *repaired* lead above
3591 // is damaged by `free_cell`, which owns that pairing for all twelve repair sites — this
3592 // site used to hand-roll it, and keeping both left neither able to discriminate.
3593 self.damage_span(row, col, col);
3594 }
3595
3596 /// Place one already-charset-translated scalar: join it to the previous cluster
3597 /// under mode 2027, attach it as a combining mark, or write it as a new glyph.
3598 ///
3599 /// Split out of `print` so `REP` can re-enter the print path *below* two things it
3600 /// must not repeat (#825): the VT52 `ESC Y` coordinate intercept, and the GL
3601 /// character-set translation — `REP` reads its grapheme back off a cell, which
3602 /// holds the *translated* glyph, so passing it through `print` would map it twice.
3603 /// Neither is observable today (the intercept is unreachable because `ESC Y`
3604 /// disarms the repeat, and no glyph either implemented set produces is a key in
3605 /// its own table), so this is insurance, and its condition is worth stating: it
3606 /// stops being insurance the moment a set is added whose output overlaps its
3607 /// input.
3608 ///
3609 /// The three arms that place content are exactly the sites that arm
3610 /// [`Term::repeat_anchor`]. xterm reaches the same set from the other end — it arms
3611 /// on every printed scalar and then rejects the zero-width ones with a guard at
3612 /// `REP` (`charproc.c:6154`) — and the two are equivalent because the only scalars
3613 /// that reach here with no width are unreachable in the first place.
3614 fn place_grapheme(&mut self, c: char) {
3615 // Grapheme-cluster mode (DEC ?2027, #295): if `c` extends the previous cell's cluster,
3616 // join it there instead of placing a new cell. OFF → the per-char (wcwidth) path below.
3617 if self.grapheme_clustering
3618 && let Some(at) = self.try_grapheme_join(c)
3619 {
3620 self.repeat_anchor = Some(at);
3621 return;
3622 }
3623 match c.width() {
3624 // Zero-width (combining marks): a zero-width code point is a combining
3625 // mark — attach it to the previous base glyph rather than dropping it.
3626 Some(0) => self.repeat_anchor = Some(self.push_combining(c)),
3627 // Reachable, and the only scalar that reaches it: `vte` sends C0 and the
3628 // 8-bit C1 range to `execute`, but `ground_dispatch` matches only
3629 // `'\x00'..='\x1f' | '\u{80}'..='\u{9f}'` there (`vte-0.15.0/src/lib.rs:722`),
3630 // so `DEL` (0x7F) arrives here and `'\u{7f}'.width()` is `None`. It writes no
3631 // cell, so it clears the anchor — which is xterm's answer too, reached by its
3632 // own route (`lastchar` is set only by CASE_PRINT, and REP guards on positive
3633 // width, `charproc.c:6154`). An earlier version of this claimed the arm was
3634 // unreachable, citing a `0x7F => ()` line that belongs to `CsiIgnore`.
3635 None => self.repeat_anchor = None,
3636 // Coerced to a pair, because a pair is the only multi-column shape the cell model
3637 // has (`WIDE_CHAR` + exactly one `WIDE_CHAR_SPACER`) — see ADR-0025, which states
3638 // every clause over "a pair" and never over a wider run. `unicode-width` genuinely
3639 // returns 3 for at least one codepoint (U+17D8 KHMER SIGN BEYYAL, a ligature drawn
3640 // as three characters), and that value is not wrong — it is unrepresentable here.
3641 //
3642 // Left uncoerced, the width fell through *every* wide branch in `write_glyph`
3643 // (each gated on `width == 2`) while still driving the cursor advance, so the glyph
3644 // landed as a lone narrow cell followed by columns that no flag distinguished from
3645 // real blanks: search could not find the text on screen and word selection split
3646 // the run, handing the clipboard a space the buffer never held (#595).
3647 //
3648 // All three references bound it, and ghostty says why in the same words —
3649 // `unicode/props.zig:11-13`, *"We clamp to [0, 2] … i.e. 3-em dash becomes a 2-em
3650 // dash"*. Clamping *here* rather than inside `write_glyph` keeps the two jobs apart:
3651 // this is the policy for an out-of-range external value, and the invariant it
3652 // establishes is asserted at the site that depends on it.
3653 Some(width) => self.repeat_anchor = self.write_glyph(c, width.min(2)),
3654 }
3655 }
3656
3657 /// Write one glyph at the cursor, handling deferred wrap and the wide-char
3658 /// spacer, then advance the cursor (deferring the wrap if it hits the edge).
3659 /// Returns where the glyph landed — `(row, col)` of its lead cell — or `None` on
3660 /// the one path that writes nothing: a width-2 glyph that cannot fit the last column
3661 /// with autowrap off is dropped. [`Term::repeat_anchor`] is set from this, so a
3662 /// print that placed no cell must not arm the repeat.
3663 fn write_glyph(&mut self, c: char, width: usize) -> Option<(usize, usize)> {
3664 // Every wide branch below is gated on `width == 2`, and the four unguarded uses
3665 // (`insert_chars`, `col + width - 1` twice, the cursor advance) assume the same bound.
3666 // The caller coerces (#595); this states the assumption at the site that holds it, so a
3667 // future second caller fails a test rather than writing an unmarked run of blanks.
3668 // Ghostty pairs its own source-side clamp with the same assertion for the same reason
3669 // (`Terminal.zig`, *"it is possible to have a width of 3 … assert(width <= 2)"*).
3670 debug_assert!(
3671 width <= 2,
3672 "write_glyph({c:?}, {width}) — the cell model represents at most a pair"
3673 );
3674 let cols = self.grid.cols();
3675
3676 // Resolve a deferred last-column wrap before placing the next glyph.
3677 // The row being left soft-wrapped: mark its last cell so reflow (#7) can
3678 // tell it from a hard CR/LF line-end.
3679 if self.cursor.pending_wrap && !self.autowrap {
3680 // **This is where DECAWM is tested, and since #869 it is the only place.**
3681 // The arm is unconditional, so under `?7l` every row-filling print leaves a
3682 // park and this guard is what spends it in place instead of wrapping — not
3683 // the narrow "the mode was turned off after the flag was armed" repair it
3684 // began as. Deleting it does not merely regress an edge case; it wraps with
3685 // autowrap disabled. `decawm.rs::autowrap_off_overwrites_the_last_column` is
3686 // the guard on the guard.
3687 //
3688 // **All four references print in place here**: xterm clears `do_wrap` and
3689 // only then asks `WRAPAROUND` (`charproc.c:7059-7061`), xterm.js un-parks
3690 // with `x = cols - 1` in the else arm of its `wraparoundMode` branch
3691 // (`InputHandler.ts:612`), ghostty gates the whole consume
3692 // (`Terminal.zig:1368`) and alacritty's `wrapline` early-returns on
3693 // `!LINE_WRAP` (`term/mod.rs:962`). What they differ on is whether the flag
3694 // is left standing afterwards, and that is a separate axis — see
3695 // `docs/agents/reference-facts.md`, where #848's "2-2" is corrected as a
3696 // sampling artefact rather than a real split.
3697 //
3698 // Pre-existing, and #848 widened it: until that change `put_tab` cleared
3699 // the flag, so `abc` + `?7l` + `HT` + `X` printed in place by accident.
3700 self.cursor.pending_wrap = false;
3701 }
3702 if self.cursor.pending_wrap {
3703 let row = self.cursor.row;
3704 // Claim the wrap only if there will *be* a next row to continue into. Parked below a
3705 // DECSTBM region on the last row, `wrapline` → `linefeed` advances nothing and the
3706 // glyph overwrites this same row from column 0 — so the wrap never happened, and a
3707 // flag set here is permanently false: the cursor never leaves, nothing clears it, and
3708 // it survives into `backspace`'s reverse-wraparound, reflow, and every text reader.
3709 //
3710 // The predicate is not new and neither is its rationale: `wrapline_advances` was
3711 // written for exactly this state and is already asked by both wide-at-boundary paths.
3712 // This narrow path was the one caller that committed without asking. (Surfaced by the
3713 // #540 completeness pass, which found a row-shift verb inheriting the bogus flag and
3714 // merging two unrelated logical lines.)
3715 if self.wrapline_advances() {
3716 self.begin_wrap(row);
3717 }
3718 self.wrapline();
3719 }
3720
3721 // A width-2 glyph that cannot fit in the last column wraps first — unless
3722 // autowrap is off, in which case it is dropped (xterm.js `continue`), not
3723 // squeezed or wrapped.
3724 if width == 2 && self.cursor.col + 1 >= cols {
3725 if !self.autowrap {
3726 return None; // dropped: nothing written, so nothing to repeat
3727 }
3728 // …but only if the wrap actually happens: vacating for a wrap that never occurs
3729 // blanks a column holding a live glyph.
3730 if self.wrapline_advances() {
3731 self.vacate_for_wrap(self.cursor.row, cols - 1);
3732 }
3733 self.wrapline();
3734 }
3735
3736 // Insert mode (IRM): open a `width`-wide gap at the cursor first, shifting
3737 // the row's tail right (off-edge cells discarded, wide halves repaired),
3738 // then write into the gap — mirrors xterm.js's insertCells (#64).
3739 if self.insert_mode {
3740 self.insert_chars(width);
3741 }
3742
3743 let (row, col) = (self.cursor.row, self.cursor.col);
3744
3745 // Overwriting either half of a pair that wrapped from the row above ends that pair, so the
3746 // row above's artefact record is void (#534). The one exception is the in-place same-width
3747 // overwrite — a wide lead replaced by another wide lead at the same column — which is
3748 // ghostty's `if (cell.wide != wide)` escape and the reason this is asked *before* the
3749 // write rather than after it. Note IRM has already run its own check inside `insert_chars`
3750 // by the time this would fire, on the pre-shift state, which is the correct one.
3751 if col <= 1 && self.wrapped_pair_at_row_start(row) && !(col == 0 && width == 2) {
3752 self.void_wrap_artefact_above(row);
3753 }
3754
3755 // Overwriting one half of an existing wide glyph orphans the other —
3756 // clear it so no stray lead/spacer is left behind.
3757 let last = col + width - 1;
3758 if col > 0 && self.grid.cell(row, col).is_wide_spacer() {
3759 self.free_cell(row, col - 1);
3760 }
3761 if last + 1 < cols && self.grid.cell(row, last).is_wide() {
3762 self.free_cell(row, last + 1);
3763 }
3764
3765 let mut cell = self.cursor.pen.cell(c);
3766 if width == 2 {
3767 cell.insert_flags(CellFlags::WIDE_CHAR);
3768 }
3769 *self.grid.cell_mut(row, col) = cell;
3770 // Stamp the pen's extended attrs — the open hyperlink (#26/#46) and a non-default
3771 // underline colour (#520) — into the row's side maps.
3772 let ext = self.pen_ext_attrs();
3773 // `.clone()`: `ExtAttrs` stopped being `Copy` at #628 (the link rider is a shared
3774 // `Arc<str>`), and the spacer below stamps the same value — a refcount bump, not
3775 // a second string.
3776 self.grid.row_mut(row).set_ext_attrs(col, ext.clone());
3777
3778 // The trailing column of a wide glyph carries a distinct spacer marker —
3779 // and the same link + underline colour, so a hover/selection/underline over
3780 // either half agrees.
3781 if width == 2 && col + 1 < cols {
3782 let mut spacer = self.cursor.pen.cell(' ');
3783 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
3784 *self.grid.cell_mut(row, col + 1) = spacer;
3785 self.grid.row_mut(row).set_ext_attrs(col + 1, ext);
3786 }
3787
3788 // Record damage for the cell(s) just written.
3789 self.damage_span(row, col, col + width - 1);
3790
3791 // Advance. Reaching/passing the last column sets pending-wrap instead of
3792 // wrapping eagerly — the cursor parks on the last column.
3793 let new_col = col + width;
3794 if new_col >= cols {
3795 self.cursor.col = cols - 1;
3796 // The park is taken whatever the mode says (#869): the cursor is logically
3797 // one past this column either way, and that is the whole of what this flag
3798 // means. With `?7l` the *consume* site above spends the park in place, so
3799 // the next glyph still overwrites the last column (#63) — but if the mode
3800 // is re-enabled before that print, the park is still there and it wraps,
3801 // which is what all four references do.
3802 self.cursor.pending_wrap = true;
3803 } else {
3804 self.cursor.col = new_col;
3805 }
3806 Some((row, col))
3807 }
3808
3809 /// The column, on the cursor's row, of the cluster the cursor last printed into —
3810 /// or `None` when nothing precedes it on this row. Shared by the combining-mark
3811 /// attach point and the mode-2027 join point, which each carried their own copy of
3812 /// it before #825.
3813 ///
3814 /// # Two cases, and why the first one is trustworthy again (#865, #869)
3815 ///
3816 /// **Parked.** [`Cursor::pending_wrap`] says the cursor is logically one past the
3817 /// column it sits on, so the cluster is *at* the cursor — and once left over a
3818 /// `WIDE_CHAR_SPACER` to reach its lead.
3819 ///
3820 /// **This reading was wrong for a whole mode until #869, and the repair is not
3821 /// here.** The flag used to be armed as `pending_wrap = self.autowrap`, so with
3822 /// `?7l` a print that filled the last column pinned the cursor and armed nothing:
3823 /// a pin and a bare *advance onto* that column shared every cursor field, and a
3824 /// mark landed one column too far left. #865 worked around it here by consulting
3825 /// [`Term::repeat_anchor`]; #869 removed the cause instead — the arm is now
3826 /// unconditional and the mode is tested where it is consumed, which is what
3827 /// alacritty (`term/mod.rs:1136`), ghostty (`Terminal.zig:1434`) and xterm
3828 /// (`charproc.c:7152`) all do — that line is the *exact-fill* arm and is
3829 /// unconditional; xterm's *overflow* arm two branches up (`:7145`) is gated on
3830 /// `WRAPAROUND`, and the arm site here is only ever reached by the former. The
3831 /// workaround was then measured dead across the
3832 /// whole core suite, against a positive control that reproduced it under the old
3833 /// arming, and removed.
3834 ///
3835 /// **Not parked.** The cursor is merely *at* a cell, so the cluster is one column
3836 /// left, and once more left over a spacer. This is also the answer after a bare
3837 /// cursor move to the last column, which the four references answer four different
3838 /// ways: xterm attaches under the cursor (`char_was_written` is false after
3839 /// `ResetWrap`, so it falls back to `cur_col`), alacritty and ghostty attach one
3840 /// column left, and xterm.js attaches nowhere — its `precedingJoinState` is zeroed
3841 /// on every escape transition (`EscapeSequenceParser.ts:676`), so `shouldJoin` is
3842 /// false (`UnicodeV6.ts:134`) and the mark becomes its own zero-width cell. This
3843 /// engine keeps the answer it had, which is the plurality's; #865 deliberately did
3844 /// not reopen it, since nothing measured reaches the case.
3845 ///
3846 /// **`REP` still does not use this**, and the reason is on [`Term::repeat_anchor`]:
3847 /// it needs the position a print wrote even where the cursor has since moved, which
3848 /// is a different question from the one asked here.
3849 fn cursor_cluster_col(&self) -> Option<usize> {
3850 let row = self.cursor.row;
3851 // The pinned case. The wide arm is the same cell reached from its spacer: a
3852 // pair that fills the row leaves the cursor on the trailing spacer, one past
3853 // the anchored lead.
3854 let col = if self.cursor.pending_wrap {
3855 self.cursor.col
3856 } else if self.cursor.col == 0 {
3857 return None;
3858 } else {
3859 self.cursor.col - 1
3860 };
3861 Some(if self.grid.cell(row, col).is_wide_spacer() {
3862 col.saturating_sub(1)
3863 } else {
3864 col
3865 })
3866 }
3867
3868 /// The text the cell at `(row, col)` holds, in print order: its base glyph followed
3869 /// by any combining marks the row's side table carries for it. One grapheme cluster
3870 /// by construction — it is what a single print produced.
3871 ///
3872 /// A `String` and not a `Vec<char>`, because both callers want text: returning scalars
3873 /// and collecting cost a second allocation and measured 2.06x on the join path
3874 /// (11.66 ms -> 24.06 ms over 20k joins, release, best of 7). `REP` iterates
3875 /// `.chars()` instead, which costs it nothing.
3876 ///
3877 /// **It is no longer on the per-scalar path.** Until #867 the mode-2027 join called this for
3878 /// every printed scalar, which is what made a growing cluster quadratic; the join now consults
3879 /// it only when a width can actually change, so this is O(L) once per cluster rather than once
3880 /// per join.
3881 fn cluster_text(&self, row: usize, col: usize) -> String {
3882 let mut out = String::new();
3883 out.push(self.grid.cell(row, col).c());
3884 if let Some(marks) = self.grid.row_ref(row).combining_at(col) {
3885 out.extend(marks.iter().copied());
3886 }
3887 out
3888 }
3889
3890 /// REP (CSI Ps b): repeat the preceding grapheme `count` times (#825). The caller
3891 /// owns the armed check — see the `'b'` arm of `csi_dispatch`, which holds both
3892 /// halves of the ordering this sequence needs.
3893 ///
3894 /// **The repeat re-enters the print path**, which is the load-bearing decision:
3895 /// printing already owns pending-wrap, autowrap, wide-character pairing, cluster
3896 /// promotion under mode 2027, the pen, insert mode and the scroll region, so a
3897 /// cell-fill would have to re-derive every one of them and would drift from typed
3898 /// text the first time any of them changed. ghostty does the same
3899 /// (`src/terminal/Terminal.zig:452-456`), and so does xterm.js.
3900 ///
3901 /// **What is repeated is the cluster at [`Term::repeat_anchor`], read off the cell.**
3902 /// A retained copy would have to be kept in step with the cell by hand at three
3903 /// arming sites and nothing would catch it drifting; the anchor keeps the *position*
3904 /// exact, which is the half a read-back can get wrong.
3905 ///
3906 /// **That the unit is the cluster is a product judgement, not a derivation**, and
3907 /// the three references give three answers. xterm repeats *nothing* after a
3908 /// combining mark — its retained value is a single `IChar`, so the mark replaces
3909 /// the base and the positive-width guard (`charproc.c:6154`) then rejects it.
3910 /// ghostty repeats the base *without* its marks: its cluster-append branch returns
3911 /// before `previous_char = c` (`Terminal.zig:1355-1365`). xterm.js repeats the
3912 /// whole cluster, reading it off the cell (`InputHandler.ts:1649-1671`). ADR-0004
3913 /// makes xterm the tie-breaker for *the spec*, and xterm's answer here follows from
3914 /// a scalar `lastchar` rather than from a reading of it — while a cell in this
3915 /// engine holds a cluster. Decided by the maintainer on 2026-09-07 and theirs to
3916 /// reverse; a better derivation does not settle it.
3917 ///
3918 /// # Two bounds, and only one of them is the load-bearing one
3919 ///
3920 /// The count is untrusted and the repeat is the only place in this engine where one
3921 /// wire parameter buys unbounded work, so it is bounded twice — for different
3922 /// reasons, and the *order of importance is the reverse of the order they read in*.
3923 ///
3924 /// **The progress guard is what actually bounds the pathological case.** An
3925 /// iteration that places no new cell has not repeated anything: under mode 2027 a
3926 /// cluster ending in `ZWJ` re-joins the cluster it was read from, so each replay
3927 /// grows one cell's cluster instead of writing a second one, and `try_grapheme_join`
3928 /// **was** O(L) in that cluster's length. Measured before the guard: `?2027h`,
3929 /// `U+1F468`, `U+200D`, then the eight bytes `CSI 65535 b` cost **593 seconds** —
3930 /// nine minutes and fifty-three seconds of one consumer thread, for eight bytes of
3931 /// PTY output. The guard ends the loop the first time an iteration leaves the anchor
3932 /// where it found it, which is exactly the condition "nothing was repeated".
3933 ///
3934 /// **#867 removed that O(L), and it did not retire this guard.** The join is now
3935 /// constant in the cluster's length, so the amplification that produced 593 seconds
3936 /// no longer exists — but a no-progress iteration is still a no-progress iteration,
3937 /// and without the guard `CSI 65535 b` would still run 65 535 of them to place
3938 /// nothing. The guard bounds pointless work; it never bounded the cost of a join.
3939 ///
3940 /// **The count cap is defence in depth and would not have caught that case**, which
3941 /// is why it is stated second. The cap is a whole buffer's worth of
3942 /// cells, and at the default 10 000-line scrollback that is 801 920 on an 80x24
3943 /// grid — larger than the 65535 a `u16` parameter can carry, so it never binds
3944 /// there. It binds on a small buffer, where a count far past what the buffer can
3945 /// hold only rewrites what the repeat already wrote. Shipping the cap alone would
3946 /// have looked like a fix for the measurement above and been none.
3947 ///
3948 /// Both are divergences from every reference: xterm (`charproc.c:6156`), xterm.js
3949 /// (`InputHandler.ts:1655`) and ghostty (`Terminal.zig:452-456`) all loop uncapped,
3950 /// and alacritty does not implement the sequence. The asymmetry that justifies them
3951 /// is that all three *are* the terminal and own the thread they burn, while this is
3952 /// a library running on a consumer's.
3953 fn repeat_last(&mut self, count: usize) {
3954 let Some((row, col)) = self.repeat_anchor else {
3955 return;
3956 };
3957 // Snapshot once: the repeats move the anchor, so re-reading it per iteration
3958 // would repeat the growing run rather than the grapheme.
3959 let cluster = self.cluster_text(row, col);
3960 let cap = (self.scrollback_limit + self.grid.rows()).saturating_mul(self.grid.cols());
3961 for _ in 0..count.min(cap.max(1)) {
3962 let before = self.repeat_anchor;
3963 for c in cluster.chars() {
3964 self.place_grapheme(c);
3965 }
3966 if self.repeat_anchor == before {
3967 break; // placed no new cell — see "the progress guard" above
3968 }
3969 }
3970 }
3971
3972 /// Attach a combining mark (width-0 code point) to the grapheme it modifies —
3973 /// the cell the cursor just left. With pending-wrap the cursor still sits on
3974 /// the just-written last-column glyph, so attach in place (no back-up, no
3975 /// deferred wrap); otherwise step back one column, and once more over a
3976 /// wide-char spacer to reach its lead. Stored in the grapheme side-table.
3977 fn push_combining(&mut self, c: char) -> (usize, usize) {
3978 let row = self.cursor.row;
3979 // `unwrap_or(0)`: a mark that opens the stream has no base and attaches to
3980 // column 0, which is what the `saturating_sub` here did before #825. The join
3981 // path declines that case instead; the two differ deliberately.
3982 let col = self.cursor_cluster_col().unwrap_or(0);
3983 // Append the mark to the row's combining map at this column (setting the
3984 // cell's combining bit). No global pool — the cluster rides the row.
3985 self.grid.row_mut(row).push_combining(col, c);
3986 self.damage_span(row, col, col);
3987 (row, col)
3988 }
3989
3990 /// Mode 2027 (#295): if `c` **extends** the previous cell's grapheme cluster (UAX #29), append
3991 /// it to that cell's side-table — no new cell, no cursor advance — and return where it joined.
3992 /// Otherwise `None`, so `place_grapheme` takes the per-scalar path (a break starts a cell).
3993 ///
3994 /// The break state lives in the cell rather than being carried across calls, so cursor moves
3995 /// and CR/LF cannot corrupt it — but the cluster is **not** reconstructed to ask the question
3996 /// (#867): [`crate::grapheme::joins_cluster`] reads a bounded tail of the side table, and the
3997 /// width oracle is consulted only when [`crate::grapheme::width_may_change`] says the answer
3998 /// can have moved. Together those make the join O(1) in the cluster's length, where it used to
3999 /// be O(L) three times over.
4000 fn try_grapheme_join(&mut self, c: char) -> Option<(usize, usize)> {
4001 let row = self.cursor.row;
4002 // Locate the previous cluster's base cell; `None` means nothing precedes it on
4003 // this row, so there is nothing to extend.
4004 let Some(col) = self.cursor_cluster_col() else {
4005 return None; // nothing precedes on this row
4006 };
4007 // The cell is read, never rebuilt into a string (#867): both the break question and the
4008 // width question are answered from the base scalar, the side table's length, and — only
4009 // when the width can actually move — the cluster text itself.
4010 let base = self.grid.cell(row, col).c();
4011 let base_is_wide = self.grid.cell(row, col).is_wide();
4012 let (joins, first_join) = {
4013 let marks = self.grid.row_ref(row).combining_at(col).unwrap_or(&[]);
4014 (
4015 crate::grapheme::joins_cluster(base, marks, c),
4016 marks.is_empty(),
4017 )
4018 };
4019 if !joins {
4020 return None;
4021 }
4022 // Width promotion: a flag's second regional indicator, or a text-base + VS16, grows the
4023 // cluster to width 2. `UnicodeWidthStr` over the whole cluster remains the authority for
4024 // that; `width_may_change` only decides whether it has to be asked, so a cluster that
4025 // keeps growing stops paying for an answer that cannot have moved. Read BEFORE the push,
4026 // because `cluster_text` reads the side table this join is about to extend.
4027 let cluster_w = if crate::grapheme::width_may_change(c, first_join, base_is_wide) {
4028 let mut prev = self.cluster_text(row, col);
4029 prev.push(c);
4030 UnicodeWidthStr::width(prev.as_str())
4031 } else if base_is_wide {
4032 2
4033 } else {
4034 1
4035 };
4036 // Join: ride the side-table (no new cell).
4037 self.grid.row_mut(row).push_combining(col, c);
4038 // Where the cluster ends up, which is not always where it was joined: a promotion at
4039 // the last column relocates it to the next row (#303), and the anchor has to follow or
4040 // it names a column `vacate_for_wrap` just blanked.
4041 let mut at = (row, col);
4042 if cluster_w == 2 && !self.grid.cell(row, col).is_wide() {
4043 at = self.promote_cluster_to_wide(row, col);
4044 } else if cluster_w == 1 && self.grid.cell(row, col).is_wide() {
4045 // The mirror case: a default-wide emoji + VS15 (text selector) shrinks to width 1.
4046 self.demote_cluster_to_narrow(row, col);
4047 }
4048 self.damage_span(row, col, col);
4049 Some(at)
4050 }
4051
4052 /// Shrink a wide cluster cell back to a single-width cell (#295): a default-wide emoji joined by
4053 /// VS15 (U+FE0E, the text selector) requests text presentation → width 1. Remove `WIDE_CHAR`,
4054 /// free the spacer, and back the cursor up over it (the inverse of `promote_cluster_to_wide`).
4055 fn demote_cluster_to_narrow(&mut self, row: usize, col: usize) {
4056 let cols = self.grid.cols();
4057 self.grid
4058 .cell_mut(row, col)
4059 .remove_flags(CellFlags::WIDE_CHAR);
4060 if col + 1 < cols {
4061 self.free_cell(row, col + 1); // free the now-unused spacer
4062 }
4063 // The cluster shrank 2→1: the cursor sat just past the wide cell (col+2, or pending-wrap on
4064 // the last column); it now sits just past the single-width cell at col+1.
4065 self.cursor.pending_wrap = false;
4066 self.cursor.col = (col + 1).min(cols - 1);
4067 self.damage_span(row, col, (col + 1).min(cols - 1));
4068 }
4069
4070 /// Widen a narrow base cell to a double-width cluster in place (#295): set `WIDE_CHAR`, write
4071 /// its spacer, and step the cursor over it. Only reached when a joining scalar (flag's 2nd RI,
4072 /// VS16) promotes the cluster to width 2. A base pinned at the last column has no room for a
4073 /// spacer — relocation is a later step; until then it stays narrow (rare, renders single-width).
4074 fn promote_cluster_to_wide(&mut self, row: usize, col: usize) -> (usize, usize) {
4075 let cols = self.grid.cols();
4076 if col + 1 >= cols {
4077 // No spacer room at the last column: relocate the whole cluster to the next line as a
4078 // wide cell (the row soft-wraps), mirroring write_glyph's wide-at-boundary wrap (#303).
4079 return self.relocate_cluster_wide(row, col);
4080 }
4081 // Overwriting col+1 with the spacer can orphan the far half of a WIDE glyph standing there
4082 // (the cursor may have been repositioned before the joining scalar arrived). Reset that
4083 // orphan, exactly as write_glyph does (2462-2470), so no dangling spacer survives.
4084 if self.grid.cell(row, col + 1).is_wide() && col + 2 < cols {
4085 self.free_cell(row, col + 2);
4086 }
4087 self.grid
4088 .cell_mut(row, col)
4089 .insert_flags(CellFlags::WIDE_CHAR);
4090 // The spacer is the lead's second half, so it takes the LEAD's extended attrs — the
4091 // hyperlink and underline colour riding the row's side maps — exactly as write_glyph
4092 // stamps both halves of a wide write. `pen.cell(' ')` carries neither (and the pen may
4093 // have moved on since the base was printed), so they are re-attached here; a base with
4094 // none clears whatever the overwritten column held (#521).
4095 let ext = self.grid.row_ref(row).ext_attrs_at(col);
4096 // The underline STYLE needs the same treatment as those extended attrs and for the same
4097 // reason this comment already gives (#829): it is the LEAD's, and the pen may have moved
4098 // on. It rides the packed cell rather than a side map, so it is carried across directly
4099 // instead of through `set_ext_attrs`. ADR-0025 D4 — a path that *synthesises* one half of
4100 // a pair carries the whole pair; taking this from the pen curls the left half and leaves
4101 // the right half bare.
4102 let lead_style = self.grid.cell(row, col).underline_style();
4103 let mut spacer = self.cursor.pen.cell(' ');
4104 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
4105 spacer.set_underline_style(lead_style);
4106 *self.grid.cell_mut(row, col + 1) = spacer;
4107 self.grid.row_mut(row).set_ext_attrs(col + 1, ext);
4108 // The cursor sat at col+1 (just past the narrow base); move it over the new spacer, applying
4109 // the same last-column pending-wrap rule as a wide write.
4110 let new_col = col + 2;
4111 if new_col >= cols {
4112 self.cursor.col = cols - 1;
4113 self.cursor.pending_wrap = true;
4114 } else {
4115 self.cursor.col = new_col;
4116 }
4117 self.damage_span(row, col, col + 1);
4118 // Promoted in place: the lead did not move.
4119 (row, col)
4120 }
4121
4122 /// Relocate a last-column narrow cluster to the next line as a wide cell (#303): its base +
4123 /// side-table marks move to `(next_row, 0..=1)` and the vacated last column becomes a soft-wrap
4124 /// (WRAPLINE + leading spacer), exactly as `write_glyph` wraps a wide glyph that can't fit. With
4125 /// autowrap off it stays narrow.
4126 ///
4127 /// The destination is an **overwrite**, so it owes the no-orphan repair every other overwrite
4128 /// site owes (#529, ADR-0025 D4) — see the comment at that site for why justerm restates it
4129 /// once per wide-writing path where the references get it structurally.
4130 ///
4131 /// The `cols < 2` arm is **unreachable since #547** —
4132 /// `MIN_COLUMNS = 2` is the floor on every path that sets a width — and is kept only as a
4133 /// bounds guard for the `col + 1` writes below, not as a described behaviour.
4134 fn relocate_cluster_wide(&mut self, row: usize, col: usize) -> (usize, usize) {
4135 let cols = self.grid.cols();
4136 if cols < 2 || !self.autowrap || !self.wrapline_advances() {
4137 // Nowhere to place a wide cell — leave it narrow. `!wrapline_advances()` joins the
4138 // other two for the same reason: with no next row, the relocation would write the
4139 // cluster over columns 0-1 of the *current* row and destroy whatever is there.
4140 return (row, col);
4141 }
4142 // Capture the base cell (glyph + attrs), its marks, and its extended attrs before
4143 // vacating. The extended attrs (hyperlink, underline colour) must be read HERE and not
4144 // after the move: they live in the *source row's* side maps, and `wrapline()` below may
4145 // scroll — after which that row is a different (or recycled) `Row` (#521).
4146 let base = *self.grid.cell(row, col);
4147 let marks: Vec<char> = self
4148 .combining_at(row, col)
4149 .map(<[char]>::to_vec)
4150 .unwrap_or_default();
4151 let ext = self.grid.row_ref(row).ext_attrs_at(col);
4152 // Vacate the last column as a soft-wrap artefact — the same step `write_glyph` takes for a
4153 // wide glyph that cannot fit, and now literally the same code, so the two cannot drift
4154 // apart again (#528; they held opposite behaviours until then).
4155 self.vacate_for_wrap(row, col);
4156 // Advance to the next line (scrolls if at the bottom); cursor lands at col 0.
4157 self.wrapline();
4158 let nr = self.cursor.row;
4159 // The destination is an overwrite like any other, so it owes the same no-orphan repair
4160 // `write_glyph` performs for its own trailing column (#529, D4): the spacer about to land
4161 // on `(nr, 1)` half-destroys a wide glyph standing there, stranding its far half at
4162 // `(nr, 2)` — a `WIDE_CHAR_SPACER` with no lead to its left, still carrying the destroyed
4163 // glyph's hyperlink and underline colour. Asked *before* the writes, on the pre-write
4164 // state, exactly as `write_glyph`'s `last + 1` check is.
4165 //
4166 // Two of the three references have this exact site, and both repair it without a rule of
4167 // their own, because they write a pair as two *separate* cell writes and the repair lives
4168 // in the write:
4169 // - xterm.js names the case outright — *"Combining character widens 1 column to 2. Move
4170 // old character to next line."* (`InputHandler.ts:583-611` @ 699f553,
4171 // `copyCellsFrom(oldRow, oldCol, 0, oldWidth, false)` at `:605-607`). The relocation
4172 // leaves `x == 2`, so its once-per-run right-edge repair (`:668-669`) lands on exactly
4173 // the orphaned column.
4174 // - ghostty relocates in `Terminal.zig:1188-1252` @ e6e26e1 and reaches the repair
4175 // through `cursorRight(1); printCell(0, .spacer_tail)` (`:1251-1252`) — that second
4176 // `printCell` runs the `cell.wide != wide` switch (`:1484`) whose `.wide` arm clears
4177 // the neighbouring lead's tail (`:1489-1499`).
4178 // - alacritty has **no** counterpart: a width-0 codepoint returns early through
4179 // `push_zerowidth` (`term/mod.rs:1069-1085` @ 852e971), so a cluster never changes
4180 // width and nothing is ever relocated. Its orphan repair (`:994-1008`) is still the
4181 // mechanism reference, reached the same way — one repair per `write_at_cursor`.
4182 // justerm writes both halves in one step, so the repair is not structural here and each
4183 // wide-writing path restates it — this is the third (`write_glyph`,
4184 // `promote_cluster_to_wide`, and now the relocation).
4185 //
4186 // What justerm does **not** copy is ghostty's reach-back at this site: its `.wide` arm
4187 // also clears the previous row's `.spacer_head` (`:1504-1506`, gated `cursor.y > 0 and
4188 // cursor.x <= 1`) — the very marker this relocation set seven statements earlier
4189 // (`:1200`). Derived from source, not executed. Suppressing it here is #534's rule
4190 // verbatim: a repair keyed on a state predicate must not fire while that state is
4191 // mid-construction.
4192 //
4193 // The other two obligations `write_glyph` carries are N/A here, recorded because an
4194 // unexplained omission is what gets re-litigated:
4195 // - the *left*-orphan repair asks `col > 0`, and the lead lands at column 0.
4196 // - `void_wrap_artefact_above(nr)` would clear a record that `vacate_for_wrap` **just
4197 // set**, in both the advance case (`nr == row + 1`, so its target `nr - 1` is `row`)
4198 // and the scroll case (`nr == row`, the source rotated up to `row - 1`). Firing it
4199 // would be self-clobbering, not merely redundant — the same shape as #534's
4200 // mid-construction rule. Measured after a repairing relocation: `is_row_wrapped(0)`
4201 // and `(0, cols-1).is_leading_spacer()` both hold.
4202 //
4203 // `2 < cols` is a live bound, not defence in depth. The print paths cannot leave a
4204 // `WIDE_CHAR` lead in the last column — `write_glyph` wraps rather than write one there
4205 // and `promote_cluster_to_wide` relocates rather than promote in place — but `Row::resize`
4206 // can: the alt screen resizes without reflowing (#567), so truncating a row through a pair
4207 // strands its lead in the final column. The relocation then meets `is_wide() == true` at
4208 // `cols == 2`, and without the bound reads `(nr, 2)` on a two-column grid — an
4209 // out-of-bounds panic in a library, inside a consumer's process, reachable by shrinking a
4210 // window over a CJK glyph. Pinned by `min_columns.rs::
4211 // a_relocation_beside_a_truncated_wide_lead_does_not_index_past_the_row`.
4212 if 2 < cols && self.grid.cell(nr, 1).is_wide() {
4213 self.free_cell(nr, 2);
4214 }
4215 // Re-place the base as a wide lead + spacer, re-attaching the marks fresh (drop the combining
4216 // bit so push_combining starts a clean cluster at the new column).
4217 let mut lead = base;
4218 lead.set_combined(false);
4219 lead.insert_flags(CellFlags::WIDE_CHAR);
4220 *self.grid.cell_mut(nr, 0) = lead;
4221 for m in marks {
4222 self.grid.row_mut(nr).push_combining(0, m);
4223 }
4224 // Re-attach the extended attrs to BOTH halves at the new row. `lead` copied the base's
4225 // presence bits but not its map entries, so without this the bit is set with nothing
4226 // behind it — the read is gated and silently returns the default, and the frame stops
4227 // round-tripping (the cell encodes as linked with no index).
4228 self.grid.row_mut(nr).set_ext_attrs(0, ext.clone());
4229 // …and the underline style from the relocated LEAD, for the reason the sibling site above
4230 // states (#829, ADR-0025 D4).
4231 let lead_style = self.grid.cell(nr, 0).underline_style();
4232 let mut spacer = self.cursor.pen.cell(' ');
4233 spacer.insert_flags(CellFlags::WIDE_CHAR_SPACER);
4234 spacer.set_underline_style(lead_style);
4235 *self.grid.cell_mut(nr, 1) = spacer;
4236 self.grid.row_mut(nr).set_ext_attrs(1, ext);
4237 // Cursor just past the wide cell (pending-wrap if it fills a 2-column row).
4238 if cols <= 2 {
4239 self.cursor.col = cols - 1;
4240 self.cursor.pending_wrap = true;
4241 } else {
4242 self.cursor.col = 2;
4243 self.cursor.pending_wrap = false;
4244 }
4245 self.damage_span(nr, 0, 1);
4246 // The cluster's new home. Callers anchor on this, not on the vacated column.
4247 (nr, 0)
4248 }
4249
4250 // ---- cursor movement (CSI A/B/C/D/E/F/G/d/e/H/f) -------------------------
4251
4252 /// Up `n` rows — CUU, and through it VT52 `ESC A` and CPL — stopping at the top
4253 /// margin when the cursor is at or below it and at the screen top otherwise.
4254 fn move_up(&mut self, n: usize) {
4255 let floor = if self.cursor.row >= self.scroll_top {
4256 self.scroll_top
4257 } else {
4258 0
4259 };
4260 self.cursor.row = self.cursor.row.saturating_sub(n).max(floor);
4261 self.cursor.pending_wrap = false;
4262 }
4263
4264 /// Down `n` rows — CUD, and through it VT52 `ESC B` and CNL — stopping at the
4265 /// bottom margin when the cursor is at or above it and at the screen bottom otherwise.
4266 fn move_down(&mut self, n: usize) {
4267 let ceiling = if self.cursor.row <= self.scroll_bottom {
4268 self.scroll_bottom
4269 } else {
4270 self.grid.rows() - 1
4271 };
4272 self.cursor.row = (self.cursor.row + n).min(ceiling);
4273 self.cursor.pending_wrap = false;
4274 }
4275
4276 fn move_forward(&mut self, n: usize) {
4277 self.cursor.col = (self.cursor.col + n).min(self.grid.cols() - 1);
4278 self.cursor.pending_wrap = false;
4279 }
4280
4281 fn move_back(&mut self, n: usize) {
4282 // Under `?45` this is n applications of the step `BS` takes — xterm's shape
4283 // literally, where one `CursorBack` serves both verbs and its loop spends one unit
4284 // of the count per step (`cursor.c:160-190`), so `CSI 3 D` from a park moves two
4285 // and a walk at column 0 costs one of the three (#873). Off the mode there is
4286 // neither a walk nor a spend to distribute, so the whole move is one saturating
4287 // subtraction — the same landing without the loop.
4288 if self.reverse_wraparound {
4289 for _ in 0..n {
4290 self.step_back();
4291 }
4292 } else {
4293 self.cursor.col = self.cursor.col.saturating_sub(n);
4294 }
4295 // Both call sites pass at least 1 — `param_or` maps an explicit `CSI 0 D` to the
4296 // default — so the loop always runs and always puts the flag down. Cleared here
4297 // anyway rather than relied upon: a zero count must still clear, as every other
4298 // positioning verb does, and the loop is the only shape in this file where that
4299 // obligation can be skipped by arithmetic.
4300 self.cursor.pending_wrap = false;
4301 }
4302
4303 fn set_col(&mut self, col: usize) {
4304 self.cursor.col = col.min(self.grid.cols() - 1);
4305 self.cursor.pending_wrap = false;
4306 }
4307
4308 fn set_row(&mut self, row: usize) {
4309 self.cursor.row = row.min(self.grid.rows() - 1);
4310 self.cursor.pending_wrap = false;
4311 }
4312
4313 fn goto(&mut self, row: usize, col: usize) {
4314 let (offset, max_row) = self.addressable_rows();
4315 self.cursor.row = (row + offset).min(max_row);
4316 self.cursor.col = col.min(self.grid.cols() - 1);
4317 self.cursor.pending_wrap = false;
4318 }
4319
4320 /// The row addressing origin and the last addressable row. Origin mode
4321 /// addresses rows relative to the scroll region's top margin and clamps to its
4322 /// bottom; otherwise rows are absolute to the screen.
4323 fn addressable_rows(&self) -> (usize, usize) {
4324 if self.origin_mode {
4325 (self.scroll_top, self.scroll_bottom)
4326 } else {
4327 (0, self.grid.rows() - 1)
4328 }
4329 }
4330
4331 /// VPR (CSI Ps e): the current row plus `n`, positioned as CUP positions a row
4332 /// — bounded by the last addressable row, not by the scroll margin CUD stops at.
4333 fn vertical_position_relative(&mut self, n: usize) {
4334 let (_, max_row) = self.addressable_rows();
4335 self.cursor.row = (self.cursor.row + n).min(max_row);
4336 self.cursor.pending_wrap = false;
4337 }
4338
4339 // ---- erase (CSI J / K) ---------------------------------------------------
4340
4341 /// Clear cells `from..to` on `row`.
4342 ///
4343 /// Background Color Erase (BCE): erased cells carry the current SGR
4344 /// background only — fg and text attributes reset to default (matches
4345 /// xterm/alacritty, where the fill is `cursor.template.bg.into()`).
4346 ///
4347 /// **Cleared concern, with its validity condition — an empty range would break the pair
4348 /// invariant.** With `from == to` the first guard below still frees the lead at `from - 1`
4349 /// while the second is skipped (`to > from` is false) and the fill loop does nothing, so the
4350 /// spacer at `from` would survive its lead — an ADR-0025 D4 break, and the exact lead-less
4351 /// orphan the word walk must then treat as opaque. This is unreachable **as long as every
4352 /// caller passes a non-empty range**, which holds today: `ECH` clamps to
4353 /// `(col + n).min(cols)` with `n >= 1` (both `CSI X` and `CSI 0 X` erase one cell), and every
4354 /// `EL`/`ED` site passes `0..cols` or `0..=cursor`. A future caller that can pass an empty
4355 /// range must guard here first.
4356 fn clear_cells(&mut self, row: usize, from: usize, to: usize) {
4357 let cols = self.grid.cols();
4358 // Erasing either half of a pair that wrapped from the row above ends it, so that row's
4359 // artefact record is void (#534). `from <= 1` rather than `from == 0` because erasing from
4360 // column 1 destroys the spacer and the no-orphan repair below then frees the lead. ghostty
4361 // reaches the same row from its erase path — `Screen.splitCellBoundary`'s `x == 0 or x ==
4362 // 1` branch (`Screen.zig:1873` @ `e6e26e1`), called from `eraseChars` (`Terminal.zig:3159`).
4363 if from <= 1 && to > from && self.wrapped_pair_at_row_start(row) {
4364 self.void_wrap_artefact_above(row);
4365 }
4366 // Don't orphan a wide char straddling the erase boundary.
4367 if from > 0 && self.grid.cell(row, from).is_wide_spacer() {
4368 self.free_cell(row, from - 1);
4369 }
4370 if to > from && to < cols && self.grid.cell(row, to - 1).is_wide() {
4371 self.free_cell(row, to);
4372 }
4373
4374 let bg = self.cursor.pen.bg;
4375 for col in from..to {
4376 let cell = self.grid.cell_mut(row, col);
4377 cell.reset();
4378 cell.set_bg(bg);
4379 }
4380 // `reset` cleared the presence bits; this releases what they gated (#628).
4381 self.grid.row_mut(row).purge_side_maps(from..to);
4382 if to > from {
4383 self.damage_span(row, from, to - 1);
4384 }
4385 }
4386
4387 /// End `row`'s soft wrap, because something just destroyed the content that was continuing
4388 /// onto the next row.
4389 ///
4390 /// Which verbs owe this is **not** derivable from the erased range — it is a per-verb rule,
4391 /// and both references spell it out call site by call site rather than inferring it:
4392 ///
4393 /// | verb | ends the wrap? | xterm | ghostty |
4394 /// |---|---|---|---|
4395 /// | `EL 0` (erase right) | **yes**, at any column | `ClearRight` → `LineClrWrapped` unconditionally (`util.c:1871`) | `cursorResetWrap()` in `eraseLine(.right)` |
4396 /// | `ECH` | **yes**, at any column | same `ClearRight` (`util.c:1961`) | `cursorResetWrap()` in `eraseChars` |
4397 /// | `DCH` | **yes** | `screen.c` | `cursorResetWrap()` — *"Our row's soft-wrap is always reset"* |
4398 /// | `EL 1` (erase left) | no | `ClearLeft`, no clear | no |
4399 /// | `ICH` | no | no | no |
4400 /// | a reverse-wrap walk (`BS` / `CSI D` under `?45`) | **no** (#873) | `CursorBack` writes no wrap flag | only *reads* `prev_row.wrap` (`Terminal.zig:1842-1843`) |
4401 ///
4402 /// The last row is the one that was wrong. The walk **did** clear the flag — copied from
4403 /// xterm.js's `line.isWrapped = false` (`InputHandler.ts:823`), which neither other
4404 /// reference does — and it did so by writing the row directly, so it never appeared in
4405 /// this table and never took the damage obligation below. Three consequences, all
4406 /// measured: two buffers with identical cells read as different logical lines depending
4407 /// on how the cursor arrived, a reflow kept them apart instead of healing it, and the
4408 /// clear's whole damage was `Partial([])` where `EL 0` through this function reports
4409 /// `Partial([LineDamage { line: 0, left: 0, right: 2 }])`, so a frame-mode consumer was
4410 /// left joined where the engine had split.
4411 /// Undoing the *cursor's* trip across the boundary does not undo the boundary.
4412 ///
4413 /// The shape behind the three that do: each destroys content **from the cursor rightward**, so
4414 /// "this row continues past its last column" can no longer be asserted. Erasing leftward or
4415 /// inserting blanks leaves the tail — and whatever it flowed into — intact.
4416 ///
4417 /// **`EL 2` is a deliberate divergence.** justerm ends the wrap; xterm does not (`ClearLine`,
4418 /// `util.c:1905`, has no `LineClrWrapped`) and ghostty copies that with a comment naming it —
4419 /// *"it seems like complete should reset the soft-wrap state of the line but in xterm it does
4420 /// not."* justerm differs because it *joins* logical lines for `accessible_text` / `search` /
4421 /// selection text, so a blanked-but-still-wrapped row visibly merges two lines in copy — a
4422 /// consequence xterm does not carry. Recorded rather than silently matched or silently
4423 /// Mark `row` as soft-wrapping into the next one — and damage the cell the bit rides on.
4424 ///
4425 /// The exact mirror of [`Term::end_wrap`], and it exists for the mirror of that function's
4426 /// reason. The flag lives on the `Row` (#538) and reaches a consumer only as the last cell's
4427 /// `WRAPLINE`, derived at encode time. Every other cell-carried fact changes when that cell is
4428 /// written, so damage covers it for free; this one does not, and a `Partial` frame would never
4429 /// ship the bit — a frame-mode consumer rebuilding logical lines from cells then keeps the two
4430 /// rows *split* forever, the exact dual of the "joined forever" that `end_wrap` guards.
4431 ///
4432 /// `end_wrap` took that obligation in #540; the set side never did. It stayed invisible because
4433 /// a wrap normally moves the cursor to the next row, and `frame_damage` tops the frame up with
4434 /// the old cursor cell. When a **scroll serves the wrap** the cursor keeps its row index, so
4435 /// nothing tops it up — which is how #557 surfaced it.
4436 ///
4437 /// Damaging here rather than at each caller is what keeps this true for set sites added later,
4438 /// the same argument `end_wrap`'s comment makes.
4439 fn begin_wrap(&mut self, row: usize) {
4440 self.grid.row_mut(row).set_wrapped(true);
4441 let last = self.grid.cols() - 1;
4442 self.damage_span(row, last, last);
4443 }
4444
4445 /// diverged; see #538.
4446 fn end_wrap(&mut self, row: usize) {
4447 self.grid.row_mut(row).set_wrapped(false);
4448 // The flag is stored on the `Row` but rides the wire on the row's **last cell**, derived
4449 // at encode time. Every other cell-carried fact changes only when that cell is written,
4450 // so damage covers it for free; this one does not, and a `Partial` frame would never
4451 // re-ship the bit — leaving a frame-mode consumer with two rows joined forever. Damaging
4452 // here rather than at each caller is what keeps that true for call sites added later.
4453 let last = self.grid.cols() - 1;
4454 self.damage_span(row, last, last);
4455 // The wrap artefact goes with the wrap. The marker's claim is "the last column is the
4456 // blank a width-2 glyph vacated **because this row continues onto the next**", so a row
4457 // that stops continuing cannot hold one (ADR-0025 D3 — position is part of the test, and
4458 // so is the wrap it is positioned in). Coupling the two here is what makes the row-shift
4459 // seams and every wrap-ending erase a single rule instead of a clear per verb: ghostty
4460 // couples them in one function the same way — `Screen.cursorResetWrap`
4461 // (`terminal/Screen.zig:1524` @ `e6e26e1`, spacer-head clear at `:1539-1545`), reached from
4462 // `deleteChars` / `eraseChars` / `eraseLine`. It early-returns on `if (!page_row.wrap)`;
4463 // this one clears unconditionally, which is strictly safer.
4464 //
4465 // Most callers erase through this column anyway, so the clear is redundant for them; the
4466 // ones it is *not* redundant for are the row-shift seams (#540's `shift_region`, which
4467 // ends a wrap without touching a cell) and `delete_chars`, whose marker rides the shift.
4468 // The leftward erases are the mirror case — they blank this column while the wrap
4469 // legitimately survives — and go through `drop_artefact_if_erased` instead.
4470 //
4471 // One wrap-ending path deliberately does *not* reach here: `shift_region`'s `top == 0`
4472 // seam, whose row is in scrollback rather than the grid. It couples the same two clears
4473 // inline; see the comment there.
4474 self.grid.cell_mut(row, last).clear_leading_spacer();
4475 }
4476
4477 /// The pair that wrapped into `row` is about to be destroyed or moved, so the artefact record
4478 /// on the row **above** it is void — drop it. **Call before the mutation.**
4479 ///
4480 /// The marker makes a claim with two clauses: this row soft-wraps (owned by `end_wrap`), and
4481 /// its last column is the blank *that specific pair* vacated. This is the second clause, and
4482 /// the rule behind every call site is one sentence: **the record survives only an in-place
4483 /// same-width overwrite.** Anything else that reaches columns 0/1 of the continuation — a
4484 /// narrow write, an erase, a shift in either direction — ends the pair the record was about,
4485 /// and a wide lead that arrives afterwards by some other route did not *wrap* from anywhere.
4486 ///
4487 /// Both references gate on that, and both gate on the state **before** the write rather than
4488 /// after it:
4489 ///
4490 /// - ghostty `Terminal.zig:1484` @ `e6e26e1` — the whole wide-repair `switch` sits under
4491 /// `if (cell.wide != wide)`, so a wide glyph overwritten by another wide glyph skips it; the
4492 /// reach-back stanza then appears in the `.wide` (`:1501-1506`) and `.spacer_tail`
4493 /// (`:1529-1532`) arms only.
4494 /// - alacritty `term/mod.rs:994` @ `852e971` — the reach-back at `:1004-1008` is inside
4495 /// `if cursor_cell.flags.intersects(WIDE_CHAR | WIDE_CHAR_SPACER)`, but with no
4496 /// width-unchanged escape, so it drops a record that is still true. Alacritty is the outlier
4497 /// of the two and justerm follows ghostty.
4498 ///
4499 /// Asking *after* the mutation instead looks equivalent and is not: it answers "is some wide
4500 /// lead standing at column 0", which a `DCH` that pulls the *next* wide glyph left also
4501 /// satisfies, and which a two-step placement (a narrow base promoted to wide by VS16 under
4502 /// mode 2027, or IRM's insert-then-write) satisfies only at the end. Both were measured
4503 /// disagreeing with the rule above before this took its current form.
4504 ///
4505 /// The erase and intra-row-shift call sites are **ported, not derived**: ghostty's
4506 /// `Screen.splitCellBoundary` (`Screen.zig:1831`, the `x == 0 or x == 1` branch at `:1873`)
4507 /// reaches up one row and clears the previous row's spacer head, and it is called from
4508 /// `deleteChars` (`Terminal.zig:3107-3109`) and `eraseChars` (`:3159-3160`). Only justerm's
4509 /// `ICH` site has no counterpart — ghostty's `insertBlanks` (`:2988`) calls it nowhere.
4510 ///
4511 /// `row == 0` does not mean "no row above": on the primary screen the text readers walk
4512 /// `[scrollback ++ grid]` as one buffer (`abs_floor() == 0`), so the row above grid row 0 is
4513 /// the last **scrollback** row and it can carry the marker. Alacritty reaches the same row for
4514 /// the same reason — its `topmost_line()` is `Line(-history_size)` (`grid/mod.rs:504`), so
4515 /// `point.line - 1` indexes into history; ghostty is the one that stops at the viewport
4516 /// (`cursor.y > 0`). On the alt screen `abs_floor()` is the screen top, so no join crosses the
4517 /// boundary and there is nothing to repair.
4518 ///
4519 /// No damage is owed by either branch, and for a stronger reason than #540's: the marker is a
4520 /// `content` bit outside `CONTENT_MARKER_MASK`, so `Cell::flags()` never sees it and it does
4521 /// not cross the wire at all. The `damage_span` below is defensive, not load-bearing.
4522 fn void_wrap_artefact_above(&mut self, row: usize) {
4523 if row > 0 {
4524 let last = self.grid.cols() - 1;
4525 if self.grid.cell(row - 1, last).is_leading_spacer() {
4526 self.grid.cell_mut(row - 1, last).clear_leading_spacer();
4527 self.damage_span(row - 1, last, last);
4528 }
4529 } else if !self.on_alt
4530 && let Some(cell) = self.scrollback.back_mut().and_then(|r| r.last_mut())
4531 {
4532 cell.clear_leading_spacer();
4533 }
4534 }
4535
4536 /// Is a wide pair standing at columns 0..=1 of `row` — i.e. is there a record for
4537 /// `void_wrap_artefact_above` to void? A cheap pre-mutation test the four call sites share, so
4538 /// the rule lives in one place rather than being re-derived per verb (ADR-0025 D2).
4539 fn wrapped_pair_at_row_start(&self, row: usize) -> bool {
4540 self.grid.cell(row, 0).is_wide()
4541 }
4542
4543 /// Drop a wide-wrap artefact marker that has outlived the wrap it belonged to, without
4544 /// touching the wrap itself.
4545 ///
4546 /// The mirror of the marker clean-up inside `end_wrap`, for the verbs that erase *leftward*:
4547 /// `EL 1` and `ED 1` correctly leave the wrap alone (the row's tail still flows onward), but
4548 /// they can still clear the last column, and then the artefact's blank turns into visible
4549 /// text that a reflow bakes in permanently. Only the marker goes; the wrap is the caller's
4550 /// business.
4551 fn drop_artefact_if_erased(&mut self, row: usize, from: usize, to: usize) {
4552 let last = self.grid.cols() - 1;
4553 if from <= last && to > last {
4554 self.grid.cell_mut(row, last).clear_leading_spacer();
4555 }
4556 }
4557
4558 /// Shift `[top..=bottom]` by one line — up unless `down` — and end the wraps the shift
4559 /// falsified. Every row-shifting verb (IL/DL/SU/SD and the region paths in LF/RI) goes
4560 /// through here so the repair cannot be forgotten at a call site (ADR-0025 D2).
4561 ///
4562 /// The wrap flag claims "this row continues into the **next** row", so it is a statement about
4563 /// *adjacency*, and rotating whole `Row`s keeps it true for free: both halves of a pair inside
4564 /// the region move by the same line, so the claim still describes the same neighbour. Only the
4565 /// two seams falsify it, where a row's next neighbour changed underneath it:
4566 ///
4567 /// - **`top - 1`**, just outside the region. Its continuation rotated away (up-shift) or was
4568 /// pushed down (down-shift), so whatever now sits at `top` is a stranger. This is the seam
4569 /// that merges two unrelated logical lines in copy/search/accessible text (#540's repro).
4570 /// - **the row that lost its continuation to the blank** — `bottom - 1` after an up-shift (the
4571 /// blank lands at `bottom`), `bottom` after a down-shift (its continuation rotated up to
4572 /// `top` and was blanked there). The down-shift form is the one that reaches *outside* the
4573 /// region: the stale claim points at `bottom + 1`, a row the verb never touched.
4574 ///
4575 /// Damaging matters as much as clearing, and `end_wrap` does both: `top - 1` is outside the
4576 /// region, so the scroll op the caller records does not cover it and a `Partial` frame would
4577 /// never re-ship the derived `WRAPLINE` bit.
4578 ///
4579 /// **Each seam has exactly one exemption, and both are facts about the caller that this
4580 /// function cannot see** — which is why they are parameters rather than tests:
4581 ///
4582 /// - `evicts_to_scrollback` exempts the **top** seam: a linefeed pushes row 0 into scrollback,
4583 /// so the readers' `[scrollback ++ grid]` walk finds the continuation one row further back
4584 /// and adjacency survives.
4585 /// - `serves_wrap` exempts the **bottom** seam: the shift was asked for by `wrapline`, so the
4586 /// blank it exposes at `bottom` is not a stranger that displaced a continuation — it *is*
4587 /// the continuation, about to be written into (#557).
4588 ///
4589 /// Both are one-sided on purpose. A wrap-serving scroll still falsifies the top seam, and a
4590 /// scrollback-evicting linefeed still falsifies the bottom one when no wrap asked for it.
4591 ///
4592 /// **No reference implements this rule**, so it is derived rather than ported — ADR-0004, the
4593 /// spec is the authority for VT semantics, above any implementation:
4594 ///
4595 /// - **ghostty** clears the wrap on *every* row a full-width IL/DL touches
4596 /// (`terminal/Terminal.zig:2746-2752`, `:2906-2912` @ `e6e26e1`). The clear runs *before* the
4597 /// row swap at `:2936-2939`, so both ends stay false: an interior pair is split, not
4598 /// preserved. It still never reaches the row above the shifted range.
4599 /// - **alacritty** has no `WRAPLINE` clear on any scroll path (@ `852e971`).
4600 /// - **xterm.js** splices whole line objects and never touches `isWrapped`
4601 /// (`common/InputHandler.ts:1345-1402` @ `699f553`). Its opposite polarity — "I continue the
4602 /// *previous* row" (`common/buffer/Buffer.ts:566-570`) — moves the exposure to the mirrored
4603 /// seam rather than removing it: a spliced-in line keeps a continuation claim about a
4604 /// predecessor it never met.
4605 ///
4606 /// The seam row's wide-wrap *marker* is the same shift's other half, and it now rides along:
4607 /// `end_wrap` clears both (#534), and the `top == 0` branch below — the one seam whose row is
4608 /// not a grid row — couples them inline for the same reason.
4609 ///
4610 /// **Validity condition for clearing at the seams rather than everywhere.** ghostty clears the
4611 /// wrap and the spacer head on *every* row a full-width IL/DL touches, and its own comment
4612 /// gives two reasons: it splits interior pairs, **and** it supports left/right margins
4613 /// (DECSLRM), where a partial-row shift can break an interior pair without moving its
4614 /// neighbour. justerm rotates whole `Row`s and implements no DECSLRM, so an interior pair and
4615 /// its continuation always move together and seam-only is sound. If left/right margins ever
4616 /// land, this rule and #534's marker rule break at the same time — neither is safe under a
4617 /// shift that moves part of a row.
4618 fn shift_region(
4619 &mut self,
4620 top: usize,
4621 bottom: usize,
4622 down: bool,
4623 evicts_to_scrollback: bool,
4624 serves_wrap: bool,
4625 ) {
4626 if down {
4627 self.grid.scroll_down_region(top, bottom);
4628 } else {
4629 self.grid.scroll_up_region(top, bottom);
4630 }
4631 // Recording the scroll op is part of shifting, not a step a caller adds after: damage is
4632 // indexed by row position, so `record_scroll` rotates `line_damage` with the content. A
4633 // seam clear damaged *before* that rotation is carried to the wrong row — and on a
4634 // down-shift it lands on `top`, which `record_scroll` immediately overwrites with
4635 // `fully_damaged`. The clear then never reaches the wire at all: the model splits the
4636 // rows, a `Partial` frame does not say so, and the consumer keeps them joined forever.
4637 // Ordering it here is what makes that unrepeatable at a sixth call site.
4638 self.record_scroll(top, bottom, if down { -1 } else { 1 });
4639 if top > 0 {
4640 self.end_wrap(top - 1);
4641 } else if !evicts_to_scrollback && !self.on_alt {
4642 // `top == 0` does not mean "no row above": on the primary the text readers walk
4643 // `[scrollback ++ grid]` as one buffer (`abs_floor() == 0`), so the row above grid row
4644 // 0 is the last *scrollback* row and it can wrap into the screen. A full-screen SU /
4645 // DL / RI therefore leaves this issue's defect one row higher, outside the grid.
4646 //
4647 // `evicts_to_scrollback` is what keeps `linefeed` out: it pushes grid row 0 into
4648 // scrollback, so the continuation is re-attached one row further back and the claim
4649 // stays true — clearing there would split a line the scroll preserved. On the alt
4650 // screen `abs_floor()` is the screen top, so no join crosses the boundary at all.
4651 //
4652 // No damage is owed with the clear, unlike `end_wrap`'s grid form: a scrollback row
4653 // only reaches the wire while `display_offset > 0`, and there `damage()` returns an
4654 // empty `Partial` (`term.rs`, the frozen-viewport short-circuit) while any scroll that
4655 // *moves* the viewport marks full damage. Valid as long as that short-circuit holds.
4656 //
4657 // The artefact marker goes with the wrap here exactly as it does in `end_wrap`, and
4658 // this branch is the reason that coupling cannot simply live in `end_wrap`: it is the
4659 // one wrap-ending path whose row is not a grid row, so it does not call it. Leaving it
4660 // out left #534's defect alive one row above the grid — reachable from every
4661 // `scroll_region_lines` verb, since all of them pass `evicts_to_scrollback: false`,
4662 // and visible as a word selection one cell too wide plus a reflow that bakes the
4663 // stranded marker mid-row.
4664 if let Some(row) = self.scrollback.back_mut() {
4665 row.set_wrapped(false);
4666 if let Some(cell) = row.last_mut() {
4667 cell.clear_leading_spacer();
4668 }
4669 }
4670 }
4671 // The blank lands at `bottom` going up and at `top` going down, so the row that lost its
4672 // continuation is the one just above it. Going down that is `top - 1`, already cleared
4673 // above; going up it is `bottom - 1`, which for a one-row region is that same row.
4674 //
4675 // The up-shift form needs the `bottom + 1` guard, and it is not defensive — without it the
4676 // clear destroys a **live** wrap. A row at the screen's bottom edge that wraps is the
4677 // ordinary soft-wrap-at-the-last-row state: `wrapline` sets the flag and the linefeed
4678 // scrolls precisely so the continuation has somewhere to land, which is the *next* row
4679 // after this shift. Its claim is about a row that does not exist yet, so the shift makes it
4680 // true rather than false.
4681 //
4682 // **The rest of that guard's original rationale was too narrow, and #557 is what it cost.**
4683 // It read: *"the link is only broken when there is a stationary row below the region
4684 // (`bottom + 1 < rows`): then the continuation stayed put while its lead moved up."* A
4685 // stationary row below is **necessary but not sufficient**. At a *region's* bottom the same
4686 // wrapline-asked-for scroll happens with `bottom + 1 < rows` perfectly true, and the clear
4687 // then split the logical line the scroll existed to continue. The geometry was never the
4688 // discriminator; **why the shift is happening** is — which is what `serves_wrap` carries.
4689 //
4690 // The guard stays anyway: it is the screen-bottom case of the same fact, and it also holds
4691 // for a *non*-wrap-serving linefeed at the screen edge.
4692 //
4693 // One invariant is still worth naming, because it was not true when this guard was first
4694 // written: **a row only claims a wrap if a next row will exist for it**. A row parked below
4695 // a DECSTBM region kept a permanent false claim, and this guard preserved it — the #540
4696 // completeness pass merged two unrelated logical lines through exactly that hole. The claim
4697 // is now gated at its set site (`write_glyph` asks `wrapline_advances`), so the guard's
4698 // premise holds. Valid as long as that gate stays.
4699 let orphaned = if serves_wrap {
4700 // The blank this shift just exposed is the continuation the wrap is waiting for, so
4701 // there is nothing to falsify — see the `serves_wrap` note on `linefeed_inner` (#557).
4702 None
4703 } else if down {
4704 Some(bottom)
4705 } else if bottom + 1 < self.grid.rows() {
4706 bottom.checked_sub(1)
4707 } else {
4708 None
4709 };
4710 if let Some(row) = orphaned {
4711 self.end_wrap(row);
4712 }
4713 }
4714
4715 fn erase_display(&mut self, mode: u16) {
4716 let (cols, rows) = (self.grid.cols(), self.grid.rows());
4717 let (cr, cc) = (self.cursor.row, self.cursor.col);
4718 match mode {
4719 0 => {
4720 // Erases this row's tail and every row below, so nothing can continue from here
4721 // — and the rows below cannot continue either.
4722 self.clear_cells(cr, cc, cols);
4723 self.end_wrap(cr);
4724 for row in (cr + 1)..rows {
4725 self.clear_cells(row, 0, cols);
4726 self.end_wrap(row);
4727 self.dispose_markers_on_row(row);
4728 }
4729 }
4730 1 => {
4731 // Leftward: this row's tail survives, so its own wrap does. The rows *above* are
4732 // gone entirely.
4733 for row in 0..cr {
4734 self.clear_cells(row, 0, cols);
4735 self.end_wrap(row);
4736 self.dispose_markers_on_row(row);
4737 }
4738 self.clear_cells(cr, 0, cc + 1);
4739 self.drop_artefact_if_erased(cr, 0, cc + 1);
4740 // Covering the whole row means nothing continues from it. xterm.js has a
4741 // dedicated arm for exactly this case, in its own words: *"Deleted entire
4742 // previous line. This next line can no longer be wrapped."*
4743 // (`InputHandler.ts:1248-1252` — under its continuation polarity that assignment
4744 // is this engine's `end_wrap(cr)`.) `EL 1` has no such arm there, and none here.
4745 if cc + 1 == cols {
4746 self.end_wrap(cr);
4747 }
4748 }
4749 2 => {
4750 for row in 0..rows {
4751 self.clear_cells(row, 0, cols);
4752 self.end_wrap(row);
4753 self.dispose_markers_on_row(row);
4754 }
4755 }
4756 // Notably **`3` (ED 3, erase scrollback) is not implemented** and falls through
4757 // here as a no-op. Recorded rather than filed, because an unimplemented verb is
4758 // not a defect — but whoever implements it inherits an obligation that is invisible
4759 // from this site (#660's completeness pass): it would be the first verb that
4760 // shortens the buffer *from the front* by N lines, so it needs both an anchor
4761 // fixup (selection, markers **and** tracked points are absolute-from-oldest — three
4762 // holders since #691, and the third has no frame to make its drift visible; the
4763 // *fourth* is search highlights, which every list of this obligation has so far
4764 // omitted — see the destruction-funnel invariant note) and a `display_offset`
4765 // clamp. Without the second, `selection_range`'s `scrollback.len() - display_offset`
4766 // underflows — and so do the same expressions in `viewport_line`,
4767 // `viewport_link_at` and `match_spans`. alacritty's `ClearMode::Saved` arm does
4768 // both (`term/mod.rs:1806-1811`).
4769 //
4770 // **A real `clear` emits it** — measured on the VM, `ESC[H ESC[2J ESC[3J`
4771 // (`tests/fixtures/osc133_clear.raw`) — so this no-op is reached in ordinary
4772 // traffic and not only by a test. Its visible consequence since #750: `ED 2`
4773 // now retires the command marks on the screen while the ones that already
4774 // scrolled off survive a `clear` a real terminal would have erased them with
4775 // (`command_lines_capture.rs` pins that, so implementing this verb will move
4776 // a test rather than silently changing an answer).
4777 _ => {}
4778 }
4779 }
4780
4781 /// Erase in line (EL): 0 = cursor→end, 1 = start→cursor, 2 = whole line.
4782 fn erase_line(&mut self, mode: u16) {
4783 let cols = self.grid.cols();
4784 let (cr, cc) = (self.cursor.row, self.cursor.col);
4785 match mode {
4786 // Erase right — ends the wrap at any column (xterm's `ClearRight`).
4787 0 => {
4788 self.clear_cells(cr, cc, cols);
4789 self.end_wrap(cr);
4790 }
4791 // Erase left — the tail survives, so the wrap does. The artefact marker does not:
4792 // if the erase reached the last column it just blanked the cell the marker described.
4793 1 => {
4794 self.clear_cells(cr, 0, cc + 1);
4795 self.drop_artefact_if_erased(cr, 0, cc + 1);
4796 }
4797 // Erase the whole line — see `end_wrap`: a deliberate divergence from xterm.
4798 2 => {
4799 self.clear_cells(cr, 0, cols);
4800 self.end_wrap(cr);
4801 }
4802 _ => {}
4803 }
4804 }
4805
4806 // ---- intra-line editing (ICH / DCH / ECH) --------------------------------
4807
4808 /// ECH (CSI Pn X): erase `n` cells in place from the cursor — no shift.
4809 /// BCE-filled (via `clear_cells`); pending-wrap is left untouched.
4810 fn erase_chars(&mut self, n: usize) {
4811 let cols = self.grid.cols();
4812 let (row, col) = (self.cursor.row, self.cursor.col);
4813 let to = (col + n).min(cols);
4814 self.clear_cells(row, col, to);
4815 // Destroys content from the cursor rightward, so the row can no longer be continuing —
4816 // unconditionally, at any column and for any `n`. Both references do exactly this (see
4817 // `end_wrap`): xterm routes ECH through the same `ClearRight` as `EL 0`, ghostty calls
4818 // `cursorResetWrap()` in `eraseChars`.
4819 self.end_wrap(row);
4820 }
4821
4822 /// ICH (CSI Pn @): insert `n` blanks at the cursor, shifting the rest of the
4823 /// line right; cells pushed past the right edge are lost. The opened gap is
4824 /// BCE-filled; pending-wrap is left untouched.
4825 fn insert_chars(&mut self, n: usize) {
4826 let cols = self.grid.cols();
4827 let (r, col) = (self.cursor.row, self.cursor.col);
4828 let n = n.min(cols - col);
4829 if n == 0 {
4830 return;
4831 }
4832 // Shifting a wrapped pair out of columns 0/1 ends it, so the row above's artefact record
4833 // is void (#534). Asked **before** the shift, which is what keeps IRM correct: `write_glyph`
4834 // routes its wide-at-boundary insert through here *after* `vacate_for_wrap` has just set
4835 // the marker on the row above, and a post-shift test would see the freshly blanked gap and
4836 // clear the marker inside its own SET site's critical section. Pre-shift the question is
4837 // about the pair that was actually there, which is the one the record is about.
4838 if col <= 1 && self.wrapped_pair_at_row_start(r) {
4839 self.void_wrap_artefact_above(r);
4840 }
4841 let bg = self.cursor.pen.bg;
4842 let row = self.grid.row_mut(r);
4843 // Shift [col .. cols-n) right by n; the tail falls off the edge. The
4844 // combining map follows the moved cells (the bit travels with the raw
4845 // copy, the cluster data must too).
4846 row.copy_within(col..cols - n, col + n);
4847 row.move_maps(col..cols - n, col + n);
4848 for cell in &mut row[col..col + n] {
4849 cell.reset();
4850 cell.set_bg(bg);
4851 }
4852 // Repair wide-char halves split at the seams (no-orphan invariant):
4853 // a lead just before the gap lost its spacer; the first shifted cell may
4854 // be a spacer whose lead did not move.
4855 if col > 0 && self.grid.cell(r, col - 1).is_wide() {
4856 self.free_cell(r, col - 1);
4857 }
4858 if col + n < cols && self.grid.cell(r, col + n).is_wide_spacer() {
4859 self.free_cell(r, col + n);
4860 }
4861 // A lead shifted to the last column lost its spacer off the edge.
4862 if self.grid.cell(r, cols - 1).is_wide() {
4863 self.free_cell(r, cols - 1);
4864 }
4865 // Note ICH needs no repair to *this* row's marker: a right shift always pushes the last
4866 // column off the edge, so it discards a marker rather than carrying one inward —
4867 // measured, and pinned by `ich_discards_the_marker_off_the_edge`.
4868 self.damage_span(r, col, cols - 1);
4869 }
4870
4871 /// DCH (CSI Pn P): delete `n` cells at the cursor, shifting the tail left; the
4872 /// vacated cells at the right are BCE-blanked. Pending-wrap is left untouched.
4873 fn delete_chars(&mut self, n: usize) {
4874 let cols = self.grid.cols();
4875 let (r, col) = (self.cursor.row, self.cursor.col);
4876 let n = n.min(cols - col);
4877 if n == 0 {
4878 return;
4879 }
4880 // The shift pulls the tail left and blanks the far end, so the row stops continuing —
4881 // ghostty says it outright (*"Our row's soft-wrap is always reset"* in `deleteChars`,
4882 // `Terminal.zig:3133` @ `e6e26e1`).
4883 //
4884 // **Before the shift, not after** (#534): `end_wrap` clears the artefact marker at the
4885 // *last* column, and the marker is a cell bit that the shift carries inward with every
4886 // other cell. Ending the wrap afterwards would clear a column the marker has already left,
4887 // stranding it mid-row where it describes nothing (ADR-0025 D3) and silently swallows the
4888 // blank between two runs in copy, search and accessible text. Same shape as #540's
4889 // `record_scroll` ordering: the clear has to happen where the state still is.
4890 self.end_wrap(r);
4891 // Deleting a wrapped pair out of columns 0/1 ends it, so the row above's artefact record
4892 // is void — and this is where the "ask before, not after" rule earns its keep twice over:
4893 // a `DCH` can pull the *next* wide glyph left into column 0, which a post-shift "is a wide
4894 // lead standing here?" test happily accepts even though the pair the record was about has
4895 // been deleted. ghostty asks the same question at the same point:
4896 // `Screen.splitCellBoundary(cursor.x)` from `deleteChars` (`Terminal.zig:3107` @ `e6e26e1`),
4897 // whose `x == 0 or x == 1` branch reaches up a row and clears the spacer head.
4898 if col <= 1 && self.wrapped_pair_at_row_start(r) {
4899 self.void_wrap_artefact_above(r);
4900 }
4901 let bg = self.cursor.pen.bg;
4902 let row = self.grid.row_mut(r);
4903 // Shift [col+n .. cols) left to [col ..); BCE-fill the vacated tail. The
4904 // combining map follows the moved cells.
4905 row.copy_within(col + n..cols, col);
4906 row.move_maps(col + n..cols, col);
4907 for cell in &mut row[cols - n..cols] {
4908 cell.reset();
4909 cell.set_bg(bg);
4910 }
4911 // Repair wide-char halves split by the deletion (no-orphan invariant):
4912 // a lead just before the cut lost its spacer; the cell now at the cursor
4913 // may be a spacer whose lead was deleted.
4914 if col > 0 && self.grid.cell(r, col - 1).is_wide() {
4915 self.free_cell(r, col - 1);
4916 }
4917 if self.grid.cell(r, col).is_wide_spacer() {
4918 self.free_cell(r, col);
4919 }
4920 self.damage_span(r, col, cols - 1);
4921 }
4922
4923 // ---- line/region editing (IL / DL / SU / SD) -----------------------------
4924
4925 /// Scroll rows `[top..=bottom]` by `n` lines, BCE-filling the exposed lines.
4926 /// `down` inserts blanks at the top (content moves down); otherwise content
4927 /// moves up and blanks appear at the bottom. Reuses the one-line region scroll
4928 /// primitives (so damage + scroll-op accumulation come for free), then fills
4929 /// the exposed lines with the current SGR background.
4930 fn scroll_region_lines(&mut self, top: usize, bottom: usize, n: usize, down: bool) {
4931 let height = bottom - top + 1;
4932 let n = n.min(height);
4933 if n == 0 {
4934 return;
4935 }
4936 // Anchors (selection #3, markers #118/#158) live at absolute buffer lines;
4937 // SU/SD/IL/DL don't accrue scrollback, so `base` is stable across the loop.
4938 let base = self.scrollback.len();
4939 for _ in 0..n {
4940 self.shift_region(top, bottom, down, false, false);
4941 // Rotate anchors with the content, like `linefeed`/`reverse_index`
4942 // (#162). `up` = content moved up = the non-`down` case. Markers rotate
4943 // with the active buffer (#187) — alt-scoped on the alt screen, so no
4944 // guard. **The selection is unguarded here for the same reason, not because
4945 // "it is cleared on alt enter"** — that was this comment's claim until #660 and
4946 // it is false: a selection made while the alt screen is up is ordinary, it does
4947 // reach this line, and rotating it is correct, because the content really did
4948 // move under it. The code was right; only its stated reason was wrong.
4949 self.selection_rotate_region(base + top, base + bottom, !down);
4950 self.markers_rotate_region(base + top, base + bottom, !down);
4951 self.tracked_rotate_region(base + top, base + bottom, !down);
4952 }
4953 self.invalidate_search_highlights();
4954 // BCE-fill the n exposed lines (the primitives blank to default).
4955 let bg = self.cursor.pen.bg;
4956 let (fill_top, fill_end) = if down {
4957 (top, top + n)
4958 } else {
4959 (bottom + 1 - n, bottom + 1)
4960 };
4961 let cols = self.grid.cols();
4962 for r in fill_top..fill_end {
4963 for c in 0..cols {
4964 let cell = self.grid.cell_mut(r, c);
4965 cell.reset();
4966 cell.set_bg(bg);
4967 }
4968 }
4969 }
4970
4971 /// SU (CSI Pn S): scroll the scroll region up by `n`.
4972 fn scroll_up_lines(&mut self, n: usize) {
4973 self.scroll_region_lines(self.scroll_top, self.scroll_bottom, n, false);
4974 }
4975
4976 /// SD (CSI Pn T): scroll the scroll region down by `n`.
4977 fn scroll_down_lines(&mut self, n: usize) {
4978 self.scroll_region_lines(self.scroll_top, self.scroll_bottom, n, true);
4979 }
4980
4981 /// IL (CSI Pn L): insert `n` blank lines at the cursor, scrolling
4982 /// `[cursor..=scroll_bottom]` down. A no-op when the cursor is outside the
4983 /// scroll region.
4984 fn insert_lines(&mut self, n: usize) {
4985 let cur = self.cursor.row;
4986 if cur < self.scroll_top || cur > self.scroll_bottom {
4987 return;
4988 }
4989 // 3-1 for clearing, and the odd one out is the row-shift family's usual
4990 // outlier: xterm `util.c:1295`, ghostty `Terminal.zig:2691` (*"Always unset
4991 // pending wrap"*), and xterm.js structurally — `insertLines` opens with
4992 // `_restrictCursor()`, whose `Math.min(cols - 1, …)` un-parks the column
4993 // (`InputHandler.ts:1346`, `:890`). Only alacritty leaves it.
4994 //
4995 // `SU`/`SD` deliberately do **not** join them: ghostty saves and restores the
4996 // flag around those two on purpose (`Terminal.zig:2390`), so this is a
4997 // per-verb answer and not "row-shift verbs clear" (#848).
4998 self.cursor.pending_wrap = false;
4999 self.scroll_region_lines(cur, self.scroll_bottom, n, true);
5000 }
5001
5002 /// DL (CSI Pn M): delete `n` lines at the cursor, scrolling
5003 /// `[cursor..=scroll_bottom]` up. A no-op when the cursor is outside the
5004 /// scroll region.
5005 fn delete_lines(&mut self, n: usize) {
5006 let cur = self.cursor.row;
5007 if cur < self.scroll_top || cur > self.scroll_bottom {
5008 return;
5009 }
5010 // Same 3-1 as `Term::insert_lines`; xterm `util.c:1388`, ghostty
5011 // `Terminal.zig:2856`, xterm.js `InputHandler.ts:1380` via `_restrictCursor`.
5012 self.cursor.pending_wrap = false;
5013 self.scroll_region_lines(cur, self.scroll_bottom, n, false);
5014 }
5015
5016 // ---- SGR (CSI m) ---------------------------------------------------------
5017
5018 fn sgr(&mut self, params: &Params) {
5019 let pen = &mut self.cursor.pen;
5020 let mut iter = params.iter();
5021 while let Some(param) = iter.next() {
5022 let code = param.first().copied().unwrap_or(0);
5023 match code {
5024 0 => pen.reset(),
5025 1 => pen.flags.insert(CellFlags::BOLD),
5026 2 => pen.flags.insert(CellFlags::DIM),
5027 3 => pen.flags.insert(CellFlags::ITALIC),
5028 // SGR 4 and its colon sub-parameter form (#829). The sub-parameter is already
5029 // here — `params.iter()` yields the whole `&[u16]` and every other arm reads only
5030 // `first()` — so `4:3` has been arriving as `[4, 3]` and being truncated to a
5031 // plain underline. `4:0` is an explicit off in every reference that implements
5032 // the form. An unrecognised sub-style stays a single underline: three of the four
5033 // references degrade that way (xterm is the outlier and swallows the whole
5034 // parameter), and losing an underline entirely is a worse failure than drawing the
5035 // wrong kind — the application asked for emphasis and would get nothing, with no way
5036 // to tell. #830 confirmed that rule against the corpus rather than changing it.
5037 //
5038 // Every value is stored **and every value is now drawn** (#830). #829 stored all six
5039 // while the shader branched on `Curly` alone, because storing and drawing are not
5040 // symmetric in cost: storing 2/4/5 was three arms and no pixel, while NOT storing
5041 // them was a loss #830 could not have repaired — a cell written `4:5m` and scrolled
5042 // into history would have recorded `Single` forever.
5043 4 => {
5044 let style = match param.get(1) {
5045 None | Some(1) => UnderlineStyle::Single,
5046 Some(0) => UnderlineStyle::None,
5047 Some(2) => UnderlineStyle::Double,
5048 Some(3) => UnderlineStyle::Curly,
5049 Some(4) => UnderlineStyle::Dotted,
5050 Some(5) => UnderlineStyle::Dashed,
5051 Some(_) => UnderlineStyle::Single,
5052 };
5053 pen.flags.set_underline_style(style);
5054 }
5055 5 => pen.flags.insert(CellFlags::BLINK),
5056 7 => pen.flags.insert(CellFlags::INVERSE),
5057 8 => pen.flags.insert(CellFlags::HIDDEN),
5058 9 => pen.flags.insert(CellFlags::STRIKETHROUGH),
5059 // The legacy double underline (#830), which predates the sub-parameter form above.
5060 // It lands on the same field, so `24` clears both spellings — ghostty gets that by
5061 // construction (4, 4:x, 21 and 24 all reduce to one variant on one arm,
5062 // `Screen.zig:2269-2271`) where xterm leaves two independent bits set and lets each
5063 // consumer resolve them (`html.c:208-216` against `svg.c:271`).
5064 //
5065 // **Decided by the spec, not by a head count**, because the corpus is not
5066 // unanimous: `vte` — the crate this engine's own parser is built on — reads `[21]`
5067 // as `CancelBold` (`vte-0.15.0/src/ansi.rs:1849`), so alacritty produces no double
5068 // underline from it at all. `ctlseqs.txt:1200` reads *"Doubly-underlined, ECMA-48
5069 // 3rd"*, and the VT tie-breaker puts the spec above any implementation including
5070 // ours; xterm (`charproc.c:4407-4409`), ghostty (`sgr.zig:301`) and xterm.js
5071 // (`InputHandler.ts:2653-2655`) all agree. A reference that *contradicts* rather
5072 // than omits is the third case ADR-0004's text does not classify — #824 settled
5073 // that routing for DA2 and it applies unchanged here.
5074 //
5075 // The consequence, pinned rather than left to a bug report: an application sending
5076 // `CSI 1m` then `CSI 21m` **meaning "stop bold"** gets a double underline and keeps
5077 // its bold. That is what `22` is for, and this arm deliberately does not touch it.
5078 21 => pen.flags.set_underline_style(UnderlineStyle::Double),
5079 22 => pen.flags.remove(CellFlags::BOLD | CellFlags::DIM),
5080 23 => pen.flags.remove(CellFlags::ITALIC),
5081 // Clears the style, not just the derived flag (#829) — removing `UNDERLINE` alone
5082 // would leave a styled-but-not-underlined pen, the disagreement this model exists
5083 // to make unrepresentable.
5084 24 => pen.flags.set_underline_style(UnderlineStyle::None),
5085 25 => pen.flags.remove(CellFlags::BLINK),
5086 27 => pen.flags.remove(CellFlags::INVERSE),
5087 28 => pen.flags.remove(CellFlags::HIDDEN),
5088 29 => pen.flags.remove(CellFlags::STRIKETHROUGH),
5089 30..=37 => pen.fg = Color::Indexed((code - 30) as u8),
5090 38 => {
5091 if let Some(c) = parse_extended_color(param, &mut iter) {
5092 pen.fg = c;
5093 }
5094 }
5095 39 => pen.fg = Color::Default,
5096 40..=47 => pen.bg = Color::Indexed((code - 40) as u8),
5097 48 => {
5098 if let Some(c) = parse_extended_color(param, &mut iter) {
5099 pen.bg = c;
5100 }
5101 }
5102 49 => pen.bg = Color::Default,
5103 // Underline colour (SGR 58 / 59, #520) — same extended-colour grammar
5104 // as 38/48 (colon `58:2:r:g:b` / `58:5:n`, or legacy semicolon), so it
5105 // reuses `parse_extended_color` verbatim. 59 returns to "follow the fg".
5106 58 => {
5107 if let Some(c) = parse_extended_color(param, &mut iter) {
5108 pen.underline_color = c;
5109 }
5110 }
5111 59 => pen.underline_color = Color::Default,
5112 // bright foreground/background (aixterm) → palette 8..=15.
5113 90..=97 => pen.fg = Color::Indexed((code - 90 + 8) as u8),
5114 100..=107 => pen.bg = Color::Indexed((code - 100 + 8) as u8),
5115 _ => {}
5116 }
5117 }
5118 }
5119}
5120
5121/// Cap a recorded scroll to what a consumer can act on **and** what the wire can
5122/// carry (#661) — two bounds for two different reasons, see [`Term::scroll_delta`].
5123///
5124/// A free function so the second bound is provable without building the grid that
5125/// reaches it: a region taller than `i16::MAX` means a screen taller than 32 767
5126/// rows, and every scroll of it rotates a `line_damage` of that length, so driving
5127/// the engine to that corner costs ~10⁹ element moves (measured: 16 s in a debug
5128/// build, for one assertion). The engine-level tests in `tests/damage.rs` prove
5129/// `scroll_delta` applies this at ordinary sizes; the wire-level one in
5130/// `tests/serialize.rs` proves a count at the bound survives `encode`.
5131fn cap_scroll(op: ScrollOp) -> ScrollOp {
5132 let height = op.bottom.saturating_sub(op.top).saturating_add(1) as isize;
5133 let bound = height.min(MAX_SCROLL_COUNT);
5134 ScrollOp {
5135 count: op.count.clamp(-bound, bound),
5136 ..op
5137 }
5138}
5139
5140/// Parse `38`/`48`/`58` extended colour (foreground / background / underline colour, #520), in
5141/// either form:
5142/// - sub-parameter (colon) form inline in `param`: `38:5:n`, `38:2:r:g:b`
5143/// (optionally `38:2:cs:r:g:b` with a colorspace id), or
5144/// - legacy (semicolon) form: pull the following top-level params from `iter`.
5145///
5146/// The colon RGB form is **count-based** (`off = if param.len() >= 6 { 3 } else { 2 }`): a 5-param
5147/// `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
5148/// `38:2::r:g:b` with an *empty* cs, the form kitty/nvim actually emit — skips the colorspace slot.
5149/// The short 5-param form is **non-conformant to T.416 / ISO-8613-6** (the de-jure standard always
5150/// carries a colorspace field), but tolerating it is the **ecosystem-dominant** behaviour, verified
5151/// against real source (2026-07, #520): VTE (`src/sgr.hh`, branches on `n > 4`), foot (`csi.c`,
5152/// `sub.idx >= 5`) and alacritty (`ansi.rs`, `params.len() > 4`) all count the sub-parameters and
5153/// decode the short form as RGB(r,g,b), exactly as here. VTE's own comment calls it a "common
5154/// misinterpretation of the standard" (foot: "bastard version") that it supports anyway; **only
5155/// xterm.js is strict** (always consumes a colorspace slot, so it misreads the short form). So a
5156/// difference from xterm here is deliberate leniency shared with the non-xterm ecosystem, not a
5157/// defect — the ADR-0004 spec-faithfulness is about not *omitting* behaviour, not about rejecting a
5158/// widely-emitted non-standard input.
5159fn parse_extended_color<'a, I>(param: &[u16], iter: &mut I) -> Option<Color>
5160where
5161 I: Iterator<Item = &'a [u16]>,
5162{
5163 if param.len() > 1 {
5164 // Colon sub-parameter form: kind is param[1].
5165 match param[1] {
5166 2 => {
5167 // 38:2:r:g:b (len 5) or 38:2:cs:r:g:b (len 6, colorspace skipped).
5168 let off = if param.len() >= 6 { 3 } else { 2 };
5169 let r = *param.get(off)? as u8;
5170 let g = *param.get(off + 1)? as u8;
5171 let b = *param.get(off + 2)? as u8;
5172 Some(Color::Rgb(r, g, b))
5173 }
5174 5 => Some(Color::Indexed(*param.get(2)? as u8)),
5175 _ => None,
5176 }
5177 } else {
5178 // Legacy semicolon form: kind, then its operands, are separate params.
5179 match iter.next()?.first().copied()? {
5180 2 => {
5181 let r = iter.next()?.first().copied()? as u8;
5182 let g = iter.next()?.first().copied()? as u8;
5183 let b = iter.next()?.first().copied()? as u8;
5184 Some(Color::Rgb(r, g, b))
5185 }
5186 5 => Some(Color::Indexed(iter.next()?.first().copied()? as u8)),
5187 _ => None,
5188 }
5189 }
5190}
5191
5192/// Reflow one screen (joined with its `scrollback`) to `cols` x `rows`, tracking
5193/// `point` (a cursor in screen coordinates). Returns the new screen rows, the new
5194/// scrollback (capped to `limit`), and the new point. The alt screen passes an
5195/// empty scrollback and discards the returned one.
5196/// The fixed dimensions a resize reflows toward.
5197#[derive(Clone, Copy)]
5198struct ReflowDims {
5199 old_cols: usize,
5200 cols: usize,
5201 rows: usize,
5202 limit: usize,
5203 /// Whether a column change may **re-split** this pane's content, or only re-fit its rows.
5204 ///
5205 /// False for the alt screen (#567). Reflow re-splits a long line so history stays readable at
5206 /// the new width — it assumes the content is text that *flows*. The alt screen has no history,
5207 /// its content is a **layout** rather than a paragraph (re-wrapping htop's columns means
5208 /// nothing), and the application already knows the new size and repaints. All three references
5209 /// take the same position with the same shape — one flag on the same resize function:
5210 /// ghostty `alt.resize(.{ .reflow = false })`, alacritty `grid.resize(!is_alt, …)`, xterm.js
5211 /// gating on `_hasScrollback` with the alt buffer built as `new Buffer(false, …)`.
5212 ///
5213 /// It is not merely wasted work: measured on a real `htop` recording taken across a live
5214 /// `SIGWINCH`, re-splitting leaves debris in the cells htop does not overwrite, because htop
5215 /// repaints **without** clearing. `vim` hides it by erasing first.
5216 reflow: bool,
5217}
5218
5219/// The result of reflowing one pane.
5220struct PaneReflow {
5221 screen: Vec<Row>,
5222 scrollback: VecDeque<Row>,
5223 /// The cursor's new screen-relative position.
5224 cursor: (usize, usize),
5225 /// Each tracked extra point's new position **in this pane's own `[history ++ screen]` frame**,
5226 /// index-aligned with the `extra_abs` argument — *before* any history the caller discards.
5227 ///
5228 /// Reported raw, with `evicted` beside it, because the two callers translate differently and
5229 /// doing it here silently picked the primary's answer for both: the primary keeps its history,
5230 /// so an extra's absolute line only moves by what the cap threw away, while the alt pane has no
5231 /// history at all and everything above the screen is *gone*. Adding the alt result to the
5232 /// primary's scrollback length then produced a line the buffer does not have — reachable
5233 /// without any reflow, on a rows-only resize.
5234 extras: Vec<(usize, usize)>,
5235 /// Rows that left the buffer entirely off the front of this pane's history. For the primary
5236 /// that is the scrollback cap's eviction; for the alt pane, whose limit is `0` because it has
5237 /// no history, it is every row the shrink pushed off the top. An extra whose raw line is below
5238 /// this **is not in the buffer any more** — the caller decides what that means for its kind.
5239 evicted: usize,
5240}
5241
5242/// Reflow one pane (its `scrollback` joined with `screen`) to `dims`, tracking
5243/// the screen-relative cursor `point` plus any `extra_abs` points given in
5244/// **absolute** `[scrollback ++ screen]` coordinates (selection anchors).
5245fn reflow_pane(
5246 screen: Vec<Row>,
5247 scrollback: VecDeque<Row>,
5248 point: (usize, usize),
5249 extra_abs: &[(usize, usize)],
5250 dims: ReflowDims,
5251) -> PaneReflow {
5252 let scroll_len = scrollback.len();
5253 let mut all: Vec<Row> = scrollback.into();
5254 all.extend(screen);
5255
5256 // The cursor is screen-relative; lift it to absolute, then track it together
5257 // with the already-absolute extras.
5258 let mut pts: Vec<(usize, usize)> = Vec::with_capacity(1 + extra_abs.len());
5259 pts.push((scroll_len + point.0, point.1));
5260 pts.extend_from_slice(extra_abs);
5261
5262 let pts = if dims.reflow && dims.cols != dims.old_cols {
5263 let (reflowed, np) = crate::grid::reflow(all, dims.cols, &pts);
5264 all = reflowed;
5265 np
5266 } else {
5267 pts
5268 };
5269
5270 // The cursor can land one row past everything the reflow emitted — "just after the content"
5271 // when the content ends on a full row (#562). That row is real, and while the pane is shorter
5272 // than the screen the caller's fit supplies it for free. When the content already fills the
5273 // pane it has to be bought, and the price is one row of history: the pane **scrolls**, which is
5274 // what a terminal does when content grows past the bottom. Without it the cursor was pulled
5275 // back onto the last glyph and the next byte destroyed a character — the ordinary shell shape,
5276 // a prompt at the bottom of a full screen.
5277 //
5278 // Five earlier designs made `reflow` itself materialise the row and were rejected on
5279 // measurements (a cursor at column 59 resized to width 4 emptied the buffer; a blank-line
5280 // exemption turned 22 alt lines into 21). `reflow` cannot see this pane's budget, so it spent
5281 // what it did not have. Here the budget is in scope, and it is the gate: a pane with no history
5282 // cannot pay — the displaced row would be destroyed rather than archived — so it keeps clamping.
5283 //
5284 // `limit > 0`, deliberately, and not "is this the alt screen": since #567 the alt panes pass
5285 // `limit: 0` because that is what an alt screen's history is, so they are excluded by the budget
5286 // rather than by a branch. That branch is what the design carrying this rule was rejected for
5287 // needing.
5288 //
5289 // This **amends** ADR-0025 rather than reading it narrowly: `reflow` does not create rows; the
5290 // seam may, when the pane can pay. What that record measured is that materialising
5291 // *unconditionally* destroys content.
5292 let cursor_abs = pts[0].0 + usize::from(pts[0].1 == dims.cols);
5293 if dims.limit > 0 {
5294 while all.len() <= cursor_abs {
5295 all.push(Row::blank(dims.cols));
5296 }
5297 }
5298
5299 let split = all.len().saturating_sub(dims.rows);
5300 let history: Vec<Row> = all.drain(0..split).collect();
5301 let mut sb: VecDeque<Row> = history.into();
5302 let mut dropped = 0usize;
5303 while sb.len() > dims.limit {
5304 sb.pop_front();
5305 dropped += 1;
5306 }
5307
5308 // `reflow` may answer `col == cols` — "just after the last cell", which is a real place in the
5309 // logical line and no place in the grid (#562). The **cursor's** reading of it is the next
5310 // *write* position, so a full row means the start of the row after; the caller's row fit
5311 // provides that row (`Grid::set_screen` pads at the bottom). A mark reads the same value the
5312 // opposite way and keeps it verbatim — see `Term::resize`.
5313 let cursor_row = pts[0].0.saturating_sub(split);
5314 let cursor = if pts[0].1 == dims.cols {
5315 (cursor_row + 1, 0)
5316 } else {
5317 (cursor_row, pts[0].1)
5318 };
5319
5320 // The bound on a tracked line belongs **here**, not inside `reflow`: this is where the final
5321 // geometry is known. The screen is padded to `dims.rows` whatever `reflow` emitted, so this
5322 // pane's last addressable line is `split + dims.rows - 1`. Bounding against `reflow`'s own row
5323 // count instead clamped away rows the fit was about to create (#562), while still being the
5324 // only thing standing between an out-of-range anchor and a panic in the consumer's process —
5325 // selection anchors and marks are written back raw, unlike the cursor (`Cursor::set_point`).
5326 // Expressed in this pane's own frame, so it is the same frame `extras` and `evicted` are in.
5327 let max_line = split + dims.rows - 1;
5328
5329 // The cursor returns to screen-relative (its absolute index minus the history split). The
5330 // extras stay in this pane's frame — see the field docs for why they are not shifted here.
5331 PaneReflow {
5332 cursor,
5333 extras: pts[1..]
5334 .iter()
5335 .map(|&(l, c)| (l.min(max_line), c))
5336 .collect(),
5337 evicted: dropped,
5338 screen: all,
5339 scrollback: sb,
5340 }
5341}
5342
5343/// Default tab stops: one every 8 columns (incl. column 0), matching xterm.
5344fn default_tabs(cols: usize) -> Vec<bool> {
5345 (0..cols).map(is_default_tab_stop).collect()
5346}
5347
5348/// Whether `col` carries a stop in the default ladder.
5349///
5350/// Shared by the table the constructor builds and the extension [`Term::resize`]
5351/// performs, which fills at the *absolute* column index. The two must not drift,
5352/// and a second literal `8` is exactly how they would.
5353fn is_default_tab_stop(col: usize) -> bool {
5354 col.is_multiple_of(8)
5355}
5356
5357/// First sub-parameter of CSI param `idx`, or `default` when absent or zero
5358/// (a zero/omitted numeric param means "1" for cursor movement and "0" for
5359/// erase — callers pass the right default).
5360/// Push onto an XTWINOPS title stack, bounded at [`TITLE_STACK_DEPTH`] (#823).
5361///
5362/// At the bound the **oldest** entry goes and the push still succeeds, which is
5363/// what both implementations carrying this feature do — xterm.js `shift()`s its
5364/// array, alacritty `remove(0)`s its `Vec`, and xterm wraps a fixed-size one.
5365/// The alternative (refuse the push) is worse in the case that actually occurs:
5366/// it breaks the pairing for the innermost nesting levels, and those are the
5367/// ones a user unwinds first.
5368fn push_title(stack: &mut Vec<String>, value: String) {
5369 if stack.len() >= TITLE_STACK_DEPTH {
5370 stack.remove(0);
5371 }
5372 stack.push(value);
5373}
5374
5375fn param_or(params: &Params, idx: usize, default: u16) -> u16 {
5376 match params.iter().nth(idx).and_then(|p| p.first().copied()) {
5377 Some(v) if v != 0 => v,
5378 _ => default,
5379 }
5380}
5381
5382/// The `Pv` field of the secondary device-attributes report (#824), derived
5383/// from the crate version so a release cannot ship a report that disagrees
5384/// with what was published.
5385///
5386/// Semver components are padded base-100, so a higher version always reports a
5387/// higher number. That is alacritty's scheme, and it is a *reinterpretation* of
5388/// the spec rather than a divergence from it: `ctlseqs.txt` calls `Pv` "the
5389/// firmware version" and fixes no encoding for it.
5390///
5391/// **The encoding has a functional floor, and it is not cosmetic.** Measured on
5392/// a real pty by sweeping this field alone (RHEL 9.2, vim 8.2), vim picks its
5393/// mouse protocol off `Pv`:
5394///
5395/// ```text
5396/// Pv < 95 -> ttymouse=xterm (no upgrade at all)
5397/// Pv = 95 -> ttymouse=sgr (vim special-cases the exact >1;95;0c
5398/// signature that macOS Terminal sends)
5399/// 95..276 -> ttymouse=xterm2
5400/// Pv >= 277 -> ttymouse=sgr
5401/// ```
5402///
5403/// The mouse rows above reproduced across two independent runs, 11 arms each,
5404/// with no-reply controls bracketing both.
5405///
5406/// A further gate sits on the same field: vim's XTGETTCAP key-code
5407/// interrogation, which its `term.txt` (*xterm-codes*) documents as needing a
5408/// response indicating "patchlevel 141 or higher". Measured here only to the
5409/// extent of bracketing — present at 276 and 1500, absent at 1, 94 and 95 — so
5410/// the doc's 141 is consistent but not independently pinned. The number
5411/// therefore gates upgrades at three separate thresholds rather than one, and
5412/// 1500 clears all three.
5413///
5414/// justerm at 0.15.0 maps to 1500 and clears it comfortably. A `0.2.x` would map
5415/// to 200 and silently cost every consumer the SGR mouse encoding — so the
5416/// base-100 scheme is load-bearing for a reason that has nothing to do with
5417/// monotonicity, and lowering the base would be a behavioural change.
5418///
5419/// Three edges, all deliberate. A component of 100 or more carries into the
5420/// next place — justerm is far from that, and widening the base would change
5421/// every number already reported for no measured gain. The pre-release suffix
5422/// is cut at the **first** hyphen, which is where semver says it begins;
5423/// alacritty cuts at the last, which mis-parses a two-part suffix like
5424/// `-rc.1-dev`. And the monotonicity above holds only below `u16::MAX`: a CSI
5425/// parameter is a `u16` in `vte` (saturating), and ghostty types the field
5426/// `firmware_version: u16`, so a `Pv` past 65535 — major version 7 — reaches a
5427/// receiver saturated. alacritty carries the same latent property; the corpus
5428/// prescribes no wider encoding, so this is recorded rather than designed
5429/// around.
5430const fn version_number(version: &str) -> u32 {
5431 let bytes = version.as_bytes();
5432 let mut parts = [0u32; 3];
5433 let mut part = 0usize;
5434 let mut i = 0usize;
5435 while i < bytes.len() {
5436 let b = bytes[i];
5437 if b == b'-' || b == b'+' {
5438 break;
5439 } else if b == b'.' {
5440 part += 1;
5441 if part >= 3 {
5442 break;
5443 }
5444 } else if b.is_ascii_digit() {
5445 parts[part] = parts[part] * 10 + (b - b'0') as u32;
5446 }
5447 i += 1;
5448 }
5449 parts[0] * 10_000 + parts[1] * 100 + parts[2]
5450}
5451
5452/// `Pp` of the secondary DA report: 1 = VT220, from the spec's closed table
5453/// (`ctlseqs.txt:825`). It names the same terminal DA1 already advertises —
5454/// `CSI ? 62 ; 22 c`, where 62 *is* VT220 (`ctlseqs.txt:778`).
5455///
5456/// The two are not forced to agree in general: DA1's first parameter is an
5457/// operating **level** and `Pp` a device **type**, and xterm can decouple them
5458/// through DECTID. justerm implements neither DECTID nor DECSCL, so nothing
5459/// here can decouple them — which is why one terminal identity is the only
5460/// coherent answer, not because disagreeing would be malformed.
5461///
5462/// ghostty is the convergence check: it derives both from one device type
5463/// (`src/terminal/device_attributes.zig:82`, `:161` @ `e6e26e1`) and pairs a
5464/// level-62 DA1 with `Pp = 1` (`src/termio/stream_handler.zig:843`). Its DA1 is
5465/// *not* byte-identical to justerm's at its default — `clipboard-write` is
5466/// `.allow` (`src/config/Config.zig:2380`), which appends `;52`; the identical
5467/// string is its deny branch. alacritty pairs `?6c` (VT102) with `Pp = 0` and
5468/// xterm.js `?1;2c` (VT100) with `Pp = 0`, both of which are what this same
5469/// rule produces at those levels — so neither is a counterexample, and no
5470/// reference in the corpus pairs a level-62 DA1 with a `Pp` other than 1.
5471const DA2_TERMINAL_TYPE: u32 = 1;
5472
5473/// `Pc` of the secondary DA report: 0.
5474///
5475/// The ground is first-principles and needs no reference: `Pc` is a **ROM
5476/// cartridge registration number**, justerm has no cartridge, and 0 is the
5477/// absence value. That is how both implementations that comment the field read
5478/// it — xterm writes it as `/* options (none) */` (`charproc.c:4267`) and
5479/// ghostty as *"Always 0 for emulators"* (`src/terminal/device_attributes.zig:88`
5480/// @ `e6e26e1`). xterm.js sends 0 in all three of its branches; alacritty alone
5481/// sends 1 (`alacritty_terminal/src/term/mod.rs:1267` @ `852e971`).
5482///
5483/// **What does *not* carry this choice, stated because it looks like it should.**
5484/// `ctlseqs.txt:839` says `Pc` *"is always zero"* only of a **DEC terminal** —
5485/// a description of hardware in xterm's own documentation, not a requirement on
5486/// emulators. And ADR-0004 tie-breaks the spec against alacritty where alacritty
5487/// *"merely omits or under-implements"*; here alacritty **contradicts**, which
5488/// is neither of its branches, and its other branch (genuine ambiguity → follow
5489/// alacritty) would give 1. So the value rests on the argument above and on the
5490/// 3-1 head count, not on a spec mandate that does not exist.
5491const DA2_ROM_CARTRIDGE: u32 = 0;
5492
5493/// The `Pv` this build reports, folded at compile time so the doc-comment above
5494/// is literally true and the query path does no arithmetic.
5495const DA2_VERSION: u32 = version_number(env!("CARGO_PKG_VERSION"));
5496
5497impl Term {
5498 /// Apply one DEC private mode set (`'h'`) or reset (`'l'`). DECSET/DECRST
5499 /// carry a list of modes, so `csi_dispatch` folds this over every parameter
5500 /// (#56); each mode is an independent toggle, not a stack.
5501 fn set_dec_private_mode(&mut self, action: char, mode: u16) {
5502 match (action, mode) {
5503 ('h', 1049) => self.enter_alt_screen(),
5504 ('l', 1049) => self.leave_alt_screen(),
5505 // Legacy alt-screen variants (#72): ?47/?1047 switch the buffer
5506 // without saving the cursor; ?1048 saves/restores the cursor without
5507 // switching. ?1049 is the two combined.
5508 ('h', 47) | ('h', 1047) => self.switch_to_alt(),
5509 ('l', 47) | ('l', 1047) => self.switch_to_primary(),
5510 ('h', 1048) => self.save_alt_cursor(),
5511 ('l', 1048) => self.restore_alt_cursor(),
5512 ('h', 6) => {
5513 // DECOM: set homes the cursor to the region top.
5514 self.origin_mode = true;
5515 self.goto(0, 0);
5516 }
5517 ('l', 6) => self.origin_mode = false, // unset leaves the cursor put
5518 ('h', 7) => self.autowrap = true, // DECAWM
5519 ('l', 7) => self.autowrap = false,
5520 ('h', 45) => self.reverse_wraparound = true, // reverse wraparound (#80)
5521 ('l', 45) => self.reverse_wraparound = false,
5522 // DECCOLM (#82): the engine is dimension-free, so emit a request the
5523 // consumer may honor by resizing — no screen/cursor/margin change here.
5524 ('h', 3) => self.events.push(TermEvent::ColumnMode { cols: 132 }),
5525 ('l', 3) => self.events.push(TermEvent::ColumnMode { cols: 80 }),
5526 ('h', 25) => self.cursor.visible = true, // DECTCEM show
5527 ('l', 25) => self.cursor.visible = false, // DECTCEM hide
5528 ('h', 12) => self.cursor.blink = true, // att610 cursor blink (#81)
5529 ('l', 12) => self.cursor.blink = false,
5530 ('h', 2004) => self.bracketed_paste = true,
5531 ('l', 2004) => self.bracketed_paste = false,
5532 ('h', 2026) => self.synchronized_output = true, // synchronized output (#73)
5533 ('l', 2026) => self.synchronized_output = false,
5534 ('h', 2027) => self.grapheme_clustering = true, // grapheme-cluster mode (#295)
5535 ('l', 2027) => self.grapheme_clustering = false,
5536 ('h', 2031) => self.color_scheme_updates = true, // color-scheme notifications (#85)
5537 ('l', 2031) => self.color_scheme_updates = false,
5538 ('h', 9001) => self.win32_input_mode = true, // win32-input-mode (#86)
5539 ('l', 9001) => self.win32_input_mode = false,
5540
5541 // Input-encoding modes (#11): DECCKM, mouse tracking + encoding,
5542 // focus reporting. Each set assigns the level; each reset clears
5543 // it (apps enable/disable the same mode, not a stack).
5544 ('h', 1) => self.app_cursor_keys = true, // DECCKM
5545 ('l', 1) => self.app_cursor_keys = false,
5546 ('h', 66) => self.application_keypad = true, // DECNKM (#74)
5547 ('l', 66) => self.application_keypad = false,
5548 // DECANM (#84): set = ANSI (the normal state); reset enters VT52. Only
5549 // the reset is meaningful — `?2h` is a no-op (already ANSI).
5550 ('l', 2) => self.vt52_mode = true,
5551 ('h', 9) => self.mouse_protocol = MouseProtocol::X10, // X10 mouse (#70)
5552 ('h', 1000) => self.mouse_protocol = MouseProtocol::Normal,
5553 ('h', 1002) => self.mouse_protocol = MouseProtocol::ButtonEvent,
5554 ('h', 1003) => self.mouse_protocol = MouseProtocol::AnyEvent,
5555 ('l', 9) | ('l', 1000) | ('l', 1002) | ('l', 1003) => {
5556 self.mouse_protocol = MouseProtocol::Off
5557 }
5558 ('h', 1006) => self.mouse_encoding = MouseEncoding::Sgr,
5559 ('l', 1006) => self.mouse_encoding = MouseEncoding::Default,
5560 ('h', 1015) => self.mouse_encoding = MouseEncoding::Urxvt,
5561 ('l', 1015) => self.mouse_encoding = MouseEncoding::Default,
5562 ('h', 1005) => self.mouse_encoding = MouseEncoding::Utf8,
5563 ('l', 1005) => self.mouse_encoding = MouseEncoding::Default,
5564 ('h', 1016) => self.mouse_encoding = MouseEncoding::SgrPixels,
5565 ('l', 1016) => self.mouse_encoding = MouseEncoding::Default,
5566 ('h', 1004) => self.focus_events = true,
5567 ('l', 1004) => self.focus_events = false,
5568
5569 _ => {} // other DEC modes are later slices
5570 }
5571 }
5572
5573 /// Dispatch one VT52 escape sequence (`ESC <final>`), reached only while
5574 /// `vt52_mode` is set (#84). VT52 is a pre-ANSI dialect: the cursor/erase
5575 /// finals map to the same `Term` primitives the ANSI path uses. `ESC <`
5576 /// returns to ANSI. Unknown finals are ignored.
5577 fn vt52_dispatch(&mut self, byte: u8) {
5578 match byte {
5579 b'A' => self.move_up(1), // cursor up
5580 b'B' => self.move_down(1), // cursor down
5581 b'C' => self.move_forward(1), // cursor right
5582 b'D' => self.move_back(1), // cursor left
5583 b'H' => self.goto(0, 0), // cursor home
5584 b'I' => self.reverse_index(), // reverse line feed
5585 b'J' => self.erase_display(0), // erase cursor → end of screen
5586 b'K' => self.erase_line(0), // erase cursor → end of line
5587 b'Y' => self.vt52_y_pending = 2, // direct address: two coord bytes follow
5588 // Identify (DECID): reply `ESC / Z` — "I am a VT52".
5589 b'Z' => self.replies.extend_from_slice(b"\x1b/Z"),
5590 b'=' => self.application_keypad = true, // enter alternate keypad
5591 b'>' => self.application_keypad = false, // exit alternate keypad
5592 b'<' => self.vt52_mode = false, // exit VT52, return to ANSI
5593 // RIS (`ESC c`) is honored even here: it is a hard "recover from any
5594 // state" reset, and `full_reset` rebuilds `Term` with `vt52_mode`
5595 // cleared, so RIS always escapes VT52 back to ANSI. VT52 defines no
5596 // other meaning for `ESC c`.
5597 b'c' => self.full_reset(),
5598 // Graphics mode (`ESC F`/`ESC G`) is a documented non-goal: the VT52
5599 // graphics glyph set differs from DEC Special Graphics, so reusing that
5600 // charset would render the wrong glyphs. No-op rather than approximate.
5601 b'F' | b'G' => {}
5602 _ => {} // unknown VT52 finals are ignored
5603 }
5604 }
5605
5606 /// Consume one `ESC Y` coordinate byte (#84). The first byte is the row, the
5607 /// second the column; each decodes as `value - 0x20`. On the second byte the
5608 /// cursor is addressed (`goto` clamps out-of-range coordinates). Reached only
5609 /// from `print` while `vt52_y_pending > 0`.
5610 fn vt52_take_coord(&mut self, c: char) {
5611 let coord = (c as usize).saturating_sub(0x20);
5612 if self.vt52_y_pending == 2 {
5613 self.vt52_y_row = coord;
5614 self.vt52_y_pending = 1;
5615 } else {
5616 self.vt52_y_pending = 0;
5617 self.goto(self.vt52_y_row, coord);
5618 }
5619 }
5620
5621 /// The allocation an OSC 8 `id=` names: the live one if that id already named a link
5622 /// with this same URI, else a fresh one recorded under the key (#635).
5623 ///
5624 /// Keyed on **id and URI together**, mirroring xterm.js's `_getEntryIdKey`
5625 /// (`` `${id};;${uri}` ``, `OscLinkService.ts:87`). Keying on the id alone would follow
5626 /// a reused id to a stale target — an application saying "same link" about two
5627 /// different destinations has not said anything the engine should honour.
5628 fn link_for_id(&mut self, id: &str, uri: &str) -> std::sync::Arc<str> {
5629 let key = format!("{id};;{uri}");
5630 // A key whose link has left the buffer is *absent*, not stale — the group it named
5631 // is gone, so this open starts a new one. That is xterm.js's behaviour too, reached
5632 // by deleting the entry rather than by letting a reference die.
5633 if let Some(live) = self.link_ids.get(&key).and_then(std::sync::Weak::upgrade) {
5634 return live;
5635 }
5636 // Amortised sweep before inserting, so dangling keys stay O(live) rather than
5637 // O(ids ever declared). Doubling the threshold keeps it O(1) per open.
5638 if self.link_ids.len() >= self.link_ids_sweep_at {
5639 self.link_ids.retain(|_, weak| weak.strong_count() > 0);
5640 self.link_ids_sweep_at = (self.link_ids.len() * 2).max(LINK_IDS_FIRST_SWEEP);
5641 }
5642 let fresh: std::sync::Arc<str> = std::sync::Arc::from(uri);
5643 self.link_ids.insert(key, std::sync::Arc::downgrade(&fresh));
5644 fresh
5645 }
5646}
5647
5648impl Perform for Term {
5649 fn print(&mut self, c: char) {
5650 // VT52 `ESC Y` direct addressing (#84): vte delivers the two coordinate
5651 // bytes here (it returned to ground after the `Y` final), so intercept
5652 // them before they would be written as glyphs.
5653 if self.vt52_y_pending > 0 {
5654 self.vt52_take_coord(c);
5655 return;
5656 }
5657 // Translate through the active (GL) character set first (#62): under DEC
5658 // Special Graphics a printable byte becomes a line-drawing glyph.
5659 let c = self.charsets[self.gl].map(c);
5660 self.place_grapheme(c);
5661 }
5662
5663 /// A DCS is terminated: not a print, so the repeat is disarmed (#825). This method
5664 /// exists for that alone — the payload is otherwise unhandled — and it is reachable
5665 /// in ordinary use: since #824 answered DA2, `vim` follows up with XTGETTCAP
5666 /// (`DCS + q <hex> ST`) queries this engine does not answer. Both halves of that
5667 /// are pinned on recorded bytes rather than asserted — `tests/closed_loop_capture.rs`
5668 /// (#891).
5669 ///
5670 /// The end of the DCS and not its start, which is both xterm's rule (its gate fires
5671 /// when the parser returns to the ground state) and the only half that can be shown
5672 /// to matter: no CSI can arrive between `hook` and here, so a disarm in `hook` is a
5673 /// guard no mutation can redden.
5674 ///
5675 /// Which DCS terminator is fed decides whether this line is load-bearing at all,
5676 /// measured by deleting it (`-`, a DCS, then `CSI 3 b`, counting dashes):
5677 ///
5678 /// | terminator | dashes without this line |
5679 /// |---|---|
5680 /// | `ESC \` (7-bit ST) | 1 — `esc_dispatch` disarms on the `\` |
5681 /// | `0x9C` (8-bit ST, which DCS accepts where OSC refuses it — #847) | 4 |
5682 /// | none; aborted by the `ESC` of the next sequence | 4 |
5683 ///
5684 /// So a test that feeds only `ESC \` proves nothing here, which is what the first
5685 /// version of `rep_after_a_dcs_repeats_nothing` did.
5686 ///
5687 /// The last row is a **deliberate divergence from xterm**, in the safe direction:
5688 /// an unterminated DCS never returns xterm's parser to the ground state, so xterm
5689 /// would still repeat, while `vte` calls this on the abort and this engine does
5690 /// not. Disarming too eagerly can only turn `REP` into a no-op.
5691 fn unhook(&mut self) {
5692 self.repeat_anchor = None;
5693 }
5694
5695 fn execute(&mut self, byte: u8) {
5696 // Not a print, so the repeat is disarmed (#825, [`Term::repeat_anchor`]). This
5697 // is also where `CAN` and `SUB` land, which abort a sequence in every state.
5698 self.repeat_anchor = None;
5699 match byte {
5700 // LF, VT, FF all line-feed.
5701 b'\n' | 0x0b | 0x0c => self.linefeed(),
5702 b'\r' => self.carriage_return(),
5703 0x08 => self.backspace(),
5704 b'\t' => self.put_tab(),
5705 0x07 => self.events.push(TermEvent::Bell), // BEL (#12)
5706 0x0e => self.gl = 1, // SO (LS1): GL = G1 (#62)
5707 0x0f => self.gl = 0, // SI (LS0): GL = G0
5708 _ => {}
5709 }
5710 }
5711
5712 fn csi_dispatch(&mut self, params: &Params, intermediates: &[u8], _ignore: bool, action: char) {
5713 // Every completed CSI disarms `REP` (#825, [`Term::repeat_anchor`]). It is
5714 // *taken* here rather than cleared on the way out because this function has
5715 // six early returns and a clear at the end would miss all of them; `REP` is
5716 // the one arm that needs the value, and it puts it back.
5717 let repeat_anchor = self.repeat_anchor.take();
5718 // Kitty keyboard-protocol negotiation: CSI > / = / < / ? ... u. The
5719 // leading intermediate distinguishes it from plain `CSI u` (SCORC) (#23).
5720 if action == 'u'
5721 && let Some(&lead) = intermediates.first()
5722 && matches!(lead, b'>' | b'<' | b'=' | b'?')
5723 {
5724 self.kitty_dispatch(lead, params);
5725 return;
5726 }
5727 // DEC private modes arrive with a '?' intermediate.
5728 if intermediates.first() == Some(&b'?') {
5729 // DECRQM (CSI ? Ps $ p) — report whether mode Ps is set. The '$'
5730 // intermediate distinguishes it from a plain `?...p`. It queries a
5731 // single mode, so it keys off the first parameter only.
5732 if action == 'p' && intermediates.contains(&b'$') {
5733 self.decrqm(param_or(params, 0, 0));
5734 return;
5735 }
5736 // Private DSR (CSI ? Ps n): ?996 = color-scheme query (#85). The
5737 // theme-agnostic engine relays it as an event for the consumer.
5738 if action == 'n' {
5739 if param_or(params, 0, 0) == 996 {
5740 self.events.push(TermEvent::ColorSchemeQuery);
5741 }
5742 return;
5743 }
5744 // DECSET/DECRST carry a *list* of modes; apply set/reset to EVERY
5745 // parameter, not just the first — htop batches `?1006;1000h` into one
5746 // CSI, so folding only params[0] dropped the 1000 (#56).
5747 for mode in params.iter().filter_map(|p| p.first().copied()) {
5748 self.set_dec_private_mode(action, mode);
5749 }
5750 return;
5751 }
5752 // DECSTR soft reset: CSI ! p (#53).
5753 if intermediates.first() == Some(&b'!') && action == 'p' {
5754 self.soft_reset();
5755 return;
5756 }
5757 // DECSCUSR set cursor style: CSI Ps SP q (space intermediate) (#89). The raw
5758 // value is read, since `param_or` folds 0 to its default and 0 is the reset.
5759 // `CSI SP q` arrives from vte as an explicit 0; `unwrap_or(1)` covers a
5760 // params list with no entry at all.
5761 if intermediates.first() == Some(&b' ') && action == 'q' {
5762 let param = params.iter().next().and_then(|p| p.first().copied());
5763 self.set_cursor_style(param.unwrap_or(1));
5764 return;
5765 }
5766 // DA2 (secondary device attributes, CSI > c) — the query vim uses to
5767 // fill `v:termresponse` and identify what it is talking to (#824).
5768 //
5769 // What answering it actually buys, measured as a control pair on a real
5770 // pty (RHEL 9.2, vim 8.2, TERM=xterm-256color, 24x80; every other query
5771 // answered identically in both arms, controls run before and after):
5772 //
5773 // no reply -> ttymouse=xterm
5774 // ESC[>1;1500;0c -> ttymouse=sgr
5775 //
5776 // The mouse protocol is what the version number buys *directly*: legacy
5777 // `xterm` encoding cannot report a column past 223 and cannot report a
5778 // release, `sgr` has neither limit.
5779 //
5780 // It is not the only effect, and the second one is the larger. Answering
5781 // also makes vim **ask ten more questions** — `DCS + q <hex> ST`
5782 // (XTGETTCAP) for `Co`, `ku`, `kd`, `kl`, `kr`, `k1`, `#2`, `#4`, `%i`
5783 // and `*7`: the colour count and the arrow / function / shifted key
5784 // codes. vim's own `term.txt` gates that on the reply indicating
5785 // "patchlevel 141 or higher", and its point is that a terminal produces
5786 // different key codes in different modes, so it asks instead of
5787 // guessing. Measured rather than taken from the doc: the requests appear
5788 // at `Pv` 276 and 1500 and are absent at 1, 94 and 95, which brackets the
5789 // gate to (95, 276] and is consistent with 141 without pinning it. What
5790 // is stable across runs is whether they appear at all; *how many* arrive
5791 // is not — one arm sent each capability once where every other sent it
5792 // twice. **justerm answers none of those today** — they fall to the
5793 // same intermediate catch-all this block sits above — so the capability
5794 // is unlocked and then unanswered. That is the honest state, and it is
5795 // #47 tail rather than this slice.
5796 //
5797 // modifyOtherKeys is *not* gated on any of it: vim emits `CSI > 4 ; 2 m`
5798 // about 180 bytes before it asks.
5799 //
5800 // `>` reaches us as an *intermediate*, so DA2 was not "unhandled" but
5801 // unreachable: the catch-all below returns before the final is ever
5802 // examined. This opened exactly one route through it — the `>` prefix
5803 // alone, with the `c` final. **A second one is open now**: the `m`
5804 // final, for XTMODKEYS (#890), in the block immediately below this one.
5805 //
5806 // It is one route out of ten `>` finals xterm routes, and the choice is
5807 // reach, not completeness: across this repo's capture corpus `CSI > c`
5808 // occurs 5 times and XTMODKEYS `CSI > m` 10 (re-measured 2026-09-11 after
5809 // #891 added a twentieth fixture; they read 4 and 7 when #890 chose on
5810 // them, and the order the choice turned on is unchanged) — the latter is
5811 // the highest-reach `>` sequence justerm did not route, which is why it
5812 // was the next one taken (#890) rather than a later one — it no longer falls
5813 // through here. XTVERSION `CSI > q` occurs **once**, in `tmux_clipboard.raw`.
5814 //
5815 // Both numbers moved after this paragraph was written, and the second one
5816 // changed sign: it said `> q` occurred *zero* times, which was true on
5817 // 2026-09-01 and false on 2026-09-02, when #842 checked in a tmux capture
5818 // that contains one (re-measured 2026-09-11, and a fresh tmux attach
5819 // recorded the same day emits it too — tmux asks unconditionally). A count
5820 // taken from a corpus is only ever true of one revision of it.
5821 //
5822 // And it is a floor rather than a measurement of reach, because all but one
5823 // capture is **open-loop** — recorded under `script(1)` or a bare `expect`,
5824 // both of which answer nothing, so no sequence an application only sends *after* a reply can
5825 // appear in it. The signature is in the corpus: answering DA2 makes vim ask
5826 // ten `DCS + q` XTGETTCAP questions, and `DCS + q` occurs **zero** times
5827 // across every open-loop fixture, four of which ask DA2. The exception is
5828 // `vim_closed_loop.raw`, which holds all ten (#891) — what it cost to record
5829 // one, and why its bytes are a function of a consumer policy as well as of
5830 // vim, is in `docs/map/territory/vt-interpretation.md`.
5831 //
5832 // The match is on the whole slice rather than `.first()`, so
5833 // `CSI > $ c` is not DA2. That is 3-1: xterm drops it
5834 // (`VTPrsTbl.c:4747`, `$` is CASE_CSI_IGNORE inside `dec2_table`),
5835 // ghostty drops it (`src/terminal/stream.zig:1612`, `else => null`) and
5836 // xterm.js drops it (its handler key packs prefix *and* intermediates,
5837 // `InputHandler.ts:233`), while alacritty **would answer** it
5838 // (`vte-0.15.0/src/ansi.rs:1572` passes `intermediates.first()`). No
5839 // producer of that form exists in any pinned corpus, so this is a
5840 // divergence with no measured reach — pinned by a test regardless,
5841 // because the predicate is otherwise unfalsifiable.
5842 if intermediates == [b'>'] && action == 'c' {
5843 // Only `Ps = 0` or omitted is a request; a qualifier we do not
5844 // recognise is answered with silence rather than with a report that
5845 // does not address it. xterm (`charproc.c:4220`), xterm.js
5846 // (`InputHandler.ts:1738`) and alacritty (`ansi.rs:1572`) all gate
5847 // this way; ghostty reads no parameter at all and has no test that
5848 // would notice.
5849 if param_or(params, 0, 0) == 0 {
5850 self.replies.extend_from_slice(
5851 format!("\x1b[>{DA2_TERMINAL_TYPE};{DA2_VERSION};{DA2_ROM_CARTRIDGE}c")
5852 .as_bytes(),
5853 );
5854 }
5855 return;
5856 }
5857 // XTMODKEYS (`CSI > Pp ; Pv m`) — the second route through the `>` guard, and
5858 // the highest-reach one: 10 occurrences across this repo's captures against
5859 // DA2's 5, all of them `Pp = 4` (modifyOtherKeys). `vim` sets it at startup
5860 // and clears it on exit, and the clear is the more frequent of the two.
5861 //
5862 // **Only `Pp = 4` is routed**, of the eight resources xterm keys off this one final;
5863 // `CSI > m` is deliberately not honoured, because an omitted `Pp` is measurably
5864 // indistinguishable from one aimed at another resource. **`Pv >= 2`, not `== 2`**:
5865 // level 2 is what separates `Ctrl+I` from `Tab`, and 3 asks for more than 2 rather
5866 // than for nothing. Both, with the reference sites, are in
5867 // `docs/agents/reference-facts.md` (#890).
5868 if intermediates == [b'>'] && action == 'm' {
5869 if param_or(params, 0, 0) == 4 {
5870 self.modify_other_keys_2 = param_or(params, 1, 0) >= 2;
5871 }
5872 return;
5873 }
5874 // Other private/intermediate sequences are later slices; ignore them
5875 // rather than misinterpret.
5876 if !intermediates.is_empty() {
5877 return;
5878 }
5879 match action {
5880 'A' => self.move_up(param_or(params, 0, 1) as usize),
5881 'B' => self.move_down(param_or(params, 0, 1) as usize),
5882 'e' => self.vertical_position_relative(param_or(params, 0, 1) as usize),
5883 // CNL / CPL (CSI Ps E / F): CUD / CUU, then CR (#898).
5884 'E' => {
5885 self.move_down(param_or(params, 0, 1) as usize);
5886 self.carriage_return();
5887 }
5888 'F' => {
5889 self.move_up(param_or(params, 0, 1) as usize);
5890 self.carriage_return();
5891 }
5892 'C' | 'a' => self.move_forward(param_or(params, 0, 1) as usize),
5893 'D' => self.move_back(param_or(params, 0, 1) as usize),
5894 // CBT (CSI Ps Z): back-tab, the mirror of HT over the tab-stop
5895 // table. Cursor motion only — it writes no cell (#826).
5896 'Z' => self.put_back_tab(param_or(params, 0, 1) as usize),
5897 // CHT (CSI Ps I): forward tab, the counted HT (#898).
5898 'I' => self.put_forward_tabs(param_or(params, 0, 1) as usize),
5899 // REP (CSI Ps b): repeat the preceding grapheme. `param_or` folds an
5900 // absent parameter and an explicit zero to one, as everywhere else here.
5901 'b' => {
5902 // The three lines are one rule and their order is the rule: put back
5903 // what this dispatch took, repeat, then clear what the repeats re-armed
5904 // through the print path. That is xterm's lifecycle — the byte
5905 // completing `CSI b` returns the parser to the ground state with nothing
5906 // printed, so a second `CSI b` repeats nothing. ghostty is the outlier
5907 // and re-arms (`printRepeat` calls `print`); pinned by
5908 // `rep_does_not_rearm_itself` (#825).
5909 self.repeat_anchor = repeat_anchor;
5910 self.repeat_last(param_or(params, 0, 1) as usize);
5911 self.repeat_anchor = None;
5912 }
5913 'G' | '`' => self.set_col(param_or(params, 0, 1) as usize - 1),
5914 'd' => self.set_row(param_or(params, 0, 1) as usize - 1),
5915 'H' | 'f' => {
5916 let row = param_or(params, 0, 1) as usize - 1;
5917 let col = param_or(params, 1, 1) as usize - 1;
5918 self.goto(row, col);
5919 }
5920 'J' => self.erase_display(param_or(params, 0, 0)),
5921 'K' => self.erase_line(param_or(params, 0, 0)),
5922 'X' => self.erase_chars(param_or(params, 0, 1) as usize),
5923 '@' => self.insert_chars(param_or(params, 0, 1) as usize),
5924 'P' => self.delete_chars(param_or(params, 0, 1) as usize),
5925 'S' => self.scroll_up_lines(param_or(params, 0, 1) as usize),
5926 'T' => self.scroll_down_lines(param_or(params, 0, 1) as usize),
5927 'L' => self.insert_lines(param_or(params, 0, 1) as usize),
5928 'M' => self.delete_lines(param_or(params, 0, 1) as usize),
5929 'g' => self.clear_tab_stop(param_or(params, 0, 0)),
5930 'r' => {
5931 let rows = self.grid.rows() as u16;
5932 let top = param_or(params, 0, 1) as usize;
5933 let bottom = param_or(params, 1, rows) as usize;
5934 self.set_scroll_region(top, bottom);
5935 }
5936 'm' => self.sgr(params),
5937 's' => self.save_cursor(), // SCOSC (CSI s) — alias of DECSC
5938 't' => self.window_ops(params), // XTWINOPS — only 22/23 (#823)
5939 'u' => self.restore_cursor(), // SCORC (CSI u) — alias of DECRC
5940 // DA1 (primary device attributes, CSI c): advertise VT220 + ANSI
5941 // colour — the levels justerm actually implements (#27).
5942 'c' => self.replies.extend_from_slice(b"\x1b[?62;22c"),
5943 'n' => self.device_status_report(param_or(params, 0, 0)),
5944 // Non-private SM/RM. Folded over every parameter (modes can batch,
5945 // like the private path #56). IRM (4) and LNM (20) so far.
5946 'h' => {
5947 for m in params.iter().filter_map(|p| p.first().copied()) {
5948 match m {
5949 4 => self.insert_mode = true,
5950 20 => self.newline_mode = true,
5951 _ => {}
5952 }
5953 }
5954 }
5955 'l' => {
5956 for m in params.iter().filter_map(|p| p.first().copied()) {
5957 match m {
5958 4 => self.insert_mode = false,
5959 20 => self.newline_mode = false,
5960 _ => {}
5961 }
5962 }
5963 }
5964 _ => {}
5965 }
5966 }
5967
5968 fn esc_dispatch(&mut self, intermediates: &[u8], _ignore: bool, byte: u8) {
5969 // Not a print: the repeat is disarmed (#825, [`Term::repeat_anchor`]).
5970 self.repeat_anchor = None;
5971 // VT52 mode (#84): the pre-ANSI dialect reuses the same `ESC <final>`
5972 // tokens vte already produces, but with different meanings, so it is a
5973 // mode-gated branch here rather than a separate parser. All VT52 sequences
5974 // are intermediate-free; anything with an intermediate is not VT52.
5975 if self.vt52_mode && intermediates.is_empty() {
5976 self.vt52_dispatch(byte);
5977 return;
5978 }
5979 if let Some(&i) = intermediates.first() {
5980 // SCS: designate a charset to G0 (`ESC ( F`) or G1 (`ESC ) F`) (#62).
5981 if matches!(i, b'(' | b')') {
5982 let set = match byte {
5983 b'0' => Charset::DecSpecialGraphics,
5984 b'A' => Charset::Uk,
5985 b'B' => Charset::Ascii,
5986 _ => return, // other sets are later slices
5987 };
5988 self.charsets[if i == b'(' { 0 } else { 1 }] = set;
5989 }
5990 // Other intermediates (G2/G3 designators, etc.) are later slices.
5991 return;
5992 }
5993 match byte {
5994 b'D' => self.linefeed(), // IND (line-feed without CR)
5995 b'E' => {
5996 // NEL (next line): carriage return + line-feed.
5997 self.carriage_return();
5998 self.linefeed();
5999 }
6000 b'H' => self.set_tab_stop(), // HTS
6001 b'M' => self.reverse_index(), // RI
6002 b'7' => self.save_cursor(), // DECSC
6003 b'8' => self.restore_cursor(), // DECRC
6004 b'c' => self.full_reset(), // RIS (#53)
6005 b'=' => self.application_keypad = true, // DECKPAM (#74)
6006 b'>' => self.application_keypad = false, // DECKPNM
6007 _ => {}
6008 }
6009 }
6010
6011 /// OSC dispatch (#12 event surface): title (0/2), cwd (7). OSC 8 hyperlink
6012 /// is per-cell state, handled in its own slice (#26), not here.
6013 fn osc_dispatch(&mut self, params: &[&[u8]], bell_terminated: bool) {
6014 // Not a print: the repeat is disarmed (#825, [`Term::repeat_anchor`]).
6015 self.repeat_anchor = None;
6016 // Which byte ended the sequence decides which byte ends its reply, and
6017 // this is the only place it is observable — vte hands it over per
6018 // dispatch and keeps nothing (#836). It rides outward on the query
6019 // events rather than being remembered: `drain_events` is a batch, so
6020 // two queries can be outstanding at once and one stored scalar could
6021 // not say which exchange it belonged to.
6022 let terminator = if bell_terminated {
6023 Terminator::Bel
6024 } else {
6025 Terminator::St
6026 };
6027 // params[0] is the OSC number; params[1..] the payload fields.
6028 let Some(&number) = params.first() else {
6029 return;
6030 };
6031 match number {
6032 // OSC 0 = icon + window title, OSC 2 = window title. Both set title.
6033 // Since #823 the string is also *retained*, because a title pop has
6034 // nothing to restore otherwise. OSC 0 writes both axes and OSC 2
6035 // only the window one — the distinction was invisible while the
6036 // engine merely forwarded, and becomes observable the moment an
6037 // axis-limited push/pop pair (which `vim` emits) is answered.
6038 //
6039 // The payload is `params[1..]` **rejoined**, not `params[1]`: `vte` splits on
6040 // every `;` and a title may legally contain one, so reading a single field cut
6041 // `make -j8; ./run` down to `make -j8` and announced the short string as the
6042 // real one (#880). Same read-site rule #650 established for `OSC 8`. The guard
6043 // is the *slice* being non-empty, not the string: a fieldless `OSC 2` must stay
6044 // ignored where `OSC 2 ;` clears the title, and `params.get(1..)` answers
6045 // `Some(&[])` for the first, whose join is indistinguishable from the second.
6046 //
6047 // The rejoin recovers only what `vte` hands over, which is at most 16 fields: a
6048 // title with 15 or more `;` still arrives cut, and cannot be told from a complete
6049 // one here (#840, closed not planned; see the VT interpretation map note).
6050 b"0" | b"2" => {
6051 if let Some(fields) = params.get(1..).filter(|f| !f.is_empty()) {
6052 let title = String::from_utf8_lossy(&fields.join(&b';')).into_owned();
6053 if number == b"0" {
6054 self.icon_name.clone_from(&title);
6055 }
6056 self.set_window_title(title);
6057 }
6058 }
6059 // OSC 7 = current working directory (a file:// URI). Rejoined for the reason
6060 // on the title arm above — `;` is a legal byte in a path and in a URI, and the
6061 // engine hands the value over as declared (#880, ADR-0017), up to the same
6062 // 16-field bound as the title.
6063 b"7" => {
6064 if let Some(fields) = params.get(1..).filter(|f| !f.is_empty()) {
6065 let cwd = String::from_utf8_lossy(&fields.join(&b';')).into_owned();
6066 self.events.push(TermEvent::Cwd(cwd));
6067 }
6068 }
6069 // OSC 133 = FinalTerm/iTerm2 shell-integration command marks (#158):
6070 // `A` prompt start, `B` command start, `C` output start, `D[;exit]`
6071 // command finished. Each anchors a kinded marker at the cursor line;
6072 // pairing + navigation is consumer policy (#160). Unknown subcommands
6073 // (or none) are ignored. `D`'s exit field parses to `i32`, else None.
6074 b"133" => match params.get(1).copied() {
6075 Some(b"A") => self.add_command_mark(MarkerKind::PromptStart),
6076 Some(b"B") => self.add_command_mark(MarkerKind::CommandStart),
6077 Some(b"C") => self.add_command_mark(MarkerKind::OutputStart),
6078 Some(b"D") => {
6079 let exit = params
6080 .get(2)
6081 .and_then(|p| core::str::from_utf8(p).ok())
6082 .and_then(|s| s.parse::<i32>().ok());
6083 self.add_command_mark(MarkerKind::CommandFinished(exit));
6084 }
6085 _ => {}
6086 },
6087 // OSC 8 = hyperlink: `OSC 8 ; params ; URI`. A non-empty URI opens a
6088 // link (made current); an empty URI closes it. `params` carries the
6089 // optional `id=` that groups runs into one link (#635).
6090 b"8" => {
6091 // One allocation per *open*, shared by that open's cells and dropped
6092 // with the last row holding it (#628 — there is no pool). Two opens of
6093 // an identical URI stay two links, deliberately: merging them would
6094 // override a distinction the application controls through `id=`. That
6095 // parameter is the *only* dedup performed, which is one rule and not
6096 // two — xterm.js states it as "links with no id will only ever be
6097 // registered a single time" beside a lookup keyed on id-plus-uri
6098 // (`OscLinkService.ts:34`, `:49-54`).
6099 // The URI is `params[2..]` **rejoined**, not `params[2]` (#650). vte splits the
6100 // OSC payload on `;`, so a URI carrying an unencoded `;` arrives in pieces and
6101 // reading only the first dropped the rest — silently, with no error. Measured,
6102 // `]8;;https://x/a;b=c` arrives as `["8", "", "https://x/a", "b=c"]`. xterm.js
6103 // special-cases the same thing from the other side, splitting on the *first* `;`
6104 // only and taking all the rest as the URI, *"to support unencoded semi-colons in
6105 // the URIs"* (`InputHandler.ts:3106-3112`). `?a=1;b=2` is a legal query string.
6106 //
6107 // Nothing is lost at the parser **up to 16 fields**, and past that the tail is
6108 // gone before this arm runs: `vte` records at most 16 field boundaries, so a URI
6109 // with 14 or more `;` resolves to a shorter one that is indistinguishable from a
6110 // complete link (#840, closed not planned; see the VT interpretation map note).
6111 //
6112 // The close survives this: `]8;;` arrives as `["8", "", ""]`, whose rejoin is
6113 // empty, and an empty URI still closes. Never decoded — a `%3B` stays `%3B`,
6114 // because the engine hands the target over exactly as declared (ADR-0017).
6115 let uri: Vec<u8> = params.get(2..).unwrap_or_default().join(&b';');
6116 self.current_link = if uri.is_empty() {
6117 None
6118 } else {
6119 let uri = String::from_utf8_lossy(&uri);
6120 Some(match osc8_link_id(params.get(1).copied().unwrap_or(b"")) {
6121 // No id declared: fresh per open, the reference-correct default.
6122 None => std::sync::Arc::from(&*uri),
6123 Some(id) => self.link_for_id(&String::from_utf8_lossy(id), &uri),
6124 })
6125 };
6126 }
6127 // OSC 4 = set/query an ANSI palette entry: `OSC 4 ; index ; spec`
6128 // (#122). The engine forwards index + raw spec; the consumer applies
6129 // it to its palette (theme-agnostic — the cell keeps `Indexed`).
6130 //
6131 // **An empty spec relays nothing, and drops only its own pair** (#834).
6132 // The engine cannot tell a *malformed* colour from a good one — it
6133 // never parses one, which is its identity and not a gap — but "this
6134 // field is empty" needs no parser, and forwarding `""` hands the
6135 // consumer a value it must invent a policy for.
6136 //
6137 // Dropping *the rest of the sequence* was the alternative, and it is
6138 // what xterm does: `ChangeOneAnsiColor` returns negative and that hits
6139 // `/* stop on any error */ break` (`misc.c:3013-3016`, pair loop at
6140 // `:2993`; chain `AllocateAnsiColor` → `xtermAllocColor` → `-1` at
6141 // `:2918`).
6142 //
6143 // **This is a deliberate divergence from the ADR-0004 tie-breaker, not
6144 // a case the tie-breaker fails to reach.** An earlier draft of this
6145 // comment claimed the latter and was wrong, which is worth stating
6146 // because the wrong version is the intuitive one: xterm makes the
6147 // *same* observation this engine makes — `strlen(spec) == 0`, no
6148 // parser, `misc.c:3105-3107` — and `XParseColor` at `:3111` is in the
6149 // `else if`, so it is never reached for an empty spec. The trigger IS
6150 // available here and "follow xterm" IS well defined. It is declined
6151 // because reading a blank field as evidence that structurally
6152 // well-formed pairs are corrupt is an inference about *application
6153 // intent*, which ADR-0017 puts on the consumer's side, and because it
6154 // would discard a value the application explicitly sent. That call is
6155 // the maintainer's, recorded on #834 with its grounds, and theirs to
6156 // reverse.
6157 //
6158 // **The references are 2–2 on this input, not 1–1**, and the two that
6159 // answer as this engine does are the two that keep walking: xterm.js
6160 // (`InputHandler.ts:3073`, loop `:3064`) and alacritty via `vte`
6161 // (`vte-0.15.0/src/ansi.rs:1372-1389` — a failed `xparse_color` falls
6162 // to `unhandled` with no `break`). ghostty relays nothing here, by a
6163 // *third* mechanism rather than by agreeing: `tokenizeScalar` drops
6164 // the empty token (`color.zig:130`) so the pairing re-aligns, and then
6165 // `RGB.parse("2")` fails into `catch return result` (`:210`), yielding
6166 // the accumulated — empty — list. Its re-alignment only becomes
6167 // *visible* where the re-aligned pair parses: `OSC 4 ; 1 ; ; #fff`
6168 // sets index 1 there and nothing anywhere else.
6169 //
6170 // The guard tests **emptiness only**, deliberately (#834 Out of
6171 // Scope). A space-only spec is relayed verbatim; TAB and NUL are C0
6172 // bytes `vte` drops inside an OSC string, so those fields arrive
6173 // genuinely empty and *are* dropped. Both are pinned by tests, so a
6174 // later "align with the reference" widening to whitespace reddens.
6175 b"4" => {
6176 // One event per `index ; spec` pair (xterm's `while slots > 1`).
6177 // The walk advances two fields whether or not a pair produces an
6178 // event, so dropping one cannot misalign the pairs after it.
6179 let mut rest = ¶ms[1..];
6180 while let [idx, spec, tail @ ..] = rest {
6181 rest = tail;
6182 if let Ok(index) = String::from_utf8_lossy(idx).parse::<u8>() {
6183 if *spec == b"?" {
6184 self.events
6185 .push(TermEvent::QueryPaletteColor { index, terminator });
6186 } else if !spec.is_empty() {
6187 self.events.push(TermEvent::SetPaletteColor {
6188 index,
6189 spec: String::from_utf8_lossy(spec).into_owned(),
6190 });
6191 }
6192 }
6193 }
6194 }
6195 // OSC 104 = reset palette entries (#122): an **empty payload** resets
6196 // the whole table, else one event per named index.
6197 //
6198 // Empty means both `OSC 104` and `OSC 104 ;` (#832). vte hands those
6199 // over as `["104"]` and `["104", ""]`, and testing only the first left
6200 // the second falling into the index loop, where `"".parse::<u8>()`
6201 // fails and the reset evaporated silently. xterm tests the payload
6202 // string rather than the field count — `if (*buf != '\0')`
6203 // (`misc.c:3057`), whose else-branch is *"resetting all colors"*
6204 // (`misc.c:3077`) — and xterm.js gates on the same emptiness
6205 // (`InputHandler.ts:3223-3224`, a slot-less RESTORE).
6206 //
6207 // The test is `params[1]` being the *whole* payload, not "every field
6208 // is empty": for `OSC 104 ; ;` xterm's buf is `";"`, which is not
6209 // empty, so that form takes the index path. (ghostty differs here —
6210 // `tokenizeScalar` drops both separators and it resets everything —
6211 // but it agrees on the form that matters, `misc.c` and xterm.js do
6212 // not, and ADR-0004 puts the spec proxy on top.)
6213 b"104" => {
6214 if params.len() <= 1 || (params.len() == 2 && params[1].is_empty()) {
6215 self.events.push(TermEvent::ResetPaletteColor(None));
6216 } else {
6217 for &idx in ¶ms[1..] {
6218 if let Ok(index) = String::from_utf8_lossy(idx).parse::<u8>() {
6219 self.events.push(TermEvent::ResetPaletteColor(Some(index)));
6220 }
6221 }
6222 }
6223 }
6224 // OSC 10/11/12 = set/query the default foreground/background/cursor
6225 // colour, stacking specs across the [fg, bg, cursor] slots (#122,
6226 // #137, #832). Each code names the slot the stack starts at. The
6227 // engine forwards raw specs (theme-agnostic).
6228 b"10" => self.special_color(params, 0, terminator),
6229 b"11" => self.special_color(params, 1, terminator),
6230 b"12" => self.special_color(params, 2, terminator),
6231 // OSC 52 = manipulate selection data (#828): `OSC 52 ; Pc ; Pd`.
6232 // The engine decodes `Pd` and relays the request; the *clipboard* is
6233 // the consumer's, and so is every policy about it.
6234 b"52" => self.clipboard(params, terminator),
6235 // OSC 110 / 111 / 112 = reset the default foreground / background /
6236 // cursor colour (#122, #832). One slot each, never a stack — xterm's
6237 // reset path resolves a single index from the code itself and walks
6238 // nothing (`misc.c:3729`).
6239 b"110" => self.events.push(TermEvent::ResetForeground),
6240 b"111" => self.events.push(TermEvent::ResetBackground),
6241 b"112" => self.events.push(TermEvent::ResetCursorColor),
6242 _ => {} // other OSCs are later slices
6243 }
6244 }
6245}
6246
6247#[cfg(test)]
6248mod tests {
6249 use super::cap_scroll;
6250 use super::version_number;
6251 use crate::Engine;
6252 use crate::damage::ScrollOp;
6253 use crate::serialize::MAX_SCROLL_COUNT;
6254
6255 /// #824 — the `Pv` mapping, in-crate because the seam cannot reach it.
6256 ///
6257 /// `tests/reply.rs` asserts the reply carries the number *this* crate
6258 /// version maps to, which is the assertion that fires the moment a release
6259 /// drifts from its report. What it cannot observe is the mapping itself:
6260 /// there is only ever one crate version at run time, so a hand-written
6261 /// literal equal to today's number is byte-identical to the derivation at
6262 /// that seam. Measured, by replacing the call site with `1500`:
6263 /// `cargo test --workspace` stayed green, and `cargo clippy --workspace
6264 /// --all-targets -- -D warnings` **failed** — `version_number` loses its
6265 /// only non-test caller and `dead_code` is an error under the gate. So the
6266 /// test suite alone cannot see it and the gate can; these cases are what
6267 /// make the mapping itself falsifiable rather than assumed.
6268 #[test]
6269 fn version_number_pads_semver_base_100() {
6270 // Each place is two decimal digits wide, so a higher version always
6271 // reports a higher number — which is the only property `Pv` promises.
6272 assert_eq!(version_number("0.0.1"), 1);
6273 assert_eq!(version_number("0.15.0"), 15_00);
6274 assert_eq!(version_number("1.2.3"), 1_02_03);
6275 assert_eq!(version_number("999.99.99"), 9_99_99_99);
6276 assert!(version_number("0.16.0") > version_number("0.15.9"));
6277 assert!(version_number("1.0.0") > version_number("0.99.99"));
6278 }
6279
6280 #[test]
6281 fn version_number_strips_a_pre_release_suffix() {
6282 // Semver starts the pre-release at the FIRST hyphen, so a two-part
6283 // suffix strips whole. alacritty cuts at the last and mis-parses this.
6284 assert_eq!(version_number("0.15.0-dev"), 15_00);
6285 assert_eq!(version_number("1.2.3-rc.1-dev"), 1_02_03);
6286 assert_eq!(version_number("1.2.3+build.5"), 1_02_03);
6287 // The cases above cannot observe the strip at all: their suffixes carry
6288 // no digits, so removing the `-` break leaves the number unchanged —
6289 // measured, by doing exactly that and watching them stay green. A digit
6290 // *inside* the suffix is what the strip is for.
6291 assert_eq!(version_number("0.15.0-rc2"), 15_00);
6292 assert_eq!(version_number("1.2.3-4"), 1_02_03);
6293 }
6294
6295 #[test]
6296 fn version_number_tolerates_a_short_or_odd_version() {
6297 // A missing component reads as zero rather than panicking, and a fourth
6298 // component is ignored — the report must not be able to fail.
6299 assert_eq!(version_number("2"), 2_00_00);
6300 assert_eq!(version_number("2.7"), 2_07_00);
6301 assert_eq!(version_number("1.2.3.4"), 1_02_03);
6302 assert_eq!(version_number(""), 0);
6303 }
6304
6305 /// #661 — the wire's `i16` bound, not the region-height one.
6306 ///
6307 /// In-crate on purpose, and the reason is cost rather than visibility: reaching
6308 /// this through `Engine` needs a screen taller than 32 767 rows *and* 32 768
6309 /// scrolls of it, each rotating a `line_damage` of that length. Measured at
6310 /// 15.8 s in a debug build for a single assertion — the whole `serialize` suite
6311 /// is 0.2 s without it. See `cap_scroll`'s note for how the coverage is split.
6312 #[test]
6313 fn a_region_taller_than_the_wire_field_truncates_rather_than_wraps() {
6314 // 40 000 rows: over i16::MAX, under MAX_ROWS (u16::MAX), so the region
6315 // height alone would let 35 000 through — and 35 000 as i16 is -30 536.
6316 let up = cap_scroll(ScrollOp {
6317 top: 0,
6318 bottom: 40_000,
6319 count: 35_000,
6320 });
6321 assert_eq!(up.count, MAX_SCROLL_COUNT, "capped, and still an up-scroll");
6322
6323 let down = cap_scroll(ScrollOp {
6324 top: 0,
6325 bottom: 40_000,
6326 count: -35_000,
6327 });
6328 assert_eq!(down.count, -MAX_SCROLL_COUNT, "sign survives the cap");
6329 }
6330
6331 /// The cap is a ceiling, not a rewrite: a count inside both bounds is reported
6332 /// exactly, and the region it names is untouched.
6333 #[test]
6334 fn a_scroll_inside_both_bounds_passes_through_unchanged() {
6335 let op = ScrollOp {
6336 top: 4,
6337 bottom: 9,
6338 count: -2,
6339 };
6340 assert_eq!(cap_scroll(op), op);
6341 }
6342
6343 /// #628 — a hyperlink's storage is released once no live row references it.
6344 ///
6345 /// In-crate on purpose: this defect has **no public observable**, which is why it
6346 /// survived from #46 until #621's completeness pass went looking. Pool indices never
6347 /// cross the wire (`Term::frame` remaps them to frame-local `link_table` positions),
6348 /// and the one public reader takes an index the caller already holds — so from
6349 /// outside the crate a pool of 5 entries and a pool of 50 000 are indistinguishable.
6350 /// The assertion has to stand where the storage does.
6351 ///
6352 /// The fixture is a buffer that cannot hold what it is fed: 2 rows plus 2 lines of
6353 /// scrollback is four lines total, so by the end all but the last four opens have
6354 /// been evicted and nothing on screen or in history refers to them.
6355 #[test]
6356 fn a_link_evicted_from_the_buffer_stops_being_stored() {
6357 let mut e = Engine::with_scrollback(20, 2, 2);
6358 for i in 0..50 {
6359 e.feed(format!("\x1b]8;;https://example.com/{i}\x07L{i}\x1b]8;;\x07\r\n").as_bytes());
6360 }
6361
6362 // The observable had to move with the storage — there is no pool left to count.
6363 // A `Weak` is the stronger form of the same claim anyway: a bounded count can be
6364 // bounded and still wrong, while a dead `Weak` says *this exact allocation* was
6365 // released.
6366 //
6367 // **`e2` must outlive the assertion, and that is the whole test.** The first
6368 // version of this scoped the engine to the block that built the `Weak`, so the
6369 // engine was dropped before the check and the `Weak` died for that reason
6370 // instead. Measured: with a deliberate leak reintroduced (a `Vec<Arc<str>>` on
6371 // `Term`, retaining every open), that version stayed **green** — a tautological
6372 // proof, confirming only that dropping an `Engine` frees its own memory. Keeping
6373 // the engine alive is what makes the assertion about reclamation.
6374 let mut e2 = Engine::with_scrollback(20, 2, 2);
6375 e2.feed(b"\x1b]8;;https://example.com/first\x07L\x1b]8;;\x07\r\n");
6376 let weak = {
6377 let arc = e2
6378 .term
6379 .grid
6380 .row_ref(0)
6381 .link_at(0)
6382 .expect("on screen")
6383 .clone();
6384 std::sync::Arc::downgrade(&arc)
6385 };
6386 // The live half first: a fix that simply never stored the URI would satisfy the
6387 // dead-`Weak` assertion below for the wrong reason.
6388 assert!(
6389 weak.upgrade().is_some(),
6390 "the URI must be alive while its cell is on screen",
6391 );
6392 for i in 0..50 {
6393 e2.feed(format!("filler {i}\r\n").as_bytes());
6394 }
6395 assert!(
6396 weak.upgrade().is_none(),
6397 "the first link scrolled out of a 4-line buffer and nothing should still \
6398 hold its URI — before #628 every OSC 8 open lived for the life of the Term",
6399 );
6400
6401 // The whole-buffer form of the same claim: 50 distinct opens through a buffer
6402 // that holds four lines leaves at most four entries *owned*.
6403 //
6404 // `owned_link_count` and not `link_at`, and that distinction is the test. The
6405 // first version summed the gated reader, which counts **linked cells** — measured
6406 // on an erased screen it read 0 while every URI was still allocated, so it could
6407 // not fail for the property this test exists to assert.
6408 // Deduped by allocation: one open covering three cells is three map entries and
6409 // one URI, so counting entries would fail at 9 for a buffer holding four links.
6410 let owned: std::collections::HashSet<*const u8> = e
6411 .term
6412 .scrollback
6413 .iter()
6414 .chain((0..2).map(|r| e.term.grid.row_ref(r)))
6415 .flat_map(|r| r.owned_links())
6416 .map(|u| std::sync::Arc::as_ptr(u) as *const u8)
6417 .collect();
6418 assert!(
6419 owned.len() <= 4,
6420 "a 4-line buffer cannot own more than 4 distinct URIs, found {}",
6421 owned.len(),
6422 );
6423 }
6424
6425 /// #628 — erasing a cell in place releases its URI, not just its presence bit.
6426 ///
6427 /// The sibling of the eviction test above, and the case that one structurally cannot
6428 /// see: `clear_cells` / `free_cell` blank a cell **without dropping its row**, so no
6429 /// row-lifetime event fires. Under `row-keyed-side-maps` rule 3 leaving the map entry
6430 /// is sanctioned — *"a write that clears the cell owes the bit, not the map"* — and
6431 /// that was exactly right while the value was a 4-byte index: a stale entry is
6432 /// unreadable through the gate and costs nothing.
6433 ///
6434 /// #628 changed what the entry *is*. The map now owns a heap string, so the same
6435 /// sanctioned line retains one. Rule 3 still holds as stated — purging is not the
6436 /// correctness step, and missing a site costs bounded retention rather than a wrong
6437 /// answer — but the optimisation it calls optional became worth taking here.
6438 /// All three references release at this point: alacritty's `Cell::reset` drops the
6439 /// `Option<Arc<CellExtra>>` outright, ghostty's ref-counted set frees at zero, and
6440 /// xterm.js's `_resetBufferLine` clears `_extendedAttrs` and disposes the line's
6441 /// markers so `OscLinkService` deletes the entry.
6442 #[test]
6443 fn an_erased_cell_releases_its_uri_not_only_its_bit() {
6444 let mut e = Engine::new(80, 24);
6445 e.feed(b"]8;;https://example.com/erasedL]8;;");
6446 let weak = {
6447 let a = e
6448 .term
6449 .grid
6450 .row_ref(0)
6451 .link_at(0)
6452 .expect("on screen")
6453 .clone();
6454 std::sync::Arc::downgrade(&a)
6455 };
6456 assert!(weak.upgrade().is_some(), "alive while on screen");
6457
6458 e.feed(b"[2J"); // ED 2 — erases in place; no row is dropped or reused
6459
6460 // The gated reader already says "no link", and so does the frame. Neither can
6461 // see the retention, which is why this assertion holds the `Weak` instead:
6462 // measured before the purge, both public views read 0 while the URI lived.
6463 assert!(e.link_at(0, 0).is_none(), "the presence bit is cleared");
6464 assert!(
6465 weak.upgrade().is_none(),
6466 "and the URI itself is released — before the purge the map kept owning it, so an erased screen retained every link it had shown",
6467 );
6468 }
6469
6470 /// `Arc`, not `Rc`, and this is what makes that a fact rather than a comment.
6471 ///
6472 /// #628 chose `Arc<str>` for the row's link map on the stated ground that `Engine` is
6473 /// `Send + Sync`; `Rc` would have removed both **silently** — no signature changes
6474 /// here, and a downstream `Mutex<Engine>` failing to compile instead. The claim was
6475 /// load-bearing and unpinned: a repo-wide grep for it found only prose.
6476 #[test]
6477 fn the_engine_stays_send_and_sync() {
6478 fn assert_send_sync<T: Send + Sync>() {}
6479 assert_send_sync::<Engine>();
6480 }
6481
6482 /// Two OSC 8 opens of an identical URI are **two links**, not one.
6483 ///
6484 /// Deliberate, and the reason is #635: merging them would override the grouping the
6485 /// application controls through `id=`, which is the one dedup xterm.js performs.
6486 /// Asserted by allocation identity through the in-crate observer rather than through
6487 /// a public accessor — the behaviour is real now, a consumer asking about it is not.
6488 #[test]
6489 fn two_opens_of_one_uri_are_two_links() {
6490 let mut e = Engine::new(40, 2);
6491 // One open covering two cells, then a *separate* open of the very same URI.
6492 e.feed(b"]8;;https://example.com/xAB]8;;");
6493 e.feed(b"]8;;https://example.com/xC]8;;");
6494
6495 let row = e.term.grid.row_ref(0);
6496 let ptr = |c: usize| std::sync::Arc::as_ptr(row.link_at(c).expect("linked")) as *const u8;
6497 assert_eq!(
6498 e.link_at(0, 0).map(|h| h.uri().to_owned()),
6499 e.link_at(0, 2).map(|h| h.uri().to_owned()),
6500 "the text is the same",
6501 );
6502 assert_eq!(ptr(0), ptr(1), "A and B are one open, so one allocation");
6503 assert_ne!(
6504 ptr(0),
6505 ptr(2),
6506 "…but C is a second open — merging the two would override the distinction `id=` exists to express (#635)",
6507 );
6508 }
6509
6510 /// The other half of the rule above: an `id=` the application declared **does** group
6511 /// (#635). One rule, not two — "never merge on URI alone, always merge on a declared
6512 /// id" is how xterm.js states it (`OscLinkService.ts:34`, `:51` at the pinned SHA), and
6513 /// justerm shipped the first half only because #26 ported `registerLink`'s id-minting
6514 /// and not its lookup.
6515 ///
6516 /// Grouping is asserted as **allocation identity**, which is not an implementation
6517 /// detail leaking into a test: since #628 the `Arc`'s address *is* link identity —
6518 /// `Term::frame` interns `link_table` by `Arc::as_ptr`, so one allocation is what makes
6519 /// two runs one link index on the wire, and that index is what a consumer groups by.
6520 #[test]
6521 fn the_same_id_and_uri_group_into_one_link() {
6522 let mut e = Engine::new(40, 2);
6523 // Two separate opens, same `id=` and same URI, on two different lines — the case
6524 // the parameter exists for (a link that cannot be one contiguous run).
6525 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07A\x1b]8;;\x07\r\n");
6526 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07B\x1b]8;;\x07");
6527
6528 let ptr = |r: usize, c: usize| {
6529 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
6530 };
6531 assert_eq!(
6532 ptr(0, 0),
6533 ptr(1, 0),
6534 "the application said these two runs are one link, so they share one allocation",
6535 );
6536
6537 // And the wire agrees, which is the half a consumer can actually see: one entry in
6538 // `link_table`, referenced by both spans. Two entries is the defect.
6539 let f = e.frame();
6540 assert_eq!(f.link_table.len(), 1, "one link ships once");
6541 }
6542
6543 /// Keyed on `id` **and** URI, not on `id` alone — xterm.js's `_getEntryIdKey` is
6544 /// `` `${id};;${uri}` `` (`OscLinkService.ts:87`). An application reusing an id for a
6545 /// different target has not said "same link"; treating it as one would follow a stale
6546 /// declaration to the wrong URI.
6547 #[test]
6548 fn the_same_id_with_a_different_uri_stays_two_links() {
6549 let mut e = Engine::new(40, 2);
6550 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07A\x1b]8;;\x07\r\n");
6551 e.feed(b"\x1b]8;id=xyz;https://example.com/b\x07B\x1b]8;;\x07");
6552
6553 let ptr = |r: usize, c: usize| {
6554 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
6555 };
6556 assert_ne!(
6557 ptr(0, 0),
6558 ptr(1, 0),
6559 "same id, different target — two links"
6560 );
6561 assert_eq!(e.frame().link_table.len(), 2, "and both ship");
6562 }
6563
6564 /// `id=` with an **empty value** is no id at all, so the no-id rule applies and each
6565 /// open is its own link. xterm.js reaches this by `parsedParams[i].slice(3) || undefined`
6566 /// (`InputHandler.ts:3130`) — the `||` is the whole behaviour, and reading `slice(3)`
6567 /// alone gives the opposite answer.
6568 ///
6569 /// Worth a test rather than a comment because the empty-string key is the one that
6570 /// would group *every* `id=`-with-no-value link in a session into one, across unrelated
6571 /// URIs — a wrong answer that grows with uptime.
6572 #[test]
6573 fn an_empty_id_value_is_no_id_at_all() {
6574 let mut e = Engine::new(40, 2);
6575 e.feed(b"\x1b]8;id=;https://example.com/a\x07A\x1b]8;;\x07\r\n");
6576 e.feed(b"\x1b]8;id=;https://example.com/a\x07B\x1b]8;;\x07");
6577
6578 let ptr = |r: usize, c: usize| {
6579 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
6580 };
6581 assert_ne!(
6582 ptr(0, 0),
6583 ptr(1, 0),
6584 "no id declared, so the reference-correct fresh-per-open rule still holds",
6585 );
6586 }
6587
6588 /// `params` is a **`:`-separated** key=value list (`id=xyz123:foo=bar:baz=quux`), and
6589 /// `id` may sit anywhere in it — xterm.js scans with `findIndex(e =>
6590 /// e.startsWith('id='))` (`InputHandler.ts:3129`). Testing only a leading `id=` would
6591 /// pass with a `starts_with` on the whole field, which is the wrong parse.
6592 #[test]
6593 fn the_id_param_is_found_among_other_params() {
6594 let mut e = Engine::new(40, 2);
6595 e.feed(b"\x1b]8;foo=bar:id=xyz:baz=quux;https://example.com/a\x07A\x1b]8;;\x07\r\n");
6596 e.feed(b"\x1b]8;id=xyz;https://example.com/a\x07B\x1b]8;;\x07");
6597
6598 let ptr = |r: usize, c: usize| {
6599 std::sync::Arc::as_ptr(e.term.grid.row_ref(r).link_at(c).expect("linked")) as *const u8
6600 };
6601 assert_eq!(
6602 ptr(0, 0),
6603 ptr(1, 0),
6604 "the id is the same whatever else rides beside it",
6605 );
6606 }
6607
6608 /// The grouping registry must not become the pool #628 deleted.
6609 ///
6610 /// Whatever maps an `id=` to its link has to hold it **weakly**: a strong reference
6611 /// would make every id'd link immortal for the life of the `Term` — the exact defect
6612 /// #628 removed, re-entering through the door #635 opens. xterm.js's equivalent map is
6613 /// reclaimed rather than weak (`_entriesWithId.delete` when the entry's last line
6614 /// marker is disposed, `OscLinkService.ts:98-100`); justerm has no disposal hook by
6615 /// design, so `Weak` is how the same lifetime is expressed here.
6616 ///
6617 /// This is the test that discriminates the two, and nothing public can: both spellings
6618 /// group correctly, and they differ only in what stays alive afterwards.
6619 #[test]
6620 fn the_id_registry_does_not_keep_a_link_alive() {
6621 let mut e = Engine::new(80, 24);
6622 e.feed(b"\x1b]8;id=xyz;https://example.com/grouped\x07L\x1b]8;;\x07");
6623 let weak = {
6624 let a = e
6625 .term
6626 .grid
6627 .row_ref(0)
6628 .link_at(0)
6629 .expect("on screen")
6630 .clone();
6631 std::sync::Arc::downgrade(&a)
6632 };
6633 assert!(weak.upgrade().is_some(), "alive while on screen");
6634
6635 e.feed(b"\x1b[2J"); // ED 2 — the in-place erase that releases the row's side maps
6636
6637 assert!(
6638 weak.upgrade().is_none(),
6639 "the id registry must hold a Weak — a strong entry would outlive the screen and rebuild #628's leak one id at a time",
6640 );
6641 }
6642}