ruvector-scipix 2.0.4

Rust OCR engine for scientific documents - extract LaTeX, MathML from math equations, research papers, and technical diagrams with ONNX GPU acceleration
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

//! HTML output formatter with math rendering support

use super::{HtmlEngine, LineData};

/// HTML formatter with math rendering
pub struct HtmlFormatter {
    engine: HtmlEngine,
    css_styling: bool,
    accessibility: bool,
    responsive: bool,
    theme: HtmlTheme,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum HtmlTheme {
    Light,
    Dark,
    Auto,
}

impl HtmlFormatter {
    pub fn new() -> Self {
        Self {
            engine: HtmlEngine::MathJax,
            css_styling: true,
            accessibility: true,
            responsive: true,
            theme: HtmlTheme::Light,
        }
    }

    pub fn with_engine(mut self, engine: HtmlEngine) -> Self {
        self.engine = engine;
        self
    }

    pub fn with_styling(mut self, styling: bool) -> Self {
        self.css_styling = styling;
        self
    }

    pub fn accessibility(mut self, enabled: bool) -> Self {
        self.accessibility = enabled;
        self
    }

    pub fn responsive(mut self, enabled: bool) -> Self {
        self.responsive = enabled;
        self
    }

    pub fn theme(mut self, theme: HtmlTheme) -> Self {
        self.theme = theme;
        self
    }

