latex-rust 3.0.0

Pure-Rust LaTeX math renderer. Parse to AST, TeX-faithful layout on exact rationals, emit SVG, PNG, or egui shapes. No JavaScript, no webview, no runtime.
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
//! TeX-faithful math box model. Dimensions are [`Dim`](crate::Dim).

mod engine;
mod metrics;
mod numbering;
mod space;
mod style;

pub use engine::{
    layout, layout_with_em_size_pt, layout_with_max_depth, layout_with_numbering,
    layout_with_numbering_and_em_size_pt,
};
pub use metrics::MathParams;
pub use numbering::{NumberFormat, NumberStyle, NumberingConfig, NumberingState};
pub use style::MathStyle;

use crate::color::Color;
use crate::dim::Dim;
use crate::error::Error;
use crate::font::MathFont;

/// What a box contains.
///
/// Glyphs carry an OpenType id from the math face. Lists compose children.
/// Color wrappers do not change dimensions. [`BoxContent::Line`] and
/// [`BoxContent::Frame`] are decorations from cancel / boxed constructs.
#[derive(Debug, PartialEq, Eq)]
pub enum BoxContent {
    /// Empty box (strut or placeholder).
    Empty,
    /// Solid rule (fraction bar, vinculum). No glyph.
    Rule,
    /// A single character whose metrics came from the math font.
    ///
    /// Build with [`BoxContent::glyph`]; the variant is non-exhaustive.
    #[non_exhaustive]
    Glyph {
        /// Character.
        ch: char,
        /// OpenType glyph id.
        glyph_id: u16,
        /// Outline scale relative to the em: 1 at text size, smaller at script
        /// and scriptscript size. Box dimensions are already scaled; renderers
        /// draw the outline at this factor.
        scale: Dim,
    },
    /// Horizontal list. Width is the sum of children.
    HList(Vec<MathBox>),
    /// Vertical list. Height/depth stack on the baseline of the first box.
    VList(Vec<MathBox>),
    /// Horizontal kern (atom spacing, `\hspace`).
    Kern(Dim),
    /// Color wrapper. Dimensions match the inner box. Sets SVG `fill`.
    Color(Color, Box<MathBox>),
    /// Background color (`\colorbox`). Inner glyphs keep the default fill.
    BackColor(Color, Box<MathBox>),
    /// Children share the left edge; each child's [`MathBox::shift`] is its baseline.
    Overlap(Vec<MathBox>),
    /// Diagonal or free line in em, relative to the box left and baseline (`y` up).
    Line {
        /// Start x (em from left).
        x1: Dim,
        /// Start y (em above baseline).
        y1: Dim,
        /// End x.
        x2: Dim,
        /// End y.
        y2: Dim,
        /// Stroke thickness (em).
        thickness: Dim,
    },
    /// Stroked rectangle around the inner box. Inner is laid out at the same origin.
    Frame {
        /// Rule thickness (em).
        thickness: Dim,
        /// Border color. `None` inherits the current fill (`\boxed`).
        stroke: Option<Color>,
        /// Contents inside the frame.
        inner: Box<MathBox>,
    },
}

/// TeX-style box: width, height above baseline, depth below, italic correction.
///
/// # Examples
///
/// ```
/// use latex_rust::{Dim, MathBox};
///
/// let packed = MathBox::hpack(vec![
///     MathBox::rule(Dim::one(), Dim::zero(), Dim::zero()),
///     MathBox::rule(Dim::ratio(1, 2), Dim::zero(), Dim::zero()),
/// ]);
/// assert_eq!(packed.width, Dim::ratio(3, 2));
/// ```
#[derive(Debug, PartialEq, Eq)]
pub struct MathBox {
    /// Width.
    pub width: Dim,
    /// Height above the baseline.
    pub height: Dim,
    /// Depth below the baseline.
    pub depth: Dim,
    /// Italic correction.
    pub italic: Dim,
    /// Baseline raise relative to the parent list (positive is up).
    pub shift: Dim,
    /// Payload.
    pub content: BoxContent,
}

