tylax 0.3.5

Tylax - High-performance bidirectional LaTeX ↔ Typst converter
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
//! Typst to LaTeX compatibility mappings
//!
//! This module contains data-driven mappings for converting Typst constructs to LaTeX.
//! Centralizes hardcoded strings to enable easy maintenance and extension.

use lazy_static::lazy_static;
use std::collections::HashMap;

// ============================================================================
// Markup Function Handlers
// ============================================================================

/// Handler type for markup functions
#[derive(Debug, Clone)]
pub enum MarkupHandler {
    /// Simple wrapper: prefix + content + suffix
    Wrap {
        prefix: &'static str,
        suffix: &'static str,
    },
    /// Environment: \begin{env} + content + \end{env}
    Environment { name: &'static str },
    /// Just output the content (pass-through)
    PassThrough,
    /// Special handling required (not in map)
    Special,
}

lazy_static! {
    /// Mapping from Typst markup function names to LaTeX handlers
    pub static ref TYPST_MARKUP_HANDLERS: HashMap<&'static str, MarkupHandler> = {
        let mut m = HashMap::new();

        // Text formatting
        m.insert("strong", MarkupHandler::Wrap { prefix: "\\textbf{", suffix: "}" });
        m.insert("bold", MarkupHandler::Wrap { prefix: "\\textbf{", suffix: "}" });
        m.insert("emph", MarkupHandler::Wrap { prefix: "\\textit{", suffix: "}" });
        m.insert("italic", MarkupHandler::Wrap { prefix: "\\textit{", suffix: "}" });
        m.insert("underline", MarkupHandler::Wrap { prefix: "\\underline{", suffix: "}" });
        m.insert("strike", MarkupHandler::Wrap { prefix: "\\sout{", suffix: "}" });
        m.insert("smallcaps", MarkupHandler::Wrap { prefix: "\\textsc{", suffix: "}" });
        m.insert("raw", MarkupHandler::Wrap { prefix: "\\texttt{", suffix: "}" });
        m.insert("sub", MarkupHandler::Wrap { prefix: "\\textsubscript{", suffix: "}" });
        m.insert("super", MarkupHandler::Wrap { prefix: "\\textsuperscript{", suffix: "}" });

        // Document structure
        m.insert("heading", MarkupHandler::Wrap { prefix: "\\section{", suffix: "}\n" });
        m.insert("list", MarkupHandler::Environment { name: "itemize" });
        m.insert("enum", MarkupHandler::Environment { name: "enumerate" });
        m.insert("quote", MarkupHandler::Environment { name: "quote" });
        m.insert("figure", MarkupHandler::Special);
        m.insert("table", MarkupHandler::Special);

        // Page elements
        m.insert("pagebreak", MarkupHandler::Wrap { prefix: "\\newpage", suffix: "" });
        m.insert("linebreak", MarkupHandler::Wrap { prefix: "\\\\", suffix: "" });
        m.insert("line", MarkupHandler::Wrap { prefix: "\\hrule", suffix: "" });

        // Pass-through
        // m.insert("text", MarkupHandler::PassThrough); // Handled as Special now
        // m.insert("align", MarkupHandler::PassThrough); // Handled as Special now
        m.insert("text", MarkupHandler::Special);
        m.insert("align", MarkupHandler::Special);

        // Special handling (complex parsing required)
        m.insert("image", MarkupHandler::Special);
        m.insert("link", MarkupHandler::Special);
        m.insert("cite", MarkupHandler::Special);
        m.insert("ref", MarkupHandler::Special);
        m.insert("label", MarkupHandler::Special);
        m.insert("bibliography", MarkupHandler::Special);
        m.insert("footnote", MarkupHandler::Special);
        m.insert("caption", MarkupHandler::Special);
        m.insert("rotate", MarkupHandler::Special);
        m.insert("rect", MarkupHandler::Special);
        m.insert("box", MarkupHandler::Special);
        m.insert("block", MarkupHandler::Special);
        m.insert("pad", MarkupHandler::Special);
        m.insert("center", MarkupHandler::Special);

        // Theorem-like environments
        m.insert("theorem", MarkupHandler::Special);
        m.insert("lemma", MarkupHandler::Special);
        m.insert("proposition", MarkupHandler::Special);
        m.insert("corollary", MarkupHandler::Special);
        m.insert("definition", MarkupHandler::Special);
        m.insert("example", MarkupHandler::Special);
        m.insert("remark", MarkupHandler::Special);
        m.insert("proof", MarkupHandler::Special);

        // Layout
        m.insert("columns", MarkupHandler::Special);
        m.insert("grid", MarkupHandler::Special);
        m.insert("center", MarkupHandler::Special);
        m.insert("box", MarkupHandler::Special);
        m.insert("block", MarkupHandler::Special);
        m.insert("rect", MarkupHandler::Special);
        m.insert("blockquote", MarkupHandler::Special);

        // Spacing
        m.insert("h", MarkupHandler::Special);  // horizontal space
        m.insert("v", MarkupHandler::Special);  // vertical space
        m.insert("pad", MarkupHandler::Special); // padding

        // Visibility
        m.insert("hide", MarkupHandler::Wrap { prefix: "\\phantom{", suffix: "}" });

        m
    };
}

