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