pulldown-latex 0.8.0

Pull parser to convert LaTeX equations to MathML
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

use heck::ToTitleCase;
use inventory::collect;
use libtest_mimic::{Arguments, Conclusion, Failed, Trial};
use pulldown_latex::{config::RenderConfig, mathml::push_mathml, Parser, Storage};
use std::{io::Write, sync::Mutex};

#[allow(clippy::type_complexity)]
pub static RENDERED: Mutex<Vec<(&str, Vec<(&str, String)>)>> = Mutex::new(Vec::new());
pub const OUTPUT_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/out");

pub struct TestCase {
    pub name: &'static str,
    pub test: fn() -> Result<(), Failed>,
}
collect!(TestCase);

pub fn test() -> Conclusion {
    let args = Arguments::from_args();
    let tests = inventory::iter::<TestCase>
        .into_iter()
        .map(|TestCase { name, test }| Trial::test(*name, test))
        .collect::<Vec<_>>();
    libtest_mimic::run(&args, tests)
}

pub fn round_trip(
    fn_name: &'static str,
    inputs: &[&'static str],
    config: RenderConfig,
) -> Result<(), Failed> {
    let mut storage = Storage::new();
    let rendered: Vec<_> = inputs
        .iter()
        .map(|input| -> Result<_, Failed> {
            show_errors(Parser::new(input, &storage))?;
            let parser = Parser::new(input, &storage);
            let mut output = String::new();
            push_mathml(&mut output, parser, config)?;
            storage.reset();
            Ok((*input, output))
        })
        .collect::<Result<_, Failed>>()?;

    RENDERED.lock()?.push((fn_name, rendered));

    Ok(())
}

pub fn show_errors(parser: Parser) -> Result<(), usize> {
    let mut error_count = 0;

    parser.for_each(|event| {
        if let Err(e) = event {
            eprintln!("{:?}", e);
            error_count += 1;
        }
    });

    if error_count > 0 {
        Err(error_count)
    } else {
        Ok(())
    }
}

// This shared module is also compiled into the cross-browser test, which uses
// its own table renderer.
#[allow(dead_code)]
pub fn tabled(file: &mut std::fs::File) -> anyhow::Result<()> {
    file.write_all(br#"<table style="max-width: 60vw; margin: auto;">"#)?;
    let mut rendered = RENDERED.lock().unwrap();
    rendered.sort();
    rendered
        .iter()
        .try_for_each(|(table_name, rows)| -> std::io::Result<()> {
            file.write_fmt(format_args!(
                r#"<tr><th colspan="2">{table_name}</th></tr>"#,
                table_name = table_name.to_title_case()
            ))?;

            rows.iter().try_for_each(|(input, output)| {
                file.write_fmt(format_args!(
                    r#"<tr><td>{input}</td><td style="position: relative">{output}</td></tr>"#,
                    input = input,
                    output = output
                ))
            })
        })?;
    file.write_all(b"</table>")?;
    Ok(())
}

pub fn html_template(
    file: &mut std::fs::File,
    title: &str,
    stylesheet: Option<&str>,
    render: impl FnOnce(&mut std::fs::File) -> anyhow::Result<()>,
) -> anyhow::Result<()> {
    let styles = match stylesheet {
        Some(stylesheet) => {
            format!(r#"<link rel="stylesheet" type="text/css" href="{OUTPUT_DIR}/{stylesheet}">"#,)
        }
        None => "".to_string(),
    };

    file.write_fmt(format_args!(
        r#"<!DOCTYPE html>
<html>
<head>
<title>{title}</title>
<link rel="stylesheet" type="text/css" href="{}/styles.css">
<meta charset="UTF-8">
{styles}</head>
<body>
"#,
        env!("CARGO_MANIFEST_DIR")
    ))?;

    render(file)?;

    file.write_fmt(format_args!(
        r#"</body>
</html>"#
    ))?;
    Ok(())
}

#[macro_export]
macro_rules! round_trip_display {
    ($name:ident, $($input:literal),+ $(,)?) => {
        $crate::round_trip!(
            $name,
            $($input),+,
            display_mode = pulldown_latex::config::DisplayMode::Block
        );
    };
    (should_panic, $name:ident, $($input:literal),+ $(,)?) => {
        $crate::round_trip!(
            should_panic,
            $name,
            $($input),+
        );
    }
}

#[macro_export]
macro_rules! round_trip {
    (should_panic, $name:ident, $($input:literal),+ $(,)?) => {
        pub fn $name() -> Result<(), libtest_mimic::Failed> {
            let inputs = &[$($input),*];
            let mut storage = pulldown_latex::Storage::new();
            for input in inputs {
                let mut parser = pulldown_latex::parser::Parser::new(input, &storage);
                if !parser.all(|event| event.is_err()) {
                    return Err(libtest_mimic::Failed::without_message());
                };
                storage.reset();
            }
            Ok(())
        }

        inventory::submit! {
            $crate::common::TestCase {
                name: stringify!($name),
                test: $name
            }
        }
    };
    ($name:ident, $($input:literal),+ $(, $field:ident = $value:expr)* $(,)?) => {
        pub fn $name() -> Result<(), libtest_mimic::Failed> {
            let inputs = &[$($input),*];
            $crate::common::round_trip(stringify!($name), inputs, pulldown_latex::config::RenderConfig {
                $($field: $value,)*
                ..Default::default()
            })
        }

        inventory::submit! {
            $crate::common::TestCase {
                name: stringify!($name),
                test: $name
            }
        }
    };
}