text-typeset 1.3.1

Turns rich text documents into GPU-ready glyph quads
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
//! Minimal inline-markup parser for label text.
//!
//! Supports:
//! - `[label](url)` — inline link
//! - `*italic*`     — italic run
//! - `**bold**`     — bold run
//!
//! Escapes: `\[`, `\]`, `\(`, `\)`, `\*`, `\\`. Unclosed markers fall back
//! to literal text — the parser never throws input away. Nesting works in
//! the obvious cases (`**bold *italic* bold**`, `[**bold link**](url)`).
//!
//! This module is independent of text-document: it only produces a small
//! `InlineMarkup` representation that `Typesetter::layout_single_line_markup`
//! and `Typesetter::layout_paragraph_markup` consume for tooltip / rich
//! label content.

use std::ops::Range;

/// Per-span style attributes. Link is orthogonal and carried on
/// [`InlineSpan::link_url`] directly.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct InlineAttrs(u8);

impl InlineAttrs {
    pub const EMPTY: Self = Self(0);
    pub const BOLD: Self = Self(1 << 0);
    pub const ITALIC: Self = Self(1 << 1);

    pub fn empty() -> Self {
        Self::EMPTY
    }
    pub fn is_bold(self) -> bool {
        self.0 & Self::BOLD.0 != 0
    }
    pub fn is_italic(self) -> bool {
        self.0 & Self::ITALIC.0 != 0
    }
    pub fn contains(self, other: Self) -> bool {
        (self.0 & other.0) == other.0
    }
}

impl std::ops::BitOr for InlineAttrs {
    type Output = Self;
    fn bitor(self, rhs: Self) -> Self {
        Self(self.0 | rhs.0)
    }
}

impl std::ops::BitOrAssign for InlineAttrs {
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0;
    }
}

/// One parsed span of a minimally-marked-up string.
#[derive(Debug, Clone)]
pub struct InlineSpan {
    /// Visible text of this span (link label for links).
    pub text: String,
    /// Bold / italic attributes.
    pub attrs: InlineAttrs,
    /// `Some(url)` if this span is a link.
    pub link_url: Option<String>,
    /// Byte range into the original source string.
    pub byte_range: Range<usize>,
}

/// Parsed input ready for shaping. Preserves the original source for
/// diagnostics and round-tripping.
#[derive(Debug, Clone)]
pub struct InlineMarkup {
    pub source: String,
    pub spans: Vec<InlineSpan>,
}

impl InlineMarkup {
    /// Parse a minimal markdown subset.
    pub fn parse(source: &str) -> Self {
        let spans = parse_spans(source, 0);
        Self {
            source: source.to_string(),
            spans,
        }
    }

    /// Shortcut for plain text (no markup) — a single span, no attrs.
    pub fn plain(text: impl Into<String>) -> Self {
        let s: String = text.into();
        let spans = if s.is_empty() {
            Vec::new()
        } else {
            let len = s.len();
            vec![InlineSpan {
                text: s.clone(),
                attrs: InlineAttrs::EMPTY,
                link_url: None,
                byte_range: 0..len,
            }]
        };
        Self { source: s, spans }
    }

    /// Flatten the markup to its visible text only (no attributes, no urls).
    pub fn flatten_plain(&self) -> String {
        self.spans.iter().map(|s| s.text.as_str()).collect()
    }

    pub fn is_empty(&self) -> bool {
        self.spans.is_empty()
    }
}

// --- parser ------------------------------------------------------------

