Skip to main content

leaf_ffi/
lib.rs

1//! leaf-ffi — the Swift / C-ABI frontend binding for leaf.
2//!
3//! This is the native-Apple analogue of `leaf-wasm`: it takes `leaf-core`'s
4//! frontend-neutral [`Doc`] — the byte-offset caret model and the AST→glyph
5//! [`VisualMap`] — and exposes it across a C ABI (via UniFFI) in the shape an
6//! AppKit/SwiftUI renderer wants. Core stays the single source of truth for the
7//! text, the caret math, and the offset⇄position mapping; the Swift side only
8//! paints glyphs and forwards key/mouse events back in, exactly as the TUI, gpui,
9//! and wasm frontends do.
10//!
11//! ## The boundary is style *runs*, not glyphs
12//!
13//! [`Doc::build_visual`] resolves the document to rows of per-character glyphs,
14//! each tagged with a semantic [`Role`] and the author's emphasis. Sending one
15//! object per character would make every keystroke O(document) in boundary
16//! crossings. Instead [`LeafDoc::view`] coalesces each row's glyphs into maximal
17//! **runs** of identical style and ships those — a handful of records per line.
18//! The Swift renderer maps each run's `role` to a font/size/weight and its
19//! emphasis flags to traits, the native counterpart of the TUI's `to_ratatui`
20//! and the web's CSS class.
21//!
22//! ## Core owns the grid; Swift owns the pixels
23//!
24//! Core lays a row out in whole character *columns* (a terminal-cell measure),
25//! and every offset⇄position method speaks that grid. It deliberately does *not*
26//! dictate presentation. So a native renderer is *proportional* — body text in a
27//! real family, headings by **size** and weight, code in a monospace panel — and
28//! never multiplies `col × cell_width`. It lets `NSLayoutManager` / Core Text
29//! shape each row, places the caret at [`DocView::caret_ch`] (a UTF-16 offset,
30//! which is exactly what `NSAttributedString` and `NSTextView` count in), and
31//! hit-tests a click through `characterIndex(for:)`, feeding the resulting
32//! row + UTF-16 offset back through [`LeafDoc::click_ch`]. Core measures nothing
33//! in pixels; Swift positions nothing in the model.
34//!
35//! ## Threading
36//!
37//! A UniFFI object is handed to Swift as a reference-counted handle whose methods
38//! take `&self`, so the [`Doc`] lives behind a [`Mutex`]. Every call locks, edits
39//! or reads, and returns a fresh [`DocView`] — one boundary crossing both mutates
40//! and repaints, same as the wasm frontend. Drive it from the main thread.
41
42use std::sync::{Arc, Mutex};
43
44use leaf_core::style::{Baseline, Role, Style as LStyle};
45use leaf_core::wysiwyg::text_width;
46use leaf_core::{
47    Alignment, BlockKind, Capabilities as CoreCapabilities, ColorScheme, Doc, Format, InlineKind,
48    LineFlow as CoreLineFlow, MarkColor as CoreMarkColor, MarkupMode as CoreMarkupMode,
49    MediaKind as CoreMediaKind, View, VisualMap,
50};
51use unicode_segmentation::UnicodeSegmentation;
52
53uniffi::setup_scaffolding!();
54
55/// A parse failure constructing a document — the only fallible entry point. Every
56/// other method is infallible (it operates on an already-parsed model), so they
57/// return a [`DocView`] directly.
58#[derive(Debug, thiserror::Error, uniffi::Error)]
59pub enum LeafError {
60    /// The `format` string handed to [`LeafDoc::new`] wasn't one leaf understands.
61    #[error("unknown format: {name}")]
62    UnknownFormat { name: String },
63    /// `leaf-core` failed to parse `source` as the requested format.
64    #[error("parse error: {message}")]
65    Parse { message: String },
66}
67
68/// A selection cited out of the source — the text, a little of what
69/// surrounded it, and the byte range it came from. The FFI shape of
70/// `leaf_core::Quote`; see [`LeafDoc::selection_quote`].
71#[derive(uniffi::Record)]
72pub struct SelectionQuote {
73    /// The selected source, verbatim.
74    pub exact: String,
75    /// What immediately preceded it — empty at the document's start.
76    pub prefix: String,
77    /// What immediately followed it — empty at the document's end.
78    pub suffix: String,
79    /// Byte offset in the source where the selection begins.
80    pub start: u64,
81    /// Byte offset where it ends (exclusive).
82    pub end: u64,
83}
84
85/// A host-painted range of the source — an annotation's footprint, a search
86/// hit. The FFI shape of `leaf_core::Highlight`; see
87/// [`LeafDoc::set_highlights`].
88#[derive(uniffi::Record)]
89pub struct Highlight {
90    /// Byte offset in the source where the wash begins.
91    pub start: u64,
92    /// Byte offset where it ends (exclusive).
93    pub end: u64,
94    /// The host's name for it, handed back on activation. Opaque to leaf.
95    pub id: String,
96    /// A rendering hint (`#RRGGBB`), or `None` for the theme's default wash.
97    pub color: Option<String>,
98    /// A margin glyph's name (an SF Symbol, for this binding's frontends), or
99    /// `None` for wash-only ink. The marker — not the wash — is what
100    /// activates a highlight; see `leaf_core::Highlight::marker`.
101    pub marker: Option<String>,
102}
103
104/// One maximal span of same-styled glyphs on a visual row — the unit the Swift
105/// renderer turns into a single styled attributed-string run.
106#[derive(uniffi::Record)]
107pub struct Run {
108    /// The run's text, glyphs concatenated in column order.
109    pub text: String,
110    /// The glyph's semantic role as a renderer class id: `body`, `h1`…`h6`,
111    /// `code`, `link`, `mark`, `list`, `quote`, `rule`.
112    pub role: String,
113    pub bold: bool,
114    pub italic: bool,
115    pub underline: bool,
116    pub strike: bool,
117    /// Raised off the baseline and drawn smaller — a footnote reference's `[1]`,
118    /// or an author's `^x^`. Mutually exclusive with [`sub`](Self::sub); core's
119    /// `Baseline` is one value, and these are its two non-default cases flattened
120    /// to the flag shape the rest of this record is spelled in.
121    pub sup: bool,
122    /// Lowered off the baseline and drawn smaller — an author's `~x~`.
123    pub sub: bool,
124    /// The byte offset in the source this run's first glyph came from.
125    ///
126    /// What a run *means*, as opposed to how it looks: a `link` role says a span
127    /// is drawn as a link but not where it points, and the only way back to that
128    /// is the source. A frontend drawing part of the document somewhere the caret
129    /// isn't — a footnote's text in a popover — pairs this with
130    /// [`LeafDoc::link_destination_at`] or [`LeafDoc::footnote_at`] to make those
131    /// runs followable.
132    ///
133    /// The alternative was for a frontend to count its way along the row's text
134    /// and ask [`LeafDoc::offset_for_pos`], which means converting between three
135    /// units that only agree on ASCII: this is a byte offset, the run's text is
136    /// characters, and a row's column is a *display* cell (a wide CJK glyph is
137    /// two). Handing the offset over is exact, O(1), and needs none of that.
138    ///
139    /// `0` for the runs of the source view, whose rows are split from raw text
140    /// rather than laid out from glyphs.
141    pub src: u32,
142    /// Whether this run lies inside the active selection — so the renderer can
143    /// paint a selection background without re-deriving it from offsets.
144    pub sel: bool,
145    /// The id of the host highlight covering this run, if one does — see
146    /// [`LeafDoc::set_highlights`]. A highlight splits a run the way the
147    /// selection does, so a wash begins and ends exactly on its bytes.
148    pub hl: Option<String>,
149    /// That highlight's rendering hint (`#RRGGBB`, or `None` for the theme's
150    /// default wash), carried beside the id so a renderer needs no lookup.
151    pub hl_color: Option<String>,
152    /// The colour the author named on a `mark` run — `"red"`, `"orange"`,
153    /// `"yellow"`, `"green"`, `"blue"`, `"purple"`, `"brown"` — or absent for a
154    /// plain `==highlight==` and for every other role.
155    ///
156    /// A *name*, unlike [`hl_color`](Self::hl_color)'s `#RRGGBB`, and that is
157    /// the difference between the two: a host highlight's colour is the host's
158    /// own choice and arrives as a value to paint, while this one is the
159    /// document's word for it and the renderer picks the wash. It rides beside
160    /// `role` rather than folding into it (`"mark-red"`) so a renderer that
161    /// knows nothing about colours still draws the run as the highlight it is.
162    pub mark_color: Option<String>,
163}
164
165/// Where a locator lands — what [`LeafDoc::locate`] answers with, and the FFI
166/// mirror of [`leaf_core::Landing`].
167///
168/// A span rather than an offset because the two things a host does with a
169/// locator want different halves of it: following one puts a caret at `start`,
170/// while peeking at one draws the rows between `start` and `end`. Only the first
171/// can be recovered from an offset alone.
172#[derive(uniffi::Record)]
173pub struct LandingView {
174    /// The first byte of the block the locator names — where a caret goes.
175    pub start: u32,
176    /// One past its last byte, so the pair maps through `pos_for_offset` to the
177    /// rendered rows the block occupies, the way [`FootnoteView`]'s pair does.
178    pub end: u32,
179}
180
181impl From<leaf_core::Landing> for LandingView {
182    fn from(l: leaf_core::Landing) -> Self {
183        LandingView {
184            start: l.start as u32,
185            end: l.end as u32,
186        }
187    }
188}
189
190/// A footnote reference and the note it names — what [`LeafDoc::footnote_at`]
191/// answers with. The FFI mirror of [`leaf_core::FootnoteRef`].
192///
193/// A reference whose definition the document is missing still comes back, with
194/// its `label` and no `text`: that a `[^99]` names nothing is a thing to tell
195/// the reader, and it is not the same as the caret standing on no reference at
196/// all (which is `None`).
197#[derive(uniffi::Record)]
198pub struct FootnoteView {
199    /// The reference's label — the `1` of `[^1]`, without the `^` or brackets.
200    pub label: String,
201    /// The note's body as source text, or `None` when nothing defines it.
202    pub text: Option<String>,
203    /// The byte offset the note's body starts at, for a "go to note" that moves
204    /// the caret there. `None` alongside a `None` `text`.
205    pub offset: Option<u32>,
206    /// Where the body ends, exclusive. With `offset` this bounds the note, so a
207    /// frontend can map the pair through `pos_for_offset` to the *rendered rows*
208    /// it occupies and draw those — the note with its markup resolved, rather
209    /// than the asterisks and backticks `text` carries. `None` alongside a
210    /// `None` `offset`.
211    pub end: Option<u32>,
212}
213
214impl From<leaf_core::FootnoteRef> for FootnoteView {
215    fn from(f: leaf_core::FootnoteRef) -> Self {
216        FootnoteView {
217            label: f.label,
218            text: f.text,
219            offset: f.offset.map(|o| o as u32),
220            end: f.end.map(|o| o as u32),
221        }
222    }
223}
224
225/// A footnote definition and the reference that sends a reader to it — what
226/// [`LeafDoc::footnote_definition_at_caret`] answers with, and the FFI mirror of
227/// [`leaf_core::FootnoteDef`].
228///
229/// The other half of [`FootnoteView`]'s round trip: that one carries a reader
230/// down to the note, this one carries them back up. A definition nothing cites
231/// still comes back, with its `label` and no `offset`, for the reason an
232/// undefined reference does — "nothing refers to this note" is worth saying.
233#[derive(uniffi::Record)]
234pub struct FootnoteDefView {
235    /// The definition's label — the `1` of `[^1]: …`, spelled exactly as
236    /// [`FootnoteView::label`] spells the same footnote's.
237    pub label: String,
238    /// The byte offset the first reference starts at, for a "back to reference"
239    /// that moves the caret there. `None` for a note nothing refers to.
240    pub offset: Option<u32>,
241}
242
243impl From<leaf_core::FootnoteDef> for FootnoteDefView {
244    fn from(f: leaf_core::FootnoteDef) -> Self {
245        FootnoteDefView {
246            label: f.label,
247            offset: f.offset.map(|o| o as u32),
248        }
249    }
250}
251
252/// One visual line: its styled runs plus the row-level flags a frontend draws
253/// chrome from.
254#[derive(uniffi::Record)]
255pub struct Row {
256    pub runs: Vec<Run>,
257    /// Drawn but holds no caret (a table rule, a block-gap blank line): the
258    /// renderer skips it for click/caret math. See [`leaf_core::VRow`].
259    pub decoration: bool,
260    /// A fenced/indented code-block line — the renderer draws a tinted, bordered
261    /// panel around each maximal run of these.
262    pub code: bool,
263    /// A fenced block's language, carried on the block's first code row only.
264    pub code_lang: Option<String>,
265    /// A `:::name{.class}` directive-container line — the renderer draws a
266    /// tinted panel around each maximal run of these, the `code` recipe. See
267    /// [`leaf_core::VRow::directive`].
268    pub directive: bool,
269    /// A directive container's space-joined `.class` attrs, carried on the
270    /// block's first row only. See [`leaf_core::VRow::directive_label`].
271    pub directive_label: Option<String>,
272    /// The heading level (1–6) if this row belongs to a heading block, else
273    /// `None`. A proportional renderer sizes the *whole* row from this so an
274    /// inline `` `code` `` run inside a heading still reads at the heading's size.
275    pub heading: Option<u8>,
276    /// What this row divides, on the blank rows a block boundary is drawn with
277    /// and `None` everywhere else — so `boundary != nil` is exactly "this row is
278    /// a drawn block boundary". A frontend spaces a boundary by the pair it
279    /// falls between (the margin above a heading is wider than the one between
280    /// two paragraphs); the *height* is the frontend's, the *kind* is core's.
281    /// See [`leaf_core::Boundary`].
282    pub boundary: Option<Boundary>,
283}
284
285/// What a drawn block boundary separates. The FFI mirror of
286/// [`leaf_core::Boundary`].
287#[derive(uniffi::Record)]
288pub struct Boundary {
289    pub above: BlockClass,
290    pub below: BlockClass,
291}
292
293/// The block kinds core tells apart — the vocabulary a [`Boundary`] is spelled
294/// in. The FFI mirror of [`leaf_core::BlockClass`]; `Other` covers every kind
295/// core doesn't separate out, so a frontend's `match` stays exhaustive as the
296/// list grows.
297#[derive(uniffi::Enum)]
298pub enum BlockClass {
299    Paragraph,
300    Heading,
301    /// A whole list. Core draws no boundary row *between* two items of one list,
302    /// tight or loose, so an `ListItem`↔`ListItem` pair never reaches a frontend.
303    List,
304    ListItem,
305    Quote,
306    Code,
307    Table,
308    Media,
309    Directive,
310    Rule,
311    Footnote,
312    Other,
313}
314
315impl From<leaf_core::BlockClass> for BlockClass {
316    fn from(k: leaf_core::BlockClass) -> Self {
317        use leaf_core::BlockClass as K;
318        match k {
319            K::Paragraph => BlockClass::Paragraph,
320            K::Heading => BlockClass::Heading,
321            K::List => BlockClass::List,
322            K::ListItem => BlockClass::ListItem,
323            K::Quote => BlockClass::Quote,
324            K::Code => BlockClass::Code,
325            K::Table => BlockClass::Table,
326            K::Media => BlockClass::Media,
327            K::Directive => BlockClass::Directive,
328            K::Rule => BlockClass::Rule,
329            K::Footnote => BlockClass::Footnote,
330            K::Other => BlockClass::Other,
331        }
332    }
333}
334
335/// One *visual line* of a table cell: its styled runs and the source offsets
336/// bounding it. A cell is usually one line, but an in-cell hard break (an inline
337/// `<br>`) splits it into several — each its own line here, so the frontend
338/// shapes and caret-maps them independently (the byte↔UTF-16 offset math a cell
339/// needs holds within a line, which carries no break). The runs are *unwrapped*:
340/// column width — and any soft wrap within it — is the frontend's to decide.
341#[derive(uniffi::Record)]
342pub struct TableCellLineView {
343    pub runs: Vec<Run>,
344    /// The source offsets bounding this line's content — the caret home at its
345    /// start and the stop just past its end.
346    pub start: u32,
347    pub end: u32,
348}
349
350/// One cell of a table's structural grid: its content as one or more visual
351/// lines, the column alignment its text honours, and the source range the whole
352/// cell occupies (where a click or the caret lands).
353#[derive(uniffi::Record)]
354pub struct TableCellView {
355    /// The cell's lines, in order — one unless an in-cell `<br>` splits it.
356    pub lines: Vec<TableCellLineView>,
357    /// `"left"`, `"right"`, `"center"`, or `"default"`.
358    pub align: String,
359    /// The source offsets bounding the cell's content — the caret anchors a
360    /// click in the cell resolves to.
361    pub start: u32,
362    pub end: u32,
363}
364
365/// One row of a table's structural grid; a header row draws bold and is ruled
366/// off from the body below it.
367#[derive(uniffi::Record)]
368pub struct TableRowView {
369    pub head: bool,
370    pub cells: Vec<TableCellView>,
371}
372
373/// A table described *structurally* rather than as the monospace box-glyph
374/// picture that spells it in [`DocView::rows`]. A proportional renderer draws its
375/// own grid from this — columns sized to content, real borders — and SKIPS the
376/// picture rows in `[start_row, end_row)`. The two describe the same cells at the
377/// same source offsets, so the caret lands identically either way. See
378/// [`leaf_core::TableInfo`].
379#[derive(uniffi::Record)]
380pub struct TableView {
381    /// The [`DocView::rows`] indices the box-drawn picture occupies — the rows a
382    /// grid-drawing frontend skips.
383    pub start_row: u32,
384    pub end_row: u32,
385    pub grid: Vec<TableRowView>,
386}
387
388/// A leaf directive (`::name{…}`) — a standalone block with no body, drawn in
389/// [`DocView::rows`] as a one-row `⧉ name` placeholder. A frontend that knows
390/// the host app's vocabulary reads this and paints the real thing over the rows
391/// in `[start_row, end_row)` — a web view for diaryx's `::embed{src=…}`, say —
392/// exactly as a grid-drawing one replaces a [`TableView`]'s picture rows. One
393/// that doesn't just paints the placeholder, which is already framed by the
394/// directive panel chrome.
395///
396/// Core resolves nothing here and neither does this layer: the vocabulary
397/// belongs to the app. See [`leaf_core::DirectiveInfo`].
398#[derive(uniffi::Record)]
399pub struct DirectiveView {
400    /// The [`DocView::rows`] indices the placeholder occupies.
401    pub start_row: u32,
402    pub end_row: u32,
403    /// The directive's type (`embed`, `toc`, `vis`), no leading colons.
404    pub name: String,
405    /// Its `[label]` text, or empty — what the placeholder row shows.
406    pub label: String,
407    /// Its `{…}` attributes in source order. A bare attribute (`{public}`) has an
408    /// empty value, which a consumer reads as a flag.
409    pub attrs: Vec<DirectiveAttr>,
410}
411
412/// One `{key=value}` attribute of a [`DirectiveView`]. A record rather than a
413/// tuple because UniFFI has no tuple type; an absent value flattens to `""`,
414/// since a bare attribute is a flag and the distinction from `key=""` has no
415/// consumer on this side.
416#[derive(uniffi::Record)]
417pub struct DirectiveAttr {
418    pub key: String,
419    pub value: String,
420}
421
422/// What a block-level media placeholder is, so Swift knows which view to build
423/// over the rows core reserved: an `NSImageView`/`UIImageView`, or an
424/// `AVPlayerView` with or without a picture to show. The peer of
425/// [`leaf_core::MediaKind`].
426#[derive(uniffi::Enum)]
427pub enum MediaKind {
428    Image,
429    Video,
430    Audio,
431}
432
433/// One `<source>` alternative of a block media element — a candidate URL plus
434/// whichever of the two things HTML picks a `<source>` by: a media query
435/// (`<picture>`) or a MIME type (`<video>`/`<audio>`).
436///
437/// Unlike the web frontend, which hands the whole list to the browser and lets
438/// it choose, a native renderer usually wants [`MediaView::src`] — already
439/// resolved for the current appearance — and reaches in here only to pick a
440/// codec `AVFoundation` can actually play.
441#[derive(uniffi::Record)]
442pub struct MediaSourceView {
443    /// The `media="…"` query, or empty for an unconditional source.
444    pub media: String,
445    /// The candidate URL (a `<picture>` `srcset` or a `<video>`/`<audio>` `src`).
446    pub src: String,
447    /// The `type="…"` MIME (`"video/webm"`), or empty when none is declared.
448    pub mime: String,
449}
450
451/// One block-level image, video, or audio: which rows core reserved for it and
452/// what to build there. The peer of [`leaf_core::MediaInfo`], and the media
453/// analogue of [`DirectiveView`] — a frontend **skips the rows in
454/// `start_row..end_row`** and lays its own view over them, rather than painting
455/// the `🖼`/`🎬`/`🔊` placeholder glyphs core put there for a surface that can't.
456#[derive(uniffi::Record)]
457pub struct MediaView {
458    /// The [`DocView::rows`] indices the placeholder occupies.
459    pub start_row: u32,
460    pub end_row: u32,
461    /// Which of the three this is — the view to build.
462    pub kind: MediaKind,
463    /// The URL to load, already resolved against the current appearance (see
464    /// [`LeafDoc::set_dark_appearance`]). A relative path resolves against the
465    /// document's own directory, which core does not know — the host does.
466    /// Empty only when a `<video>`/`<audio>` named neither a `src` nor a
467    /// `<source>`, which is a broken document.
468    pub src: String,
469    /// A `<video>`'s poster frame URL, or empty. An image destination, so it
470    /// loads exactly as an image `src` does — worth showing before the movie is
471    /// ready, or in place of one that won't play.
472    pub poster: String,
473    /// The alt / fallback text, for the view's accessibility label.
474    pub alt: String,
475    /// The `<source>` alternatives in document order; empty for a plain image.
476    pub sources: Vec<MediaSourceView>,
477}
478
479/// A per-destination measured height, the way Swift reports one back — the input
480/// half of the loop [`LeafDoc::set_media_rows`] closes.
481#[derive(uniffi::Record)]
482pub struct MediaHeight {
483    /// The media's `src` as it appeared in the document, keying it to a
484    /// [`MediaView`].
485    pub destination: String,
486    /// How many visual rows the laid-out view needs.
487    pub rows: u32,
488}
489
490/// A whole rendered frame: the rows to paint, where the caret sits, and the
491/// toolbar state — everything the Swift side needs for one repaint, in one value.
492/// Returned by every view-producing method.
493#[derive(uniffi::Record)]
494pub struct DocView {
495    pub rows: Vec<Row>,
496    /// Tables described structurally, for a frontend that draws its own grid
497    /// instead of painting the box-glyph rows. Empty in the source view. Each
498    /// names the `rows` span its picture occupies, to be skipped.
499    pub tables: Vec<TableView>,
500    /// Leaf directives (`::name{…}`) described structurally, for a frontend that
501    /// paints what the host app's vocabulary makes of them instead of the `⧉`
502    /// placeholder row. Empty in the source view, where the directive is the
503    /// literal text the caret is editing.
504    pub directives: Vec<DirectiveView>,
505    /// Block-level images, videos, and audio described structurally, for a
506    /// frontend that lays real views over the rows core reserved instead of
507    /// painting the placeholder glyphs. Empty in the source view, where the
508    /// `![](…)` or `<video>` markup is the literal text being edited.
509    pub media: Vec<MediaView>,
510    /// The caret's row: an index into [`Self::rows`].
511    pub caret_row: u32,
512    /// The caret's display *column* within its row — core's grid position. Kept
513    /// for callers reasoning in columns; a proportional renderer wants
514    /// [`Self::caret_ch`] instead.
515    pub caret_col: u32,
516    /// The caret's offset within its row's text in **UTF-16 code units** — what
517    /// `NSAttributedString`/`NSTextView` count to. This is `caret_col` mapped
518    /// through the row's grapheme widths, so it lands the caret correctly past
519    /// wide glyphs (CJK, emoji) where a column and a character index diverge.
520    pub caret_ch: u32,
521    /// The caret's **source byte offset** — the coordinate a table cell is keyed
522    /// by (`TableCellView::start`/`end`), so a frontend drawing its own grid can
523    /// find which cell the caret sits in without the picture-row indices.
524    pub caret_src: u32,
525    /// Whether a (non-empty) selection is active.
526    pub has_selection: bool,
527    /// The selection's *fixed* end (the caret is the moving end), as a row and a
528    /// UTF-16 offset — so the renderer can restore a native selection with the
529    /// same direction the model has. Equal to the caret when `has_selection` is
530    /// false.
531    pub anchor_row: u32,
532    pub anchor_ch: u32,
533    /// Whether the buffer differs from the last saved bytes — for a "● modified"
534    /// affordance.
535    pub dirty: bool,
536    /// Whether there is a step to undo, and one to redo — what a native Edit
537    /// menu or an undo manager enables its items by. Both false on a read-only
538    /// document. See [`leaf_core::Doc::can_undo`] for the bound this is.
539    pub can_undo: bool,
540    pub can_redo: bool,
541    /// `"wysiwyg"` or `"source"`, for a view-toggle affordance.
542    pub view: String,
543    /// The heading level at the caret, if any — a toolbar lights H1…H6 from it.
544    pub heading: Option<u32>,
545    /// The inline marks active at the caret (`bold`, `italic`, `code`, …) — the
546    /// toolbar lights the matching buttons.
547    pub active: Vec<String>,
548    /// The destination of the link the caret stands in, or `None` — the toolbar
549    /// lights its Link button from it and seeds an edit of that link with it.
550    ///
551    /// It rides the frame rather than being a query a toolbar makes for itself
552    /// because a toolbar only redraws when the *state* changes: walking the caret
553    /// out of a link changes no mark, no heading, and no dirty flag, so a Link
554    /// button reading this by a call of its own would keep a stale light on. Same
555    /// reason `heading` is here and not asked for.
556    ///
557    /// Only a *parsed* link answers ([`LeafDoc::link_destination_at_caret`]);
558    /// a wikilink is literal text with no node behind it, and has nothing to
559    /// repoint — see `LinkTarget.swift`.
560    pub link: Option<String>,
561    /// The colour of the highlight the caret stands in — which swatch a colour
562    /// palette draws as the current one, and `None` both outside a highlight and
563    /// inside an uncoloured one.
564    ///
565    /// It rides the frame for `link`'s reason, and more sharply: walking from a
566    /// red highlight into a blue one changes no mark, no heading, no dirty flag
567    /// and no link, so a palette asking for itself would never be told to move
568    /// its checkmark.
569    ///
570    /// An enum rather than the name string [`Run::mark_color`] carries, because
571    /// the two are different questions. A run's colour is a *rendering* hint that
572    /// has to survive a name this build has never heard of (a newer twig's
573    /// eighth colour draws as a plain highlight rather than not at all); this is
574    /// the closed palette a control offers, and a name outside it is not a
575    /// swatch anyone can press.
576    pub mark_color: Option<MarkColor>,
577}
578
579/// The colour of a highlight — the closed palette [`LeafDoc::set_mark_color`]
580/// writes and [`DocView::mark_color`] reports.
581///
582/// Obsidian's spelling, which is twig's: a circle emoji straight after the
583/// opening `==`, so `==🔴 text==` is a highlight of `text` in [`MarkColor::Red`].
584/// The emoji is *spelling* rather than content — it never appears in the text a
585/// reader sees, and never in a [`Run`].
586#[derive(Clone, Copy, Debug, Eq, PartialEq, uniffi::Enum)]
587pub enum MarkColor {
588    Red,
589    Orange,
590    Yellow,
591    Green,
592    Blue,
593    Purple,
594    Brown,
595}
596
597impl From<CoreMarkColor> for MarkColor {
598    fn from(c: CoreMarkColor) -> Self {
599        match c {
600            CoreMarkColor::Red => MarkColor::Red,
601            CoreMarkColor::Orange => MarkColor::Orange,
602            CoreMarkColor::Yellow => MarkColor::Yellow,
603            CoreMarkColor::Green => MarkColor::Green,
604            CoreMarkColor::Blue => MarkColor::Blue,
605            CoreMarkColor::Purple => MarkColor::Purple,
606            CoreMarkColor::Brown => MarkColor::Brown,
607        }
608    }
609}
610
611impl From<MarkColor> for CoreMarkColor {
612    fn from(c: MarkColor) -> Self {
613        match c {
614            MarkColor::Red => CoreMarkColor::Red,
615            MarkColor::Orange => CoreMarkColor::Orange,
616            MarkColor::Yellow => CoreMarkColor::Yellow,
617            MarkColor::Green => CoreMarkColor::Green,
618            MarkColor::Blue => CoreMarkColor::Blue,
619            MarkColor::Purple => CoreMarkColor::Purple,
620            MarkColor::Brown => CoreMarkColor::Brown,
621        }
622    }
623}
624
625/// A visual position: a row index plus a UTF-16 offset within that row's text —
626/// the coordinate the geometry side (Core Text) draws from. Returned by
627/// [`LeafDoc::pos_for_offset`], the bridge from a source offset (what a
628/// `UITextPosition` wraps) to where it sits on screen.
629#[derive(uniffi::Record)]
630pub struct RowCol {
631    pub row: u32,
632    pub ch: u32,
633}
634
635/// The rows a source range covers, both ends **inclusive** — what a frontend
636/// slices out of a frame to draw a block somewhere other than where it sits: a
637/// footnote peek, a link peek, a landing flash. Returned by
638/// [`LeafDoc::row_range_for`].
639///
640/// Inclusive rather than half-open because the answer is "these rows", not "up
641/// to here": every caller wants `rows[first...last]`, and a `last` one past the
642/// end would be a second thing to get wrong at each of them. `last >= first`
643/// always, so the pair is never empty — a range with no visible byte still
644/// covers the row it opened on.
645#[derive(uniffi::Record)]
646pub struct RowRange {
647    pub first: u32,
648    pub last: u32,
649}
650
651/// Which formatting controls this document's format can spell — the toolbar's
652/// enabled state, one flag per button, from [`LeafDoc::capabilities`]. Mirrors
653/// [`leaf_core::Capabilities`], where the reasoning lives.
654///
655/// Its shape is a flat record of `Bool`s rather than a query taking a gesture
656/// because the Swift side wants exactly one crossing and a value it can hold in
657/// an `@Observable`: `let caps = doc.capabilities()`, then
658/// `.disabled(!caps.bold)` on each control.
659#[derive(uniffi::Record)]
660pub struct Capabilities {
661    pub bold: bool,
662    pub italic: bool,
663    pub code: bool,
664    pub mark: bool,
665    pub underline: bool,
666    pub strike: bool,
667    /// [`LeafDoc::set_mark_color`] — the highlight *palette*, which Markdown
668    /// spells and djot does not, though both spell the highlight itself. Gate
669    /// the swatches on this *and* on [`LeafDoc::caret_in_mark`], the way the grid
670    /// controls take `table` and `caret_in_table`: one is a fact about the
671    /// format, the other about where the caret is standing.
672    pub mark_color: bool,
673    pub superscript: bool,
674    pub subscript: bool,
675    /// Both [`LeafDoc::set_heading`] and [`LeafDoc::set_paragraph`] — they are
676    /// the same gesture in core and stand or fall together.
677    pub heading: bool,
678    pub blockquote: bool,
679    pub bullet_list: bool,
680    pub ordered_list: bool,
681    /// [`LeafDoc::toggle_task_item`], [`LeafDoc::toggle_task_checked`] and
682    /// [`LeafDoc::toggle_task_at`] — including a *tap* on a rendered checkbox,
683    /// which should not be live where the box cannot be spelled.
684    pub task: bool,
685    pub link: bool,
686    /// [`LeafDoc::insert_image`] and [`LeafDoc::insert_media`] both.
687    pub image: bool,
688    pub thematic_break: bool,
689    /// [`LeafDoc::insert_footnote`]. Markdown and djot spell the pair; HTML does
690    /// not, so the button goes rather than dims into a refusal.
691    pub footnote: bool,
692    pub code_language: bool,
693    /// The grid controls. Gate them on this *and* [`LeafDoc::caret_in_table`]:
694    /// this asks whether the format's tables are editable, that whether the
695    /// caret is in one.
696    pub table: bool,
697    /// Shift+Return inside a cell — [`LeafDoc::cell_line_break`].
698    pub cell_line_break: bool,
699}
700
701impl From<CoreCapabilities> for Capabilities {
702    fn from(c: CoreCapabilities) -> Self {
703        Self {
704            bold: c.bold,
705            italic: c.italic,
706            code: c.code,
707            mark: c.mark,
708            underline: c.underline,
709            strike: c.strike,
710            mark_color: c.mark_color,
711            superscript: c.superscript,
712            // `subscript` is a Swift keyword; uniffi escapes it in the generated
713            // binding (`caps.`subscript``), so the field keeps its real name
714            // here rather than wearing a suffix on both sides of the boundary.
715            subscript: c.subscript,
716            heading: c.heading,
717            blockquote: c.blockquote,
718            bullet_list: c.bullet_list,
719            ordered_list: c.ordered_list,
720            task: c.task,
721            link: c.link,
722            image: c.image,
723            thematic_break: c.thematic_break,
724            footnote: c.footnote,
725            code_language: c.code_language,
726            table: c.table,
727            cell_line_break: c.cell_line_break,
728        }
729    }
730}
731
732/// A table column's text alignment — the argument to
733/// [`LeafDoc::table_set_alignment`]. Mirrors twig's `Alignment`.
734#[derive(uniffi::Enum)]
735pub enum TableAlignment {
736    Default,
737    Left,
738    Right,
739    Center,
740}
741
742impl TableAlignment {
743    fn into_core(self) -> Alignment {
744        match self {
745            TableAlignment::Default => Alignment::Default,
746            TableAlignment::Left => Alignment::Left,
747            TableAlignment::Right => Alignment::Right,
748            TableAlignment::Center => Alignment::Center,
749        }
750    }
751}
752
753/// How much of the source markup the rich view exposes — the argument to
754/// [`LeafDoc::set_markup_mode`]. Mirrors [`leaf_core::MarkupMode`]; `None`
755/// is the default (the clean surface Diaryx ships, with typed syntax kept
756/// literal).
757///
758/// A single three-way ladder rather than a pair of toggles, because only three
759/// of the four combinations of its two axes — reveal the caret's delimiters,
760/// author markup from typing — are coherent. See [`leaf_core::MarkupMode`]
761/// for which one is left out and why.
762#[derive(uniffi::Enum)]
763pub enum MarkupMode {
764    None,
765    Shortcuts,
766    Full,
767}
768
769impl MarkupMode {
770    fn into_core(self) -> CoreMarkupMode {
771        match self {
772            MarkupMode::None => CoreMarkupMode::None,
773            MarkupMode::Shortcuts => CoreMarkupMode::Shortcuts,
774            MarkupMode::Full => CoreMarkupMode::Full,
775        }
776    }
777
778    fn from_core(mode: CoreMarkupMode) -> Self {
779        match mode {
780            CoreMarkupMode::None => MarkupMode::None,
781            CoreMarkupMode::Shortcuts => MarkupMode::Shortcuts,
782            CoreMarkupMode::Full => MarkupMode::Full,
783        }
784    }
785}
786
787/// How the rich view treats a soft break (a bare newline inside a paragraph) —
788/// the argument to [`LeafDoc::set_line_flow`]. Mirrors [`leaf_core::LineFlow`];
789/// `Fold` is the default (soft breaks reflow into the paragraph, as before).
790#[derive(uniffi::Enum)]
791pub enum LineFlow {
792    Fold,
793    Preserve,
794}
795
796impl LineFlow {
797    fn into_core(self) -> CoreLineFlow {
798        match self {
799            LineFlow::Fold => CoreLineFlow::Fold,
800            LineFlow::Preserve => CoreLineFlow::Preserve,
801        }
802    }
803
804    fn from_core(mode: CoreLineFlow) -> Self {
805        match mode {
806            CoreLineFlow::Fold => LineFlow::Fold,
807            CoreLineFlow::Preserve => LineFlow::Preserve,
808        }
809    }
810}
811
812/// A live leaf document bound for a native Apple frontend: `leaf_core::Doc` plus
813/// the wrap width the current viewport implies, behind a mutex. Constructed from
814/// an in-memory string and driven entirely through method calls — there is no
815/// filesystem behind it.
816#[derive(uniffi::Object)]
817pub struct LeafDoc {
818    inner: Mutex<Inner>,
819}
820
821/// The guarded state. Its methods assume the lock is held (they take `&mut
822/// self`); the [`LeafDoc`] exported wrappers acquire it, delegate, and return the
823/// resulting frame.
824struct Inner {
825    doc: Doc,
826    /// The wrap mode. `Some(cols)` wraps the map at that column budget (a terminal,
827    /// or a fixed-cell frontend); `None` builds it **unwrapped** — one row per block —
828    /// for a proportional GUI that wraps at its own pixel width. `build_visual`
829    /// caches on `(revision, width)`, so re-syncing when neither moved is free.
830    width: Option<usize>,
831    /// The host's current appearance, which a `<picture>`'s `prefers-color-scheme`
832    /// `<source>`s are matched against when resolving a block image's URL. Core
833    /// has no theme of its own, so this is AppKit/UIKit answering on its behalf;
834    /// defaults to light until the host calls
835    /// [`LeafDoc::set_dark_appearance`].
836    scheme: ColorScheme,
837}
838
839// SAFETY: `Doc` embeds a `twig::Editor`, which holds a `NonNull<TwigEditor>` and
840// is therefore `!Send`. UniFFI hands `LeafDoc` to Swift as a reference-counted
841// handle that must be `Send + Sync`, so `Inner` must be `Send`. This is sound
842// because:
843//   1. Every access goes through `LeafDoc::lock()` — the `Mutex` serializes all
844//      reads and mutations, so there is never concurrent access to the handle.
845//   2. twig's editor handle owns a plain heap allocation with no thread-affinity
846//      (no thread-locals, no per-thread state) — moving the pointer between
847//      threads is fine as long as use is serialized, which (1) guarantees.
848// The intended usage is still main-thread-driven; this impl only permits the
849// handle to cross threads safely, it does not invite concurrent use.
850unsafe impl Send for Inner {}
851
852impl Inner {
853    /// Rebuild the visual map at the current width. Cheap (cached) when nothing
854    /// changed; the guard that lets every movement/click method assume a fresh
855    /// grid regardless of call order.
856    fn sync(&mut self) {
857        match self.width {
858            Some(w) => self.doc.build_visual(w),
859            None => self.doc.build_visual_unwrapped(),
860        }
861    }
862
863    /// The plain text of visual row `row` in the active view — the string the
864    /// renderer concatenates its runs into. Backs the column⇄UTF-16 mapping.
865    fn row_text(&self, row: usize) -> String {
866        match self.doc.view {
867            View::Wysiwyg => self
868                .doc
869                .vmap
870                .rows
871                .get(row)
872                .map(|r| r.glyphs.iter().map(|g| g.ch).collect())
873                .unwrap_or_default(),
874            View::Source => self
875                .doc
876                .source
877                .split('\n')
878                .nth(row)
879                .unwrap_or("")
880                .to_string(),
881        }
882    }
883
884    /// The `(row, display-column)` a source offset sits at in the active view.
885    fn pos_of_offset(&self, off: usize) -> (usize, usize) {
886        match self.doc.view {
887            View::Wysiwyg => self.doc.vmap.pos_of_offset(off),
888            View::Source => {
889                let s = &self.doc.source;
890                // Walk back to a character boundary, not just into range. Every
891                // offset here arrives from a UI toolkit counting in its own
892                // units, so one landing mid-character is ordinary input — and
893                // slicing on it aborts the process across an FFI boundary that
894                // has no unwinding. `snap_stop` and `text_in_range` already do
895                // this; this was the one door left open.
896                let mut off = off.min(s.len());
897                while off > 0 && !s.is_char_boundary(off) {
898                    off -= 1;
899                }
900                let row = s[..off].bytes().filter(|&b| b == b'\n').count();
901                let line_start = s[..off].rfind('\n').map_or(0, |i| i + 1);
902                (row, text_width(&s[line_start..off]))
903            }
904        }
905    }
906
907    /// The inclusive row span a source range occupies in the active view.
908    ///
909    /// The rich view defers to [`leaf_core::wysiwyg::VisualMap::row_range_for`],
910    /// where the reasoning lives. The source view has no hidden bytes at all —
911    /// every byte is drawn on the line it is written on — so counting newlines
912    /// is the whole answer, and the last row is the one holding the range's last
913    /// byte rather than the one past it.
914    fn row_range_for(&self, start: usize, end: usize) -> (usize, usize) {
915        match self.doc.view {
916            View::Wysiwyg => self.doc.vmap.row_range_for(start..end),
917            View::Source => {
918                let first = self.pos_of_offset(start).0;
919                let last = self.pos_of_offset(end.max(start.saturating_add(1)) - 1).0;
920                (first, last.max(first))
921            }
922        }
923    }
924
925    /// The source offset under a click at row `row`, `ch` UTF-16 units in.
926    fn offset_at(&mut self, row: usize, ch: usize) -> usize {
927        self.sync();
928        let col = utf16_to_col(&self.row_text(row), ch);
929        self.doc.click(row, col, false);
930        self.doc.caret
931    }
932
933    // ── position mapping for UITextInput (non-mutating; caret untouched) ───────
934    // These branch by view exactly as `pos_of_offset` does, so the WYSIWYG map and
935    // the raw-source grid each answer in their own coordinates.
936
937    /// The source offset of display column `col` on visual `row` — the inverse of
938    /// [`Self::pos_of_offset`] in column space.
939    fn offset_of_col(&self, row: usize, col: usize) -> usize {
940        match self.doc.view {
941            View::Wysiwyg => self.doc.vmap.offset_of_pos(row, col),
942            View::Source => {
943                let line = self.row_text(row);
944                let (mut c, mut b) = (0usize, 0usize);
945                for g in line.graphemes(true) {
946                    if c >= col {
947                        break;
948                    }
949                    c += text_width(g);
950                    b += g.len();
951                }
952                self.source_line_start(row) + b
953            }
954        }
955    }
956
957    /// The byte offset where visual `row` begins in the source view.
958    fn source_line_start(&self, row: usize) -> usize {
959        self.doc
960            .source
961            .split('\n')
962            .take(row)
963            .map(|l| l.len() + 1)
964            .sum()
965    }
966
967    /// The next caret stop after `off`, or `None` at the end.
968    fn stop_after(&self, off: usize) -> Option<usize> {
969        match self.doc.view {
970            View::Wysiwyg => self.doc.vmap.stop_after(off),
971            View::Source => {
972                let s = &self.doc.source;
973                if off >= s.len() {
974                    None
975                } else {
976                    Some(
977                        s[off..]
978                            .grapheme_indices(true)
979                            .nth(1)
980                            .map_or(s.len(), |(i, _)| off + i),
981                    )
982                }
983            }
984        }
985    }
986
987    /// The previous caret stop before `off`, or `None` at the start.
988    fn stop_before(&self, off: usize) -> Option<usize> {
989        match self.doc.view {
990            View::Wysiwyg => self.doc.vmap.stop_before(off),
991            View::Source => {
992                let s = &self.doc.source;
993                let off = off.min(s.len());
994                if off == 0 {
995                    None
996                } else {
997                    s[..off].grapheme_indices(true).next_back().map(|(i, _)| i)
998                }
999            }
1000        }
1001    }
1002
1003    /// Snap `off` to a valid caret stop (WYSIWYG) / char boundary (source).
1004    fn snap_stop(&self, off: usize) -> usize {
1005        let s = &self.doc.source;
1006        let mut off = off.min(s.len());
1007        match self.doc.view {
1008            View::Wysiwyg => self.doc.vmap.snap_to_stop(off),
1009            View::Source => {
1010                while off > 0 && !s.is_char_boundary(off) {
1011                    off -= 1;
1012                }
1013                off
1014            }
1015        }
1016    }
1017
1018    /// The navigable visual row above `row`, if any.
1019    fn nav_above(&self, row: usize) -> Option<usize> {
1020        match self.doc.view {
1021            View::Wysiwyg => self.doc.vmap.navigable_above(row),
1022            View::Source => (row > 0).then(|| row - 1),
1023        }
1024    }
1025
1026    /// The navigable visual row below `row`, if any.
1027    fn nav_below(&self, row: usize) -> Option<usize> {
1028        match self.doc.view {
1029            View::Wysiwyg => self.doc.vmap.navigable_below(row),
1030            View::Source => {
1031                let n = self.doc.source.split('\n').count();
1032                (row + 1 < n).then_some(row + 1)
1033            }
1034        }
1035    }
1036
1037    /// Resolve the current document to a renderable frame of style runs. Called
1038    /// for the first paint, on resize, and by every mutating wrapper so one
1039    /// boundary crossing both edits and repaints.
1040    fn view(&mut self) -> DocView {
1041        self.sync();
1042
1043        let (ss, se) = self.doc.selection().unwrap_or((usize::MAX, usize::MAX));
1044
1045        // The two views speak different grids — the WYSIWYG map's resolved glyphs
1046        // vs the raw source split on newlines — and `caret_pos` branches to match,
1047        // so the rows must too or the caret lands on the wrong text.
1048        let rows = match self.doc.view {
1049            View::Wysiwyg => wysiwyg_rows(&self.doc.vmap, ss, se, self.doc.highlights()),
1050            View::Source => source_rows(&self.doc.source, ss, se),
1051        };
1052        // Structural tables, for a proportional renderer that draws its own grid;
1053        // none in the source view (the caret rides raw pipe text there).
1054        let tables = match self.doc.view {
1055            View::Wysiwyg => wysiwyg_tables(&self.doc.vmap, ss, se, self.doc.highlights()),
1056            View::Source => Vec::new(),
1057        };
1058
1059        // Leaf directives, on the same terms as the tables above: structural in
1060        // the rich view, absent in the source view.
1061        let directives = match self.doc.view {
1062            View::Wysiwyg => wysiwyg_directives(&self.doc.vmap),
1063            View::Source => Vec::new(),
1064        };
1065
1066        // Block media, on the same terms again: only the rich view has
1067        // placeholder rows to lay a view over.
1068        let media = match self.doc.view {
1069            View::Wysiwyg => wysiwyg_media(&self.doc.vmap, self.scheme),
1070            View::Source => Vec::new(),
1071        };
1072
1073        let (caret_row, caret_col) = self.doc.caret_pos();
1074        // Map the caret's display column to a UTF-16 text offset so a native
1075        // renderer can place it past wide glyphs (see [`DocView::caret_ch`]).
1076        let caret_ch = col_to_utf16(&self.row_text(caret_row), caret_col);
1077        // The selection's fixed (anchor) end, in the same row/UTF-16 terms.
1078        let (has_selection, anchor_row, anchor_ch) = match self.doc.selection() {
1079            Some(_) => {
1080                let a = self.doc.anchor.unwrap_or(self.doc.caret);
1081                let (ar, ac) = self.pos_of_offset(a);
1082                (true, ar, col_to_utf16(&self.row_text(ar), ac))
1083            }
1084            None => (false, caret_row, caret_ch),
1085        };
1086        let heading = self.doc.current_heading_level();
1087        let active = self
1088            .doc
1089            .active_inline_marks()
1090            .iter()
1091            .map(|k| mark_id(k).to_string())
1092            .collect();
1093        let link = self.doc.link_destination_at_caret();
1094        let mark_color = self.doc.mark_color_at_caret().map(MarkColor::from);
1095
1096        DocView {
1097            rows,
1098            tables,
1099            directives,
1100            media,
1101            caret_row: caret_row as u32,
1102            caret_col: caret_col as u32,
1103            caret_ch: caret_ch as u32,
1104            caret_src: self.doc.caret.min(self.doc.source.len()) as u32,
1105            has_selection,
1106            anchor_row: anchor_row as u32,
1107            anchor_ch: anchor_ch as u32,
1108            dirty: self.doc.dirty,
1109            can_undo: self.doc.can_undo(),
1110            can_redo: self.doc.can_redo(),
1111            view: self.doc.view_name().to_string(),
1112            heading,
1113            active,
1114            link,
1115            mark_color,
1116        }
1117    }
1118}
1119
1120#[uniffi::export]
1121impl LeafDoc {
1122    /// Parse `source` as `format` (`"markdown"`/`"md"`, `"djot"`/`"dj"`,
1123    /// `"html"`, `"xml"`) into a live, untitled document.
1124    #[uniffi::constructor]
1125    pub fn new(source: String, format: String) -> Result<Arc<Self>, LeafError> {
1126        let format = match format.to_ascii_lowercase().as_str() {
1127            "markdown" | "md" => Format::Markdown,
1128            "djot" | "dj" => Format::Djot,
1129            "html" | "htm" => Format::Html,
1130            "xml" => Format::Xml,
1131            other => {
1132                return Err(LeafError::UnknownFormat {
1133                    name: other.to_string(),
1134                });
1135            }
1136        };
1137        let doc = Doc::from_source(source, format).map_err(|e| LeafError::Parse {
1138            message: e.to_string(),
1139        })?;
1140        Ok(Arc::new(LeafDoc {
1141            inner: Mutex::new(Inner {
1142                doc,
1143                width: Some(80),
1144                scheme: ColorScheme::Light,
1145            }),
1146        }))
1147    }
1148
1149    /// Resolve the current document to a renderable frame — the first paint.
1150    pub fn view(&self) -> DocView {
1151        self.lock().view()
1152    }
1153
1154    /// Set the wrap width (in columns) the viewport implies and repaint. For a
1155    /// fixed-cell frontend (a terminal); a proportional GUI uses [`set_unwrapped`].
1156    pub fn set_width(&self, cols: u32) -> DocView {
1157        let mut g = self.lock();
1158        g.width = Some((cols as usize).max(1));
1159        g.view()
1160    }
1161
1162    /// Switch to **unwrapped** layout — one visual row per block, no column wrapping —
1163    /// and repaint. A proportional GUI calls this once at start-up, then wraps each
1164    /// row at its own pixel width (the caret/hit/selection geometry it derives from
1165    /// the pixel wrap; core still owns the caret model, in byte offsets). Idempotent
1166    /// and cheap to leave in place across edits.
1167    pub fn set_unwrapped(&self) -> DocView {
1168        let mut g = self.lock();
1169        g.width = None;
1170        g.view()
1171    }
1172
1173    /// Tell core whether the host is in a dark appearance, so a `<picture>`'s
1174    /// `prefers-color-scheme` `<source>`s resolve to the right banner. Call it
1175    /// from `viewDidChangeEffectiveAppearance` (AppKit) or
1176    /// `traitCollectionDidChange` (UIKit).
1177    ///
1178    /// Cheap to call repeatedly: resolving at the same appearance yields the same
1179    /// URLs, and a renderer keying its views by `src` tears nothing down.
1180    pub fn set_dark_appearance(&self, dark: bool) -> DocView {
1181        let mut g = self.lock();
1182        g.scheme = if dark {
1183            ColorScheme::Dark
1184        } else {
1185            ColorScheme::Light
1186        };
1187        g.view()
1188    }
1189
1190    /// Report how many visual rows each block media actually needs, measured from
1191    /// the views the renderer laid out, keyed by the media's `src`.
1192    ///
1193    /// Core does no I/O and can't know how tall a picture or a player is, so this
1194    /// is the only way a placeholder grows past its default single row. The loop
1195    /// is: lay out at the current reservation → measure → call this → repaint if
1196    /// it changed. Handing over the same measurements again is a no-op, so a
1197    /// renderer can report its current state each frame without diffing first.
1198    ///
1199    /// A frontend that lays media out in its own units and simply reserves the
1200    /// vertical space itself (the way the gpui GUI does with images) never needs
1201    /// to call this at all.
1202    pub fn set_media_rows(&self, heights: Vec<MediaHeight>) -> DocView {
1203        let mut g = self.lock();
1204        g.doc.set_media_rows(
1205            heights
1206                .into_iter()
1207                .map(|h| (h.destination, h.rows.max(1) as usize))
1208                .collect(),
1209        );
1210        g.view()
1211    }
1212
1213    /// Insert a block-level image, video, or audio at the caret. Any selection
1214    /// becomes the alt / fallback text. See [`leaf_core::Doc::insert_media`] for
1215    /// the markup each kind spells.
1216    pub fn insert_media(&self, kind: MediaKind, destination: String, alt: String) -> DocView {
1217        let mut g = self.lock();
1218        let kind = match kind {
1219            MediaKind::Image => CoreMediaKind::Image,
1220            MediaKind::Video => CoreMediaKind::Video,
1221            MediaKind::Audio => CoreMediaKind::Audio,
1222        };
1223        g.doc.insert_media(kind, &destination, &alt);
1224        g.view()
1225    }
1226
1227    /// Insert a thematic break (`---`) at the caret — the toolbar's Horizontal
1228    /// Rule button. See [`leaf_core::Doc::insert_thematic_break`] for how it
1229    /// handles a selection, a blank line, and the caret sitting mid-paragraph,
1230    /// mid-list, or inside a quote.
1231    pub fn insert_thematic_break(&self) -> DocView {
1232        let mut g = self.lock();
1233        g.doc.insert_thematic_break();
1234        g.view()
1235    }
1236
1237    /// The current source text — for a save (write to disk / iCloud / a document
1238    /// wrapper) or a source-view display.
1239    pub fn source(&self) -> String {
1240        self.lock().doc.source.clone()
1241    }
1242
1243    /// The selected text, if any — for a clipboard copy/cut.
1244    pub fn selected_text(&self) -> Option<String> {
1245        self.lock().doc.selected_text().map(str::to_string)
1246    }
1247
1248    /// The selection as a quote with up to `context` characters of what
1249    /// surrounded it, cut from the **source** — the shape a host that cites or
1250    /// annotates a passage wants, findable in the document again by plain
1251    /// string search. `None` when nothing is selected. See
1252    /// `leaf_core::Doc::selection_quote`.
1253    pub fn selection_quote(&self, context: u32) -> Option<SelectionQuote> {
1254        let g = self.lock();
1255        g.doc
1256            .selection_quote(context as usize)
1257            .map(|q| SelectionQuote {
1258                exact: q.exact,
1259                prefix: q.prefix,
1260                suffix: q.suffix,
1261                start: q.start as u64,
1262                end: q.end as u64,
1263            })
1264    }
1265
1266    /// Whether the document refuses to change — see `set_read_only`.
1267    pub fn read_only(&self) -> bool {
1268        self.lock().doc.read_only()
1269    }
1270
1271    /// Turn the read-only gate on or off — a *reading* surface over the same
1272    /// rendering, selection and navigation the editor has. Enforced in core at
1273    /// the three doors every mutation goes through, so a host that also quiets
1274    /// its input chrome is polishing, not protecting.
1275    pub fn set_read_only(&self, on: bool) -> DocView {
1276        let mut g = self.lock();
1277        g.doc.set_read_only(on);
1278        g.view()
1279    }
1280
1281    /// Replace the host-painted source ranges wholesale and repaint — see
1282    /// `leaf_core::Doc::set_highlights` for why it is a replace, and
1283    /// [`Highlight`] for what one is.
1284    pub fn set_highlights(&self, highlights: Vec<Highlight>) -> DocView {
1285        let mut g = self.lock();
1286        let hls = highlights
1287            .into_iter()
1288            .map(|h| leaf_core::Highlight {
1289                start: h.start as usize,
1290                end: h.end as usize,
1291                id: h.id,
1292                color: h.color,
1293                marker: h.marker,
1294            })
1295            .collect();
1296        g.doc.set_highlights(hls);
1297        g.view()
1298    }
1299
1300    /// The id of the highlight covering source `offset`, if one does — what a
1301    /// frontend asks when the reader activates a spot on the page.
1302    pub fn highlight_at(&self, offset: u32) -> Option<String> {
1303        self.lock()
1304            .doc
1305            .highlight_at(offset as usize)
1306            .map(|h| h.id.clone())
1307    }
1308
1309    /// The host-painted ranges as last set, sorted by start — what a frontend
1310    /// walks to lay out margin markers.
1311    pub fn highlights(&self) -> Vec<Highlight> {
1312        self.lock()
1313            .doc
1314            .highlights()
1315            .iter()
1316            .map(|h| Highlight {
1317                start: h.start as u64,
1318                end: h.end as u64,
1319                id: h.id.clone(),
1320                color: h.color.clone(),
1321                marker: h.marker.clone(),
1322            })
1323            .collect()
1324    }
1325
1326    /// Mark the buffer saved after the host persisted [`LeafDoc::source`] its own
1327    /// way — clears the dirty flag without touching a filesystem.
1328    pub fn mark_saved(&self) -> DocView {
1329        let mut g = self.lock();
1330        g.doc.mark_saved();
1331        g.view()
1332    }
1333
1334    // ── text input ───────────────────────────────────────────────────────────
1335
1336    pub fn insert(&self, text: String) -> DocView {
1337        let mut g = self.lock();
1338        g.doc.insert(&text);
1339        g.view()
1340    }
1341
1342    pub fn paste(&self, text: String) -> DocView {
1343        let mut g = self.lock();
1344        g.doc.paste(&text);
1345        g.view()
1346    }
1347
1348    pub fn newline(&self) -> DocView {
1349        let mut g = self.lock();
1350        g.doc.newline();
1351        g.view()
1352    }
1353
1354    /// Tab away from a table: indent the caret's line (or the selected lines) one
1355    /// level, nesting a list item under its sibling. The frontend calls this when
1356    /// [`LeafDoc::cell_tab`] declined because the caret isn't in a table.
1357    pub fn indent(&self) -> DocView {
1358        let mut g = self.lock();
1359        g.doc.indent();
1360        g.view()
1361    }
1362
1363    /// Shift+Tab away from a table: take one indent level back off the caret's
1364    /// line (or the selected lines), unnesting a list item. The mirror of
1365    /// [`LeafDoc::indent`].
1366    pub fn outdent(&self) -> DocView {
1367        let mut g = self.lock();
1368        g.doc.outdent();
1369        g.view()
1370    }
1371
1372    // ── table keys ────────────────────────────────────────────────────────────
1373    // Tab, Return, and Shift+Return take on table meanings when the caret is in
1374    // one. Each returns `Some(view)` when it acted as a table key and `None` when
1375    // the caret isn't in a table — the frontend then does the key's ordinary job
1376    // (indent, newline), so these keep their meaning everywhere else.
1377
1378    /// Tab (`forward`) / Shift+Tab hops to the next/previous cell; Tab past the
1379    /// last cell appends a fresh row and enters it.
1380    pub fn cell_tab(&self, forward: bool) -> Option<DocView> {
1381        let mut g = self.lock();
1382        g.sync();
1383        g.doc.cell_tab(forward).then(|| g.view())
1384    }
1385
1386    /// Return drops to the cell below in the same column, appending a row at the
1387    /// table's bottom.
1388    pub fn cell_return(&self) -> Option<DocView> {
1389        let mut g = self.lock();
1390        g.sync();
1391        g.doc.cell_return().then(|| g.view())
1392    }
1393
1394    /// Shift+Return inserts a hard line break *within* the current cell.
1395    pub fn cell_line_break(&self) -> Option<DocView> {
1396        let mut g = self.lock();
1397        g.sync();
1398        g.doc.cell_line_break().then(|| g.view())
1399    }
1400
1401    pub fn backspace(&self) -> DocView {
1402        let mut g = self.lock();
1403        g.doc.backspace();
1404        g.view()
1405    }
1406
1407    pub fn delete_forward(&self) -> DocView {
1408        let mut g = self.lock();
1409        g.doc.delete_forward();
1410        g.view()
1411    }
1412
1413    pub fn delete_word_back(&self) -> DocView {
1414        let mut g = self.lock();
1415        g.doc.delete_word_back();
1416        g.view()
1417    }
1418
1419    pub fn delete_word_forward(&self) -> DocView {
1420        let mut g = self.lock();
1421        g.doc.delete_word_forward();
1422        g.view()
1423    }
1424
1425    // ── caret movement ───────────────────────────────────────────────────────
1426    // Each syncs the grid first (movement reads the stop table / column layout),
1427    // moves, then repaints — `Inner::view` re-syncs but that's the cached no-op.
1428
1429    pub fn move_left(&self, extend: bool) -> DocView {
1430        let mut g = self.lock();
1431        g.sync();
1432        g.doc.move_left(extend);
1433        g.view()
1434    }
1435
1436    pub fn move_right(&self, extend: bool) -> DocView {
1437        let mut g = self.lock();
1438        g.sync();
1439        g.doc.move_right(extend);
1440        g.view()
1441    }
1442
1443    pub fn move_up(&self, extend: bool) -> DocView {
1444        let mut g = self.lock();
1445        g.sync();
1446        g.doc.move_up(extend);
1447        g.view()
1448    }
1449
1450    pub fn move_down(&self, extend: bool) -> DocView {
1451        let mut g = self.lock();
1452        g.sync();
1453        g.doc.move_down(extend);
1454        g.view()
1455    }
1456
1457    pub fn move_word_left(&self, extend: bool) -> DocView {
1458        let mut g = self.lock();
1459        g.sync();
1460        g.doc.move_word_left(extend);
1461        g.view()
1462    }
1463
1464    pub fn move_word_right(&self, extend: bool) -> DocView {
1465        let mut g = self.lock();
1466        g.sync();
1467        g.doc.move_word_right(extend);
1468        g.view()
1469    }
1470
1471    pub fn move_home(&self, extend: bool) -> DocView {
1472        let mut g = self.lock();
1473        g.sync();
1474        g.doc.move_home(extend);
1475        g.view()
1476    }
1477
1478    pub fn move_end(&self, extend: bool) -> DocView {
1479        let mut g = self.lock();
1480        g.sync();
1481        g.doc.move_end(extend);
1482        g.view()
1483    }
1484
1485    pub fn move_doc_start(&self, extend: bool) -> DocView {
1486        let mut g = self.lock();
1487        g.sync();
1488        g.doc.move_doc_start(extend);
1489        g.view()
1490    }
1491
1492    pub fn move_doc_end(&self, extend: bool) -> DocView {
1493        let mut g = self.lock();
1494        g.sync();
1495        g.doc.move_doc_end(extend);
1496        g.view()
1497    }
1498
1499    pub fn select_all(&self) -> DocView {
1500        let mut g = self.lock();
1501        g.doc.select_all();
1502        g.view()
1503    }
1504
1505    /// Place the caret from a click, in core's column grid: `row` indexes the
1506    /// visual [`Row`]s and `col` is the glyph column within it. Core clamps both
1507    /// to real caret stops. Prefer [`LeafDoc::click_ch`] from a proportional
1508    /// renderer.
1509    pub fn click(&self, row: u32, col: u32, extend: bool) -> DocView {
1510        let mut g = self.lock();
1511        g.sync();
1512        g.doc.click(row as usize, col as usize, extend);
1513        g.view()
1514    }
1515
1516    /// Place the caret from a click whose horizontal position is a **UTF-16
1517    /// offset** into the visual row's text — what `characterIndex(for:)` hands
1518    /// back. Converted to core's display column before clicking, so a proportional
1519    /// renderer never reasons about column widths itself.
1520    pub fn click_ch(&self, row: u32, ch: u32, extend: bool) -> DocView {
1521        let mut g = self.lock();
1522        g.sync();
1523        let col = utf16_to_col(&g.row_text(row as usize), ch as usize);
1524        g.doc.click(row as usize, col, extend);
1525        g.view()
1526    }
1527
1528    /// Select the word under a click (row, `ch`) — the double-click gesture.
1529    pub fn select_word_ch(&self, row: u32, ch: u32) -> DocView {
1530        let mut g = self.lock();
1531        let off = g.offset_at(row as usize, ch as usize);
1532        g.doc.select_word_at(off);
1533        g.view()
1534    }
1535
1536    /// Select the whole logical text block under a click (row, `ch`) — the
1537    /// triple-click gesture. Grabs the entire block even where it soft-wraps.
1538    pub fn select_block_ch(&self, row: u32, ch: u32) -> DocView {
1539        let mut g = self.lock();
1540        let off = g.offset_at(row as usize, ch as usize);
1541        g.doc.select_block_at(off);
1542        g.view()
1543    }
1544
1545    /// Mirror a native selection into the model: `[anchor, focus]` given as
1546    /// row + UTF-16 offset pairs. Each is resolved to a source offset the way a
1547    /// click is, then set as the selection's fixed and moving ends. A collapsed
1548    /// range (`anchor == focus`) just places the caret.
1549    pub fn set_selection(
1550        &self,
1551        anchor_row: u32,
1552        anchor_ch: u32,
1553        focus_row: u32,
1554        focus_ch: u32,
1555    ) -> DocView {
1556        let mut g = self.lock();
1557        let anchor = g.offset_at(anchor_row as usize, anchor_ch as usize);
1558        let focus = g.offset_at(focus_row as usize, focus_ch as usize);
1559        g.doc.place_caret(anchor, false);
1560        if anchor != focus {
1561            g.doc.place_caret(focus, true);
1562        }
1563        g.view()
1564    }
1565
1566    // ── rich clipboard (mirrors leaf-tui / leaf-gpui / leaf-wasm) ─────────────
1567
1568    /// The current selection rendered to HTML by twig — the rich flavor a copy
1569    /// writes alongside the plain [`LeafDoc::selected_text`]. `None` when nothing
1570    /// is selected.
1571    pub fn selection_html(&self) -> Option<String> {
1572        self.lock().doc.selection_html()
1573    }
1574
1575    /// Paste, preferring the clipboard's rich (`text/html`) flavor: twig parses
1576    /// `html` into the document's own markup and inserts it. Falls back to the
1577    /// plain `text` when there's no HTML or it doesn't parse.
1578    pub fn paste_rich(&self, html: Option<String>, text: String) -> DocView {
1579        let mut g = self.lock();
1580        let took = html.as_deref().is_some_and(|h| g.doc.paste_html(h));
1581        if !took {
1582            g.doc.paste(&text);
1583        }
1584        g.view()
1585    }
1586
1587    // ── formatting commands (mirror leaf-gpui's EditorCommand) ────────────────
1588
1589    pub fn toggle_bold(&self) -> DocView {
1590        let mut g = self.lock();
1591        g.doc.toggle(InlineKind::Strong);
1592        g.view()
1593    }
1594
1595    pub fn toggle_italic(&self) -> DocView {
1596        let mut g = self.lock();
1597        g.doc.toggle(InlineKind::Emph);
1598        g.view()
1599    }
1600
1601    pub fn toggle_code(&self) -> DocView {
1602        let mut g = self.lock();
1603        g.doc.toggle(InlineKind::Verbatim);
1604        g.view()
1605    }
1606
1607    pub fn toggle_mark(&self) -> DocView {
1608        let mut g = self.lock();
1609        g.doc.toggle(InlineKind::Mark);
1610        g.view()
1611    }
1612
1613    /// Whether the caret stands in a highlight — what a colour palette enables
1614    /// itself by, since a colour is a property of a highlight that already
1615    /// exists. The caret-side half of [`Capabilities::mark_color`].
1616    pub fn caret_in_mark(&self) -> bool {
1617        self.lock().doc.caret_in_mark()
1618    }
1619
1620    /// Colour the highlight at the caret, or clear its colour with `None`.
1621    ///
1622    /// Markdown only — `==🔴 text==` is its spelling and djot has none — and
1623    /// only where there is a highlight to colour: this does not make one, so a
1624    /// coloured highlight from bare text is [`LeafDoc::toggle_mark`] and then
1625    /// this, which is the order the button and its palette already sit in. Both
1626    /// refusals leave the document alone and say so in the status line.
1627    pub fn set_mark_color(&self, color: Option<MarkColor>) -> DocView {
1628        let mut g = self.lock();
1629        g.doc.set_mark_color(color.map(CoreMarkColor::from));
1630        g.view()
1631    }
1632
1633    /// One press of a colour swatch: colour the highlight at the caret, or —
1634    /// over a selection that isn't highlighted yet — highlight it and colour it,
1635    /// as **one** undo step.
1636    ///
1637    /// [`LeafDoc::set_mark_color`] is the exact gesture; this is the compound a
1638    /// toolbar presses, and it lives in core so that every frontend answers
1639    /// "what does a swatch mean over plain text" the same way. `None` clears the
1640    /// colour, and over an unhighlighted selection means simply "highlight
1641    /// this". A bare caret in no highlight is left alone.
1642    pub fn highlight(&self, color: Option<MarkColor>) -> DocView {
1643        let mut g = self.lock();
1644        g.doc.highlight(color.map(CoreMarkColor::from));
1645        g.view()
1646    }
1647
1648    pub fn toggle_underline(&self) -> DocView {
1649        let mut g = self.lock();
1650        g.doc.toggle(InlineKind::Insert);
1651        g.view()
1652    }
1653
1654    pub fn toggle_strike(&self) -> DocView {
1655        let mut g = self.lock();
1656        g.doc.toggle(InlineKind::Delete);
1657        g.view()
1658    }
1659
1660    pub fn set_paragraph(&self) -> DocView {
1661        let mut g = self.lock();
1662        g.doc.set_block(BlockKind::Paragraph);
1663        g.view()
1664    }
1665
1666    /// Toggle the current block to a heading of `level` (1–6); toggling the
1667    /// active level off returns it to a paragraph, per core.
1668    pub fn set_heading(&self, level: u32) -> DocView {
1669        let mut g = self.lock();
1670        g.doc.toggle_heading(level);
1671        g.view()
1672    }
1673
1674    pub fn toggle_blockquote(&self) -> DocView {
1675        let mut g = self.lock();
1676        g.doc.toggle_blockquote();
1677        g.view()
1678    }
1679
1680    pub fn toggle_list(&self, ordered: bool) -> DocView {
1681        let mut g = self.lock();
1682        g.doc.toggle_list(ordered);
1683        g.view()
1684    }
1685
1686    /// Tick or untick the task item at the caret. See
1687    /// [`leaf_core::Doc::toggle_task_checked`].
1688    pub fn toggle_task_checked(&self) -> DocView {
1689        let mut g = self.lock();
1690        g.doc.toggle_task_checked();
1691        g.view()
1692    }
1693
1694    /// Tick or untick the task item covering `offset` — a tap on a rendered
1695    /// checkbox, which must not drag the caret across the document to get there.
1696    pub fn toggle_task_at(&self, offset: u64) -> DocView {
1697        let mut g = self.lock();
1698        g.doc.toggle_task_at(offset as usize);
1699        g.view()
1700    }
1701
1702    /// Give the list item at the caret a checkbox, or take its checkbox away.
1703    pub fn toggle_task_item(&self) -> DocView {
1704        let mut g = self.lock();
1705        g.doc.toggle_task_item();
1706        g.view()
1707    }
1708
1709    /// Whether the item at the caret has a box and which way it faces — `None`
1710    /// for a plain list item or no item at all. Drives a toolbar's checked state.
1711    pub fn task_checked_at_caret(&self) -> Option<bool> {
1712        let mut g = self.lock();
1713        g.doc.task_checked_at_caret()
1714    }
1715
1716    /// Which of the formatting commands above this document's format can
1717    /// actually spell — one flag per control, for building the toolbar.
1718    ///
1719    /// Read once when a document opens: the answer depends only on the format,
1720    /// so it cannot change under an edit. Every command refuses on its own
1721    /// regardless — the model is the authority, not the toolbar — so a frontend
1722    /// that ignores this stays correct, it just offers buttons whose only effect
1723    /// is a line in the status bar.
1724    ///
1725    /// Don't collapse it to one flag. An HTML document takes ⌘B, ⌘I and inline
1726    /// code (its marks are a tag pair) while refusing every heading, list, quote
1727    /// and link, and Markdown refuses the underline djot spells — so a toolbar
1728    /// driven by [`Self::authorable`] alone would be wrong in both directions.
1729    pub fn capabilities(&self) -> Capabilities {
1730        self.lock().doc.capabilities().into()
1731    }
1732
1733    /// Whether this document's format offers *any* door in — `false` only for a
1734    /// wholly parse-only one (XML), where an app may as well open the file
1735    /// read-only and hide the formatting section outright. For anything finer,
1736    /// including whether to dim an individual button, use [`Self::capabilities`].
1737    pub fn authorable(&self) -> bool {
1738        self.lock().doc.authorable()
1739    }
1740
1741    // ── table editing ─────────────────────────────────────────────────────────
1742
1743    /// Whether the caret is inside a table — for enabling the table controls.
1744    /// Pair it with [`Capabilities::table`]: the caret is genuinely inside an
1745    /// HTML `<table>`, and the grid controls still cannot edit one.
1746    pub fn caret_in_table(&self) -> bool {
1747        self.lock().doc.caret_in_table()
1748    }
1749
1750    /// Insert an empty row below (`below`) or above the caret's row.
1751    pub fn table_insert_row(&self, below: bool) -> DocView {
1752        let mut g = self.lock();
1753        g.doc.table_insert_row(below);
1754        g.view()
1755    }
1756
1757    /// Delete the caret's row (not the header or the last body row).
1758    pub fn table_delete_row(&self) -> DocView {
1759        let mut g = self.lock();
1760        g.doc.table_delete_row();
1761        g.view()
1762    }
1763
1764    /// Insert an empty column right (`right`) or left of the caret's column.
1765    pub fn table_insert_column(&self, right: bool) -> DocView {
1766        let mut g = self.lock();
1767        g.doc.table_insert_column(right);
1768        g.view()
1769    }
1770
1771    /// Delete the caret's column (unless it is the only one).
1772    pub fn table_delete_column(&self) -> DocView {
1773        let mut g = self.lock();
1774        g.doc.table_delete_column();
1775        g.view()
1776    }
1777
1778    /// Set the caret's column to `alignment`.
1779    pub fn table_set_alignment(&self, alignment: TableAlignment) -> DocView {
1780        let mut g = self.lock();
1781        g.doc.table_set_alignment(alignment.into_core());
1782        g.view()
1783    }
1784
1785    /// Move the caret's row one place down (`down`) or up.
1786    pub fn table_move_row(&self, down: bool) -> DocView {
1787        let mut g = self.lock();
1788        g.doc.table_move_row(down);
1789        g.view()
1790    }
1791
1792    /// Move the caret's column one place right (`right`) or left.
1793    pub fn table_move_column(&self, right: bool) -> DocView {
1794        let mut g = self.lock();
1795        g.doc.table_move_column(right);
1796        g.view()
1797    }
1798
1799    pub fn insert_link(&self, destination: String) -> DocView {
1800        let mut g = self.lock();
1801        g.doc.insert_link(&destination);
1802        g.view()
1803    }
1804
1805    /// The destination of the link under the caret, if the caret is inside one —
1806    /// so a frontend can open it (⌘-click / "Open Link") or show it. `None` when the
1807    /// caret isn't on a link.
1808    pub fn link_destination_at_caret(&self) -> Option<String> {
1809        self.lock().doc.link_destination_at_caret()
1810    }
1811
1812    /// The destination of the link at byte offset `off` —
1813    /// [`link_destination_at_caret`](Self::link_destination_at_caret) for a place
1814    /// the caret isn't.
1815    ///
1816    /// What a frontend drawing part of the document *outside* the document asks:
1817    /// a footnote's text in a popover has link runs in it, and this is how those
1818    /// runs learn where they point, since a `Run` carries how a span looks and
1819    /// not what it means.
1820    pub fn link_destination_at(&self, off: u32) -> Option<String> {
1821        self.lock().doc.link_destination_at(off as usize)
1822    }
1823
1824    /// Where the locator `id` lands in this document — the `#v2` half of a
1825    /// `chapter.dj#v2`, resolved to the block it names. `None` when nothing here
1826    /// answers to it, which is a host's cue to open the document at its top
1827    /// rather than refuse to go.
1828    ///
1829    /// The query that gives a link finer granularity than the file. It reads an
1830    /// explicit `{#v1}`, a djot heading's minted id, or (for Markdown, which
1831    /// mints none) a heading's own words slugged — see [`leaf_core::Doc::locate`].
1832    ///
1833    /// Asked of *any* document, not only the open one: a host peeking at a
1834    /// citation builds a [`LeafDoc`] over the other file's bytes and asks this,
1835    /// which is what lets a hover show the verse instead of the filename.
1836    pub fn locate(&self, id: String) -> Option<LandingView> {
1837        self.lock().doc.locate(&id).map(LandingView::from)
1838    }
1839
1840    /// Write a footnote at the caret — the toolbar's Footnote button. Both the
1841    /// `[^1]` and the definition it needs go in as one edit (one undo takes both
1842    /// back), the label is the lowest number the document has free, and the caret
1843    /// is left **in the empty note** ready to type it. Gate the button on
1844    /// [`Capabilities::footnote`]; see [`leaf_core::Doc::insert_footnote`].
1845    pub fn insert_footnote(&self) -> DocView {
1846        let mut g = self.lock();
1847        g.doc.insert_footnote();
1848        g.view()
1849    }
1850
1851    /// The footnote reference under the caret, resolved to the note it names —
1852    /// so a frontend can show the note when a reader activates a `[1]`, instead
1853    /// of the nothing a reference click used to do. `None` when the caret isn't
1854    /// on a reference; see [`FootnoteView`] for the reference that resolved to
1855    /// no definition.
1856    pub fn footnote_at_caret(&self) -> Option<FootnoteView> {
1857        self.lock().doc.footnote_at_caret().map(FootnoteView::from)
1858    }
1859
1860    /// The footnote reference at byte offset `off`, resolved to the note it
1861    /// names — [`footnote_at_caret`](Self::footnote_at_caret) for a place the
1862    /// caret isn't.
1863    ///
1864    /// This is what a hover asks: a pointer resting on a `[1]` wants the note's
1865    /// text in a popover, and moving the caret to find out would yank the reader
1866    /// out of wherever they were typing.
1867    pub fn footnote_at(&self, off: u32) -> Option<FootnoteView> {
1868        self.lock()
1869            .doc
1870            .footnote_at(off as usize)
1871            .map(FootnoteView::from)
1872    }
1873
1874    /// The footnote definition the caret stands in, and where the reference that
1875    /// names it is — the return leg of [`footnote_at_caret`](Self::footnote_at_caret),
1876    /// so following a footnote is a round trip rather than a fall.
1877    ///
1878    /// `None` when the caret isn't in a definition, which is also how a frontend
1879    /// tells the two directions apart: the reference query answers up top, this
1880    /// one answers down in the notes, and never both at once.
1881    pub fn footnote_definition_at_caret(&self) -> Option<FootnoteDefView> {
1882        self.lock()
1883            .doc
1884            .footnote_definition_at_caret()
1885            .map(FootnoteDefView::from)
1886    }
1887
1888    pub fn undo(&self) -> DocView {
1889        let mut g = self.lock();
1890        g.doc.undo();
1891        g.view()
1892    }
1893
1894    pub fn redo(&self) -> DocView {
1895        let mut g = self.lock();
1896        g.doc.redo();
1897        g.view()
1898    }
1899
1900    /// Switch between the rendered WYSIWYG surface and the raw source.
1901    pub fn toggle_view(&self) -> DocView {
1902        let mut g = self.lock();
1903        g.doc.toggle_view();
1904        g.view()
1905    }
1906
1907    /// The current markup-exposure preference (see [`MarkupMode`]).
1908    pub fn markup_mode(&self) -> MarkupMode {
1909        MarkupMode::from_core(self.lock().doc.markup_mode())
1910    }
1911
1912    /// Set the markup-exposure preference. Returns a fresh view so a frontend
1913    /// can repaint — and under `Full` it must, because the returned view is the
1914    /// first one showing the caret's line raw. Diaryx leaves it at the `None`
1915    /// default.
1916    pub fn set_markup_mode(&self, mode: MarkupMode) -> DocView {
1917        let mut g = self.lock();
1918        g.doc.set_markup_mode(mode.into_core());
1919        g.view()
1920    }
1921
1922    /// The current soft-break flow preference (see [`LineFlow`]).
1923    pub fn line_flow(&self) -> LineFlow {
1924        LineFlow::from_core(self.lock().doc.line_flow())
1925    }
1926
1927    /// Set the soft-break flow preference. Returns a fresh view so a frontend
1928    /// can repaint: like the markup-exposure preference this one changes rendering
1929    /// immediately, laying preserved soft breaks out as their own rows.
1930    pub fn set_line_flow(&self, mode: LineFlow) -> DocView {
1931        let mut g = self.lock();
1932        g.doc.set_line_flow(mode.into_core());
1933        g.view()
1934    }
1935}
1936
1937// ── UITextInput support ──────────────────────────────────────────────────────
1938// A `UITextPosition` on the Swift side wraps a source byte offset; these are the
1939// offset↔geometry, stepping, and range-editing primitives the protocol needs.
1940// Queries never move the caret — they only read the (synced) visual map — so the
1941// system can probe positions freely while the model's selection stays put.
1942#[uniffi::export]
1943impl LeafDoc {
1944    /// The caret's source offset (the selection's moving end).
1945    pub fn caret_offset(&self) -> u32 {
1946        self.lock().doc.caret as u32
1947    }
1948
1949    /// The selection's fixed end (equals the caret when there's no selection).
1950    pub fn anchor_offset(&self) -> u32 {
1951        let g = self.lock();
1952        g.doc.anchor.unwrap_or(g.doc.caret) as u32
1953    }
1954
1955    /// The last caret stop in the document — `UITextInput.endOfDocument`.
1956    pub fn doc_end_offset(&self) -> u32 {
1957        let mut g = self.lock();
1958        g.sync();
1959        let end = g.doc.source.len();
1960        g.snap_stop(end) as u32
1961    }
1962
1963    /// Snap an arbitrary offset to the nearest valid caret stop.
1964    pub fn snap_offset(&self, off: u32) -> u32 {
1965        let mut g = self.lock();
1966        g.sync();
1967        g.snap_stop(off as usize) as u32
1968    }
1969
1970    /// Where a source offset sits on screen: its visual `(row, ch)`.
1971    pub fn pos_for_offset(&self, off: u32) -> RowCol {
1972        let mut g = self.lock();
1973        g.sync();
1974        let (row, col) = g.pos_of_offset(off as usize);
1975        let ch = col_to_utf16(&g.row_text(row), col);
1976        RowCol {
1977            row: row as u32,
1978            ch: ch as u32,
1979        }
1980    }
1981
1982    /// The rows a source range covers, inclusive — for drawing a block away
1983    /// from where it sits (a footnote peek, a link peek, a landing flash).
1984    ///
1985    /// Ask this rather than mapping `start` and `end - 1` through
1986    /// [`Self::pos_for_offset`]. That pair reads correctly and is wrong: a
1987    /// block's last byte is often *hidden* — a note or a paragraph ending in a
1988    /// link ends inside the link's destination — and `pos_for_offset` snaps a
1989    /// hidden offset forward to the next visible glyph, which for a trailing
1990    /// one is on the next block's row. A peek slicing that span drew the block
1991    /// after it too. `pos_for_offset`'s snap is right for a caret and wrong for
1992    /// a span; this is the question spans should be asking.
1993    pub fn row_range_for(&self, start: u32, end: u32) -> RowRange {
1994        let mut g = self.lock();
1995        g.sync();
1996        let (first, last) = g.row_range_for(start as usize, end as usize);
1997        RowRange {
1998            first: first as u32,
1999            last: last as u32,
2000        }
2001    }
2002
2003    /// The source offset at visual `(row, ch)` — the inverse of
2004    /// [`Self::pos_for_offset`], for hit-testing a point to a position.
2005    pub fn offset_for_pos(&self, row: u32, ch: u32) -> u32 {
2006        let mut g = self.lock();
2007        g.sync();
2008        let col = utf16_to_col(&g.row_text(row as usize), ch as usize);
2009        g.offset_of_col(row as usize, col) as u32
2010    }
2011
2012    /// Move `off` by `delta` caret stops (negative = left) — `position(from:offset:)`.
2013    pub fn step_offset(&self, off: u32, delta: i32) -> u32 {
2014        let mut g = self.lock();
2015        g.sync();
2016        let mut o = g.snap_stop(off as usize);
2017        if delta >= 0 {
2018            for _ in 0..delta {
2019                match g.stop_after(o) {
2020                    Some(n) => o = n,
2021                    None => break,
2022                }
2023            }
2024        } else {
2025            for _ in 0..(-delta) {
2026                match g.stop_before(o) {
2027                    Some(p) => o = p,
2028                    None => break,
2029                }
2030            }
2031        }
2032        o as u32
2033    }
2034
2035    /// The count of caret stops between two offsets (signed) — `offset(from:to:)`.
2036    pub fn distance_offset(&self, from: u32, to: u32) -> i32 {
2037        let mut g = self.lock();
2038        g.sync();
2039        let (from, to) = (from as usize, to as usize);
2040        let (mut a, b, sign) = if from <= to {
2041            (from, to, 1i32)
2042        } else {
2043            (to, from, -1i32)
2044        };
2045        a = g.snap_stop(a);
2046        let mut n = 0i32;
2047        while a < b {
2048            match g.stop_after(a) {
2049                Some(x) => {
2050                    a = x;
2051                    n += 1;
2052                }
2053                None => break,
2054            }
2055        }
2056        n * sign
2057    }
2058
2059    /// The UTF-16 index at which source offset `off` sits in the visible text —
2060    /// the string `text_in_range(0, doc_end_offset())` returns — which is the
2061    /// character space AppKit's `NSTextInputClient` and `NSAccessibility` speak.
2062    ///
2063    /// leaf's own handle is the source byte offset, and the two are not one
2064    /// scale apart: WYSIWYG hides delimiters, a block gap is spelled as one
2065    /// `\n`, and a character outside the BMP is two UTF-16 units. A frontend
2066    /// hands the system an `NSRange` converted with this and turns the ranges
2067    /// it gets back through `offset_for_utf16_index`, so Look Up, dictation, and
2068    /// VoiceOver all index the same text the frontend drew.
2069    pub fn utf16_index_for_offset(&self, off: u32) -> u32 {
2070        let mut g = self.lock();
2071        g.sync();
2072        let off = (off as usize).min(g.doc.source.len());
2073        match g.doc.view {
2074            View::Wysiwyg => g.doc.vmap.visible_utf16_len(0, off) as u32,
2075            View::Source => {
2076                let off = g.snap_stop(off);
2077                g.doc.source[..off].encode_utf16().count() as u32
2078            }
2079        }
2080    }
2081
2082    /// The inverse of `utf16_index_for_offset`: the source offset of the
2083    /// visible character at UTF-16 `index`, or the document's end stop at or
2084    /// past the end of the text. An index inside a surrogate pair resolves to
2085    /// the character that owns it, and one on the `\n` a block gap is spelled
2086    /// with to the stop at the end of the block before it. Always a caret stop.
2087    pub fn offset_for_utf16_index(&self, index: u32) -> u32 {
2088        let mut g = self.lock();
2089        g.sync();
2090        let len = g.doc.source.len();
2091        let end = g.snap_stop(len);
2092        let index = index as usize;
2093        match g.doc.view {
2094            // A block separator resolves to the gap offset, which is no stop;
2095            // snapping lands it on the row end before it, the stop a caret
2096            // standing "after the last character" already means.
2097            View::Wysiwyg => g
2098                .doc
2099                .vmap
2100                .offset_at_visible_utf16(end, index)
2101                .map_or(end, |o| g.snap_stop(o)) as u32,
2102            View::Source => {
2103                let mut seen = 0usize;
2104                for (i, ch) in g.doc.source.char_indices() {
2105                    let n = ch.len_utf16();
2106                    if index < seen + n {
2107                        return i as u32;
2108                    }
2109                    seen += n;
2110                }
2111                end as u32
2112            }
2113        }
2114    }
2115
2116    /// The offset one navigable row up/down from `off`, keeping its column —
2117    /// `position(from:in: .up/.down)`. `None` at the top/bottom edge.
2118    pub fn vertical_offset(&self, off: u32, down: bool) -> Option<u32> {
2119        let mut g = self.lock();
2120        g.sync();
2121        let (row, col) = g.pos_of_offset(off as usize);
2122        let target = if down {
2123            g.nav_below(row)
2124        } else {
2125            g.nav_above(row)
2126        };
2127        target.map(|r| g.offset_of_col(r, col) as u32)
2128    }
2129
2130    /// The visible text between two offsets — `text(in:)`. In the WYSIWYG
2131    /// view this is *not* the raw source slice: a hidden inline-mark
2132    /// delimiter (`**`, `` ` ``, `_`) contributes nothing, matching what
2133    /// `distance_offset`/`step_offset` already count in this same offset
2134    /// space — while a genuine block boundary the range spans (a paragraph
2135    /// gap, a table rule, …) contributes one inserted `'\n'` that
2136    /// `distance_offset`/`step_offset` do *not* count (a block boundary costs
2137    /// caret motion zero stops there, by design — see
2138    /// `the_caret_skips_the_gap_between_two_paragraphs` in `leaf-core`'s
2139    /// `doc.rs`). So the relationship is
2140    /// `text_in_range(a, b).chars().count() >= distance_offset(a, b)`, not
2141    /// strict equality: the two agree exactly when `(a, b)` spans no block
2142    /// boundary, and `text_in_range` is never shorter, only ever as long or
2143    /// longer, when it does. That inequality is still what
2144    /// `UITextInput`'s own word/line tokenizer needs (see
2145    /// [`leaf_core::wysiwyg::VisualMap::visible_text`] for why): it only reads
2146    /// this string to find a boundary and converts the result back to a
2147    /// position via `position(from:offset:)`, which walks stops — the
2148    /// inserted character is never hit as one, it only keeps the tokenizer
2149    /// from reading two paragraphs' last/first words as a single run of
2150    /// letters. The source view has nothing hidden to begin with, so there
2151    /// this is still exactly the raw slice.
2152    pub fn text_in_range(&self, from: u32, to: u32) -> String {
2153        let mut g = self.lock();
2154        g.sync();
2155        let len = g.doc.source.len();
2156        let (mut a, mut b) = ((from as usize).min(len), (to as usize).min(len));
2157        if a > b {
2158            std::mem::swap(&mut a, &mut b);
2159        }
2160        match g.doc.view {
2161            View::Wysiwyg => g.doc.vmap.visible_text(a, b),
2162            View::Source => {
2163                let s = &g.doc.source;
2164                while a > 0 && !s.is_char_boundary(a) {
2165                    a -= 1;
2166                }
2167                while b < s.len() && !s.is_char_boundary(b) {
2168                    b += 1;
2169                }
2170                s[a..b].to_string()
2171            }
2172        }
2173    }
2174
2175    /// Set the selection to `[anchor, focus]` by source offsets — the setter behind
2176    /// `UITextInput.selectedTextRange` and handle dragging.
2177    pub fn set_selection_offsets(&self, anchor: u32, focus: u32) -> DocView {
2178        let mut g = self.lock();
2179        g.doc.place_caret(anchor as usize, false);
2180        if focus != anchor {
2181            g.doc.place_caret(focus as usize, true);
2182        }
2183        g.view()
2184    }
2185
2186    /// Select the exact source range `[start, end)`, snapping neither end to a
2187    /// visible caret stop — for a host painting a range it already knows the
2188    /// bytes of (a search hit, an annotation) rather than hit-testing a touch.
2189    ///
2190    /// `set_selection_offsets` above is the *other* verb: it goes through
2191    /// `place_caret`, which snaps, and is what a drag handle wants. This one
2192    /// takes the range as given, so a selection over `**needle**`'s inner word
2193    /// is the word and not one byte short of it.
2194    pub fn select_range(&self, start: u32, end: u32) -> DocView {
2195        let mut g = self.lock();
2196        g.doc.select_range(start as usize, end as usize);
2197        g.view()
2198    }
2199
2200    /// Replace the source range `[from, to]` with `text` — `replace(_:withText:)`.
2201    pub fn replace_range(&self, from: u32, to: u32, text: String) -> DocView {
2202        let mut g = self.lock();
2203        g.doc.place_caret(from as usize, false);
2204        if to != from {
2205            g.doc.place_caret(to as usize, true);
2206        }
2207        g.doc.insert(&text);
2208        g.view()
2209    }
2210}
2211
2212impl LeafDoc {
2213    /// Acquire the guard, recovering from a poisoned lock: a panic in `leaf-core`
2214    /// under one call shouldn't wedge the whole document handle for the app.
2215    fn lock(&self) -> std::sync::MutexGuard<'_, Inner> {
2216        self.inner.lock().unwrap_or_else(|p| p.into_inner())
2217    }
2218}
2219
2220/// The UTF-16 offset into `text` of display column `col`. Walks grapheme clusters
2221/// exactly as core measures columns ([`text_width`] per cluster), so a wide
2222/// cluster advances the column by its cells while the offset advances by its
2223/// UTF-16 length; the two coincide only on plain ASCII.
2224fn col_to_utf16(text: &str, col: usize) -> usize {
2225    let mut c = 0usize;
2226    let mut u = 0usize;
2227    for g in text.graphemes(true) {
2228        if c >= col {
2229            break;
2230        }
2231        c += text_width(g);
2232        u += g.chars().map(char::len_utf16).sum::<usize>();
2233    }
2234    u
2235}
2236
2237/// The display column of the grapheme boundary at or before UTF-16 offset `off`
2238/// — the inverse of [`col_to_utf16`], turning a native click position back into
2239/// core's column. Core then clamps the column to a real caret stop.
2240fn utf16_to_col(text: &str, off: usize) -> usize {
2241    let mut c = 0usize;
2242    let mut u = 0usize;
2243    for g in text.graphemes(true) {
2244        if u >= off {
2245            break;
2246        }
2247        u += g.chars().map(char::len_utf16).sum::<usize>();
2248        c += text_width(g);
2249    }
2250    c
2251}
2252
2253/// The renderer class id for a semantic role. Heading level is folded into the
2254/// id (`h1`…`h6`) so a single style rule per level applies.
2255fn role_name(r: Role) -> String {
2256    match r {
2257        Role::Body => "body".into(),
2258        Role::Heading(level) => format!("h{}", level.clamp(1, 6)),
2259        Role::Code => "code".into(),
2260        Role::Link => "link".into(),
2261        // The colour rides `Run::mark_color`, not the class id: a renderer that
2262        // styles `mark` and nothing else still draws a coloured highlight.
2263        Role::Mark(_) => "mark".into(),
2264        Role::ListMarker => "list".into(),
2265        Role::QuoteGutter => "quote".into(),
2266        Role::Rule => "rule".into(),
2267        Role::Image => "image".into(),
2268        Role::Delimiter => "delimiter".into(),
2269    }
2270}
2271
2272/// The toolbar id for an inline mark — kept in sync with the Swift button ids.
2273fn mark_id(kind: InlineKind) -> &'static str {
2274    match kind {
2275        InlineKind::Strong => "bold",
2276        InlineKind::Emph => "italic",
2277        InlineKind::Verbatim => "code",
2278        InlineKind::Mark => "mark",
2279        InlineKind::Insert => "underline",
2280        InlineKind::Delete => "strike",
2281        InlineKind::Superscript => "superscript",
2282        InlineKind::Subscript => "subscript",
2283    }
2284}
2285
2286/// The WYSIWYG rows: each visual row's glyphs coalesced into maximal runs of
2287/// identical `(style, selected)`. A glyph is selected when its source byte lies
2288/// in `[ss, se)`.
2289fn wysiwyg_rows(vmap: &VisualMap, ss: usize, se: usize, hls: &[leaf_core::Highlight]) -> Vec<Row> {
2290    vmap.rows
2291        .iter()
2292        .map(|vrow| {
2293            Row {
2294                runs: runs_of(&vrow.glyphs, ss, se, hls),
2295                decoration: vrow.decoration,
2296                code: vrow.code,
2297                code_lang: vrow.code_lang.clone(),
2298                directive: vrow.directive,
2299                directive_label: vrow.directive_label.clone(),
2300                // Straight off the row, not scanned out of its glyphs: an empty
2301                // heading has none to scan, and a renderer sizing the line by a
2302                // glyph's role drew `# ` at body height until it had text.
2303                heading: vrow.heading,
2304                boundary: vrow.boundary.map(|b| Boundary {
2305                    above: b.above.into(),
2306                    below: b.below.into(),
2307                }),
2308            }
2309        })
2310        .collect()
2311}
2312
2313/// Coalesce `glyphs` into maximal runs of identical `(style, selected)` — the
2314/// shared body of a row's runs and a table cell's runs. A glyph is selected when
2315/// its source byte lies in `[ss, se)`.
2316/// Split a cell's flat glyphs into its visual lines at the in-cell break glyphs
2317/// (`\n`, from a `<br>`), each with the source range it spans. A line runs from
2318/// its first glyph's offset to the break that ends it (`cell_end` for the last);
2319/// an empty line — a leading/trailing break, or an empty cell — collapses to a
2320/// single caret home. The break glyphs themselves are dropped (they hold no
2321/// caret), exactly as the monospace picture drops them.
2322fn cell_lines(
2323    glyphs: &[leaf_core::Glyph],
2324    cell_start: usize,
2325    cell_end: usize,
2326    ss: usize,
2327    se: usize,
2328    hls: &[leaf_core::Highlight],
2329) -> Vec<TableCellLineView> {
2330    let mut lines = Vec::new();
2331    let mut seg: Vec<leaf_core::Glyph> = Vec::new();
2332    // The current line's start offset: the cell's for the first line, then the
2333    // first real glyph after each break (`None` until that glyph is seen).
2334    let mut line_start: Option<usize> = Some(cell_start);
2335    for g in glyphs {
2336        if g.ch == '\n' {
2337            let start = line_start.unwrap_or(g.src);
2338            lines.push(TableCellLineView {
2339                runs: runs_of(&seg, ss, se, hls),
2340                start: start as u32,
2341                end: g.src as u32,
2342            });
2343            seg.clear();
2344            line_start = None;
2345        } else {
2346            if line_start.is_none() {
2347                line_start = Some(g.src);
2348            }
2349            seg.push(g.clone());
2350        }
2351    }
2352    lines.push(TableCellLineView {
2353        runs: runs_of(&seg, ss, se, hls),
2354        start: line_start.unwrap_or(cell_end) as u32,
2355        end: cell_end as u32,
2356    });
2357    lines
2358}
2359
2360fn runs_of(
2361    glyphs: &[leaf_core::Glyph],
2362    ss: usize,
2363    se: usize,
2364    hls: &[leaf_core::Highlight],
2365) -> Vec<Run> {
2366    // Which highlight (by index) covers a glyph — first by start when several
2367    // overlap, matching `Doc::highlight_at`. Part of the run key: a highlight
2368    // splits a run exactly the way the selection does, so its wash begins and
2369    // ends on its own bytes.
2370    let hl_of = |src: usize| hls.iter().position(|h| h.start <= src && src < h.end);
2371    let mut runs: Vec<Run> = Vec::new();
2372    let mut buf = String::new();
2373    // The style/selection/highlight key the run is accumulating, and the source
2374    // offset its first glyph came from — carried alongside rather than
2375    // re-derived, since a run's glyphs are contiguous but its *text* has no
2376    // offsets in it.
2377    let mut cur: Option<(LStyle, bool, Option<usize>, usize)> = None;
2378    for g in glyphs {
2379        let key = (g.style, g.src >= ss && g.src < se, hl_of(g.src));
2380        match cur {
2381            Some((style, sel, hl, _)) if (style, sel, hl) == key => buf.push(g.ch),
2382            _ => {
2383                if let Some((style, was_sel, hl, src)) = cur.take() {
2384                    runs.push(make_run(
2385                        std::mem::take(&mut buf),
2386                        style,
2387                        was_sel,
2388                        hl.map(|i| &hls[i]),
2389                        src,
2390                    ));
2391                }
2392                cur = Some((key.0, key.1, key.2, g.src));
2393                buf.push(g.ch);
2394            }
2395        }
2396    }
2397    if let Some((style, was_sel, hl, src)) = cur {
2398        runs.push(make_run(buf, style, was_sel, hl.map(|i| &hls[i]), src));
2399    }
2400    runs
2401}
2402
2403/// The leaf directives of a WYSIWYG frame — each with the `rows` span its
2404/// placeholder occupies (to be painted over) and the name/attributes a frontend
2405/// resolves it by. The peer of [`wysiwyg_tables`] for a block that renders as a
2406/// thing rather than as text.
2407fn wysiwyg_directives(vmap: &VisualMap) -> Vec<DirectiveView> {
2408    vmap.directives
2409        .iter()
2410        .map(|d| DirectiveView {
2411            start_row: d.rows_span.start as u32,
2412            end_row: d.rows_span.end as u32,
2413            name: d.name.clone(),
2414            label: d.label.clone(),
2415            attrs: d
2416                .attrs
2417                .iter()
2418                .map(|(k, v)| DirectiveAttr {
2419                    key: k.clone(),
2420                    value: v.clone().unwrap_or_default(),
2421                })
2422                .collect(),
2423        })
2424        .collect()
2425}
2426
2427/// The block media of a WYSIWYG frame — each with the `rows` span its
2428/// placeholder occupies (to be laid over) and what to build there. The peer of
2429/// [`wysiwyg_directives`], with each URL already resolved under `scheme`.
2430///
2431/// Resolving here rather than in Swift keeps the one piece of `<picture>` logic
2432/// core owns (`prefers-color-scheme` matching) in core. The `<source>` list
2433/// still crosses untouched, so a renderer can additionally pick by MIME — which
2434/// codecs AVFoundation has is not something core can know.
2435fn wysiwyg_media(vmap: &VisualMap, scheme: ColorScheme) -> Vec<MediaView> {
2436    vmap.media
2437        .iter()
2438        .map(|m| MediaView {
2439            start_row: m.rows_span.start as u32,
2440            end_row: m.rows_span.end as u32,
2441            kind: match m.kind {
2442                CoreMediaKind::Image => MediaKind::Image,
2443                CoreMediaKind::Video => MediaKind::Video,
2444                CoreMediaKind::Audio => MediaKind::Audio,
2445            },
2446            src: m.resolve(scheme).to_string(),
2447            poster: m.poster.clone(),
2448            alt: m.alt.clone(),
2449            sources: m
2450                .sources
2451                .iter()
2452                .map(|s| MediaSourceView {
2453                    media: s.media.clone(),
2454                    src: s.srcset.clone(),
2455                    mime: s.mime.clone(),
2456                })
2457                .collect(),
2458        })
2459        .collect()
2460}
2461
2462/// The structural tables of a WYSIWYG frame — each with the `rows` span its
2463/// box-glyph picture occupies (to be skipped) and its grid of styled cells.
2464fn wysiwyg_tables(
2465    vmap: &VisualMap,
2466    ss: usize,
2467    se: usize,
2468    hls: &[leaf_core::Highlight],
2469) -> Vec<TableView> {
2470    vmap.tables
2471        .iter()
2472        .map(|t| TableView {
2473            start_row: t.rows_span.start as u32,
2474            end_row: t.rows_span.end as u32,
2475            grid: t
2476                .grid
2477                .iter()
2478                .map(|row| TableRowView {
2479                    head: row.head,
2480                    cells: row
2481                        .cells
2482                        .iter()
2483                        .map(|cell| TableCellView {
2484                            lines: cell_lines(&cell.glyphs, cell.start, cell.end, ss, se, hls),
2485                            align: align_name(cell.align),
2486                            start: cell.start as u32,
2487                            end: cell.end as u32,
2488                        })
2489                        .collect(),
2490                })
2491                .collect(),
2492        })
2493        .collect()
2494}
2495
2496/// The wire name for a cell's column alignment.
2497fn align_name(a: Alignment) -> String {
2498    match a {
2499        Alignment::Left => "left",
2500        Alignment::Right => "right",
2501        Alignment::Center => "center",
2502        Alignment::Default => "default",
2503    }
2504    .to_string()
2505}
2506
2507/// The source rows: the raw document split on `'\n'`, every line plain body text
2508/// with the `[ss, se)` selection carved out as its own run. Backs the source
2509/// view, whose caret rides raw byte offsets.
2510fn source_rows(source: &str, ss: usize, se: usize) -> Vec<Row> {
2511    let body = LStyle::default();
2512    let mut rows = Vec::new();
2513    let mut byte = 0usize;
2514
2515    for raw in source.split('\n') {
2516        let start = byte;
2517        let end = start + raw.len();
2518        // Selection overlap with this line, in line-local byte coordinates.
2519        let a = ss.clamp(start, end) - start;
2520        let b = se.clamp(start, end) - start;
2521
2522        // The source view's rows are split from raw text, so a run's offset is
2523        // simply where its slice starts — no glyphs to read one off.
2524        let mut runs = Vec::new();
2525        if a < b {
2526            if a > 0 {
2527                runs.push(make_run(raw[..a].to_string(), body, false, None, start));
2528            }
2529            runs.push(make_run(raw[a..b].to_string(), body, true, None, start + a));
2530            if b < raw.len() {
2531                runs.push(make_run(raw[b..].to_string(), body, false, None, start + b));
2532            }
2533        } else if !raw.is_empty() {
2534            runs.push(make_run(raw.to_string(), body, false, None, start));
2535        }
2536
2537        rows.push(Row {
2538            runs,
2539            decoration: false,
2540            code: false,
2541            code_lang: None,
2542            directive: false,
2543            directive_label: None,
2544            heading: None,  // source view is raw text — no resolved heading rows
2545            boundary: None, // …and no resolved block structure to divide
2546        });
2547        byte = end + 1; // skip the '\n' that `split` consumed
2548    }
2549    rows
2550}
2551
2552/// Build a [`Run`] from an accumulated string and the core style it was drawn
2553/// with — the one place role and emphasis flags cross into the view shape.
2554fn make_run(
2555    text: String,
2556    style: LStyle,
2557    sel: bool,
2558    hl: Option<&leaf_core::Highlight>,
2559    src: usize,
2560) -> Run {
2561    Run {
2562        text,
2563        role: role_name(style.role),
2564        bold: style.bold,
2565        italic: style.italic,
2566        underline: style.underline,
2567        strike: style.strikethrough,
2568        sup: style.baseline == Baseline::Super,
2569        sub: style.baseline == Baseline::Sub,
2570        src: src as u32,
2571        sel,
2572        hl: hl.map(|h| h.id.clone()),
2573        hl_color: hl.and_then(|h| h.color.clone()),
2574        mark_color: mark_color_name(style.role),
2575    }
2576}
2577
2578/// The name of a `mark` role's colour, for [`Run::mark_color`]. `None` for a
2579/// plain highlight and for every other role — the same answer, because neither
2580/// has a colour to name.
2581fn mark_color_name(role: Role) -> Option<String> {
2582    match role {
2583        Role::Mark(c) => c.map(|c| c.name().to_string()),
2584        _ => None,
2585    }
2586}
2587
2588#[cfg(test)]
2589mod tests {
2590    use super::*;
2591
2592    fn doc(src: &str) -> Arc<LeafDoc> {
2593        LeafDoc::new(src.to_string(), "markdown".to_string()).unwrap()
2594    }
2595
2596    #[test]
2597    fn a_footnote_definition_ending_the_file_is_itself_not_a_copy() {
2598        // No trailing newline: twig closes the last block on the virtual newline
2599        // it supplies at EOF, so the block's `span.end` is one past the source.
2600        // The definition and the `section` whose bytes contain it then both
2601        // overran, both keyed the block cache as *empty*, and the definition was
2602        // served the section's rows — this rendered the heading a second time.
2603        let src = "A claim[^1] worth checking.\n\n# A heading with a reference[^1] in it\n\n[^1]: The first note.\n[^note]: A note with a word for a label.";
2604        let d = LeafDoc::new(src.to_string(), "djot".to_string()).unwrap();
2605        let text: Vec<String> = d
2606            .view()
2607            .rows
2608            .iter()
2609            .map(|r| r.runs.iter().map(|x| x.text.as_str()).collect())
2610            .collect();
2611        assert_eq!(
2612            text.last().map(String::as_str),
2613            Some("[note] A note with a word for a label."),
2614            "the last definition should render itself: {text:?}"
2615        );
2616        assert_eq!(
2617            text.iter()
2618                .filter(|t| t.contains("A heading with a reference"))
2619                .count(),
2620            1,
2621            "the heading should render exactly once: {text:?}"
2622        );
2623    }
2624
2625    #[test]
2626    fn an_empty_heading_crosses_the_boundary_carrying_its_level() {
2627        // What the toolbar's H1 leaves on a blank line: a heading with no text
2628        // yet. The renderer sizes a row by this field, so a `nil` here is a line
2629        // (and a caret) drawn at body height that jumps to heading height on the
2630        // first keystroke — the level can't be scanned out of the runs, because
2631        // an empty heading has none.
2632        let d = doc("body\n\n# \n");
2633        let v = d.view();
2634        let head = v.rows.last().expect("the heading's row");
2635        assert!(
2636            head.runs.iter().all(|r| r.text.is_empty()),
2637            "the `# ` marker is hidden"
2638        );
2639        assert_eq!(head.heading, Some(1));
2640        assert_eq!(
2641            v.rows[0].heading, None,
2642            "the paragraph above is not a heading"
2643        );
2644    }
2645
2646    #[test]
2647    fn typing_into_a_heading_made_on_a_blank_line_keeps_the_caret_on_its_row() {
2648        // The reported bug at the boundary the Swift renderer reads: with a blank
2649        // line under it, the caret came back on a row two below the heading it
2650        // was actually in, and the view drew it there.
2651        let d = doc("one\n\ntwo\n\n\n\n");
2652        let _ = d.click(4, 0, false); // the first of the two blank lines
2653        let _ = d.set_heading(1);
2654        let mut v = d.view();
2655        for c in "title".chars() {
2656            v = d.insert(c.to_string());
2657        }
2658        assert_eq!(d.source(), "one\n\ntwo\n\n# title\n\n");
2659        assert_eq!(
2660            (v.caret_row, v.caret_ch),
2661            (4, 5),
2662            "the caret is on the heading's row"
2663        );
2664        assert_eq!(v.rows[4].heading, Some(1));
2665    }
2666
2667    #[test]
2668    fn a_video_crosses_the_boundary_as_media_with_the_rows_to_lay_it_over() {
2669        // What the Swift renderer actually consumes: a row span to cover, a kind
2670        // to build a view from, and a URL to load. A frontend that skipped the
2671        // span would paint core's `🎬` placeholder underneath its own player.
2672        let d = doc("<video src=\"clip.mp4\" poster=\"still.png\" controls></video>\n");
2673        let v = d.view();
2674        assert_eq!(v.media.len(), 1);
2675        let m = &v.media[0];
2676        assert!(matches!(m.kind, MediaKind::Video));
2677        assert_eq!(m.src, "clip.mp4");
2678        assert_eq!(m.poster, "still.png");
2679        assert!(
2680            m.end_row > m.start_row,
2681            "the span must cover at least its label row"
2682        );
2683    }
2684
2685    #[test]
2686    fn a_pictures_dark_source_resolves_by_appearance() {
2687        // The one piece of `<picture>` logic core owns, exercised across the
2688        // boundary: the same document resolves to a different URL depending on
2689        // what the host said its appearance was.
2690        let d = doc(
2691            "<picture><source media=\"(prefers-color-scheme: dark)\" srcset=\"d.svg\">\
2692             <img src=\"l.svg\" alt=\"banner\"></picture>\n",
2693        );
2694        assert_eq!(d.view().media[0].src, "l.svg", "light by default");
2695        assert_eq!(d.set_dark_appearance(true).media[0].src, "d.svg");
2696        assert_eq!(d.set_dark_appearance(false).media[0].src, "l.svg");
2697    }
2698
2699    #[test]
2700    fn tapping_below_a_trailing_picture_and_typing_keeps_it_a_picture() {
2701        // The whole gesture, across the boundary, in the order the Apple frontend
2702        // performs it: the layout clamps a point below the last row onto the
2703        // picture's row and asks for the position past its label glyphs; that
2704        // offset becomes the selection; then a character arrives. Before the two
2705        // halves of this fix, the offset was the stop *in front of* the picture
2706        // and the character dissolved it into a paragraph with an inline image —
2707        // the photo stopped being drawn, and nothing said so.
2708        let d = doc("hi\n\n![](p.png)\n");
2709        let v = d.set_unwrapped();
2710        let row = v.media[0].start_row;
2711        let label: u32 = v.rows[row as usize]
2712            .runs
2713            .iter()
2714            .map(|r| r.text.encode_utf16().count() as u32)
2715            .sum();
2716
2717        let off = d.offset_for_pos(row, label);
2718        assert_eq!(
2719            off,
2720            "hi\n\n![](p.png)".len() as u32,
2721            "the stop past the picture"
2722        );
2723
2724        d.set_selection_offsets(off, off);
2725        let after = d.insert("x".to_string());
2726        assert_eq!(d.source(), "hi\n\n![](p.png)\n\nx\n");
2727        assert_eq!(after.media.len(), 1, "still a picture, one paragraph up");
2728    }
2729
2730    #[test]
2731    fn backspace_from_that_same_tap_takes_the_picture_whole() {
2732        // The other half of the same gesture, and the one that cost this project's
2733        // own test vault a photo: tap under the picture, press Backspace. That
2734        // offset is the stop past the markup, so a byte-step deleted the closing
2735        // paren and left the literal text `![](p.png` where a photo had been.
2736        let d = doc("hi\n\n![](p.png)\n");
2737        d.set_unwrapped();
2738        let off = "hi\n\n![](p.png)".len() as u32;
2739        d.set_selection_offsets(off, off);
2740        let after = d.backspace();
2741        assert_eq!(d.source(), "hi\n");
2742        assert_eq!(after.media.len(), 0, "gone as a picture, not as bytes");
2743        let undone = d.undo();
2744        assert_eq!(d.source(), "hi\n\n![](p.png)\n");
2745        assert_eq!(
2746            undone.media.len(),
2747            1,
2748            "and one undo brings the picture back"
2749        );
2750    }
2751
2752    #[test]
2753    fn measured_heights_grow_the_reserved_span() {
2754        // The height loop: core reserves one row until the renderer measures the
2755        // real view and reports back, because core does no I/O and cannot know.
2756        let d = doc("![a cat](cat.png)\n");
2757        let before = &d.view().media[0];
2758        assert_eq!(
2759            before.end_row - before.start_row,
2760            1,
2761            "one row until measured"
2762        );
2763
2764        let after = d.set_media_rows(vec![MediaHeight {
2765            destination: "cat.png".to_string(),
2766            rows: 6,
2767        }]);
2768        let m = &after.media[0];
2769        assert_eq!(
2770            m.end_row - m.start_row,
2771            6,
2772            "the span grew to what was measured"
2773        );
2774    }
2775
2776    #[test]
2777    fn inserted_media_comes_straight_back_out_as_media() {
2778        // Round trip across the boundary, the pair that matters: what Swift asks
2779        // to insert, Swift sees on the very next frame.
2780        let d = doc("\n");
2781        let v = d.insert_media(
2782            MediaKind::Audio,
2783            "take.mp3".to_string(),
2784            "a take".to_string(),
2785        );
2786        assert_eq!(v.media.len(), 1);
2787        assert!(matches!(v.media[0].kind, MediaKind::Audio));
2788        assert_eq!(v.media[0].src, "take.mp3");
2789        assert_eq!(v.media[0].alt, "a take");
2790    }
2791
2792    #[test]
2793    fn the_source_view_publishes_no_media() {
2794        // In the source view the `<video>` markup is the literal text the caret
2795        // is editing — laying a player over it would cover what's being typed.
2796        let d = doc("<video src=\"clip.mp4\" controls></video>\n");
2797        assert_eq!(d.view().media.len(), 1);
2798        assert!(
2799            d.toggle_view().media.is_empty(),
2800            "no placeholders in the source view"
2801        );
2802    }
2803
2804    /// **A foreign caller's offset must never panic.** Every offset entering
2805    /// leaf comes from a UI toolkit that counts in its own units — UIKit hands
2806    /// back UTF-16 positions — so an offset landing mid-character is a normal
2807    /// thing to be handed, not a bug in the caller. Slicing on it aborts the
2808    /// process across the FFI boundary, where there is no unwinding to catch.
2809    ///
2810    /// Reproduces a real crash: `byte index 1236 is not a char boundary; it is
2811    /// inside '…'`.
2812    #[test]
2813    fn an_offset_inside_a_multibyte_char_does_not_panic() {
2814        let d = doc(
2815            "# April 02, 2026\n\nAn interesting thing AI said to me:\n\n> a person… who journals\n",
2816        );
2817        d.toggle_view(); // to the raw source view, where offsets index bytes directly
2818        let src = d.source();
2819        // The interior byte of the `…` — exactly the shape of the crash.
2820        let mid = src.find('…').expect("the ellipsis is in the fixture") + 1;
2821        assert!(
2822            !src.is_char_boundary(mid),
2823            "the fixture must be mid-character"
2824        );
2825
2826        // Every entry point that takes a raw source offset.
2827        let _ = d.pos_for_offset(mid as u32);
2828        let _ = d.vertical_offset(mid as u32, true);
2829        let _ = d.vertical_offset(mid as u32, false);
2830        let _ = d.snap_offset(mid as u32);
2831        let _ = d.step_offset(mid as u32, 1);
2832        let _ = d.step_offset(mid as u32, -1);
2833        let _ = d.distance_offset(0, mid as u32);
2834        let _ = d.text_in_range(0, mid as u32);
2835        let _ = d.set_selection_offsets(mid as u32, mid as u32);
2836        // And the caret must not come to rest inside the character either — a
2837        // mid-character caret is a later panic waiting for the next edit.
2838        let _ = d.replace_range(mid as u32, mid as u32, "x".to_string());
2839        assert!(
2840            d.source().is_char_boundary(d.caret_offset() as usize),
2841            "the caret must sit on a character boundary"
2842        );
2843    }
2844
2845    #[test]
2846    fn cell_lines_split_on_the_break_glyph_carrying_each_lines_source_range() {
2847        use leaf_core::Glyph;
2848        let g = |ch, src| Glyph {
2849            ch,
2850            style: LStyle::default(),
2851            src,
2852            stop: true,
2853        };
2854        // "a" at 10, a `<br>` at 11..15 (the break glyph), "b" at 15; cell 10..16.
2855        let glyphs = [g('a', 10), g('\n', 11), g('b', 15)];
2856        let lines = cell_lines(&glyphs, 10, 16, 0, 0, &[]);
2857        assert_eq!(lines.len(), 2, "one break makes two lines");
2858        assert_eq!(
2859            (lines[0].start, lines[0].end),
2860            (10, 11),
2861            "line 1 ends at the break"
2862        );
2863        assert_eq!(
2864            (lines[1].start, lines[1].end),
2865            (15, 16),
2866            "line 2 begins past it"
2867        );
2868        let text =
2869            |l: &TableCellLineView| l.runs.iter().map(|r| r.text.clone()).collect::<String>();
2870        assert_eq!(text(&lines[0]), "a");
2871        assert_eq!(text(&lines[1]), "b");
2872
2873        // A trailing break leaves an empty last line homed at the cell's end.
2874        let trailing = [g('a', 10), g('\n', 11)];
2875        let lines = cell_lines(&trailing, 10, 15, 0, 0, &[]);
2876        assert_eq!(lines.len(), 2);
2877        assert!(lines[1].runs.is_empty());
2878        assert_eq!((lines[1].start, lines[1].end), (15, 15));
2879
2880        // No break: one line spanning the whole cell.
2881        let plain = [g('P', 10), g('e', 11)];
2882        let lines = cell_lines(&plain, 10, 12, 0, 0, &[]);
2883        assert_eq!(lines.len(), 1);
2884        assert_eq!((lines[0].start, lines[0].end), (10, 12));
2885    }
2886
2887    fn row_text(v: &DocView, row: usize) -> String {
2888        v.rows[row].runs.iter().map(|r| r.text.clone()).collect()
2889    }
2890
2891    #[test]
2892    fn unwrapped_collapses_a_paragraph_to_one_row() {
2893        let d = doc("one two three four five six seven eight\n");
2894        let wrapped = d.set_width(10);
2895        let unwrapped = d.set_unwrapped();
2896        assert!(
2897            unwrapped.rows.len() < wrapped.rows.len(),
2898            "a narrow column wrap splits the paragraph; unwrapped keeps it whole"
2899        );
2900        assert!(
2901            (0..unwrapped.rows.len()).any(|i| row_text(&unwrapped, i).contains("eight")),
2902            "the whole paragraph, including its last word, sits on a single unwrapped row"
2903        );
2904    }
2905
2906    #[test]
2907    fn offsets_round_trip_when_unwrapped() {
2908        let d = doc("hello world\n");
2909        d.set_unwrapped();
2910        // offset -> (row, ch) -> offset is stable, so the pixel-wrapping frontend can
2911        // map between its visual lines and core's byte-offset caret model.
2912        let rc = d.pos_for_offset(6); // the 'w' of "world"
2913        assert_eq!(d.offset_for_pos(rc.row, rc.ch), 6);
2914    }
2915
2916    #[test]
2917    fn set_unwrapped_is_idempotent() {
2918        let d = doc("a paragraph of some length here\n");
2919        let first = d.set_unwrapped();
2920        let second = d.set_unwrapped();
2921        assert_eq!(first.rows.len(), second.rows.len());
2922    }
2923
2924    #[test]
2925    fn newline_on_last_list_item_before_a_blockquote_starts_a_new_item() {
2926        let src = "- one\n- two\n- three\n\n> quote\n";
2927        let d = doc(src);
2928        let off = (src.find("three").unwrap() + "three".len()) as u32; // end of "three" = 19
2929        d.set_selection_offsets(off, off);
2930        d.newline();
2931        let after = d.source();
2932        assert!(
2933            after.contains("- three\n- ") && after.contains("> quote"),
2934            "expected a new empty list item with the blockquote intact, got: {after:?}"
2935        );
2936    }
2937
2938    #[test]
2939    fn enter_on_an_empty_line_adds_one_newline_and_one_backspace_undoes_it() {
2940        let d = doc("hello\n");
2941        d.set_selection_offsets(5, 5);
2942        d.newline(); // paragraph "hello" → a paragraph break, caret on the empty line
2943        let after_para = d.source();
2944        let caret_para = d.caret_offset();
2945        d.newline(); // Enter on the empty line
2946        assert_eq!(
2947            d.source().len(),
2948            after_para.len() + 1,
2949            "an empty-line Enter adds a single newline, not another paragraph break"
2950        );
2951        d.backspace(); // a single Backspace restores the previous state
2952        assert_eq!(d.source(), after_para);
2953        assert_eq!(d.caret_offset(), caret_para);
2954    }
2955
2956    #[test]
2957    fn enter_in_a_nonempty_paragraph_still_opens_a_new_paragraph() {
2958        let d = doc("hello\n");
2959        d.set_selection_offsets(5, 5);
2960        let before = d.source().len();
2961        d.newline();
2962        assert_eq!(
2963            d.source().len(),
2964            before + 2,
2965            "a paragraph break is still \\n\\n"
2966        );
2967    }
2968
2969    #[test]
2970    fn link_destination_at_caret_reads_the_caret_link() {
2971        let d = doc("see [t](https://x.dev) ok\n");
2972        d.set_selection_offsets(5, 5); // caret on the link text "t"
2973        assert_eq!(
2974            d.link_destination_at_caret().as_deref(),
2975            Some("https://x.dev")
2976        );
2977        d.set_selection_offsets(0, 0); // caret on plain text
2978        assert_eq!(d.link_destination_at_caret(), None);
2979    }
2980
2981    #[test]
2982    fn the_frame_carries_the_caret_link_so_a_toolbar_can_light_and_seed_from_it() {
2983        // The reason it rides `DocView` rather than being asked for: stepping the
2984        // caret out of the link changes no other chrome fact on the frame, so a
2985        // toolbar that only redraws on a *changed* state would keep a stale light.
2986        let d = doc("see [t](https://x.dev) ok\n");
2987        d.set_selection_offsets(5, 5);
2988        let inside = d.view();
2989        assert_eq!(inside.link.as_deref(), Some("https://x.dev"));
2990        assert_eq!(inside.heading, None);
2991        assert!(inside.active.is_empty());
2992
2993        d.set_selection_offsets(0, 0);
2994        let outside = d.view();
2995        assert_eq!(outside.link, None);
2996        // Nothing else the frame reports moved with it.
2997        assert_eq!(outside.heading, inside.heading);
2998        assert_eq!(outside.active, inside.active);
2999    }
3000
3001    #[test]
3002    fn insert_footnote_crosses_and_leaves_the_caret_in_the_new_note() {
3003        // The button's round trip through the boundary: both halves written, and
3004        // a caret offset a host can type into without asking anything else.
3005        let d = doc("A claim and more.\n");
3006        d.set_selection_offsets(7, 7); // just past "A claim"
3007        d.insert_footnote();
3008        assert!(
3009            d.source().starts_with("A claim[^1] and more."),
3010            "{:?}",
3011            d.source()
3012        );
3013        assert!(d.source().contains("[^1]:"), "{:?}", d.source());
3014
3015        let note = d.footnote_at(9).expect("the reference just written");
3016        assert_eq!(note.label, "1");
3017        assert_eq!(
3018            d.caret_offset(),
3019            note.offset.expect("an empty note is still a place")
3020        );
3021        // …and the way back out is the same one a reader uses.
3022        assert_eq!(
3023            d.footnote_definition_at_caret().expect("in the note").label,
3024            "1"
3025        );
3026    }
3027
3028    #[test]
3029    fn a_highlight_is_coloured_at_the_caret_and_the_frame_says_which() {
3030        // The whole crossing a colour palette makes: press the swatch, and the
3031        // frame that comes back names the colour so the swatch can light.
3032        let d = doc("a word b\n");
3033        d.set_selection_offsets(2, 6);
3034        d.toggle_mark();
3035        assert_eq!(d.source(), "a ==word== b\n");
3036
3037        d.set_selection_offsets(5, 5); // inside the highlight
3038        assert!(d.caret_in_mark());
3039        let v = d.set_mark_color(Some(MarkColor::Red));
3040        assert_eq!(d.source(), "a ==🔴 word== b\n");
3041        assert_eq!(v.mark_color, Some(MarkColor::Red));
3042
3043        // And the way back: no colour, still a highlight.
3044        let v = d.set_mark_color(None);
3045        assert_eq!(d.source(), "a ==word== b\n");
3046        assert_eq!(v.mark_color, None);
3047        assert!(d.caret_in_mark());
3048    }
3049
3050    #[test]
3051    fn one_press_highlights_and_colours_and_one_undo_takes_it_back() {
3052        // What a toolbar swatch calls. The fold is core's, and it is what makes
3053        // the press reversible in one step rather than leaving an uncoloured
3054        // highlight behind.
3055        let d = doc("a word b\n");
3056        d.set_selection_offsets(2, 6);
3057        let v = d.highlight(Some(MarkColor::Purple));
3058        assert_eq!(d.source(), "a ==\u{1F7E3} word== b\n");
3059        assert_eq!(v.mark_color, Some(MarkColor::Purple));
3060
3061        d.undo();
3062        assert_eq!(d.source(), "a word b\n");
3063    }
3064
3065    #[test]
3066    fn the_palette_has_two_gates_and_they_ask_different_questions() {
3067        // `mark_color` is the format's answer and `caret_in_mark` the caret's.
3068        // A djot document spells the highlight and no colour for it, so the two
3069        // disagree there — which is the case a toolbar gating on either one
3070        // alone gets wrong.
3071        assert!(doc("x\n").capabilities().mark_color);
3072        let dj = LeafDoc::new("a {=word=} b\n".to_string(), "djot".to_string()).unwrap();
3073        assert!(dj.capabilities().mark, "djot writes the highlight");
3074        assert!(!dj.capabilities().mark_color, "and no colour on it");
3075        dj.set_selection_offsets(5, 5);
3076        assert!(dj.caret_in_mark(), "the caret is in one all the same");
3077
3078        let d = doc("a word b\n");
3079        d.set_selection_offsets(3, 3);
3080        assert!(!d.caret_in_mark(), "no highlight to colour here");
3081        assert_eq!(d.set_mark_color(Some(MarkColor::Blue)).mark_color, None);
3082        assert_eq!(d.source(), "a word b\n", "and nothing written");
3083    }
3084
3085    #[test]
3086    fn capabilities_answer_for_footnotes_the_way_the_format_does() {
3087        assert!(
3088            doc("x\n").capabilities().footnote,
3089            "markdown spells the pair"
3090        );
3091        let html = LeafDoc::new("<p>x</p>\n".to_string(), "html".to_string()).unwrap();
3092        assert!(
3093            !html.capabilities().footnote,
3094            "html has no footnote of its own"
3095        );
3096    }
3097
3098    #[test]
3099    fn footnote_at_caret_crosses_with_its_note_and_its_offset() {
3100        let d = doc("A claim[^1] and more.\n\n[^1]: the note\n");
3101        d.set_selection_offsets(9, 9); // caret on the reference's label
3102        let f = d
3103            .footnote_at_caret()
3104            .expect("the caret stands in a reference");
3105        assert_eq!(f.label, "1");
3106        assert_eq!(f.text.as_deref(), Some("the note"));
3107        // The note's first word — a byte the caret can actually rest on. The
3108        // definition's `[^1]:` marker is decoration with no stop of its own.
3109        assert_eq!(f.offset, Some(29));
3110        assert_eq!(f.end, Some(37));
3111
3112        d.set_selection_offsets(0, 0); // caret on plain text
3113        assert!(d.footnote_at_caret().is_none());
3114    }
3115
3116    #[test]
3117    fn footnote_at_crosses_for_an_offset_without_moving_the_caret() {
3118        // What a hover needs: the note under the pointer, and the caret left
3119        // exactly where the reader put it.
3120        let d = doc("A claim[^1] and more.\n\n[^1]: the note\n");
3121        d.set_selection_offsets(0, 0);
3122        let f = d.footnote_at(9).expect("offset 9 stands in the reference");
3123        assert_eq!(f.label, "1");
3124        assert_eq!(f.text.as_deref(), Some("the note"));
3125        assert_eq!(d.caret_offset(), 0, "asking must not move the caret");
3126        assert!(d.footnote_at(2).is_none(), "offset 2 is prose");
3127    }
3128
3129    #[test]
3130    fn footnote_definition_at_caret_crosses_with_the_way_back() {
3131        let d = doc("A claim[^1] and more.\n\n[^1]: the note\n");
3132        d.set_selection_offsets(30, 30); // caret inside the note's body
3133        let f = d
3134            .footnote_definition_at_caret()
3135            .expect("the caret stands in a definition");
3136        assert_eq!(f.label, "1");
3137        assert_eq!(f.offset, Some(9), "the reference's label");
3138
3139        // Disjoint from the reference query, which is what lets one gesture mean
3140        // "down" up top and "back up" down here.
3141        d.set_selection_offsets(9, 9);
3142        assert!(d.footnote_definition_at_caret().is_none());
3143        assert!(d.footnote_at_caret().is_some());
3144    }
3145
3146    /// The contract a peek is built on: a note's offsets map to rows whose runs
3147    /// are the note *rendered* — emphasis as an italic run, `` `code` `` as a
3148    /// code run, a link as a link run — so a frontend draws it the way the
3149    /// document draws it instead of showing the reader raw asterisks.
3150    #[test]
3151    fn a_notes_offsets_map_to_its_rendered_rows() {
3152        let src = "Claim[^a].\n\n[^a]: see *emphasis* and `code` and [a link](https://x.dev).\n";
3153        let d = doc(src);
3154        let view = d.set_unwrapped();
3155        d.set_selection_offsets(6, 6); // the reference's label
3156
3157        let f = d.footnote_at_caret().expect("a reference");
3158        let start = d.pos_for_offset(f.offset.expect("a note"));
3159        let end = d.pos_for_offset(f.end.expect("a note") - 1);
3160        assert_eq!(
3161            start.row, end.row,
3162            "a one-paragraph note is one unwrapped row"
3163        );
3164
3165        let row = &view.rows[start.row as usize];
3166        let runs: Vec<(&str, &str, bool)> = row
3167            .runs
3168            .iter()
3169            .map(|r| (r.role.as_str(), r.text.as_str(), r.italic))
3170            .collect();
3171        assert!(runs.contains(&("body", "emphasis", true)), "got {runs:?}");
3172        assert!(
3173            runs.iter()
3174                .any(|(role, text, _)| *role == "code" && *text == "code"),
3175            "got {runs:?}"
3176        );
3177        assert!(
3178            runs.iter()
3179                .any(|(role, text, _)| *role == "link" && *text == "a link"),
3180            "got {runs:?}"
3181        );
3182
3183        // The rendered row carries no markup characters at all — which is the
3184        // whole point, and what `text` (source bytes) deliberately still does.
3185        let rendered: String = row.runs.iter().map(|r| r.text.as_str()).collect();
3186        assert!(
3187            !rendered.contains('*') && !rendered.contains('`'),
3188            "got {rendered:?}"
3189        );
3190        assert!(
3191            f.text.as_deref().unwrap().contains('*'),
3192            "the source answer keeps them"
3193        );
3194
3195        // `ch` is where the body starts within the row — past the `[a] ` marker,
3196        // so a frontend that wants the note without its label can slice there.
3197        assert_eq!(row.runs[0].role, "list");
3198        assert_eq!(start.ch as usize, row.runs[0].text.chars().count());
3199
3200        // And each run says where it came from, which is how a link run drawn in
3201        // a popover learns where it points. `Run` otherwise says how a span
3202        // looks, never what it means.
3203        let link = row
3204            .runs
3205            .iter()
3206            .find(|r| r.role == "link")
3207            .expect("a link run");
3208        assert_eq!(
3209            d.link_destination_at(link.src).as_deref(),
3210            Some("https://x.dev"),
3211            "the run at {} is the link",
3212            link.src
3213        );
3214    }
3215
3216    /// The peek bug, in the shape it was actually found in: three notes, each
3217    /// ending in a link, which is what a real citation block looks like.
3218    ///
3219    /// `a_notes_offsets_map_to_its_rendered_rows` above uses a note ending in a
3220    /// visible `.`, so its last byte has a row of its own and `end - 1` reads
3221    /// right. Take the full stop away — end the note *with* the link, as a
3222    /// citation does — and the last byte falls inside the hidden destination,
3223    /// where `pos_for_offset` snaps forward onto the next note's row. Hovering
3224    /// `[^2]` peeked notes 2 *and* 3.
3225    #[test]
3226    fn a_note_ending_in_a_link_covers_its_own_row_and_no_other() {
3227        let src = "A[^1] B[^2] C[^3].\n\n\
3228                   [^1]: https://en.wikipedia.org/wiki/Moravec%27s_paradox\n\n\
3229                   [^2]: [\"How to Get Startup Ideas,\" Nov 2012](https://www.paulgraham.com/startupideas.html)\n\n\
3230                   [^3]: [Alma 37:46](https://www.churchofjesuschrist.org/study/scriptures/bofm/alma/37?lang=eng&id=p46#p46)\n";
3231        let d = doc(src);
3232        let view = d.set_unwrapped();
3233
3234        // The caret in the [^2] reference, exactly as a hover resolves it.
3235        let off2 = src.find("[^2] C").unwrap() as u32 + 2;
3236        d.set_selection_offsets(off2, off2);
3237        let f = d.footnote_at_caret().expect("a reference");
3238        let (start, end) = (f.offset.expect("a note"), f.end.expect("a note"));
3239
3240        let span = d.row_range_for(start, end);
3241        assert_eq!(span.first, span.last, "one note is one unwrapped row");
3242
3243        // And what it draws is note 2 alone — the assertion the popover failed.
3244        let drawn: String = view.rows[span.first as usize]
3245            .runs
3246            .iter()
3247            .map(|r| r.text.as_str())
3248            .collect();
3249        assert!(drawn.contains("How to Get Startup Ideas"), "got {drawn:?}");
3250        assert!(
3251            !drawn.contains("Alma"),
3252            "note 3 leaked into the peek: {drawn:?}"
3253        );
3254
3255        // The old arithmetic, pinned as still wrong so nobody quietly restores
3256        // it: this is the failure `row_range_for` exists instead of.
3257        assert_ne!(
3258            d.pos_for_offset(end - 1).row,
3259            span.last,
3260            "the forward snap still leaves the note's row — that is the point",
3261        );
3262
3263        // Note 1 is a bare autolink, whose visible text *is* its URL, so it was
3264        // never affected and must not change.
3265        let off1 = src.find("[^1] B").unwrap() as u32 + 2;
3266        d.set_selection_offsets(off1, off1);
3267        let f1 = d.footnote_at_caret().expect("a reference");
3268        let one = d.row_range_for(f1.offset.unwrap(), f1.end.unwrap());
3269        assert_eq!(one.first, one.last);
3270        assert_ne!(one.first, span.first, "and it is a different note");
3271    }
3272
3273    /// A run's `src` is a byte offset core handed over, not something a frontend
3274    /// counted its way to — so multi-byte prose ahead of a link inside a note
3275    /// can't slide it.
3276    ///
3277    /// The offset is a *byte* offset while the run's text is characters and the
3278    /// row's columns are display cells; `src` is the only one of the three a
3279    /// frontend can use without converting between the other two.
3280    #[test]
3281    fn a_runs_source_offset_survives_multibyte_prose_ahead_of_it() {
3282        let src = "Claim[^a].\n\n[^a]: 日記 café [a link](https://x.dev).\n";
3283        let d = doc(src);
3284        let view = d.set_unwrapped();
3285        d.set_selection_offsets(6, 6);
3286
3287        let f = d.footnote_at_caret().expect("a reference");
3288        let start = d.pos_for_offset(f.offset.expect("a note"));
3289        let row = &view.rows[start.row as usize];
3290        let link = row
3291            .runs
3292            .iter()
3293            .find(|r| r.role == "link")
3294            .expect("a link run");
3295
3296        assert_eq!(
3297            d.link_destination_at(link.src).as_deref(),
3298            Some("https://x.dev")
3299        );
3300        assert_eq!(
3301            &src[link.src as usize..][.."a link".len()],
3302            "a link",
3303            "and it is a byte offset, not a character or column index"
3304        );
3305        // Which the character count is not: `日記 café ` is 9 characters and 13
3306        // bytes, so anything derived from the run text lands in the wrong place.
3307        let counted: usize = row
3308            .runs
3309            .iter()
3310            .take_while(|r| r.role != "link")
3311            .map(|r| r.text.chars().count())
3312            .sum();
3313        assert_ne!(counted, link.src as usize);
3314    }
3315
3316    /// The round trip through the API a frontend actually calls — which places
3317    /// carets, and so snaps them to real stops. Offsets that named the `[^`
3318    /// markers passed every test that assigned the caret directly and still
3319    /// dumped the reader in the paragraph above the note.
3320    #[test]
3321    fn following_a_footnote_and_coming_back_lands_on_real_caret_stops() {
3322        let d = doc("A claim[^1] and more.\n\n[^1]: the note\n");
3323        d.set_selection_offsets(9, 9);
3324
3325        let down = d
3326            .footnote_at_caret()
3327            .expect("a reference")
3328            .offset
3329            .expect("a note");
3330        d.set_selection_offsets(down, down);
3331        assert_eq!(
3332            d.caret_offset(),
3333            down,
3334            "the note is somewhere the caret fits"
3335        );
3336
3337        let up = d
3338            .footnote_definition_at_caret()
3339            .expect("arrived inside the definition")
3340            .offset
3341            .expect("a reference to return to");
3342        d.set_selection_offsets(up, up);
3343        assert_eq!(d.caret_offset(), up, "and so is the reference");
3344        assert_eq!(
3345            d.footnote_at_caret().expect("back on the reference").label,
3346            "1"
3347        );
3348    }
3349
3350    #[test]
3351    fn a_footnote_reference_crosses_the_ffi_raised() {
3352        // The whole point of the `sup` flag: without it a reference reaches
3353        // Swift as a run indistinguishable from a hyperlink's, which is why it
3354        // used to draw at body size.
3355        let d = doc("A claim[^1] and more.\n");
3356        let view = d.view();
3357        let runs: Vec<&Run> = view.rows.iter().flat_map(|r| &r.runs).collect();
3358        let chip = runs
3359            .iter()
3360            .find(|r| r.text.contains('1'))
3361            .expect("the reference's chip");
3362        assert!(chip.sup, "the reference should cross raised");
3363        assert!(!chip.sub);
3364        assert_eq!(
3365            chip.role, "link",
3366            "and still carrying the role every frontend paints"
3367        );
3368        // The prose it interrupts is a run of its own, on the normal baseline —
3369        // which is what proves the flag splits runs rather than bleeding.
3370        let prose = runs
3371            .iter()
3372            .find(|r| r.text.contains("claim"))
3373            .expect("the prose");
3374        assert!(!prose.sup && !prose.sub);
3375    }
3376
3377    #[test]
3378    fn utf16_indices_round_trip_through_the_visible_text_in_both_views() {
3379        // Hidden delimiters, an emoji outside the BMP, and a block gap: the
3380        // three ways an `NSRange` into the visible text and a source byte
3381        // offset part company.
3382        let d = doc("a **b\u{1F600}** c\n\nd\n");
3383        let end = d.doc_end_offset();
3384        let text = d.text_in_range(0, end);
3385        assert_eq!(text, "a b\u{1F600} c\nd");
3386        let total = text.encode_utf16().count() as u32;
3387        assert_eq!(d.utf16_index_for_offset(end), total);
3388        assert_eq!(d.offset_for_utf16_index(total), end);
3389        // Walk every stop: index it, and come back to the same stop.
3390        let mut off = 0u32;
3391        loop {
3392            let idx = d.utf16_index_for_offset(off);
3393            assert_eq!(
3394                d.offset_for_utf16_index(idx),
3395                off,
3396                "stop {off} via index {idx}"
3397            );
3398            let next = d.step_offset(off, 1);
3399            if next == off {
3400                break;
3401            }
3402            off = next;
3403        }
3404        // The 'c' comes after the hidden `**` and the two-unit emoji.
3405        let c = "a **b\u{1F600}** c".find(" c").unwrap() as u32 + 1;
3406        assert_eq!(
3407            d.utf16_index_for_offset(c),
3408            "a b\u{1F600} ".encode_utf16().count() as u32
3409        );
3410
3411        // Source view: the text is the raw source, so the index is the plain
3412        // UTF-16 count of the bytes before the offset — delimiters included.
3413        d.toggle_view();
3414        assert_eq!(
3415            d.text_in_range(0, d.doc_end_offset()),
3416            "a **b\u{1F600}** c\n\nd\n"
3417        );
3418        assert_eq!(
3419            d.utf16_index_for_offset(c),
3420            "a **b\u{1F600}** ".encode_utf16().count() as u32
3421        );
3422        assert_eq!(d.offset_for_utf16_index(d.utf16_index_for_offset(c)), c);
3423        // Inside the emoji's surrogate pair resolves to the emoji itself.
3424        let emoji = "a **b".len() as u32;
3425        assert_eq!(
3426            d.offset_for_utf16_index(d.utf16_index_for_offset(emoji) + 1),
3427            emoji
3428        );
3429    }
3430
3431    #[test]
3432    fn text_in_range_hides_delimiters_like_the_screen_does() {
3433        // "a **bold** c\n": 0:'a' 1:' ' 2:'*' 3:'*' 4:'b' 5:'o' 6:'l' 7:'d'
3434        // 8:'*' 9:'*' 10:' ' 11:'c' 12:'\n'. Bytes 8..10 are the closing `**`
3435        // — hidden, no glyph — and bytes 2..4 the opening `**`, likewise
3436        // hidden. `caret_steps_over_hidden_delimiters` in leaf-core already
3437        // pins that one Right from 7 (just past the 'd') lands on 10 (the
3438        // space before 'c'), skipping 8/9 entirely — so the *visible* text
3439        // transiting [7, 10) is exactly "d": the closing `**` contributes
3440        // nothing, matching what's drawn on screen.
3441        let d = doc("a **bold** c\n");
3442        assert_eq!(d.text_in_range(7, 10), "d");
3443        assert_eq!(
3444            d.text_in_range(7, 10).chars().count() as i32,
3445            d.distance_offset(7, 10),
3446            "text(in:).count() must equal offset(from:to:) — the UITextInput invariant this bug broke"
3447        );
3448
3449        // Plain text with no hidden delimiter in range: unchanged, still the
3450        // raw slice, proving the fix doesn't regress the common case.
3451        assert_eq!(d.text_in_range(0, 1), "a");
3452        assert_eq!(d.text_in_range(11, 12), "c");
3453        assert_eq!(
3454            d.text_in_range(0, 1).chars().count() as i32,
3455            d.distance_offset(0, 1)
3456        );
3457    }
3458
3459    #[test]
3460    fn text_in_range_matches_distance_offset_across_marked_up_and_plain_spans() {
3461        // The general invariant, straddling bold/italic/code spans and not:
3462        // for any pair of offsets, the visible text `text_in_range` returns
3463        // must have exactly as many `chars()` as `distance_offset` reports
3464        // stops between them — otherwise iOS's word tokenizer (which fetches
3465        // a text window, finds a boundary by indexing into *that string*, and
3466        // converts the index back to a position via `position(from:offset:)`)
3467        // resolves the boundary at the wrong offset.
3468        let d = doc("a **bold** _em_ and `code` here\n");
3469        let len = d.source().len() as u32;
3470        let mut pairs = Vec::new();
3471        let mut a = 0u32;
3472        while a < len {
3473            let mut b = a + 1;
3474            while b <= len {
3475                pairs.push((a, b));
3476                b += 3; // sample rather than an O(n^2) sweep
3477            }
3478            a += 1;
3479        }
3480        for (a, b) in pairs {
3481            let text = d.text_in_range(a, b);
3482            let dist = d.distance_offset(a, b).abs();
3483            assert_eq!(
3484                text.chars().count() as i32,
3485                dist,
3486                "text_in_range({a}, {b}) = {text:?} has {} chars, but distance_offset says {dist}",
3487                text.chars().count()
3488            );
3489        }
3490    }
3491
3492    #[test]
3493    fn text_in_range_separates_paragraphs_so_words_dont_merge_across_the_gap() {
3494        // Regression: double-tapping the last word on a line immediately
3495        // followed by a paragraph break selected past the break into the
3496        // next paragraph — and kept compounding across further trivial
3497        // paragraphs in a row — because `text_in_range` returned the two
3498        // paragraphs' text with nothing between them: "hello" then "hello"
3499        // read back as one merged "hellohello" run of letters, no different
3500        // from the raw source concatenation, and iOS's word tokenizer duly
3501        // selected the whole run as a single word.
3502        let d = doc("hello\n\nhello\n\nhello\n");
3503        let src = d.source();
3504        assert_eq!(
3505            src.find("hello").unwrap(),
3506            0,
3507            "paragraph 1 at the very start"
3508        );
3509        let p2 = src[5..].find("hello").unwrap() + 5; // 7: paragraph 2's "hello"
3510
3511        // A window straddling the tail of paragraph 1 ("lo") and the head of
3512        // paragraph 2 ("he").
3513        let text = d.text_in_range(3, p2 as u32 + 2);
3514        assert_ne!(
3515            text, "lohe",
3516            "the two paragraphs' words must not read as merged"
3517        );
3518        assert!(
3519            text.chars().any(|c| !c.is_alphanumeric()),
3520            "a non-letter must separate the two paragraphs' words: got {text:?}"
3521        );
3522        assert_eq!(
3523            text, "lo\nhe",
3524            "exactly one separator opens the second paragraph's head"
3525        );
3526
3527        // A window that is nothing but the bare gap itself (no glyph on the
3528        // left, since it starts exactly at the end of paragraph 1's own last
3529        // row) must still carry the break — this is the case a naive
3530        // "insert a separator only between two real hits" fix undercounts,
3531        // since there is no earlier hit to anchor it to.
3532        let gap_only = d.text_in_range(5, p2 as u32);
3533        assert!(
3534            gap_only.chars().count() as i32 >= d.distance_offset(5, p2 as u32),
3535            "text_in_range must never be shorter than distance_offset: {gap_only:?}"
3536        );
3537
3538        // The invariant the two existing tests above assert (strict
3539        // equality) no longer holds once the range spans a paragraph
3540        // boundary — see `text_in_range`'s doc comment — but it must never
3541        // *undercount* relative to `distance_offset`, which is what would let
3542        // a tokenizer's `position(from:offset:)` walk past where the text it
3543        // was handed actually put a boundary.
3544        for (a, b) in [(0u32, src.len() as u32), (3, p2 as u32 + 2), (5, p2 as u32)] {
3545            let text = d.text_in_range(a, b);
3546            let dist = d.distance_offset(a, b);
3547            assert!(
3548                text.chars().count() as i32 >= dist,
3549                "text_in_range({a}, {b}) = {text:?} ({} chars) is shorter than distance_offset {dist}",
3550                text.chars().count()
3551            );
3552        }
3553
3554        // Caret motion itself is untouched by any of this: from the very end
3555        // of paragraph 1's row, a paragraph gap still costs exactly one
3556        // Right press to reach the start of paragraph 2 — matching
3557        // leaf-core's `the_caret_skips_the_gap_between_two_paragraphs`.
3558        assert_eq!(
3559            d.distance_offset(5, p2 as u32),
3560            1,
3561            "one Right crosses the whole gap"
3562        );
3563    }
3564
3565    #[test]
3566    fn a_coloured_highlight_rides_out_as_a_name_beside_the_mark_role() {
3567        // The host draws the wash, so the colour has to reach it. It rides
3568        // `mark_color` rather than folding into `role` (`"mark-red"`) on
3569        // purpose: a renderer that only knows `"mark"` — every version of the
3570        // Swift one before this field existed — still draws the highlight.
3571        let d = doc("a ==\u{1F534} red== and ==plain== b\n");
3572        let runs = &d.view().rows[0].runs;
3573        let marks: Vec<(&str, Option<&str>)> = runs
3574            .iter()
3575            .filter(|r| r.role == "mark")
3576            .map(|r| (r.text.as_str(), r.mark_color.as_deref()))
3577            .collect();
3578        assert_eq!(marks, [("red", Some("red")), ("plain", None)]);
3579        assert!(
3580            runs.iter()
3581                .all(|r| r.role == "mark" || r.mark_color.is_none()),
3582            "nothing but a mark names a colour"
3583        );
3584    }
3585
3586    #[test]
3587    fn a_highlight_splits_runs_on_its_own_bytes_and_carries_its_id() {
3588        let d = doc("one two three\n");
3589        let view = d.set_highlights(vec![Highlight {
3590            start: 4,
3591            end: 7,
3592            id: "remark-1".into(),
3593            color: Some("#ffe066".into()),
3594            marker: Some("text.bubble".into()),
3595        }]);
3596        let row = &view.rows[0];
3597        let texts: Vec<(&str, Option<&str>)> = row
3598            .runs
3599            .iter()
3600            .map(|r| (r.text.as_str(), r.hl.as_deref()))
3601            .collect();
3602        assert_eq!(
3603            texts,
3604            [("one ", None), ("two", Some("remark-1")), (" three", None)],
3605            "the wash begins and ends exactly on the highlight's bytes"
3606        );
3607        assert_eq!(row.runs[1].hl_color.as_deref(), Some("#ffe066"));
3608        assert_eq!(d.highlight_at(5).as_deref(), Some("remark-1"));
3609        assert_eq!(
3610            d.highlights()
3611                .first()
3612                .and_then(|h| h.marker.clone())
3613                .as_deref(),
3614            Some("text.bubble"),
3615            "the marker rides back out for the frontend's margin pass"
3616        );
3617        assert_eq!(d.highlight_at(7), None, "end is exclusive");
3618        // A replace with nothing clears the wash.
3619        let view = d.set_highlights(Vec::new());
3620        assert!(view.rows[0].runs.iter().all(|r| r.hl.is_none()));
3621    }
3622}