texform 0.1.0

LaTeX formula parser, editor, and normalizer — the public TeXForm facade
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

use texform::{
    Error, FlattenGroupsConfig, NormalizeConfig, ParseConfig, Profile, TransformConfig,
    TransformEngine,
};
use texform_transform::FinalizeAstConfig;

fn engine() -> TransformEngine {
    TransformEngine::builder()
        .packages(&["base"])
        .profile(Profile::Equiv)
        .build()
        .expect("engine should build")
}

#[test]
fn transform_rejects_documents_with_parse_errors() {
    let engine = engine();
    let mut document = engine
        .parser()
        .parse_with("{", &ParseConfig::LENIENT)
        .into_parts()
        .0
        .expect("lenient parse should keep a partial document");

    let error = engine
        .transform(&mut document)
        .expect_err("error documents must not be transformed");
    assert!(matches!(error, Error::IncompleteTree));
}

#[test]
fn transform_updates_document_in_place() {
    let engine = engine();
    let mut document = engine
        .parser()
        .parse("{{x}}")
        .try_into_document()
        .expect("parse should succeed")
        .0;
    let root_id = document.root().id();

    let report = engine
        .transform_with(
            &mut document,
            &TransformConfig {
                rewrite_enabled: false,
                lower_attributes_enabled: false,
                finalize_ast: FinalizeAstConfig::ENABLED,
                flatten_groups: FlattenGroupsConfig::STRUCTURAL_ONLY,
                max_iterations: 100,
            },
        )
        .expect("transform should succeed");

    assert_eq!(document.to_latex().expect("document should serialize"), "x");
    assert_eq!(report.flatten_groups.actions.replaced_single_child, 2);

    let y = document.create_char('y').expect("char should be created");
    document
        .append_child(root_id, y)
        .expect("pre-transform root id should still belong to the document");
    assert_eq!(
        document.to_latex().expect("document should serialize"),
        "x y"
    );
}

#[test]
fn normalize_uses_finalize_ast_by_default() {
    let engine = engine();

    let result = engine
        .normalize(r"f^{\prime\prime}")
        .expect("normalize should succeed");

    assert_eq!(result.normalized, "f''");
    assert_eq!(
        result
            .report
            .finalize_ast
            .steps
            .merge_adjacent_primes
            .applied_count,
        1
    );
}

#[test]
fn normalize_can_disable_finalize_ast_explicitly() {
    let engine = engine();

    let result = engine
        .normalize_with(
            r"f^{\prime\prime}",
            &NormalizeConfig {
                parse: ParseConfig::STRICT,
                transform: TransformConfig {
                    rewrite_enabled: true,
                    lower_attributes_enabled: true,
                    finalize_ast: FinalizeAstConfig::DISABLED,
                    flatten_groups: FlattenGroupsConfig::STRUCTURAL_ONLY,
                    max_iterations: 100,
                },
            },
        )
        .expect("normalize should succeed");

    assert_eq!(result.normalized, r"f ^ { '' }");
    assert_eq!(
        result
            .report
            .finalize_ast
            .steps
            .merge_adjacent_primes
            .applied_count,
        0
    );
}