Skip to main content

text_typeset/
types.rs

1/// Opaque handle to a registered font face.
2///
3/// Obtained from [`crate::TextFontService::register_font`] or [`crate::TextFontService::register_font_as`].
4/// Pass to [`crate::TextFontService::set_default_font`] to make it the default.
5#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
6pub struct FontFaceId(pub u32);
7
8// ── Render output ───────────────────────────────────────────────
9
10/// Everything needed to draw one frame.
11///
12/// Produced by [`crate::DocumentFlow::render`]. Contains glyph quads (textured rectangles
13/// from the atlas), inline image placeholders, and decoration rectangles
14/// (selections, cursor, underlines, table borders, etc.).
15///
16/// The adapter draws the frame in three passes:
17/// 1. Upload `atlas_pixels` as a GPU texture (only when `atlas_dirty` is true).
18/// 2. Draw each [`GlyphQuad`] as a textured rectangle from the atlas.
19/// 3. Draw each [`DecorationRect`] as a colored rectangle.
20pub struct RenderFrame {
21    /// True if the atlas texture changed since the last frame (needs re-upload).
22    pub atlas_dirty: bool,
23    /// Atlas texture width in pixels.
24    pub atlas_width: u32,
25    /// Atlas texture height in pixels.
26    pub atlas_height: u32,
27    /// RGBA pixel data, row-major. Length = `atlas_width * atlas_height * 4`.
28    pub atlas_pixels: Vec<u8>,
29    /// One textured rectangle per visible glyph.
30    pub glyphs: Vec<GlyphQuad>,
31    /// Inline image placeholders. The adapter loads the actual image data
32    /// (e.g., via `TextDocument::resource(name)`) and draws it at the given
33    /// screen position.
34    pub images: Vec<ImageQuad>,
35    /// Decoration rectangles: selections, cursor, underlines, strikeouts,
36    /// overlines, backgrounds, table borders, and cell backgrounds.
37    pub decorations: Vec<DecorationRect>,
38    /// Per-block glyph data for incremental updates. Keyed by block_id.
39    pub(crate) block_glyphs: Vec<(usize, Vec<GlyphQuad>)>,
40    /// Per-block decoration data (underlines, etc. — NOT cursor/selection).
41    pub(crate) block_decorations: Vec<(usize, Vec<DecorationRect>)>,
42    /// Per-block image data for incremental updates.
43    pub(crate) block_images: Vec<(usize, Vec<ImageQuad>)>,
44    /// Per-block height snapshot for detecting height changes in incremental render.
45    pub(crate) block_heights: std::collections::HashMap<usize, f32>,
46    /// Per-block glyph cache keys, parallel to [`Self::block_glyphs`]. Used by
47    /// [`crate::DocumentFlow::render_cursor_only`] and
48    /// [`crate::DocumentFlow::render_block_only`] to mark every cached
49    /// glyph as still-in-use in the shared `GlyphCache` — otherwise
50    /// glyphs reused via paint-cache hits (which never re-enter the
51    /// `cache.get()` path that refreshes timestamps) would age out and
52    /// their atlas slots could be reallocated for unrelated glyphs,
53    /// silently corrupting the cached `GlyphQuad`s' atlas references.
54    pub(crate) block_glyph_keys: Vec<(usize, Vec<crate::atlas::cache::GlyphCacheKey>)>,
55    /// Flat glyph cache keys, parallel to [`Self::glyphs`]. Rebuilt from
56    /// [`Self::block_glyph_keys`] by `rebuild_flat_frame`; passed to
57    /// [`crate::TextFontService::touch_glyphs`] on every cursor-only /
58    /// block-only paint so the shared atlas keeps visible glyphs alive.
59    pub(crate) glyph_keys: Vec<crate::atlas::cache::GlyphCacheKey>,
60    /// Snapshot of [`crate::TextFontService::eviction_epoch`] at the
61    /// moment this frame's atlas references were baked. Cursor-only
62    /// and block-only paths compare against the service's current
63    /// epoch and fall back to a full re-render if eviction has
64    /// happened since — defensive safety net behind the `touch_glyphs`
65    /// keep-alive mechanism.
66    pub(crate) atlas_eviction_epoch: u64,
67}
68
69/// A positioned glyph to draw as a textured quad from the atlas.
70///
71/// The adapter draws the rectangle at `screen` position, sampling from
72/// the `atlas` rectangle in the atlas texture, tinted with `color`.
73#[derive(Clone)]
74#[non_exhaustive]
75pub struct GlyphQuad {
76    /// Screen position and size: `[x, y, width, height]` in pixels.
77    pub screen: [f32; 4],
78    /// Atlas source rectangle: `[x, y, width, height]` in atlas pixel coordinates.
79    pub atlas: [f32; 4],
80    /// Glyph color: `[r, g, b, a]`, 0.0-1.0.
81    /// For normal text glyphs, this is the text color (default black).
82    /// For color emoji, this is `[1, 1, 1, 1]` (color is baked into the atlas).
83    pub color: [f32; 4],
84    /// `true` if the atlas region for this glyph holds a pre-multiplied
85    /// RGBA color bitmap (color emoji via COLR/CBDT/sbix). The renderer
86    /// must sample `texture.rgb` directly instead of using the texture
87    /// as an alpha mask tinted by [`color`](Self::color).
88    pub is_color: bool,
89}
90
91/// An inline image placeholder.
92///
93/// text-typeset computes the position and size but does NOT load or rasterize
94/// the image. The adapter retrieves the image data (e.g., from
95/// `TextDocument::resource(name)`) and draws it as a separate texture.
96#[derive(Clone)]
97#[non_exhaustive]
98pub struct ImageQuad {
99    /// Screen position and size: `[x, y, width, height]` in pixels.
100    pub screen: [f32; 4],
101    /// Image resource name (matches `FragmentContent::Image::name` from text-document).
102    pub name: String,
103    /// Document-absolute character offset of this image's single `U+FFFC`.
104    ///
105    /// The name alone cannot say *which* placement this is — a document may
106    /// hold one picture in three places — so anything that has to answer "is
107    /// THIS image inside the selection" needs the offset. Same value, derived
108    /// the same way, as the offset `hit_test` reports for a click on it.
109    pub char_offset: usize,
110}
111
112impl ImageQuad {
113    /// An image placement: `screen` as `[x, y, width, height]`, the resource
114    /// `name`, and the `char_offset` of its `U+FFFC`. For a host that stands
115    /// in for the typesetter, a test for instance.
116    pub fn new(screen: [f32; 4], name: impl Into<String>, char_offset: usize) -> Self {
117        Self {
118            screen,
119            name: name.into(),
120            char_offset,
121        }
122    }
123}
124
125/// A colored rectangle for decorations (underlines, selections, borders, etc.).
126#[derive(Clone)]
127#[non_exhaustive]
128pub struct DecorationRect {
129    /// Screen position and size: `[x, y, width, height]` in pixels.
130    pub rect: [f32; 4],
131    /// Color: `[r, g, b, a]`, 0.0-1.0.
132    pub color: [f32; 4],
133    /// What kind of decoration this rectangle represents.
134    pub kind: DecorationKind,
135}
136
137/// The type of a [`DecorationRect`].
138#[derive(Debug, Clone, Copy, PartialEq, Eq)]
139pub enum DecorationKind {
140    /// Selection highlight (translucent background behind selected text).
141    Selection,
142    /// Cursor caret (thin vertical line at the insertion point).
143    Cursor,
144    /// Underline (below baseline, from font metrics).
145    Underline,
146    /// Strikethrough (at x-height, from font metrics).
147    Strikeout,
148    /// Overline (at ascent line).
149    Overline,
150    /// Generic background (e.g., frame borders).
151    Background,
152    /// Block-level background color.
153    BlockBackground,
154    /// Table border line.
155    TableBorder,
156    /// Table cell background color.
157    TableCellBackground,
158    /// Text-level background highlight (behind individual text runs).
159    /// Adapters should draw these before glyph quads so text appears on top.
160    TextBackground,
161    /// Cell-level selection highlight (entire cell background when cells are
162    /// selected as a rectangular region, as opposed to text within cells).
163    CellSelection,
164}
165
166/// Underline style for text decorations.
167#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
168pub enum UnderlineStyle {
169    /// No underline.
170    #[default]
171    None,
172    /// Solid single underline.
173    Single,
174    /// Dashed underline.
175    Dash,
176    /// Dotted underline.
177    Dot,
178    /// Alternating dash-dot pattern.
179    DashDot,
180    /// Alternating dash-dot-dot pattern.
181    DashDotDot,
182    /// Wavy underline.
183    Wave,
184    /// Spell-check underline (wavy, typically red).
185    SpellCheck,
186}
187
188/// Vertical alignment for characters (superscript, subscript, etc.).
189#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
190pub enum VerticalAlignment {
191    /// Normal baseline alignment.
192    #[default]
193    Normal,
194    /// Superscript: smaller size, shifted up.
195    SuperScript,
196    /// Subscript: smaller size, shifted down.
197    SubScript,
198}
199
200// ── Hit testing ─────────────────────────────────────────────────
201
202/// Disambiguates the two visual placements a single character position
203/// can have at a soft-wrap boundary. A long paragraph that wraps across
204/// lines K and K+1 has one character position N that sits at both the
205/// END of line K and the START of line K+1; affinity picks which one
206/// the caret renders at and which line `Home`/`End`-style navigation
207/// considers "current".
208///
209/// Affinity is a display concern: it makes no sense without a layout
210/// engine and a wrap width. It is never persisted with the text model
211/// (cf. Cocoa `NSSelectionAffinity` on `NSTextView`, not on
212/// `NSTextStorage`; Chromium `PositionWithAffinity` at the editing
213/// layer, not on `Position`; same in Qt and CodeMirror).
214///
215/// At positions that are NOT wrap boundaries — the interior of a line,
216/// the start of the first wrap-line, the end of the last wrap-line of
217/// a paragraph — affinity is a no-op and the rendering is identical.
218#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
219pub enum CursorAffinity {
220    /// Place the caret at the END of the previous wrap line. This is
221    /// the visual "trailing" placement and the default for any
222    /// position not produced by an upstream-side interaction.
223    #[default]
224    Downstream,
225    /// Place the caret at the START of the next wrap line.
226    Upstream,
227}
228
229/// Result of [`crate::DocumentFlow::hit_test`] - maps a screen-space point to a
230/// document position.
231#[non_exhaustive]
232pub struct HitTestResult {
233    /// Absolute character position in the document.
234    pub position: usize,
235    /// Which side of a soft-wrap boundary the click landed on. When
236    /// the matched line's Y range contained the click and `position`
237    /// equals that line's `char_range.start` AND the preceding line in
238    /// the same block wraps at the same position, the click is on the
239    /// upstream side of the boundary → `Upstream`. Otherwise
240    /// `Downstream`. At non-wrap positions, the start of a line after a
241    /// hard break included, the value is `Downstream` (default) and does
242    /// not affect anything.
243    pub affinity: CursorAffinity,
244    /// Which block (paragraph) was hit, identified by stable block ID.
245    pub block_id: usize,
246    /// Character offset within the block (0 = start of block).
247    pub offset_in_block: usize,
248    /// What region of the layout was hit.
249    pub region: HitRegion,
250    /// Tooltip text if the hit position has a tooltip. None otherwise.
251    pub tooltip: Option<String>,
252    /// When non-None, the hit position is inside a table cell.
253    /// Identifies the table by its stable table ID.
254    /// None for hits on top-level blocks, frame blocks, or outside any table.
255    pub table_id: Option<usize>,
256}
257
258/// What region of the layout a hit test landed in.
259#[derive(Debug)]
260pub enum HitRegion {
261    /// Inside a text run (normal text content).
262    Text,
263    /// In the block's left margin area (before any text content).
264    LeftMargin,
265    /// In the block's indent area.
266    Indent,
267    /// On a table border line.
268    TableBorder,
269    /// Below all content in the document.
270    BelowContent,
271    /// Past the end of a line (to the right of the last character).
272    PastLineEnd,
273    /// On an inline image.
274    Image { name: String },
275    /// On a hyperlink.
276    Link { href: String },
277}
278
279// ── Cursor display ──────────────────────────────────────────────
280
281/// Cursor display state for rendering.
282///
283/// The adapter reads cursor position from text-document's `TextCursor`
284/// and creates this struct to feed to [`crate::DocumentFlow::set_cursor`].
285/// text-typeset uses it to generate caret and selection decorations
286/// in the next [`crate::DocumentFlow::render`] call.
287pub struct CursorDisplay {
288    /// Cursor position (character offset in the document).
289    pub position: usize,
290    /// Selection anchor. Equals `position` when there is no selection.
291    /// When different from `position`, the range `[min(anchor, position), max(anchor, position))`
292    /// is highlighted as a selection.
293    pub anchor: usize,
294    /// Which side of a soft-wrap boundary the caret renders on (see
295    /// [`CursorAffinity`]). At non-boundary positions this is a
296    /// no-op; default `Downstream` (current behavior before affinity
297    /// was introduced).
298    pub affinity: CursorAffinity,
299    /// Whether the caret is visible (false during the blink-off phase).
300    /// The adapter manages the blink timer; text-typeset just respects this flag.
301    pub visible: bool,
302    /// When non-empty, render cell-level selection highlights instead of
303    /// text-level selection. Each tuple is `(table_id, row, col)` identifying
304    /// a selected cell. The adapter fills this from `TextCursor::selected_cells()`.
305    pub selected_cells: Vec<(usize, usize, usize)>,
306}
307
308// ── Scrolling ───────────────────────────────────────────────────
309
310/// Visual position and size of a laid-out table, and of its rows and
311/// columns.
312///
313/// Returned by [`crate::DocumentFlow::table_visual_info`]. `x` / `y` are the
314/// document-space top-left of the whole table box; `column_xs` and `row_ys`
315/// are measured from that origin, so cell `(r, c)` occupies
316/// `(x + column_xs[c], y + row_ys[r], column_content_widths[c], row_heights[r])`.
317#[non_exhaustive]
318pub struct TableVisualInfo {
319    /// Table ID (matches `TableSnapshot::table_id`).
320    pub table_id: usize,
321    /// Document-space x of the table box's left edge, in pixels.
322    pub x: f32,
323    /// Document-space y of the table box's top edge, in pixels.
324    pub y: f32,
325    /// Total width of the table, in pixels.
326    pub width: f32,
327    /// Total height of the table including borders, in pixels.
328    pub height: f32,
329    /// Left edge of each column's content area, relative to `x`.
330    pub column_xs: Vec<f32>,
331    /// Width of each column's content area, in pixels.
332    pub column_content_widths: Vec<f32>,
333    /// Top edge of each row's content area, relative to `y`.
334    pub row_ys: Vec<f32>,
335    /// Height of each row's content area, in pixels.
336    pub row_heights: Vec<f32>,
337}
338
339/// Visual position and size of a laid-out block.
340///
341/// Returned by [`crate::DocumentFlow::block_visual_info`].
342#[non_exhaustive]
343pub struct BlockVisualInfo {
344    /// Block ID (matches `BlockSnapshot::block_id`).
345    pub block_id: usize,
346    /// X position of the left edge of the block's content column, relative to
347    /// the document start, in pixels.
348    ///
349    /// Zero for a block in the document's own column. A block inside a table
350    /// cell or a frame has its own left origin — column 1 of a table does not
351    /// start at the document's left edge — so anything placing a rectangle
352    /// around the block's text has to start here rather than at zero.
353    pub x: f32,
354    /// Y position of the block's top edge relative to the document start, in pixels.
355    pub y: f32,
356    /// Total height of the block including margins, in pixels.
357    pub height: f32,
358}
359
360// ── OpenType features ───────────────────────────────────────────
361
362/// An OpenType feature toggle applied during shaping.
363///
364/// `tag` is the 4-byte feature tag (e.g. `*b"liga"`, `*b"smcp"`,
365/// `*b"tnum"`, `*b"ss01"`); `value` is the feature value — `0` disables
366/// it, `1` enables it, and some features (e.g. `aalt`) take an index.
367///
368/// Script-mandated features (Arabic joining, Indic reordering, etc.)
369/// always apply regardless of this list; these toggles control the
370/// *discretionary* typographic features a caller wants on or off.
371#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
372pub struct FontFeature {
373    /// The 4-byte OpenType feature tag.
374    pub tag: [u8; 4],
375    /// Feature value: `0` = off, `1` = on, or a feature-specific index.
376    pub value: u32,
377}
378
379impl FontFeature {
380    /// A feature tag turned on (`value = 1`).
381    pub const fn on(tag: [u8; 4]) -> Self {
382        Self { tag, value: 1 }
383    }
384
385    /// A feature tag turned off (`value = 0`).
386    pub const fn off(tag: [u8; 4]) -> Self {
387        Self { tag, value: 0 }
388    }
389
390    /// A feature tag with an explicit value.
391    pub const fn new(tag: [u8; 4], value: u32) -> Self {
392        Self { tag, value }
393    }
394}
395
396/// Hyphenation settings for line wrapping.
397///
398/// Presence (`Some`) enables hyphenation; the `language` selects the
399/// Knuth-Liang dictionary. Soft hyphens (U+00AD) always break and render a
400/// hyphen when enabled, regardless of language; dictionary hyphenation
401/// applies only when the language's patterns are compiled in (otherwise it
402/// silently falls back to soft-hyphen-only).
403#[derive(Clone, Copy, Debug, PartialEq, Eq)]
404pub struct Hyphenation {
405    /// ISO 639-1 language code, e.g. `*b"en"`, `*b"fr"`, `*b"de"`.
406    pub language: [u8; 2],
407}
408
409impl Hyphenation {
410    /// Hyphenation in the given ISO 639-1 language.
411    pub const fn new(language: [u8; 2]) -> Self {
412        Self { language }
413    }
414
415    /// English hyphenation (`en`).
416    pub const ENGLISH: Self = Self { language: *b"en" };
417}
418
419impl Default for Hyphenation {
420    fn default() -> Self {
421        Self::ENGLISH
422    }
423}
424
425// ── Single-line API ────────────────────────────────────────────
426
427/// Text formatting parameters for the single-line layout API.
428///
429/// Controls font selection, size, and text color. All fields are optional
430/// and fall back to the typesetter's defaults (default font, default size,
431/// default text color).
432#[derive(Clone, Debug, Default)]
433pub struct TextFormat {
434    /// Font family name (e.g., "Noto Sans", "monospace").
435    /// None means use the default font.
436    pub font_family: Option<String>,
437    /// Font weight (100-900). Overrides `font_bold`.
438    pub font_weight: Option<u32>,
439    /// Shorthand for weight 700. Ignored if `font_weight` is set.
440    pub font_bold: Option<bool>,
441    /// Italic style.
442    pub font_italic: Option<bool>,
443    /// Font size in pixels. None means use the default size.
444    pub font_size: Option<f32>,
445    /// Text color (RGBA, 0.0-1.0). None means use the typesetter's text color.
446    pub color: Option<[f32; 4]>,
447    /// Discretionary OpenType features to toggle during shaping (ligatures,
448    /// small caps, tabular numerals, stylistic sets, …). Empty = font defaults.
449    pub features: Vec<FontFeature>,
450    /// Hyphenation (Knuth-Liang dictionary + soft-hyphen breaks) for line
451    /// wrapping. `None` = disabled (default); most useful for justified
452    /// prose. See [`Hyphenation`].
453    pub hyphenation: Option<Hyphenation>,
454}
455
456/// Result of [`crate::DocumentFlow::layout_single_line`].
457///
458/// Contains the measured dimensions and GPU-ready glyph quads for a
459/// single line of text. No flow layout, line breaking, or bidi analysis
460/// is performed.
461#[non_exhaustive]
462pub struct SingleLineResult {
463    /// Total advance width of the shaped text, in pixels.
464    pub width: f32,
465    /// Line height (ascent + descent + leading), in pixels.
466    pub height: f32,
467    /// Distance from the top of the line to the baseline, in pixels.
468    pub baseline: f32,
469    /// Distance from baseline to the top of the underline, in logical
470    /// pixels. Positive = below the baseline. Sourced from the primary
471    /// font's `post` table.
472    pub underline_offset: f32,
473    /// Underline line thickness in logical pixels. Sourced from the
474    /// primary font's stroke size.
475    pub underline_thickness: f32,
476    /// GPU-ready glyph quads, positioned at y=0 (no scroll offset).
477    pub glyphs: Vec<GlyphQuad>,
478    /// Per-glyph cache keys, parallel to `glyphs`. Callers that cache
479    /// glyph output externally should pass these back to
480    /// [`crate::TextFontService::touch_glyphs`] each frame to prevent the
481    /// atlas from evicting still-visible glyphs.
482    pub glyph_keys: Vec<crate::atlas::cache::GlyphCacheKey>,
483    /// Per-span bounding rectangles for markup-aware layout
484    /// ([`crate::DocumentFlow::layout_single_line_markup`]). Empty for
485    /// the plain-text layout path.
486    pub spans: Vec<LaidOutSpan>,
487}
488
489/// A single laid-out span produced by the markup-aware layout path.
490///
491/// When a link wraps across two paragraph lines, it produces two
492/// `LaidOutSpan` entries sharing the same URL and byte_range but with
493/// distinct `line_index` / `rect`.
494#[derive(Debug, Clone)]
495#[non_exhaustive]
496pub struct LaidOutSpan {
497    pub kind: LaidOutSpanKind,
498    /// Which wrapped line this span piece lives on (0 for single-line).
499    pub line_index: usize,
500    /// Local-space rect: `[x, y, width, height]`, same space as glyph quads.
501    pub rect: [f32; 4],
502    /// Byte range into the original markup source.
503    pub byte_range: std::ops::Range<usize>,
504}
505
506/// Kind discriminator for [`LaidOutSpan`].
507#[derive(Debug, Clone)]
508pub enum LaidOutSpanKind {
509    Text,
510    Link { url: String },
511}
512
513/// Result of [`crate::DocumentFlow::layout_paragraph`].
514///
515/// Contains the measured dimensions and GPU-ready glyph quads for a
516/// multi-line paragraph wrapped at a fixed width. Glyphs are positioned
517/// in paragraph-local coordinates: `x = 0` is the left edge of the
518/// paragraph, `y = 0` is the top of the first line's line box. The
519/// adapter should offset all glyph quads by the paragraph's screen
520/// position before drawing.
521#[non_exhaustive]
522pub struct ParagraphResult {
523    /// Width of the widest laid-out line, in pixels. May be less than the
524    /// `max_width` passed to `layout_paragraph` if the content is narrower.
525    pub width: f32,
526    /// Total stacked paragraph height in pixels — sum of line heights for
527    /// all emitted lines.
528    pub height: f32,
529    /// Distance from `y = 0` to the baseline of the first line, in pixels.
530    pub baseline_first: f32,
531    /// Number of lines actually emitted (respects `max_lines` when set).
532    pub line_count: usize,
533    /// Line height (single line's ascent + descent + leading), in pixels.
534    /// Useful for callers that need to reason about per-line geometry.
535    pub line_height: f32,
536    /// Distance from baseline to the top of the underline, in logical
537    /// pixels. Positive = below the baseline. Sourced from the primary
538    /// font's `post` table.
539    pub underline_offset: f32,
540    /// Underline line thickness in logical pixels. Sourced from the
541    /// primary font's stroke size.
542    pub underline_thickness: f32,
543    /// GPU-ready glyph quads in paragraph-local coordinates.
544    pub glyphs: Vec<GlyphQuad>,
545    /// Per-glyph cache keys, parallel to `glyphs`. See
546    /// [`SingleLineResult::glyph_keys`].
547    pub glyph_keys: Vec<crate::atlas::cache::GlyphCacheKey>,
548    /// Per-span bounding rectangles for markup-aware layout
549    /// ([`crate::DocumentFlow::layout_paragraph_markup`]). Empty for
550    /// the plain-text layout path.
551    pub spans: Vec<LaidOutSpan>,
552}
553
554impl RenderFrame {
555    pub(crate) fn new() -> Self {
556        Self {
557            atlas_dirty: false,
558            atlas_width: 0,
559            atlas_height: 0,
560            atlas_pixels: Vec::new(),
561            glyphs: Vec::new(),
562            images: Vec::new(),
563            decorations: Vec::new(),
564            block_glyphs: Vec::new(),
565            block_decorations: Vec::new(),
566            block_images: Vec::new(),
567            block_heights: std::collections::HashMap::new(),
568            block_glyph_keys: Vec::new(),
569            glyph_keys: Vec::new(),
570            atlas_eviction_epoch: 0,
571        }
572    }
573}
574
575// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
576// CharacterGeometry — accessibility per-character advance data
577// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
578
579/// Per-character advance geometry for a laid-out text run.
580///
581/// Consumed by accessibility layers that need to populate AccessKit's
582/// `character_positions` and `character_widths` on a `Role::TextRun`
583/// node so screen reader highlight cursors and screen magnifiers can
584/// track the caret at character granularity.
585///
586/// `position` is measured in run-local coordinates: the first
587/// character of the requested range sits at `position == 0.0`, and
588/// subsequent characters accumulate their advance widths. `width` is
589/// the advance width of each character, in the same units.
590#[derive(Debug, Clone, Copy, PartialEq)]
591#[non_exhaustive]
592pub struct CharacterGeometry {
593    pub position: f32,
594    pub width: f32,
595}
596
597// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
598// Line geometry — per-line, per-character layout output
599// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
600
601/// Reading direction of a [`LineSegment`], as the accessibility layer
602/// needs it.
603///
604/// Distinct from [`crate::TextDirection`], which carries an `Auto`
605/// variant meaning "not yet resolved". Geometry is produced *after*
606/// shaping, so every segment's direction is known.
607#[derive(Debug, Clone, Copy, PartialEq, Eq)]
608pub enum GeometryDirection {
609    LeftToRight,
610    RightToLeft,
611}
612
613/// How a laid-out line ends.
614///
615/// A screen reader distinguishes a paragraph break (which it announces
616/// and which occupies a character in the accessible text) from a soft
617/// wrap (which occupies nothing).
618#[derive(Debug, Clone, Copy, PartialEq, Eq)]
619pub enum LineEnd {
620    /// The line was broken to fit the wrap width. Nothing in the source
621    /// separates it from the next line.
622    SoftWrap,
623    /// The line ends with an explicit break in the source: a `\n`, a `\r\n`,
624    /// or any other hard line break of UAX #14 (a carriage return, next
625    /// line, vertical tab, form feed, paragraph separator, or the line
626    /// separator U+2028 a word processor inserts for Shift+Enter).
627    ///
628    /// `chars` is how many source *characters* the break occupies (1, or 2
629    /// for `\r\n`); `bytes` is how many source *bytes* it occupies (1 for
630    /// `\n`, 2 for `\r\n`, 3 for U+2028). AccessKit counts a `\r\n` as a
631    /// single character whose `character_lengths` entry is 2 — that is
632    /// `bytes`.
633    HardBreak { chars: u8, bytes: u8 },
634    /// The line ends because the source does.
635    EndOfText,
636}
637
638impl LineEnd {
639    /// The explicit break `text` ends with, if it ends with one.
640    pub(crate) fn hard_break_ending(text: &str) -> Option<Self> {
641        if text.ends_with("\r\n") {
642            return Some(LineEnd::HardBreak { chars: 2, bytes: 2 });
643        }
644        let last = text.chars().next_back()?;
645        is_hard_break(last).then(|| LineEnd::HardBreak {
646            chars: 1,
647            bytes: last.len_utf8() as u8,
648        })
649    }
650}
651
652/// Whether `c` is a hard line break, after which a line always ends (UAX #14
653/// classes BK, CR, LF and NL): line feed, carriage return, next line,
654/// vertical tab, form feed, line separator (U+2028) and paragraph separator
655/// (U+2029).
656///
657/// It is laid out as nothing: no glyph and no advance. A font that draws one
658/// (some draw U+2028 as a box) would otherwise put it at the end of the line,
659/// and its advance would push a right-aligned or centred line off its place.
660pub(crate) fn is_hard_break(c: char) -> bool {
661    matches!(
662        c,
663        '\n' | '\r' | '\u{0085}' | '\u{000B}' | '\u{000C}' | '\u{2028}' | '\u{2029}'
664    )
665}
666
667/// Where a line's trailing ellipsis was drawn, for a line the layout
668/// truncated.
669#[derive(Debug, Clone, Copy, PartialEq)]
670#[non_exhaustive]
671pub struct LineTruncation {
672    /// Leading edge of the ellipsis glyph, in layout-local coordinates.
673    pub ellipsis_x: f32,
674    /// Advance width of the ellipsis glyph.
675    pub ellipsis_width: f32,
676}
677
678/// One direction-uniform stretch of a laid-out line.
679///
680/// A pure LTR or pure RTL line has exactly one segment; a bidirectional
681/// line has one per direction change, in *logical* order.
682#[derive(Debug, Clone, PartialEq)]
683#[non_exhaustive]
684pub struct LineSegment {
685    /// Byte range of this segment in the source text (or, on the markup
686    /// paths, in [`LayoutGeometry::rendered_text`]).
687    pub byte_range: std::ops::Range<usize>,
688    /// Character range of this segment, in the same text.
689    pub char_range: std::ops::Range<usize>,
690    /// Reading direction of every character in this segment.
691    pub direction: GeometryDirection,
692    /// Bounding box `[x, y, width, height]` in layout-local coordinates.
693    pub rect: [f32; 4],
694    /// One entry per character of `char_range`, in **logical** order.
695    ///
696    /// `position` is measured from the segment's *leading* edge — its
697    /// left edge when [`direction`](Self::direction) is
698    /// [`GeometryDirection::LeftToRight`], its right edge when it is
699    /// [`GeometryDirection::RightToLeft`] — so positions are
700    /// non-decreasing and widths are never negative in both cases.
701    ///
702    /// A character with no advance of its own (a combining mark, the
703    /// interior of a ligature) reports its cluster's leading position and
704    /// a width of `0.0`.
705    pub characters: Vec<CharacterGeometry>,
706}
707
708/// One laid-out visual line.
709#[derive(Debug, Clone, PartialEq)]
710#[non_exhaustive]
711pub struct LineGeometry {
712    /// Zero-based index of this line within the layout.
713    pub index: usize,
714    /// Byte range of the line in the source text, including any trailing
715    /// hard break (see [`LineEnd`]).
716    pub byte_range: std::ops::Range<usize>,
717    /// Character range of the line, in the same text.
718    pub char_range: std::ops::Range<usize>,
719    /// Bounding box `[x, y, width, height]` in layout-local coordinates.
720    /// `y` is the top of the line box, `height` its full line height.
721    pub rect: [f32; 4],
722    /// Baseline y in layout-local coordinates.
723    pub baseline: f32,
724    /// Where a caret sits on a line with no glyphs of its own — the x the
725    /// first typed character would take, honouring indent, alignment and
726    /// base direction.
727    pub caret_x: f32,
728    /// Direction-uniform stretches in logical order.
729    ///
730    /// **Empty means unmeasurable, never partial**: a consumer that finds
731    /// no segments must fall back to degenerate geometry for the whole
732    /// line rather than for part of it.
733    pub segments: Vec<LineSegment>,
734    /// How the line ends.
735    pub end: LineEnd,
736    /// Set when the line was cut short and an ellipsis drawn.
737    pub truncation: Option<LineTruncation>,
738}
739
740/// One hyperlink in a markup layout, reported against the rendered text.
741#[derive(Debug, Clone, PartialEq)]
742#[non_exhaustive]
743pub struct LinkGeometry {
744    /// Byte range of the link's label in
745    /// [`LayoutGeometry::rendered_text`] — *not* in the markup source.
746    pub rendered_byte_range: std::ops::Range<usize>,
747    /// The link target.
748    pub url: String,
749}
750
751/// Per-line, per-character geometry for one layout call.
752///
753/// Produced by the `*_with_geometry` layout methods on
754/// [`crate::DocumentFlow`]. Every range in it indexes
755/// [`rendered_text`](Self::rendered_text) when that is `Some` (the markup
756/// paths) and the caller's source text otherwise.
757#[derive(Debug, Clone, Default, PartialEq)]
758#[non_exhaustive]
759pub struct LayoutGeometry {
760    /// One entry per emitted line, in visual top-to-bottom order.
761    pub lines: Vec<LineGeometry>,
762    /// How many further lines the layout produced but did not emit,
763    /// because `max_lines` cut them.
764    pub dropped_lines: usize,
765    /// Byte length of the text every range indexes.
766    pub source_len: usize,
767    /// The text the ranges index, when it differs from the caller's input
768    /// — i.e. on the markup paths, where the syntax has been stripped.
769    /// `None` on the plain-text paths, where the input *is* that text.
770    pub rendered_text: Option<String>,
771    /// Hyperlinks found in the markup, against the rendered text.
772    pub links: Vec<LinkGeometry>,
773}