justerm_core/logical.rs
1//! Viewport logical lines (#113, ADR-0017): soft-wrap-joined text plus a
2//! per-char map back to viewport cells. This is the buffer-wide *mechanism* a
3//! frame-mode consumer needs for URL detection — the regex and `new URL()`
4//! validation stay consumer-side (policy). It also serves the a11y screen-reader
5//! mirror (#119). The cell-aware assembly lives in `term/logical.rs` — the `Term` half
6//! of this model, moved out of `term.rs` in #601; this module is just the returned shape.
7
8/// One soft-wrap-joined logical line touching the viewport.
9#[derive(Clone, PartialEq, Eq, Debug)]
10pub struct LogicalLine {
11 /// The line text: wrap-joined across soft-wrapped rows, wide-char spacers
12 /// skipped, trailing blanks trimmed. This is **not** the equivalence to xterm.js's
13 /// `BufferLine.translateToString(true)` an earlier version of this comment claimed. The
14 /// spacer skip matches; the wrap join does not (that method spans one `BufferLine` —
15 /// xterm pairs it with `Buffer.getWrappedRangeForLine`); and the trim still differs,
16 /// but on a **narrower** case than this comment used to name. Until #685 the trim was
17 /// `str::trim_end()`, the Unicode `White_Space` property, so it dropped a printed
18 /// U+00A0 / U+3000 / U+2003 as well. It now removes only `' '` — the codepoint a blank
19 /// cell packs, and therefore the only one that can be padding. What remains is a
20 /// printed trailing **ASCII space**, which xterm keeps (it bounds by written extent)
21 /// and this cannot, because `Cell` has no bit distinguishing a written `' '` from a
22 /// blank. Pinned in `docs/agents/reference-facts.md` § "Trimming a line's end" and
23 /// `docs/map/invariant/only-u0020-can-be-padding.md`.
24 pub text: String,
25 /// Per `text` char, the viewport cell `(row, col)` it came from. A `row`
26 /// outside `0..rows` is off-screen wrapped context (a line that wraps in from
27 /// above the top / out past the bottom) — present so a URL spanning the edge
28 /// still matches; the consumer highlights only the in-range cells.
29 pub cells: Vec<(i32, usize)>,
30}