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
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

use texform_core::parse::{self, ContextItem, ParseConfig};

use crate::parse_result::ParseResult;

#[derive(Clone, Debug)]
pub struct Parser {
    inner: parse::ParseContext,
    default_config: ParseConfig,
}

pub struct ParserBuilder {
    inner: parse::ParseContextBuilder,
    default_config: ParseConfig,
}

#[derive(Debug)]
pub struct ParserBuildError(parse::ParseContextBuildError);

impl std::fmt::Display for ParserBuildError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match &self.0 {
            parse::ParseContextBuildError::PackageLoad(error) => error.fmt(f),
            parse::ParseContextBuildError::InvalidContextItem { name, source } => {
                write!(f, "invalid context item {name}: {source}")
            }
        }
    }
}

impl std::error::Error for ParserBuildError {}

impl Parser {
    pub fn builder() -> ParserBuilder {
        ParserBuilder {
            inner: parse::ParseContext::builder(),
            default_config: ParseConfig::default(),
        }
    }

    /// Parse a LaTeX formula with this parser's default configuration.
    ///
    /// The standalone [`Parser`] default is [`ParseConfig::LENIENT`]. Use
    /// [`parse_with`](Self::parse_with) to override per call.
    pub fn parse(&self, src: &str) -> ParseResult {
        ParseResult::from_core(self.inner.parse(src, &self.default_config))
    }

    pub fn parse_with(&self, src: &str, config: &ParseConfig) -> ParseResult {
        ParseResult::from_core(self.inner.parse(src, config))
    }

    pub fn lookup_command(
        &self,
        name: &str,
        mode: parse::ContentMode,
    ) -> Option<&parse::ActiveCommandRecord> {
        self.inner.lookup_command(name, mode)
    }

    pub fn lookup_explicit_command(
        &self,
        name: &str,
        mode: parse::ContentMode,
    ) -> Option<&parse::ActiveCommandRecord> {
        self.inner.lookup_explicit_command(name, mode)
    }

    pub fn lookup_character(
        &self,
        name: &str,
        mode: parse::ContentMode,
    ) -> Option<&parse::ActiveCharacterRecord> {
        self.inner.lookup_character(name, mode)
    }

    pub fn lookup_env(
        &self,
        name: &str,
        mode: parse::ContentMode,
    ) -> Option<&parse::ActiveEnvironmentRecord> {
        self.inner.lookup_env(name, mode)
    }

    pub fn is_delimiter_control(&self, name: &str) -> bool {
        self.inner.is_delimiter_control(name)
    }

    pub fn knows_command_name(&self, name: &str) -> bool {
        self.inner.knows_command_name(name)
    }

    pub fn knows_env_name(&self, name: &str) -> bool {
        self.inner.knows_env_name(name)
    }

    pub fn knows_character_name(&self, name: &str) -> bool {
        self.inner.knows_character_name(name)
    }

    pub(crate) fn inner(&self) -> &parse::ParseContext {
        &self.inner
    }

    pub fn default_parse_config(&self) -> &ParseConfig {
        &self.default_config
    }
}

impl ParserBuilder {
    pub fn packages(mut self, packages: &[&str]) -> Self {
        self.inner = self.inner.packages(packages);
        self
    }

    pub fn empty_knowledge(mut self) -> Self {
        self.inner = parse::ParseContextBuilder::empty();
        self
    }

    pub fn default_parse_config(mut self, config: ParseConfig) -> Self {
        self.default_config = config;
        self
    }

    pub fn item(mut self, item: impl Into<ContextItem>) -> Self {
        self.inner = self.inner.insert_item(item);
        self
    }

    pub fn insert_item(self, item: impl Into<ContextItem>) -> Self {
        self.item(item)
    }

    pub fn remove_command(mut self, name: impl Into<String>) -> Self {
        self.inner = self.inner.remove_command(name);
        self
    }

    pub fn remove_environment(mut self, name: impl Into<String>) -> Self {
        self.inner = self.inner.remove_environment(name);
        self
    }

    pub fn remove_delimiter_control(mut self, name: impl Into<String>) -> Self {
        self.inner = self.inner.remove_delimiter_control(name);
        self
    }

    pub fn build(self) -> Result<Parser, ParserBuildError> {
        Ok(Parser {
            inner: self.inner.build().map_err(ParserBuildError)?,
            default_config: self.default_config,
        })
    }
}