fn parse_spans(source: &str, base_offset: usize) -> Vec<InlineSpan> {
    let bytes = source.as_bytes();
    let mut out: Vec<InlineSpan> = Vec::new();
    let mut i: usize = 0;
    let mut text_start: usize = 0;
    let mut text_buf = String::new();

    let flush_text =
        |out: &mut Vec<InlineSpan>, text_buf: &mut String, text_start: usize, end: usize| {
            if !text_buf.is_empty() {
                out.push(InlineSpan {
                    text: std::mem::take(text_buf),
                    attrs: InlineAttrs::EMPTY,
                    link_url: None,
                    byte_range: (base_offset + text_start)..(base_offset + end),
                });
            }
        };

    while i < bytes.len() {
        let b = bytes[i];

        // Escape: \X → literal X
        if b == b'\\' && i + 1 < bytes.len() {
            let next = bytes[i + 1];
            if matches!(next, b'[' | b']' | b'(' | b')' | b'*' | b'\\') {
                if text_buf.is_empty() {
                    text_start = i;
                }
                text_buf.push(next as char);
                i += 2;
                continue;
            }
        }

        // Bold **…**
        if b == b'*'
            && i + 1 < bytes.len()
            && bytes[i + 1] == b'*'
            && let Some(close) = find_marker(source, i + 2, "**")
            && close > i + 2
        {
            flush_text(&mut out, &mut text_buf, text_start, i);
            let inner = &source[i + 2..close];
            let mut inner_spans = parse_spans(inner, base_offset + i + 2);
            for sp in inner_spans.iter_mut() {
                sp.attrs |= InlineAttrs::BOLD;
            }
            out.extend(inner_spans);
            i = close + 2;
            text_start = i;
            continue;
        }

        // Italic *…*
        if b == b'*'
            && let Some(close) = find_marker(source, i + 1, "*")
            && close > i + 1
        {
            // Don't consume a `*` that's actually the start of a `**`.
            let close_is_double = close + 1 < bytes.len() && bytes[close + 1] == b'*';
            if !close_is_double {
                flush_text(&mut out, &mut text_buf, text_start, i);
                let inner = &source[i + 1..close];
                let mut inner_spans = parse_spans(inner, base_offset + i + 1);
                for sp in inner_spans.iter_mut() {
                    sp.attrs |= InlineAttrs::ITALIC;
                }
                out.extend(inner_spans);
                i = close + 1;
                text_start = i;
                continue;
            }
        }

        // Link [label](url)
        if b == b'['
            && let Some(close_label) = find_bracket_close(source, i + 1)
            && close_label + 1 < bytes.len()
            && bytes[close_label + 1] == b'('
            && let Some(close_paren) = find_paren_close(source, close_label + 2)
        {
            flush_text(&mut out, &mut text_buf, text_start, i);
            let label = source[i + 1..close_label].to_string();
            let url = source[close_label + 2..close_paren].to_string();
            out.push(InlineSpan {
                text: label,
                attrs: InlineAttrs::EMPTY,
                link_url: Some(url),
                byte_range: (base_offset + i)..(base_offset + close_paren + 1),
            });
            i = close_paren + 1;
            text_start = i;
            continue;
        }

        // Literal char. Advance by UTF-8 scalar length so we never split a
        // multi-byte sequence.
        if text_buf.is_empty() {
            text_start = i;
        }
        let ch_len = utf8_char_len(b);
        let ch_end = (i + ch_len).min(bytes.len());
        text_buf.push_str(&source[i..ch_end]);
        i = ch_end;
    }

    flush_text(&mut out, &mut text_buf, text_start, bytes.len());
    out
}

fn utf8_char_len(first: u8) -> usize {
    match first {
        0x00..=0x7F => 1,
        0xC2..=0xDF => 2,
        0xE0..=0xEF => 3,
        0xF0..=0xF4 => 4,
        _ => 1,
    }
}

/// Find the next occurrence of `marker` in `source` starting at `from`,
/// skipping escaped characters. Returns the byte index of the first byte
/// of the marker, or `None` if unmatched.
fn find_marker(source: &str, from: usize, marker: &str) -> Option<usize> {
    let bytes = source.as_bytes();
    let mk = marker.as_bytes();
    if mk.is_empty() {
        return None;
    }
    let mut i = from;
    while i + mk.len() <= bytes.len() {
        if bytes[i] == b'\\' && i + 1 < bytes.len() {
            i += 2;
            continue;
        }
        if bytes[i..i + mk.len()] == *mk {
            return Some(i);
        }
        i += 1;
    }
    None
}

fn find_bracket_close(source: &str, from: usize) -> Option<usize> {
    let bytes = source.as_bytes();
    let mut i = from;
    while i < bytes.len() {
        if bytes[i] == b'\\' && i + 1 < bytes.len() {
            i += 2;
            continue;
        }
        if bytes[i] == b']' {
            return Some(i);
        }
        i += 1;
    }
    None
}

