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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425

use crate::parser::error::Result;
use crate::parser::Iter;
use crate::xdoc::is_whitespace;

#[derive(Clone, Copy, Eq, PartialEq, Debug)]
pub(crate) enum StringType {
    /// A string inside of an element, e.g. <element>string</element>.
    Element,
    /// An attribute value string surrounded by double quotes, e.g. `"value"`.
    AttributeDouble,
    /// An attribute value string surrounded by single quotes, e.g. `'value'`.
    AttributeSingle,
}

/// Parse a string that terminates based on some character(s) determined by `string_type`.
pub(crate) fn parse_string(iter: &mut Iter<'_>, string_type: StringType) -> Result<String> {
    let mut space_buffer = None;
    let mut is_non_white_reached = false;
    let mut result = String::new();
    while !is_end_char(iter, string_type) {
        if iter.st.c == '&' {
            let c = parse_escape(iter)?;
            if is_whitespace(c) {
                if is_non_white_reached {
                    space_buffer = Some(' ');
                }
            } else {
                is_non_white_reached = true;
                if let Some(space) = space_buffer {
                    result.push(space);
                    space_buffer = None;
                }
                result.push(c);
            }
        } else if is_forbidden(iter, string_type) {
            return parse_err!(iter, "forbidden character in {:?} string", string_type);
        } else if iter.is_whitespace() {
            if is_non_white_reached {
                space_buffer = Some(' ');
            }
        } else {
            is_non_white_reached = true;
            if let Some(space) = space_buffer {
                result.push(space);
                space_buffer = None;
            }
            result.push(iter.st.c);
        }

        if !iter.advance() {
            return parse_err!(
                iter,
                "input ended before termination character '{}' was reached",
                end_char(string_type)
            );
        }
    }
    Ok(result)
}

fn is_forbidden(iter: &Iter<'_>, string_type: StringType) -> bool {
    // & and < are illegal (as well as " or ' in attributes).
    match iter.st.c {
        '&' | '<' => true,
        '"' => string_type == StringType::AttributeDouble,
        '\'' => string_type == StringType::AttributeSingle,
        _ => false,
    }
}

fn end_char(string_type: StringType) -> char {
    match string_type {
        StringType::Element => '<',
        StringType::AttributeDouble => '"',
        StringType::AttributeSingle => '\'',
    }
}

fn is_end_char(iter: &Iter<'_>, string_type: StringType) -> bool {
    iter.is(end_char(string_type))
}

fn parse_escape(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    match iter.st.c {
        'a' => parse_amp_or_apos(iter),
        'g' => parse_gt(iter),
        'l' => parse_lt(iter),
        'q' => parse_quot(iter),
        '#' => parse_codepoint(iter),
        _ => parse_err!(iter, "unexpected character in escape sequence"),
    }
}

fn parse_amp_or_apos(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    if iter.is('m') {
        parse_amp(iter)
    } else if iter.is('p') {
        parse_apos(iter)
    } else {
        parse_err!(iter, "expected either &amp; or &apos;")
    }
}

fn parse_amp(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 'p')?;
    iter.advance_or_die()?;
    expect!(iter, ';')?;
    Ok('&')
}

fn parse_apos(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 'o')?;
    iter.advance_or_die()?;
    expect!(iter, 's')?;
    iter.advance_or_die()?;
    expect!(iter, ';')?;
    Ok('\'')
}

fn parse_gt(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 't')?;
    iter.advance_or_die()?;
    expect!(iter, ';')?;
    Ok('>')
}

fn parse_lt(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 't')?;
    iter.advance_or_die()?;
    expect!(iter, ';')?;
    Ok('<')
}

fn parse_quot(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 'u')?;
    iter.advance_or_die()?;
    expect!(iter, 'o')?;
    iter.advance_or_die()?;
    expect!(iter, 't')?;
    iter.advance_or_die()?;
    expect!(iter, ';')?;
    Ok('"')
}

fn parse_codepoint(iter: &mut Iter<'_>) -> Result<char> {
    if iter.peek_is('x') {
        parse_hexidecimal_codepoint(iter)
    } else {
        parse_decimal_codepoint(iter)
    }
}

fn parse_hexidecimal_codepoint(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    expect!(iter, 'x')?;
    iter.advance_or_die()?;
    let mut data = String::new();
    while !iter.is(';') {
        if !iter.is_hex() {
            return parse_err!(iter, "non-hex-digit in hexidecimal unicode escape");
        }
        data.push(iter.st.c);
        iter.advance_or_die()?;
    }
    let codepoint = u32::from_str_radix(data.as_str(), 16)
        .map_err(|e| create_parser_error!(&iter.st, "{}", e))?;
    let maybe_char = std::char::from_u32(codepoint);
    match maybe_char {
        Some(c) => Ok(c),
        None => parse_err!(iter, "illegal unicode codepoint '{}'", codepoint),
    }
}

fn parse_decimal_codepoint(iter: &mut Iter<'_>) -> Result<char> {
    iter.advance_or_die()?;
    let mut data = String::new();
    while !iter.is(';') {
        if !iter.is_digit() {
            return parse_err!(iter, "non-digit in decimal unicode escape");
        }
        data.push(iter.st.c);
        iter.advance_or_die()?;
    }
    let codepoint = data
        .parse::<u32>()
        .map_err(|e| create_parser_error!(&iter.st, "{}", e))?;
    let maybe_char = std::char::from_u32(codepoint);
    match maybe_char {
        Some(c) => Ok(c),
        None => parse_err!(iter, "illegal unicode codepoint '{}'", codepoint),
    }
}

