xml5ever 0.3.0

Push based streaming parser for xml
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

// Copyright 2015 The xml5ever Project Developers. See the
// COPYRIGHT file at the top-level directory of this distribution.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use std::borrow::Cow::Borrowed;
use tendril::StrTendril;
use tokenizer::{Tag, StartTag, EndTag, ShortTag, EmptyTag};
use tree_builder::types::*;
use tree_builder::interface::TreeSink;
use tree_builder::actions::XmlTreeBuilderActions;

fn any_not_whitespace(x: &StrTendril) -> bool {
    !x.bytes().all(|b| matches!(b, b'\t' | b'\r' | b'\n' | b'\x0C' | b' '))
}

/// Encapsulates rules needed to build a tree representation.
pub trait XmlTreeBuilderStep {

    /// Each step presents resolving received Token, in a
    /// given XmlPhase.
    fn step(&mut self, mode: XmlPhase, token: Token) -> XmlProcessResult;
}

#[doc(hidden)]
impl<Handle, Sink> XmlTreeBuilderStep
    for super::XmlTreeBuilder<Handle, Sink>
    where Handle: Clone,
          Sink: TreeSink<Handle=Handle>,
{

    fn step(&mut self, mode: XmlPhase, token: Token) -> XmlProcessResult {
        self.debug_step(mode, &token);

        match mode {
            StartPhase => match token {
                TagToken(Tag{kind: StartTag, name, attrs}) => {
                    let tag = {
                        let mut tag = Tag {
                            kind: StartTag,
                            name: name,
                            attrs: attrs,
                        };
                        self.process_namespaces(&mut tag);
                        tag
                    };
                    self.phase = MainPhase;
                    let handle = self.append_tag_to_doc(tag);
                    self.add_to_open_elems(handle)

                },
                TagToken(Tag{kind: EmptyTag, name, attrs}) => {
                    let tag = {
                        let mut tag = Tag {
                            kind: EmptyTag,
                            name: name,
                            attrs: attrs,
                        };
                        self.process_namespaces(&mut tag);
                        tag
                    };
                    self.phase = EndPhase;
                    self.append_tag_to_doc(tag);
                    Done
                },
                CommentToken(comment) => {
                    self.append_comment_to_doc(comment)
                },
                PIToken(pi) => {
                    self.append_pi_to_doc(pi)
                },
                CharacterTokens(ref chars)
                    if !any_not_whitespace(chars) => {
                        Done
                },
                EOFToken => {
                    self.sink.parse_error(Borrowed("Unexpected EOF in start phase"));
                    Reprocess(EndPhase, EOFToken)
                },
                DoctypeToken(d) => {
                    self.append_doctype_to_doc(d);
                    Done
                },
                _ => {
                    self.sink.parse_error(Borrowed("Unexpected element in start phase"));
                    Done
                },
            },
            MainPhase => match token {
                CharacterTokens(chs) => {
                    self.append_text(chs)
                },
                TagToken(Tag{kind: StartTag, name, attrs}) => {
                    let tag = {
                        let mut tag = Tag {
                            kind: StartTag,
                            name: name,
                            attrs: attrs,
                        };
                        self.process_namespaces(&mut tag);
                        tag
                    };
                    self.insert_tag(tag)
                },
                TagToken(Tag{kind: EmptyTag, name, attrs}) => {
                    let tag = {
                        let mut tag = Tag {
                            kind: EmptyTag,
                            name: name,
                            attrs: attrs,
                        };
                        self.process_namespaces(&mut tag);
                        tag
                    };
                    if tag.name.local == local_name!("script") {
                        self.insert_tag(tag.clone());
                        self.complete_script();
                        self.close_tag(tag)
                    } else {
                        self.append_tag(tag)
                    }
                },
                TagToken(Tag{kind: EndTag, name, attrs}) => {
                    let tag = {
                        let mut tag = Tag {
                            kind: EndTag,
                            name: name,
                            attrs: attrs,
                        };
                        self.process_namespaces(&mut tag);
                        tag
                    };
                    if tag.name.local == local_name!("script") {
                        self.complete_script();
                    }
                    let retval = self.close_tag(tag);
                    if self.no_open_elems() {
                        self.phase = EndPhase;
                    }
                    retval
                },
                TagToken(Tag{kind: ShortTag, ..}) => {
                    self.pop();
                    if self.no_open_elems() {
                        self.phase = EndPhase;
                    }
                    Done
                },
                CommentToken(comment) => {
                    self.append_comment_to_tag(comment)
                },
                PIToken(pi) => {
                    self.append_pi_to_tag(pi)
                },
                EOFToken | NullCharacterToken=> {
                    Reprocess(EndPhase, EOFToken)
                }
                DoctypeToken(_) => {
                    self.sink.parse_error(Borrowed("Unexpected element in main phase"));
                    Done
                }
            },
            EndPhase => match token {
                CommentToken(comment) => {
                    self.append_comment_to_doc(comment)
                },
                PIToken(pi) => {
                    self.append_pi_to_doc(pi)
                },
                CharacterTokens(ref chars)
                    if !any_not_whitespace(chars) => {
                        Done
                },
                EOFToken => {
                    self.stop_parsing()
                }
                _ => {
                    self.sink.parse_error(Borrowed("Unexpected element in end phase"));
                    Done
                }
            },

        }
    }
}