exile 0.0.9

DOM-Style XML Parser
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

/*!
The `bang` module parses those constructs that start with `<!`.
!*/

// use crate::xdoc::xdocv2::doctype::DocTypeDecl;
use crate::Node;

use super::element::LtParse;
use super::error::Result;
use super::Iter;

/// Parses an XML node that starts with `<!`. Expected the iterator to be pointing at `<` when
/// called, and expects the next character to be `!`. Returns the iterator pointing at the next
/// character after the closing `>`.
pub(super) fn parse_bang(iter: &mut Iter<'_>) -> Result<LtParse> {
    debug_assert_eq!('<', iter.st.c);
    iter.advance_or_die()?;
    debug_assert_eq!('!', iter.st.c);
    let next = iter.peek_or_die()?;
    match next {
        '-' => {
            // skip comment expects the iter to be advanced passed lt
            let comment = parse_comment(iter)?;
            Ok(LtParse::Some(Node::Comment(comment)))
        }
        '[' => {
            let cdata = parse_cdata(iter)?;
            Ok(LtParse::Some(Node::CData(cdata)))
        }
        'D' => {
            let s = parse_doctype(iter)?;
            Ok(LtParse::DocType(s))
        }
        _ => return parse_err!(iter, "illegal char '{}' after <!", iter.st.c),
    }
}

/// Parses a comment. Takes the iterator pointing at `!` and returns the iterator pointing at the
/// first character after the closing '>'. Returns an error  if it is not a well-formed comment.
pub(super) fn parse_comment(iter: &mut Iter<'_>) -> Result<String> {
    expect!(iter, '!')?;
    iter.advance_or_die()?;
    expect!(iter, '-')?;
    iter.advance_or_die()?;
    expect!(iter, '-')?;
    iter.advance_or_die()?;
    let mut comment = String::new();
    loop {
        if iter.is('-') && iter.peek_is('-') {
            // advance to the second dash
            iter.advance_or_die()?;
            // advance to the char after the second dash
            iter.advance_or_die()?;
            if iter.is('>') {
                break;
            } else {
                return parse_err!(iter, "-- is not allowed in a comment string");
            }
        } else {
            comment.push(iter.st.c);
        }
        iter.advance_or_die()?;
    }
    // advance the iter to the char following -->
    iter.advance();
    Ok(comment)
}

// TODO - support doctypes https://github.com/webern/exile/issues/22
/// Advances the iterator past a `<!DOCTYPE` section. Expects the iterator to be pointing at `!` and
/// returns the iterator pointing at the first character after the closing `>`. Does not inspect
/// the contents to ensure they are well-formed.
fn parse_doctype(iter: &mut Iter<'_>) -> Result<String> {
    expect!(iter, '!')?;
    let mut s = String::from("<");
    while !iter.is('>') {
        if iter.is('[') {
            parse_nested_doctype_stuff(iter, &mut s)?
        }
        s.push(iter.st.c);
        iter.advance_or_die()?;
    }
    s.push(iter.st.c);
    // advance the iter to the char following ]>
    iter.advance();
    Ok(s)
    // let _ = DocTypeDecl::parse(iter)?;
    // Ok(())
}

// TODO - support doctypes https://github.com/webern/exile/issues/22
/// Helps `skip_doctype` to find the end of a doctype section.
fn parse_nested_doctype_stuff(iter: &mut Iter<'_>, s: &mut String) -> Result<()> {
    expect!(iter, '[')?;
    s.push(iter.st.c);
    iter.advance_or_die()?;
    while !iter.is(']') {
        s.push(iter.st.c);
        iter.advance_or_die()?;
    }
    Ok(())
}

/// `<![CDATA[foo]]>`
fn parse_cdata(iter: &mut Iter<'_>) -> Result<String> {
    // we assume the first char has been checked and is !
    iter.advance_or_die()?;
    // we assume the second char has been checked and is [
    iter.advance_or_die()?;
    expect!(iter, 'C')?;
    iter.advance_or_die()?;
    expect!(iter, 'D')?;
    iter.advance_or_die()?;
    expect!(iter, 'A')?;
    iter.advance_or_die()?;
    expect!(iter, 'T')?;
    iter.advance_or_die()?;
    expect!(iter, 'A')?;
    iter.advance_or_die()?;
    expect!(iter, '[')?;
    iter.advance_or_die()?;
    let mut data = String::new();
    let mut backet_buffer = String::new();
    loop {
        let c = iter.st.c;
        if c == ']' {
            backet_buffer.push(']');
            iter.advance_or_die()?;
            continue;
        } else if c == '>' && backet_buffer.len() >= 2 {
            if backet_buffer.len() > 2 {
                data.push_str(&backet_buffer[2..])
            }
            break;
        } else if !backet_buffer.is_empty() {
            data.push_str(&backet_buffer);
            backet_buffer.clear();
        }
        data.push(c);
        iter.advance_or_die()?
    }
    iter.advance();
    Ok(data)
}

////////////////////////////////////////////////////////////////////////////////////////////////////

#[test]
fn parse_bang_cdata_1() {
    let data = "foo";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>bar", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_2() {
    let data = "foo]] >bar]>]>x";
    let iter_char_after = 'x';
    let input = format!("<![CDATA[{}]]>x", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_3() {
    let data = "foo]]>bar]>]>x";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>x", data);
    let expected = LtParse::Some(Node::CData("foo".into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_4() {
    let data = "<xml>bloop</xml>";
    let iter_char_after = '<';
    let input = format!("<![CDATA[{}]]><foo></foo>", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_5() {
    let data = "<![CDATA[";
    let iter_char_after = '<';
    let input = format!("<![CDATA[{}]]><foo></foo>", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_6() {
    let data = "<&]>]";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>bar", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_7() {
    let data = "]";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>bar", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_8() {
    let data = "]]";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>bar", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_cdata_9() {
    let data = "]]]";
    let iter_char_after = 'b';
    let input = format!("<![CDATA[{}]]>bar", data);
    let expected = LtParse::Some(Node::CData(data.into()));
    let mut iter = Iter::new(&input).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

// TODO - write real tests for doctypes https://github.com/webern/exile/issues/22
#[test]
fn parse_bang_doctype() {
    let data = r#"<!DOCTYPE doc [
<!ELEMENT doc (#PCDATA)>
<!ATTLIST doc a1 CDATA #IMPLIED>
]>x"#;
    let iter_char_after = 'x';
    let expected = LtParse::DocType(data[..data.len() - 1].to_owned());
    let mut iter = Iter::new(data).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_comment_1() {
    let data = r#"<!-- foo -->x"#;
    let iter_char_after = 'x';
    let expected = LtParse::Some(Node::Comment(" foo ".into()));
    let mut iter = Iter::new(data).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_comment_2() {
    let data = r#"<!-- foo-->x"#;
    let iter_char_after = 'x';
    let expected = LtParse::Some(Node::Comment(" foo".into()));
    let mut iter = Iter::new(data).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_comment_3() {
    let data = r#"<!--foo-->x"#;
    let iter_char_after = 'x';
    let expected = LtParse::Some(Node::Comment("foo".into()));
    let mut iter = Iter::new(data).unwrap();
    let actual = parse_bang(&mut iter).unwrap();
    assert_eq!(expected, actual);
    assert_eq!(iter_char_after, iter.st.c);
}

#[test]
fn parse_bang_comment_bad_1() {
    let data = r#"<!-- -- -->x"#;
    let mut iter = Iter::new(data).unwrap();
    let result = parse_bang(&mut iter);
    assert!(result.is_err());
}