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
use std::rc::Rc;
use xmlparser::{StrSpan, Token, Tokenizer};
use self::loader::IncludeLoaderError;
#[cfg(feature = "http-loader-base")]
pub mod http_loader;
pub mod loader;
#[cfg(feature = "local-loader")]
pub mod local_loader;
pub mod memory_loader;
pub mod noop_loader;
#[macro_export]
macro_rules! parse_attribute {
() => {
fn parse_attribute<'a>(
&mut self,
name: xmlparser::StrSpan<'a>,
value: xmlparser::StrSpan<'a>,
) -> Result<(), Error> {
self.attributes.insert(name.to_string(), value.to_string());
Ok(())
}
};
}
#[macro_export]
macro_rules! parse_child {
($child_parser:ident) => {
fn parse_child_element<'a>(
&mut self,
tag: xmlparser::StrSpan<'a>,
tokenizer: &mut xmlparser::Tokenizer<'a>,
) -> Result<(), Error> {
self.children
.push($child_parser::parse(tag, tokenizer, self.opts.clone())?);
Ok(())
}
};
}
#[macro_export]
macro_rules! parse_comment {
() => {
fn parse_child_comment(&mut self, value: xmlparser::StrSpan) -> Result<(), Error> {
self.children
.push($crate::comment::Comment::from(value.as_str()).into());
Ok(())
}
};
}
#[macro_export]
macro_rules! parse_text {
() => {
fn parse_child_text(&mut self, value: xmlparser::StrSpan) -> Result<(), Error> {
self.children
.push($crate::text::Text::from(value.as_str()).into());
Ok(())
}
};
}
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error("unexpected attribute at position {0}")]
UnexpectedAttribute(usize),
#[error("unexpected element at position {0}")]
UnexpectedElement(usize),
#[error("unexpected comment at position {0}")]
UnexpectedComment(usize),
#[error("unexpected text at position {0}")]
UnexpectedText(usize),
#[error("missing attribute {0}")]
MissingAttribute(&'static str),
#[error("invalid element: {0}")]
InvalidElement(String),
#[error("invalid format")]
InvalidFormat,
#[error("size limit reached")]
SizeLimit,
#[error("unable to load included template")]
ParserError(#[from] xmlparser::Error),
#[error("no root node found")]
NoRootNode,
#[error("unable to load included template")]
IncludeLoaderError(#[from] IncludeLoaderError),
}
pub(crate) fn next_token<'a>(tokenizer: &mut Tokenizer<'a>) -> Result<Token<'a>, Error> {
if let Some(token) = tokenizer.next() {
Ok(token?)
} else {
Err(Error::InvalidFormat)
}
}
pub(crate) fn is_element_start<'a>(token: &'a Token<'a>) -> Option<&'a StrSpan<'a>> {
match token {
Token::ElementStart { local, .. } => Some(local),
_ => None,
}
}
pub trait Parser: Sized {
type Output;
fn build(self) -> Result<Self::Output, Error>;
fn should_ignore_children(&self) -> bool {
false
}
fn parse_attribute<'a>(&mut self, name: StrSpan<'a>, _value: StrSpan<'a>) -> Result<(), Error> {
Err(Error::UnexpectedAttribute(name.start()))
}
fn parse_children(&mut self, tokenizer: &mut Tokenizer<'_>) -> Result<(), Error> {
loop {
let token = next_token(tokenizer)?;
match token {
Token::Comment { text, span: _ } => {
self.parse_child_comment(text)?;
}
Token::Text { text } => {
if !text.trim().is_empty() {
self.parse_child_text(text)?;
}
}
Token::ElementStart {
prefix: _,
local,
span: _,
} => {
self.parse_child_element(local, tokenizer)?;
}
Token::ElementEnd { end: _, span: _ } => return Ok(()),
_ => return Err(Error::InvalidFormat),
};
}
}
fn parse_child_element<'a>(
&mut self,
tag: StrSpan<'a>,
_tokenizer: &mut Tokenizer<'a>,
) -> Result<(), Error> {
Err(Error::UnexpectedElement(tag.start()))
}
fn parse_child_comment(&mut self, value: StrSpan) -> Result<(), Error> {
Err(Error::UnexpectedComment(value.start()))
}
fn parse_child_text(&mut self, value: StrSpan) -> Result<(), Error> {
Err(Error::UnexpectedText(value.start()))
}
fn parse(mut self, tokenizer: &mut Tokenizer) -> Result<Self, Error> {
loop {
let token = next_token(tokenizer)?;
match token {
Token::Attribute {
prefix: _,
local,
value,
span: _,
} => {
self.parse_attribute(local, value)?;
}
Token::ElementEnd { end, span: _ } => {
match end {
xmlparser::ElementEnd::Empty => {
return Ok(self);
}
xmlparser::ElementEnd::Open => {
if !self.should_ignore_children() {
self.parse_children(tokenizer)?;
}
return Ok(self);
}
_ => return Err(Error::InvalidFormat),
}
}
_ => {
return Err(Error::InvalidFormat);
}
};
}
}
}
pub trait Parsable: Sized {
fn parse<'a>(
tag: StrSpan<'a>,
tokenizer: &mut Tokenizer<'a>,
opts: Rc<ParserOptions>,
) -> Result<Self, Error>;
}
#[derive(Debug)]
pub struct ParserOptions {
pub include_loader: Box<dyn loader::IncludeLoader>,
}
#[allow(clippy::box_default)]
impl Default for ParserOptions {
fn default() -> Self {
Self {
include_loader: Box::new(noop_loader::NoopIncludeLoader::default()),
}
}
}