// ============================================================================
// Math Function Handlers
// ============================================================================

/// Handler type for math functions
#[derive(Debug, Clone)]
pub enum MathHandler {
    /// Direct command: \cmd{arg1}{arg2}...
    Command { latex_cmd: &'static str },
    /// Command with optional arg: `\cmd[opt]{arg}`
    CommandWithOpt { latex_cmd: &'static str },
    /// Delimiter pair: `\left<open> content \right<close>`
    Delimiters {
        open: &'static str,
        close: &'static str,
    },
    /// Environment: \begin{env}...\end{env}
    Environment { name: &'static str },
    /// Big operator: \cmd with limits
    BigOperator { latex_cmd: &'static str },
    /// Special handling required
    Special,
}

lazy_static! {
    /// Mapping from Typst math function names to LaTeX handlers
    pub static ref TYPST_MATH_HANDLERS: HashMap<&'static str, MathHandler> = {
        let mut m = HashMap::new();

        // Fractions
        m.insert("frac", MathHandler::Command { latex_cmd: "\\frac" });
        m.insert("dfrac", MathHandler::Command { latex_cmd: "\\dfrac" });
        m.insert("tfrac", MathHandler::Command { latex_cmd: "\\tfrac" });
        m.insert("binom", MathHandler::Command { latex_cmd: "\\binom" });

        // Roots
        m.insert("sqrt", MathHandler::CommandWithOpt { latex_cmd: "\\sqrt" });
        m.insert("root", MathHandler::CommandWithOpt { latex_cmd: "\\sqrt" });

        // Decorations / Accents
        m.insert("vec", MathHandler::Command { latex_cmd: "\\vec" });
        m.insert("hat", MathHandler::Command { latex_cmd: "\\widehat" });
        m.insert("widehat", MathHandler::Command { latex_cmd: "\\widehat" });
        m.insert("tilde", MathHandler::Command { latex_cmd: "\\widetilde" });
        m.insert("widetilde", MathHandler::Command { latex_cmd: "\\widetilde" });
        m.insert("overline", MathHandler::Command { latex_cmd: "\\overline" });
        m.insert("ol", MathHandler::Command { latex_cmd: "\\overline" });
        m.insert("underline", MathHandler::Command { latex_cmd: "\\underline" });
        m.insert("ul", MathHandler::Command { latex_cmd: "\\underline" });
        m.insert("overbrace", MathHandler::Command { latex_cmd: "\\overbrace" });
        m.insert("underbrace", MathHandler::Command { latex_cmd: "\\underbrace" });
        m.insert("cancel", MathHandler::Command { latex_cmd: "\\cancel" });
        m.insert("hide", MathHandler::Command { latex_cmd: "\\phantom" });
        m.insert("box", MathHandler::Command { latex_cmd: "\\boxed" });
        m.insert("dot", MathHandler::Command { latex_cmd: "\\dot" });
        m.insert("ddot", MathHandler::Command { latex_cmd: "\\ddot" });
        m.insert("acute", MathHandler::Command { latex_cmd: "\\acute" });
        m.insert("grave", MathHandler::Command { latex_cmd: "\\grave" });
        m.insert("macron", MathHandler::Command { latex_cmd: "\\bar" });
        m.insert("bar", MathHandler::Command { latex_cmd: "\\bar" });
        m.insert("breve", MathHandler::Command { latex_cmd: "\\breve" });
        m.insert("caron", MathHandler::Command { latex_cmd: "\\check" });

        // Delimiters
        m.insert("abs", MathHandler::Delimiters { open: "\\left|", close: "\\right|" });
        m.insert("norm", MathHandler::Delimiters { open: "\\left\\|", close: "\\right\\|" });
        m.insert("floor", MathHandler::Delimiters { open: "\\left\\lfloor ", close: "\\right\\rfloor" });
        m.insert("ceil", MathHandler::Delimiters { open: "\\left\\lceil ", close: "\\right\\rceil" });
        m.insert("round", MathHandler::Delimiters { open: "\\left\\lfloor ", close: "\\right\\rceil" });

        // Big operators
        m.insert("sum", MathHandler::BigOperator { latex_cmd: "\\sum" });
        m.insert("prod", MathHandler::BigOperator { latex_cmd: "\\prod" });
        m.insert("int", MathHandler::BigOperator { latex_cmd: "\\int" });
        m.insert("oint", MathHandler::BigOperator { latex_cmd: "\\oint" });
        m.insert("iint", MathHandler::BigOperator { latex_cmd: "\\iint" });
        m.insert("iiint", MathHandler::BigOperator { latex_cmd: "\\iiint" });
        m.insert("lim", MathHandler::BigOperator { latex_cmd: "\\lim" });
        m.insert("limsup", MathHandler::BigOperator { latex_cmd: "\\limsup" });
        m.insert("liminf", MathHandler::BigOperator { latex_cmd: "\\liminf" });
        m.insert("max", MathHandler::BigOperator { latex_cmd: "\\max" });
        m.insert("min", MathHandler::BigOperator { latex_cmd: "\\min" });
        m.insert("sup", MathHandler::BigOperator { latex_cmd: "\\sup" });
        m.insert("inf", MathHandler::BigOperator { latex_cmd: "\\inf" });

        // Font styles
        m.insert("text", MathHandler::Command { latex_cmd: "\\text" });
        m.insert("upright", MathHandler::Command { latex_cmd: "\\mathrm" });
        m.insert("bold", MathHandler::Command { latex_cmd: "\\mathbf" });
        m.insert("bf", MathHandler::Command { latex_cmd: "\\mathbf" });
        m.insert("italic", MathHandler::Command { latex_cmd: "\\mathit" });
        m.insert("it", MathHandler::Command { latex_cmd: "\\mathit" });
        m.insert("cal", MathHandler::Command { latex_cmd: "\\mathcal" });
        m.insert("mathcal", MathHandler::Command { latex_cmd: "\\mathcal" });
        m.insert("frak", MathHandler::Command { latex_cmd: "\\mathfrak" });
        m.insert("mathfrak", MathHandler::Command { latex_cmd: "\\mathfrak" });
        m.insert("bb", MathHandler::Command { latex_cmd: "\\mathbb" });
        m.insert("mathbb", MathHandler::Command { latex_cmd: "\\mathbb" });
        m.insert("mono", MathHandler::Command { latex_cmd: "\\mathtt" });
        m.insert("mathtt", MathHandler::Command { latex_cmd: "\\mathtt" });
        m.insert("sans", MathHandler::Command { latex_cmd: "\\mathsf" });
        m.insert("mathsf", MathHandler::Command { latex_cmd: "\\mathsf" });

        // Matrix environments
        m.insert("mat", MathHandler::Environment { name: "matrix" });
        m.insert("matrix", MathHandler::Environment { name: "matrix" });
        m.insert("pmat", MathHandler::Environment { name: "pmatrix" });
        m.insert("pmatrix", MathHandler::Environment { name: "pmatrix" });
        m.insert("bmat", MathHandler::Environment { name: "bmatrix" });
        m.insert("bmatrix", MathHandler::Environment { name: "bmatrix" });
        m.insert("Bmat", MathHandler::Environment { name: "Bmatrix" });
        m.insert("Bmatrix", MathHandler::Environment { name: "Bmatrix" });
        m.insert("vmat", MathHandler::Environment { name: "vmatrix" });
        m.insert("vmatrix", MathHandler::Environment { name: "vmatrix" });
        m.insert("Vmat", MathHandler::Environment { name: "Vmatrix" });
        m.insert("Vmatrix", MathHandler::Environment { name: "Vmatrix" });
        m.insert("cases", MathHandler::Environment { name: "cases" });

        // Special
        m.insert("color", MathHandler::Special);
        m.insert("limits", MathHandler::Special);
        m.insert("arrow", MathHandler::Special);
        m.insert("accent", MathHandler::Special);
        m.insert("class", MathHandler::Special);
        m.insert("op", MathHandler::Special);
        m.insert("display", MathHandler::Special);
        m.insert("inline", MathHandler::Special);
        m.insert("h", MathHandler::Special);
        m.insert("set", MathHandler::Special);
        m.insert("Set", MathHandler::Special);

        // math.* namespace functions (need special handling)
        m.insert("math.vec", MathHandler::Special);  // Column vector -> pmatrix
        m.insert("math.mat", MathHandler::Environment { name: "matrix" });
        m.insert("math.cases", MathHandler::Environment { name: "cases" });
        m.insert("math.abs", MathHandler::Delimiters { open: "\\left|", close: "\\right|" });
        m.insert("math.norm", MathHandler::Delimiters { open: "\\left\\|", close: "\\right\\|" });
        m.insert("math.floor", MathHandler::Delimiters { open: "\\left\\lfloor ", close: "\\right\\rfloor" });
        m.insert("math.ceil", MathHandler::Delimiters { open: "\\left\\lceil ", close: "\\right\\rceil" });
        m.insert("math.round", MathHandler::Delimiters { open: "\\left\\lfloor ", close: "\\right\\rceil" });

        // lr() - auto-sizing delimiters
        m.insert("lr", MathHandler::Special);

        // attach() - for limits positioning
        m.insert("attach", MathHandler::Special);

        // scripts() - script positioning mode
        m.insert("scripts", MathHandler::Special);

        // primes() - prime marks
        m.insert("primes", MathHandler::Special);

        // stretch() - stretchy symbols
        m.insert("stretch", MathHandler::Special);

        // mid() - middle delimiter (for conditionals like P(A|B))
        m.insert("mid", MathHandler::Special);

        // circle() - circled content
        m.insert("circle", MathHandler::Special);

        // Vector calculus operators
        m.insert("gradient", MathHandler::Command { latex_cmd: "\\nabla" });
        m.insert("grad", MathHandler::Command { latex_cmd: "\\nabla" });
        m.insert("divergence", MathHandler::Special);  // nabla dot
        m.insert("curl", MathHandler::Special);  // nabla cross
        m.insert("laplacian", MathHandler::Command { latex_cmd: "\\Delta" });

        // Cross and dot products
        m.insert("dot.op", MathHandler::Command { latex_cmd: "\\cdot" });
        m.insert("cross", MathHandler::Command { latex_cmd: "\\times" });
        m.insert("times", MathHandler::Command { latex_cmd: "\\times" });

        // Additional accents from tex2typst
        m.insert("diaer", MathHandler::Command { latex_cmd: "\\ddot" });  // diaeresis
        m.insert("arrow.r", MathHandler::Command { latex_cmd: "\\overrightarrow" });
        m.insert("arrow.l", MathHandler::Command { latex_cmd: "\\overleftarrow" });

        // Spacing commands
        m.insert("thin", MathHandler::Command { latex_cmd: "\\," });
        m.insert("med", MathHandler::Command { latex_cmd: "\\:" });
        m.insert("thick", MathHandler::Command { latex_cmd: "\\;" });
        m.insert("quad", MathHandler::Command { latex_cmd: "\\quad" });
        m.insert("wide", MathHandler::Command { latex_cmd: "\\qquad" });

        // Additional operators
        m.insert("det", MathHandler::BigOperator { latex_cmd: "\\det" });
        m.insert("gcd", MathHandler::BigOperator { latex_cmd: "\\gcd" });
        m.insert("deg", MathHandler::BigOperator { latex_cmd: "\\deg" });
        m.insert("dim", MathHandler::BigOperator { latex_cmd: "\\dim" });
        m.insert("ker", MathHandler::BigOperator { latex_cmd: "\\ker" });
        m.insert("hom", MathHandler::BigOperator { latex_cmd: "\\hom" });
        m.insert("arg", MathHandler::BigOperator { latex_cmd: "\\arg" });
        m.insert("Pr", MathHandler::BigOperator { latex_cmd: "\\Pr" });
        m.insert("exp", MathHandler::BigOperator { latex_cmd: "\\exp" });
        m.insert("log", MathHandler::BigOperator { latex_cmd: "\\log" });
        m.insert("ln", MathHandler::BigOperator { latex_cmd: "\\ln" });
        m.insert("lg", MathHandler::BigOperator { latex_cmd: "\\lg" });
        m.insert("sin", MathHandler::BigOperator { latex_cmd: "\\sin" });
        m.insert("cos", MathHandler::BigOperator { latex_cmd: "\\cos" });
        m.insert("tan", MathHandler::BigOperator { latex_cmd: "\\tan" });
        m.insert("cot", MathHandler::BigOperator { latex_cmd: "\\cot" });
        m.insert("sec", MathHandler::BigOperator { latex_cmd: "\\sec" });
        m.insert("csc", MathHandler::BigOperator { latex_cmd: "\\csc" });
        m.insert("arcsin", MathHandler::BigOperator { latex_cmd: "\\arcsin" });
        m.insert("arccos", MathHandler::BigOperator { latex_cmd: "\\arccos" });
        m.insert("arctan", MathHandler::BigOperator { latex_cmd: "\\arctan" });
        m.insert("sinh", MathHandler::BigOperator { latex_cmd: "\\sinh" });
        m.insert("cosh", MathHandler::BigOperator { latex_cmd: "\\cosh" });
        m.insert("tanh", MathHandler::BigOperator { latex_cmd: "\\tanh" });
        m.insert("coth", MathHandler::BigOperator { latex_cmd: "\\coth" });

        m
    };
}

// ============================================================================
// Heading Level Mapping
// ============================================================================

lazy_static! {
    /// Mapping from heading level to LaTeX sectioning command
    pub static ref HEADING_COMMANDS: Vec<&'static str> = vec![
        "\\section",       // level 1
        "\\subsection",    // level 2
        "\\subsubsection", // level 3
        "\\paragraph",     // level 4
        "\\subparagraph",  // level 5
    ];
}

/// Get LaTeX sectioning command for a heading level (1-indexed)
pub fn get_heading_command(level: usize) -> &'static str {
    HEADING_COMMANDS
        .get(level.saturating_sub(1))
        .copied()
        .unwrap_or("\\paragraph")
}

// ============================================================================
// Math Functions that delegate to markup mode
// ============================================================================

lazy_static! {
    /// Math functions that should be wrapped in $ when encountered in markup mode
    pub static ref MATH_FUNCS_IN_MARKUP: std::collections::HashSet<&'static str> = {
        let mut s = std::collections::HashSet::new();
        s.insert("frac");
        s.insert("sqrt");
        s.insert("sum");
        s.insert("prod");
        s.insert("int");
        s.insert("lim");
        s.insert("mat");
        s.insert("pmat");
        s.insert("bmat");
        s.insert("cases");
        s.insert("vec");
        s
    };
}