    /// Format content to HTML
    pub fn format(&self, content: &str, lines: Option<&[LineData]>) -> String {
        let mut html = String::new();

        // HTML header with math rendering scripts
        html.push_str(&self.html_header());

        // Body start with theme class
        html.push_str("<body");
        if self.css_styling {
            html.push_str(&format!(r#" class="theme-{:?}""#, self.theme).to_lowercase());
        }
        html.push_str(">\n");

        // Main content container
        html.push_str(r#"<div class="content">"#);
        html.push_str("\n");

        // Format content
        if let Some(line_data) = lines {
            html.push_str(&self.format_lines(line_data));
        } else {
            html.push_str(&self.format_text(content));
        }

        html.push_str("</div>\n");
        html.push_str("</body>\n</html>");

        html
    }

    /// Generate HTML header with scripts and styles
    fn html_header(&self) -> String {
        let mut header = String::from("<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n");
        header.push_str(r#"    <meta charset="UTF-8">"#);
        header.push_str("\n");

        if self.responsive {
            header.push_str(
                r#"    <meta name="viewport" content="width=device-width, initial-scale=1.0">"#,
            );
            header.push_str("\n");
        }

        header.push_str("    <title>Mathematical Content</title>\n");

        // Math rendering scripts
        match self.engine {
            HtmlEngine::MathJax => {
                header.push_str(r#"    <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>"#);
                header.push_str("\n");
                header.push_str(r#"    <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>"#);
                header.push_str("\n");
                header.push_str("    <script>\n");
                header.push_str("    MathJax = {\n");
                header.push_str("        tex: {\n");
                header.push_str(r#"            inlineMath: [['$', '$'], ['\\(', '\\)']],"#);
                header.push_str("\n");
                header.push_str(r#"            displayMath: [['$$', '$$'], ['\\[', '\\]']]"#);
                header.push_str("\n");
                header.push_str("        }\n");
                header.push_str("    };\n");
                header.push_str("    </script>\n");
            }
            HtmlEngine::KaTeX => {
                header.push_str(r#"    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css">"#);
                header.push_str("\n");
                header.push_str(r#"    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js"></script>"#);
                header.push_str("\n");
                header.push_str(r#"    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/contrib/auto-render.min.js" onload="renderMathInElement(document.body);"></script>"#);
                header.push_str("\n");
            }
            HtmlEngine::Raw => {
                // No math rendering
            }
        }

        // CSS styling
        if self.css_styling {
            header.push_str("    <style>\n");
            header.push_str(&self.generate_css());
            header.push_str("    </style>\n");
        }

        header.push_str("</head>\n");
        header
    }

    /// Generate CSS styles
    fn generate_css(&self) -> String {
        let mut css = String::new();

        css.push_str("        body {\n");
        css.push_str("            font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;\n");
        css.push_str("            line-height: 1.6;\n");
        css.push_str("            max-width: 800px;\n");
        css.push_str("            margin: 0 auto;\n");
        css.push_str("            padding: 20px;\n");
        css.push_str("        }\n");

        // Theme colors
        match self.theme {
            HtmlTheme::Light => {
                css.push_str("        body.theme-light {\n");
                css.push_str("            background-color: #ffffff;\n");
                css.push_str("            color: #333333;\n");
                css.push_str("        }\n");
            }
            HtmlTheme::Dark => {
                css.push_str("        body.theme-dark {\n");
                css.push_str("            background-color: #1e1e1e;\n");
                css.push_str("            color: #d4d4d4;\n");
                css.push_str("        }\n");
            }
            HtmlTheme::Auto => {
                css.push_str("        @media (prefers-color-scheme: dark) {\n");
                css.push_str("            body { background-color: #1e1e1e; color: #d4d4d4; }\n");
                css.push_str("        }\n");
            }
        }

        css.push_str("        .content { padding: 20px; }\n");
        css.push_str("        .math-display { text-align: center; margin: 20px 0; }\n");
        css.push_str("        .math-inline { display: inline; }\n");
        css.push_str("        .equation-block { margin: 15px 0; padding: 10px; background: #f5f5f5; border-radius: 4px; }\n");
        css.push_str("        table { border-collapse: collapse; width: 100%; margin: 20px 0; }\n");
        css.push_str(
            "        th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }\n",
        );
        css.push_str("        th { background-color: #f2f2f2; }\n");

        if self.accessibility {
            css.push_str("        .sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0,0,0,0); border: 0; }\n");
        }

        css
    }

    /// Format plain text to HTML
    fn format_text(&self, text: &str) -> String {
        let escaped = self.escape_html(text);

        // Convert math delimiters if present
        let mut html = escaped;

        // Display math $$...$$
        html = html.replace("$$", "<div class=\"math-display\">$$");
        html = html.replace("$$", "$$</div>");

        // Inline math $...$
        // This is simplistic - a real implementation would need proper parsing

        format!("<p>{}</p>", html)
    }

    /// Format line data to HTML
    fn format_lines(&self, lines: &[LineData]) -> String {
        let mut html = String::new();

        for line in lines {
            match line.line_type.as_str() {
                "text" => {
                    html.push_str("<p>");
                    html.push_str(&self.escape_html(&line.text));
                    html.push_str("</p>\n");
                }
                "math" | "equation" => {
                    let latex = line.latex.as_ref().unwrap_or(&line.text);
                    html.push_str(r#"<div class="math-display">"#);
                    if self.accessibility {
                        html.push_str(&format!(
                            r#"<span class="sr-only">Equation: {}</span>"#,
                            self.escape_html(&line.text)
                        ));
                    }
                    html.push_str(&format!("$${}$$", latex));
                    html.push_str("</div>\n");
                }
                "inline_math" => {
                    let latex = line.latex.as_ref().unwrap_or(&line.text);
                    html.push_str(&format!(r#"<span class="math-inline">${}$</span>"#, latex));
                }
                "heading" => {
                    html.push_str(&format!("<h2>{}</h2>\n", self.escape_html(&line.text)));
                }
                "table" => {
                    html.push_str(&self.format_table(&line.text));
                }
                "image" => {
                    html.push_str(&format!(
                        r#"<img src="{}" alt="Image" loading="lazy">"#,
                        self.escape_html(&line.text)
                    ));
                    html.push_str("\n");
                }
                _ => {
                    html.push_str("<p>");
                    html.push_str(&self.escape_html(&line.text));
                    html.push_str("</p>\n");
                }
            }
        }

        html
    }

    /// Format table to HTML
    fn format_table(&self, table: &str) -> String {
        let mut html = String::from("<table>\n");

        let rows: Vec<&str> = table.lines().collect();
        for (i, row) in rows.iter().enumerate() {
            html.push_str("  <tr>\n");

            let cells: Vec<&str> = row
                .split('|')
                .map(|s| s.trim())
                .filter(|s| !s.is_empty())
                .collect();

            let tag = if i == 0 { "th" } else { "td" };

            for cell in cells {
                html.push_str(&format!(
                    "    <{}>{}</{}>\n",
                    tag,
                    self.escape_html(cell),
                    tag
                ));
            }

            html.push_str("  </tr>\n");
        }

        html.push_str("</table>\n");
        html
    }

    /// Escape HTML special characters
    fn escape_html(&self, text: &str) -> String {
        text.replace('&', "&amp;")
            .replace('<', "&lt;")
            .replace('>', "&gt;")
            .replace('"', "&quot;")
            .replace('\'', "&#39;")
    }
}

impl Default for HtmlFormatter {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn test_html_header() {
        let formatter = HtmlFormatter::new().with_engine(HtmlEngine::MathJax);
        let header = formatter.html_header();

        assert!(header.contains("<!DOCTYPE html>"));
        assert!(header.contains("MathJax"));
    }

    #[test]
    fn test_katex_header() {
        let formatter = HtmlFormatter::new().with_engine(HtmlEngine::KaTeX);
        let header = formatter.html_header();

        assert!(header.contains("katex"));
    }

    #[test]
    fn test_escape_html() {
        let formatter = HtmlFormatter::new();
        let result = formatter.escape_html("<script>alert('test')</script>");

        assert!(result.contains("&lt;"));
        assert!(result.contains("&gt;"));
        assert!(!result.contains("<script>"));
    }

    #[test]
    fn test_format_lines() {
        let formatter = HtmlFormatter::new();
        let lines = vec![
            LineData {
                line_type: "text".to_string(),
                text: "Introduction".to_string(),
                latex: None,
                bbox: BoundingBox::new(0.0, 0.0, 100.0, 20.0),
                confidence: 0.95,
                words: None,
            },
            LineData {
                line_type: "equation".to_string(),
                text: "E = mc^2".to_string(),
                latex: Some(r"E = mc^2".to_string()),
                bbox: BoundingBox::new(0.0, 25.0, 100.0, 30.0),
                confidence: 0.98,
                words: None,
            },
        ];

        let result = formatter.format_lines(&lines);
        assert!(result.contains("<p>Introduction</p>"));
        assert!(result.contains("math-display"));
        assert!(result.contains("$$"));
    }

    #[test]
    fn test_dark_theme() {
        let formatter = HtmlFormatter::new().theme(HtmlTheme::Dark);
        let css = formatter.generate_css();

        assert!(css.contains("theme-dark"));
        assert!(css.contains("#1e1e1e"));
    }

    #[test]
    fn test_accessibility() {
        let formatter = HtmlFormatter::new().accessibility(true);
        let lines = vec![LineData {
            line_type: "equation".to_string(),
            text: "x squared".to_string(),
            latex: Some("x^2".to_string()),
            bbox: BoundingBox::new(0.0, 0.0, 100.0, 20.0),
            confidence: 0.98,
            words: None,
        }];

        let result = formatter.format_lines(&lines);
        assert!(result.contains("sr-only"));
        assert!(result.contains("Equation:"));
    }
}