oak-tex 0.0.11

TeX/LaTeX document preparation system parser with support for typesetting commands and macros.
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

#![doc = include_str!("readme.md")]
use core::range::Range;

/// Root node of the TeX AST.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexRoot {
    /// The span of the root node.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The items contained in the root node.
    pub items: Vec<TexItem>,
}

/// A top-level item in a TeX document.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TexItem {
    /// A TeX command.
    Command(TexCommand),
    /// A TeX environment.
    Environment(TexEnvironment),
    /// A TeX group.
    Group(TexGroup),
    /// A TeX math environment.
    Math(TexMath),
    /// A superscript.
    Superscript(TexSuperscript),
    /// A subscript.
    Subscript(TexSubscript),
    /// Plain text.
    Text {
        /// The span of the text.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
        /// The content of the text.
        content: String,
    },
    /// A comment.
    Comment {
        /// The span of the comment.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
        /// The content of the comment.
        content: String,
    },
}

/// A TeX environment (e.g., \begin{matrix} ... \end{matrix}).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexEnvironment {
    /// The span of the environment.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The name of the environment.
    pub name: String,
    /// The arguments to the environment.
    pub arguments: Vec<TexArgument>,
    /// The content of the environment.
    pub content: TexRoot,
}

/// A TeX superscript (^).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexSuperscript {
    /// The span of the superscript.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The target of the superscript.
    pub target: Option<Box<TexItem>>,
    /// The content of the superscript.
    pub content: Box<TexRoot>,
}

/// A TeX subscript (_).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexSubscript {
    /// The span of the subscript.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The target of the subscript.
    pub target: Option<Box<TexItem>>,
    /// The content of the subscript.
    pub content: Box<TexRoot>,
}

/// A TeX math environment ($...$ or $$...$$).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexMath {
    /// The span of the math environment.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The content of the math environment.
    pub content: TexRoot,
    /// Whether this is a display math environment.
    pub is_display: bool,
}

/// A TeX command (e.g., \section, \textbf).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexCommand {
    /// The span of the command.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The name of the command.
    pub name: String,
    /// The arguments to the command.
    pub arguments: Vec<TexArgument>,
}

/// A TeX argument.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TexArgument {
    /// An optional argument ([...]).
    Optional(TexRoot),
    /// A mandatory argument ({...}).
    Required(TexRoot),
}

/// A TeX group (e.g., { ... }).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TexGroup {
    /// The span of the group.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The content of the group.
    pub content: TexRoot,
}

impl TexRoot {
    /// Creates a new TeX root node.
    pub fn new(span: Range<usize>) -> Self {
        Self { span, items: Vec::new() }
    }
}