////////////////////////////////////////////////////////////////////////////////////////////////////
// tests
////////////////////////////////////////////////////////////////////////////////////////////////////

#[test]
fn test_parse_amp_ok() {
    use crate::parser::Iter;
    let mut iter = Iter::new("mp;").unwrap();
    let c = parse_amp(&mut iter).unwrap();
    assert_eq!('&', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_amp_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("mp").unwrap();
    let result = parse_amp(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_apos_ok() {
    use crate::parser::Iter;
    let mut iter = Iter::new("pos;").unwrap();
    let c = parse_apos(&mut iter).unwrap();
    assert_eq!('\'', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_apos_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("pox;").unwrap();
    let result = parse_apos(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_gt_ok() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_t;;").unwrap();
    let c = parse_gt(&mut iter).unwrap();
    assert_eq!('>', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_gt_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("gt:").unwrap();
    let result = parse_gt(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_lt_ok() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_t;").unwrap();
    let c = parse_lt(&mut iter).unwrap();
    assert_eq!('<', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_lt_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_t:").unwrap();
    let result = parse_lt(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_quot_ok() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_uot;").unwrap();
    let c = parse_quot(&mut iter).unwrap();
    assert_eq!('"', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_quot_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_uot:").unwrap();
    let result = parse_quot(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_decimal_codepoint_beer_ok() {
    // &#127866; -> šŸŗ
    use crate::parser::Iter;
    let mut iter = Iter::new("_127866;").unwrap();
    let c = parse_decimal_codepoint(&mut iter).unwrap();
    assert_eq!('šŸŗ', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_decimal_codepoint_beer_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_101 52;").unwrap();
    let result = parse_decimal_codepoint(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_hexidecimal_codepoint_beer_ok() {
    // &#x1F37A; -> šŸŗ
    use crate::parser::Iter;
    let mut iter = Iter::new("_x1F37A;").unwrap();
    let c = parse_hexidecimal_codepoint(&mut iter).unwrap();
    assert_eq!('šŸŗ', c);
    assert_eq!(';', iter.st.c);
}

#[test]
fn test_parse_hexidecimal_codepoint_beer_err() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_x1F37Z;").unwrap();
    let result = parse_hexidecimal_codepoint(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_codepoint_hex_ok() {
    // &#128153; &#x1f499; šŸ’™
    use crate::parser::Iter;
    let mut iter = Iter::new("_x1f499;").unwrap();
    let c = parse_codepoint(&mut iter).unwrap();
    assert_eq!('šŸ’™', c);
}

#[test]
fn test_parse_codepoint_decimal_ok() {
    // &#128153; &#x1f499; šŸ’™
    use crate::parser::Iter;
    let mut iter = Iter::new("_128153;").unwrap();
    let c = parse_codepoint(&mut iter).unwrap();
    assert_eq!('šŸ’™', c);
}

#[test]
fn test_parse_codepoint_bad_decimal() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_4294967295;").unwrap();
    let result = parse_codepoint(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_codepoint_bad_hexidecimal() {
    use crate::parser::Iter;
    let mut iter = Iter::new("_xFFFFFFFF;").unwrap();
    let result = parse_codepoint(&mut iter);
    assert!(result.is_err());
}

#[test]
fn test_parse_string_ok() {
    let input = "a&amp;b&apos;c&gt;d&lt;e&quot;f&#x1f499;g&#127866;h\"blahblah";
    let expected = "a&b'c>d<e\"fšŸ’™gšŸŗh";
    use crate::parser::Iter;
    let mut iter = Iter::new(input).unwrap();
    let actual = parse_string(&mut iter, StringType::AttributeDouble).unwrap();
    assert_eq!(expected, actual);
}

#[test]
fn test_parse_string_end_err() {
    let input = "a&amp;b&apos;c&gt;d&lt;e&quot;f&#x1f499;g&#127866;h";
    use crate::parser::Iter;
    let mut iter = Iter::new(input).unwrap();
    let result = parse_string(&mut iter, StringType::AttributeDouble);
    assert!(result.is_err());
}

#[test]
fn test_parse_string_bad_escape_err() {
    let input = "a&zoo;\"";
    use crate::parser::Iter;
    let mut iter = Iter::new(input).unwrap();
    let result = parse_string(&mut iter, StringType::AttributeDouble);
    assert!(result.is_err());
}

#[test]
fn test_parse_string_bad_amp_or_apos_err() {
    let input = "a&anp;\"";
    use crate::parser::Iter;
    let mut iter = Iter::new(input).unwrap();
    let result = parse_string(&mut iter, StringType::AttributeDouble);
    assert!(result.is_err());
}

#[test]
fn test_parse_string_quotes_inside_1() {
    let want = r#"attr val with something 'quoted' inside"#;
    let terminated = format!("{}\"", want);
    use crate::parser::Iter;
    let mut iter = Iter::new(terminated.as_str()).unwrap();
    let got = parse_string(&mut iter, StringType::AttributeDouble).unwrap();
    assert_eq!(got, want);
}

#[test]
fn test_parse_string_quotes_inside_2() {
    let want = r#"attr val with something "quoted" inside"#;
    let terminated = format!("{}'", want);
    use crate::parser::Iter;
    let mut iter = Iter::new(terminated.as_str()).unwrap();
    let got = parse_string(&mut iter, StringType::AttributeSingle).unwrap();
    assert_eq!(got, want);
}

#[test]
fn test_space_before_escape() {
    let input = "x:\n      &lt; y ><";
    let want = "x: < y >";
    use crate::parser::Iter;
    let mut iter = Iter::new(input).unwrap();
    let got = parse_string(&mut iter, StringType::Element).unwrap();
    assert_eq!(got, want);
}