/// Check if a function should be treated as math when in markup mode
pub fn is_math_func_in_markup(name: &str) -> bool {
    MATH_FUNCS_IN_MARKUP.contains(name)
}

// ============================================================================
// Tests
// ============================================================================

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

    #[test]
    fn test_markup_handlers() {
        assert!(TYPST_MARKUP_HANDLERS.contains_key("strong"));
        assert!(TYPST_MARKUP_HANDLERS.contains_key("emph"));

        if let Some(MarkupHandler::Wrap { prefix, suffix }) = TYPST_MARKUP_HANDLERS.get("strong") {
            assert_eq!(*prefix, "\\textbf{");
            assert_eq!(*suffix, "}");
        } else {
            panic!("Expected Wrap handler for strong");
        }
    }

    #[test]
    fn test_math_handlers() {
        assert!(TYPST_MATH_HANDLERS.contains_key("frac"));
        assert!(TYPST_MATH_HANDLERS.contains_key("sqrt"));

        if let Some(MathHandler::Command { latex_cmd }) = TYPST_MATH_HANDLERS.get("frac") {
            assert_eq!(*latex_cmd, "\\frac");
        } else {
            panic!("Expected Command handler for frac");
        }
    }

    #[test]
    fn test_heading_commands() {
        assert_eq!(get_heading_command(1), "\\section");
        assert_eq!(get_heading_command(2), "\\subsection");
        assert_eq!(get_heading_command(3), "\\subsubsection");
        assert_eq!(get_heading_command(6), "\\paragraph"); // fallback
    }

    #[test]
    fn test_math_funcs_in_markup() {
        assert!(is_math_func_in_markup("frac"));
        assert!(is_math_func_in_markup("sqrt"));
        assert!(!is_math_func_in_markup("strong"));
    }
}