impl BoxContent {
    /// Glyph content drawn at `scale` times the em (1 for text size).
    #[must_use]
    pub fn glyph(ch: char, glyph_id: u16, scale: Dim) -> Self {
        Self::Glyph {
            ch,
            glyph_id,
            scale,
        }
    }
}

impl MathBox {
    /// Zero-size empty box.
    #[must_use]
    pub fn empty() -> Self {
        Self {
            width: Dim::zero(),
            height: Dim::zero(),
            depth: Dim::zero(),
            italic: Dim::zero(),
            shift: Dim::zero(),
            content: BoxContent::Empty,
        }
    }

    /// Rule with explicit dimensions (fraction bar, strut).
    #[must_use]
    pub fn rule(width: Dim, height: Dim, depth: Dim) -> Self {
        Self {
            width,
            height,
            depth,
            italic: Dim::zero(),
            shift: Dim::zero(),
            content: BoxContent::Rule,
        }
    }

    /// Horizontal kern of `width` (zero height and depth).
    #[must_use]
    pub fn kern(width: Dim) -> Self {
        Self {
            width: width.clone(),
            height: Dim::zero(),
            depth: Dim::zero(),
            italic: Dim::zero(),
            shift: Dim::zero(),
            content: BoxContent::Kern(width),
        }
    }

    /// Box from a font glyph. Errors if the face has no glyph for `ch`.
    pub fn from_glyph(font: &MathFont, ch: char) -> Result<Self, Error> {
        let g = font.glyph(ch)?;
        Ok(Self {
            width: g.advance,
            height: g.height,
            depth: g.depth,
            italic: font.italic_correction(g.glyph_id),
            shift: Dim::zero(),
            content: BoxContent::glyph(ch, g.glyph_id, Dim::one()),
        })
    }

    /// Pack boxes in a row. Width sums; height and depth are maxima.
    #[must_use]
    pub fn hpack(children: Vec<Self>) -> Self {
        let mut width = Dim::zero();
        let mut height = Dim::zero();
        let mut depth = Dim::zero();
        for c in &children {
            width = &width + &c.width;
            height = height.max(&c.height);
            depth = depth.max(&c.depth);
        }
        Self {
            width,
            height,
            depth,
            italic: Dim::zero(),
            shift: Dim::zero(),
            content: BoxContent::HList(children),
        }
    }

    /// Pack boxes in a column, first child on the baseline.
    ///
    /// Subsequent children sit below the previous (height + depth stacked).
    #[must_use]
    pub fn vpack(children: Vec<Self>) -> Self {
        if children.is_empty() {
            return Self::empty();
        }
        let mut width = Dim::zero();
        let height = children[0].height.clone();
        let mut depth = children[0].depth.clone();
        for c in children.iter().skip(1) {
            width = width.max(&c.width);
            depth = &depth + &c.height;
            depth = &depth + &c.depth;
        }
        width = width.max(&children[0].width);
        Self {
            width,
            height,
            depth,
            italic: Dim::zero(),
            shift: Dim::zero(),
            content: BoxContent::VList(children),
        }
    }

    /// Raise this box's baseline by `shift` (positive is up).
    #[must_use]
    pub fn with_shift(mut self, shift: Dim) -> Self {
        self.shift = shift;
        self
    }

    /// Gold-stable width/height/depth decimal string.
    #[must_use]
    pub fn dim_gold(&self) -> String {
        format!(
            "w={} h={} d={}",
            self.width.to_dec_string(),
            self.height.to_dec_string(),
            self.depth.to_dec_string()
        )
    }
}

impl Clone for MathBox {
    fn clone(&self) -> Self {
        clone_math_box(self)
    }
}

