latex-rust 1.0.0

Pure-Rust LaTeX math renderer. Parse to AST, TeX-faithful layout in zenith-float, emit SVG, PNG, or egui shapes. No JavaScript, no webview, no runtime.
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

//! LaTeX-Rust: a pure Rust LaTeX **math** renderer.
//!
//! Parse a math string to a typed AST, lay it out with a TeX-faithful box
//! model whose dimensions are zenith-float [`Dim`] values (no hardware `f32` /
//! `f64` in layout arithmetic), and render to SVG, PNG (`features = ["png"]`),
//! or egui shapes (`features = ["egui"]`).
//!
//! Crate layout follows the build-sheet architecture: [`parser`],
//! [`mod@layout`], [`font`], [`render`] (`svg` / `png` / `egui`).
//!
//! Unsupported constructs return [`Error`] — never a fake render.
//!
//! # Examples
//!
//! ```
//! use latex_rust::{parse, layout, tokenize, lookup, MathFont, MathStyle, Dim, MathBox};
//!
//! let ast = parse(r"\frac{1}{2}").expect("parse");
//! assert_eq!(ast.gold(), r#"(frac (atom Ord "1") (atom Ord "2"))"#);
//!
//! let tokens = tokenize(r"\frac{1}{2}").expect("tokens");
//! assert!(!tokens.is_empty());
//! assert_eq!(lookup(r"\alpha").unwrap().glyph, "α");
//!
//! let font = MathFont::stix_two_math().expect("STIX Two Math");
//! assert_eq!(font.units_per_em(), 1000);
//!
//! let boxed = layout(&ast, &font, MathStyle::Text).expect("layout");
//! assert!(!boxed.width.is_zero());
//!
//! let svg = latex_rust::latex_to_svg(r"x", &font, &latex_rust::SvgOptions::new()).expect("svg");
//! assert!(svg.contains("<path"));
//!
//! 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));
//! ```

#![deny(missing_docs)]
#![deny(clippy::float_arithmetic)]
#![deny(clippy::undocumented_unsafe_blocks)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

mod atoms;
mod color;
mod dim;
mod error;
mod style_map;
mod symbols;

/// OpenType MATH metrics and the embedded STIX Two Math face.
pub mod font;
/// AST → TeX-faithful [`MathBox`](layout::MathBox).
pub mod layout;
/// LaTeX math → [`MathNode`](parser::MathNode) AST.
pub mod parser;
/// Box model → SVG, PNG, or egui primitives.
pub mod render;

pub use atoms::symbol_atom_kind;
pub use color::{named_color, parse_color_spec, Color, ColorTable};
pub use dim::{Dim, DIM_PREC};
pub use error::{Error, FontError, ParseError};
pub use font::{
    GlyphMetrics, MathFont, STIX_TWO_MATH_NAME, STIX_TWO_MATH_OTF, STIX_TWO_MATH_SHA256,
};
pub use layout::{
    layout, layout_with_numbering, BoxContent, MathBox, MathParams, MathStyle, NumberFormat,
    NumberStyle, NumberingConfig, NumberingState,
};
pub use parser::{
    format_tokens, parse, parse_with_colors, preprocess, tokenize, AccentKind, AtomKind, ColSpec,
    DelimSize, Delimiter, EnvRow, EqNumber, IntegralKind, MathNode, MatrixStyle, PhantomKind,
    SpaceKind, TextStyle, Token,
};
#[cfg(feature = "egui")]
pub use render::egui::{latex_to_shapes, paint_egui, shapes};
pub use render::egui::{render_egui, EguiOptions};
pub use render::png::{latex_to_png, render_png, PngBackground, PngOptions};
pub use render::svg::{latex_to_svg, render_svg, SvgOptions};
pub use style_map::styled_char;
pub use symbols::{category_count, glyph_char, lookup, symbols, SymbolEntry, SymbolKind};