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
//! Tree structure definitions for virtual DOM nodes
//!
//! This module contains the foundational types for KaTeX's virtual DOM system,
//! including the base VirtualNode trait and DocumentFragment structure.
use crate::ParseError;
use crate::types::CssStyle;
#[cfg(feature = "wasm")]
use web_sys;
/// Base virtual DOM node interface used in both DOM tree and MathML tree
/// implementations
pub trait VirtualNode {
/// Convert into HTML markup string
fn to_markup(&self) -> Result<String, ParseError>;
/// Convert into a DOM node
#[cfg(feature = "wasm")]
fn to_node(&self) -> web_sys::Node;
}
/// Document fragment containing elements without DOM representation
#[derive(Debug)]
pub struct DocumentFragment<ChildType: VirtualNode> {
/// The child nodes contained within this document fragment. These represent
/// the nested elements in the virtual DOM tree structure used for
/// mathematical rendering in KaTeX. Each child is a VirtualNode that
/// can be rendered into HTML or MathML markup.
///
/// # See Also
/// - [`VirtualNode`]: The trait implemented by child nodes
/// - [`DocumentFragment::new`]: Constructor for creating fragments with
/// children
pub children: Vec<ChildType>,
/// CSS class names applied to this document fragment. These classes control
/// styling and layout in the rendered mathematical output, following
/// KaTeX's CSS conventions.
///
/// # See Also
/// - [`DocumentFragment::has_class`]: Method to check for specific classes
pub classes: Vec<String>,
/// The height of this document fragment in em units, representing the
/// vertical extent above the baseline in mathematical rendering. Used
/// for proper alignment and spacing in LaTeX expressions.
///
/// # Mathematical Context
/// In KaTeX, height is crucial for aligning superscripts, fractions, and
/// other vertical elements.
pub height: f64,
/// The depth of this document fragment in em units, representing the
/// vertical extent below the baseline in mathematical rendering. Used
/// for proper alignment and spacing in LaTeX expressions.
///
/// # Mathematical Context
/// In KaTeX, depth is crucial for aligning subscripts, fractions, and other
/// vertical elements.
pub depth: f64,
/// The maximum font size used within this document fragment, in points.
/// This value determines the scaling factor for the entire fragment in
/// mathematical rendering.
///
/// # See Also
/// - Font metrics in KaTeX for size calculations
pub max_font_size: f64,
/// Inline CSS styles applied to this document fragment. These styles
/// override default KaTeX styling and allow for custom rendering
/// adjustments in mathematical expressions.
///
/// # See Also
/// - [`CssStyle`]: The type used for style properties
/// - KaTeX CSS documentation for available style properties
pub style: CssStyle,
}
impl<ChildType: VirtualNode + Clone> Clone for DocumentFragment<ChildType> {
fn clone(&self) -> Self {
Self {
children: self.children.clone(),
classes: self.classes.clone(),
height: self.height,
depth: self.depth,
max_font_size: self.max_font_size,
style: self.style.clone(),
}
}
}
impl<ChildType: VirtualNode> DocumentFragment<ChildType> {
/// Create a new document fragment with the given children
#[must_use]
pub fn new(children: Vec<ChildType>) -> Self {
Self {
children,
classes: Vec::new(),
height: 0.0,
depth: 0.0,
max_font_size: 0.0,
style: CssStyle::default(),
}
}
/// Check if the fragment has a specific class
#[must_use]
pub fn has_class(&self, class_name: &str) -> bool {
self.classes.iter().any(|cls| cls == class_name)
}
}
impl<ChildType: VirtualNode + Clone + 'static> VirtualNode for DocumentFragment<ChildType> {
fn to_markup(&self) -> Result<String, ParseError> {
self.children.iter().map(VirtualNode::to_markup).collect()
}
#[cfg(feature = "wasm")]
fn to_node(&self) -> web_sys::Node {
use wasm_bindgen::JsCast as _;
let document = web_sys::window().unwrap().document().unwrap();
let fragment = document.create_document_fragment();
for child in &self.children {
let node = child.to_node();
fragment.append_child(&node).unwrap();
}
fragment.dyn_into::<web_sys::Node>().unwrap()
}
}
pub use crate::dom_tree::HtmlDomNode;
pub use crate::mathml_tree::MathDomNode;