impl Clone for BoxContent {
    fn clone(&self) -> Self {
        match self {
            Self::Empty => Self::Empty,
            Self::Rule => Self::Rule,
            Self::Kern(w) => Self::Kern(w.clone()),
            Self::Glyph {
                ch,
                glyph_id,
                scale,
            } => Self::glyph(*ch, *glyph_id, scale.clone()),
            Self::Line {
                x1,
                y1,
                x2,
                y2,
                thickness,
            } => Self::Line {
                x1: x1.clone(),
                y1: y1.clone(),
                x2: x2.clone(),
                y2: y2.clone(),
                thickness: thickness.clone(),
            },
            Self::HList(children) => Self::HList(children.iter().map(MathBox::clone).collect()),
            Self::VList(children) => Self::VList(children.iter().map(MathBox::clone).collect()),
            Self::Overlap(children) => Self::Overlap(children.iter().map(MathBox::clone).collect()),
            Self::Color(color, inner) => Self::Color(*color, Box::new(MathBox::clone(inner))),
            Self::BackColor(color, inner) => {
                Self::BackColor(*color, Box::new(MathBox::clone(inner)))
            }
            Self::Frame {
                thickness,
                stroke,
                inner,
            } => Self::Frame {
                thickness: thickness.clone(),
                stroke: *stroke,
                inner: Box::new(MathBox::clone(inner)),
            },
        }
    }
}

impl Drop for MathBox {
    fn drop(&mut self) {
        // Derived drop walks `HList` / `Overlap` / `Frame` on the native
        // stack. A fraction chain the parser accepts is that deep, so the
        // children move to a heap stack first.
        let mut stack = Vec::new();
        drain_box(self, &mut stack);
        while let Some(mut child) = stack.pop() {
            drain_box(&mut child, &mut stack);
        }
    }
}

fn drain_box(bx: &mut MathBox, out: &mut Vec<MathBox>) {
    match &mut bx.content {
        BoxContent::HList(children)
        | BoxContent::VList(children)
        | BoxContent::Overlap(children) => out.append(children),
        BoxContent::Color(_, inner) | BoxContent::BackColor(_, inner) => {
            out.push(std::mem::replace(inner.as_mut(), MathBox::empty()));
        }
        BoxContent::Frame { inner, .. } => {
            out.push(std::mem::replace(inner.as_mut(), MathBox::empty()));
        }
        BoxContent::Empty
        | BoxContent::Rule
        | BoxContent::Kern(_)
        | BoxContent::Glyph { .. }
        | BoxContent::Line { .. } => {}
    }
}

enum CloneTask<'a> {
    Box(&'a MathBox),
    List {
        width: Dim,
        height: Dim,
        depth: Dim,
        italic: Dim,
        shift: Dim,
        kind: ListKind,
        n: usize,
    },
    Wrap {
        width: Dim,
        height: Dim,
        depth: Dim,
        italic: Dim,
        shift: Dim,
        kind: WrapKind,
    },
}

enum ListKind {
    H,
    V,
    Overlap,
}

enum WrapKind {
    Color(Color),
    BackColor(Color),
    Frame {
        thickness: Dim,
        stroke: Option<Color>,
    },
}

fn clone_math_box(root: &MathBox) -> MathBox {
    let mut tasks = vec![CloneTask::Box(root)];
    let mut done: Vec<MathBox> = Vec::new();
    while let Some(task) = tasks.pop() {
        match task {
            CloneTask::Box(bx) => push_box_task(bx, &mut tasks, &mut done),
            CloneTask::List {
                width,
                height,
                depth,
                italic,
                shift,
                kind,
                n,
            } => {
                let start = done.len().saturating_sub(n);
                let children = done.split_off(start);
                let content = match kind {
                    ListKind::H => BoxContent::HList(children),
                    ListKind::V => BoxContent::VList(children),
                    ListKind::Overlap => BoxContent::Overlap(children),
                };
                done.push(MathBox {
                    width,
                    height,
                    depth,
                    italic,
                    shift,
                    content,
                });
            }
            CloneTask::Wrap {
                width,
                height,
                depth,
                italic,
                shift,
                kind,
            } => {
                let inner = done.pop().unwrap_or_else(MathBox::empty);
                let content = match kind {
                    WrapKind::Color(c) => BoxContent::Color(c, Box::new(inner)),
                    WrapKind::BackColor(c) => BoxContent::BackColor(c, Box::new(inner)),
                    WrapKind::Frame { thickness, stroke } => BoxContent::Frame {
                        thickness,
                        stroke,
                        inner: Box::new(inner),
                    },
                };
                done.push(MathBox {
                    width,
                    height,
                    depth,
                    italic,
                    shift,
                    content,
                });
            }
        }
    }
    done.pop().unwrap_or_else(MathBox::empty)
}