fn find_paren_close(source: &str, from: usize) -> Option<usize> {
    let bytes = source.as_bytes();
    let mut i = from;
    while i < bytes.len() {
        if bytes[i] == b'\\' && i + 1 < bytes.len() {
            i += 2;
            continue;
        }
        if bytes[i] == b')' {
            return Some(i);
        }
        i += 1;
    }
    None
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn plain_text_produces_single_span() {
        let m = InlineMarkup::parse("hello world");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "hello world");
        assert!(m.spans[0].link_url.is_none());
        assert_eq!(m.spans[0].attrs, InlineAttrs::EMPTY);
        assert_eq!(m.spans[0].byte_range, 0..11);
    }

    #[test]
    fn empty_input_produces_no_spans() {
        let m = InlineMarkup::parse("");
        assert!(m.spans.is_empty());
    }

    #[test]
    fn link_between_text() {
        let m = InlineMarkup::parse("see [docs](https://x) now");
        assert_eq!(m.spans.len(), 3);
        assert_eq!(m.spans[0].text, "see ");
        assert_eq!(m.spans[1].text, "docs");
        assert_eq!(m.spans[1].link_url.as_deref(), Some("https://x"));
        assert_eq!(m.spans[2].text, " now");
    }

    #[test]
    fn two_adjacent_links() {
        let m = InlineMarkup::parse("[a](b)[c](d)");
        assert_eq!(m.spans.len(), 2);
        assert_eq!(m.spans[0].text, "a");
        assert_eq!(m.spans[0].link_url.as_deref(), Some("b"));
        assert_eq!(m.spans[1].text, "c");
        assert_eq!(m.spans[1].link_url.as_deref(), Some("d"));
    }

    #[test]
    fn unclosed_bracket_is_literal() {
        let m = InlineMarkup::parse("unclosed [bracket text");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "unclosed [bracket text");
    }

    #[test]
    fn escaped_brackets_are_literal() {
        let m = InlineMarkup::parse(r"\[not a link\]");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "[not a link]");
    }

    #[test]
    fn empty_label_link_still_parses() {
        let m = InlineMarkup::parse("[](url)");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "");
        assert_eq!(m.spans[0].link_url.as_deref(), Some("url"));
    }

    #[test]
    fn empty_url_link_still_parses() {
        let m = InlineMarkup::parse("[label]()");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "label");
        assert_eq!(m.spans[0].link_url.as_deref(), Some(""));
    }

    #[test]
    fn bold_wraps_inner_text() {
        let m = InlineMarkup::parse("a **b** c");
        assert_eq!(m.spans.len(), 3);
        assert_eq!(m.spans[0].text, "a ");
        assert!(!m.spans[0].attrs.is_bold());
        assert_eq!(m.spans[1].text, "b");
        assert!(m.spans[1].attrs.is_bold());
        assert!(!m.spans[1].attrs.is_italic());
        assert_eq!(m.spans[2].text, " c");
    }

    #[test]
    fn italic_wraps_inner_text() {
        let m = InlineMarkup::parse("a *b* c");
        assert_eq!(m.spans.len(), 3);
        assert!(m.spans[1].attrs.is_italic());
        assert!(!m.spans[1].attrs.is_bold());
    }

    #[test]
    fn bold_italic_nesting() {
        let m = InlineMarkup::parse("**bold *italic* bold**");
        // Inside bold: "bold ", "italic" (italic), " bold" — all bold.
        assert!(m.spans.iter().all(|s| s.attrs.is_bold()));
        assert!(m.spans.iter().any(|s| s.attrs.is_italic()));
    }

    #[test]
    fn link_inside_bold() {
        let m = InlineMarkup::parse("**see [docs](url)**");
        assert!(m.spans.iter().all(|s| s.attrs.is_bold()));
        assert!(m.spans.iter().any(|s| s.link_url.is_some()));
    }

    #[test]
    fn unclosed_bold_is_literal() {
        let m = InlineMarkup::parse("**unclosed");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "**unclosed");
    }

    #[test]
    fn tooltip_key_url_passes_through_verbatim() {
        // The `:key` URL scheme is recognized by the tooltip widget,
        // not the parser. Parser just stores the URL as-is.
        let m = InlineMarkup::parse("click [here](:my-key) to learn more");
        let link = m.spans.iter().find(|s| s.link_url.is_some()).unwrap();
        assert_eq!(link.text, "here");
        assert_eq!(link.link_url.as_deref(), Some(":my-key"));
    }

    #[test]
    fn flatten_plain_concatenates_text() {
        let m = InlineMarkup::parse("a **b** [c](d) e");
        assert_eq!(m.flatten_plain(), "a b c e");
    }

    #[test]
    fn utf8_multibyte_characters_preserved() {
        let m = InlineMarkup::parse("café ☕ résumé");
        assert_eq!(m.spans.len(), 1);
        assert_eq!(m.spans[0].text, "café ☕ résumé");
    }

    #[test]
    fn byte_ranges_are_absolute_into_source() {
        let m = InlineMarkup::parse("a [b](c) d");
        // "a " = 0..2
        // "[b](c)" = 2..8
        // " d" = 8..10
        assert_eq!(m.spans[0].byte_range, 0..2);
        assert_eq!(m.spans[1].byte_range, 2..8);
        assert_eq!(m.spans[2].byte_range, 8..10);
    }
}