fn push_box_task<'a>(bx: &'a MathBox, tasks: &mut Vec<CloneTask<'a>>, done: &mut Vec<MathBox>) {
    let width = bx.width.clone();
    let height = bx.height.clone();
    let depth = bx.depth.clone();
    let italic = bx.italic.clone();
    let shift = bx.shift.clone();
    match &bx.content {
        BoxContent::Empty => done.push(MathBox {
            width,
            height,
            depth,
            italic,
            shift,
            content: BoxContent::Empty,
        }),
        BoxContent::Rule => done.push(MathBox {
            width,
            height,
            depth,
            italic,
            shift,
            content: BoxContent::Rule,
        }),
        BoxContent::Kern(w) => done.push(MathBox {
            width,
            height,
            depth,
            italic,
            shift,
            content: BoxContent::Kern(w.clone()),
        }),
        BoxContent::Glyph {
            ch,
            glyph_id,
            scale,
        } => done.push(MathBox {
            width,
            height,
            depth,
            italic,
            shift,
            content: BoxContent::glyph(*ch, *glyph_id, scale.clone()),
        }),
        BoxContent::Line {
            x1,
            y1,
            x2,
            y2,
            thickness,
        } => done.push(MathBox {
            width,
            height,
            depth,
            italic,
            shift,
            content: BoxContent::Line {
                x1: x1.clone(),
                y1: y1.clone(),
                x2: x2.clone(),
                y2: y2.clone(),
                thickness: thickness.clone(),
            },
        }),
        BoxContent::HList(children) => {
            tasks.push(CloneTask::List {
                width,
                height,
                depth,
                italic,
                shift,
                kind: ListKind::H,
                n: children.len(),
            });
            for child in children.iter().rev() {
                tasks.push(CloneTask::Box(child));
            }
        }
        BoxContent::VList(children) => {
            tasks.push(CloneTask::List {
                width,
                height,
                depth,
                italic,
                shift,
                kind: ListKind::V,
                n: children.len(),
            });
            for child in children.iter().rev() {
                tasks.push(CloneTask::Box(child));
            }
        }
        BoxContent::Overlap(children) => {
            tasks.push(CloneTask::List {
                width,
                height,
                depth,
                italic,
                shift,
                kind: ListKind::Overlap,
                n: children.len(),
            });
            for child in children.iter().rev() {
                tasks.push(CloneTask::Box(child));
            }
        }
        BoxContent::Color(c, inner) => {
            tasks.push(CloneTask::Wrap {
                width,
                height,
                depth,
                italic,
                shift,
                kind: WrapKind::Color(*c),
            });
            tasks.push(CloneTask::Box(inner));
        }
        BoxContent::BackColor(c, inner) => {
            tasks.push(CloneTask::Wrap {
                width,
                height,
                depth,
                italic,
                shift,
                kind: WrapKind::BackColor(*c),
            });
            tasks.push(CloneTask::Box(inner));
        }
        BoxContent::Frame {
            thickness,
            stroke,
            inner,
        } => {
            tasks.push(CloneTask::Wrap {
                width,
                height,
                depth,
                italic,
                shift,
                kind: WrapKind::Frame {
                    thickness: thickness.clone(),
                    stroke: *stroke,
                },
            });
            tasks.push(CloneTask::Box(inner));
        }
    }
}