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
// Copyright 2014-2017 The html5ever 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. /// Something which can be inserted into the DOM. /// /// Adjacent sibling text nodes are merged into a single node, so /// the sink may not want to allocate a `Handle` for each. use std::ascii::AsciiExt; use std::borrow::Cow; use tendril::StrTendril; use interface::{QualName, ExpandedName, Attribute}; pub use self::NodeOrText::{AppendNode, AppendText}; pub use self::QuirksMode::{Quirks, LimitedQuirks, NoQuirks}; /// Something which can be inserted into the DOM. /// /// Adjacent sibling text nodes are merged into a single node, so /// the sink may not want to allocate a `Handle` for each. pub enum NodeOrText<Handle> { AppendNode(Handle), AppendText(StrTendril), } /// A document's quirks mode. #[derive(PartialEq, Eq, Copy, Clone, Hash, Debug)] #[cfg_attr(feature = "heap_size", derive(HeapSizeOf))] pub enum QuirksMode { Quirks, LimitedQuirks, NoQuirks, } /// Whether to interrupt further parsing of the current input until /// the next explicit resumption of the tokenizer, or continue without /// any interruption. #[derive(PartialEq, Eq, Copy, Clone, Hash, Debug)] pub enum NextParserState { /// Stop further parsing. Suspend, /// Continue without interruptions. Continue, } #[derive(Default)] pub struct ElementFlags { /// A document fragment should be created, associated with the element, /// and returned in TreeSink::get_template_contents /// /// https://html.spec.whatwg.org/multipage/#template-contents pub template: bool, /// This boolean should be recorded with the element and returned /// in TreeSink::is_mathml_annotation_xml_integration_point /// /// https://html.spec.whatwg.org/multipage/#html-integration-point pub mathml_annotation_xml_integration_point: bool, _private: () } pub fn create_element<Sink>(sink: &mut Sink, name: QualName, attrs: Vec<Attribute>) -> Sink::Handle where Sink: TreeSink { let mut flags = ElementFlags::default(); match name.expanded() { expanded_name!(html "template") => { flags.template = true } expanded_name!(mathml "annotation-xml") => { flags.mathml_annotation_xml_integration_point = attrs.iter().any(|attr| { attr.name.expanded() == expanded_name!("", "encoding") && ( attr.value.eq_ignore_ascii_case("text/html") || attr.value.eq_ignore_ascii_case("application/xhtml+xml") ) }) } _ => {} } sink.create_element(name, attrs, flags) } pub trait TreeSink { /// `Handle` is a reference to a DOM node. The tree builder requires /// that a `Handle` implements `Clone` to get another reference to /// the same node. type Handle: Clone; /// The overall result of parsing. /// /// This should default to Self, but default associated types are not stable yet. /// (https://github.com/rust-lang/rust/issues/29661) type Output; /// Consume this sink and return the overall result of parsing. /// /// TODO:This should default to `fn finish(self) -> Self::Output { self }`, /// but default associated types are not stable yet. /// (https://github.com/rust-lang/rust/issues/29661) fn finish(self) -> Self::Output; /// Signal a parse error. fn parse_error(&mut self, msg: Cow<'static, str>); /// Get a handle to the `Document` node. fn get_document(&mut self) -> Self::Handle; /// What is the name of this element? /// /// Should never be called on a non-element node; /// feel free to `panic!`. fn elem_name<'a>(&'a self, target: &'a Self::Handle) -> ExpandedName<'a>; /// Create an element. /// /// When creating a template element (`name.ns.expanded() == expanded_name!(html "template")`), /// an associated document fragment called the "template contents" should /// also be created. Later calls to self.get_template_contents() with that /// given element return it. /// https://html.spec.whatwg.org/multipage/#htmltemplateelement fn create_element(&mut self, name: QualName, attrs: Vec<Attribute>, flags: ElementFlags) -> Self::Handle; /// Create a comment node. fn create_comment(&mut self, text: StrTendril) -> Self::Handle; /// Create a Processing Instruction node. fn create_pi(&mut self, target: StrTendril, data: StrTendril) -> Self::Handle; /// Append a node as the last child of the given node. If this would /// produce adjacent sibling text nodes, it should concatenate the text /// instead. /// /// The child node will not already have a parent. fn append(&mut self, parent: &Self::Handle, child: NodeOrText<Self::Handle>); /// Append a `DOCTYPE` element to the `Document` node. fn append_doctype_to_document(&mut self, name: StrTendril, public_id: StrTendril, system_id: StrTendril); /// Mark a HTML `<script>` as "already started". fn mark_script_already_started(&mut self, _node: &Self::Handle) {} /// Indicate that a node was popped off the stack of open elements. fn pop(&mut self, _node: &Self::Handle) {} /// Get a handle to a template's template contents. The tree builder /// promises this will never be called with something else than /// a template element. fn get_template_contents(&mut self, target: &Self::Handle) -> Self::Handle; /// Do two handles refer to the same node? fn same_node(&self, x: &Self::Handle, y: &Self::Handle) -> bool; /// Are two handles present in the same tree fn same_tree(&self, _x: &Self::Handle, _y: &Self::Handle) -> bool { true } /// Set the document's quirks mode. fn set_quirks_mode(&mut self, mode: QuirksMode); /// Does the node have a parent? fn has_parent_node(&self, node: &Self::Handle) -> bool; /// Append a node as the sibling immediately before the given node. /// This method will only be called if has_parent_node(sibling) is true /// /// The tree builder promises that `sibling` is not a text node. However its /// old previous sibling, which would become the new node's previous sibling, /// could be a text node. If the new node is also a text node, the two should /// be merged, as in the behavior of `append`. /// /// NB: `new_node` may have an old parent, from which it should be removed. fn append_before_sibling(&mut self, sibling: &Self::Handle, new_node: NodeOrText<Self::Handle>); /// Add each attribute to the given element, if no attribute with that name /// already exists. The tree builder promises this will never be called /// with something else than an element. fn add_attrs_if_missing(&mut self, target: &Self::Handle, attrs: Vec<Attribute>); /// Associate the given form-associatable element with the form element fn associate_with_form(&mut self, _target: &Self::Handle, _form: &Self::Handle) {} /// Detach the given node from its parent. fn remove_from_parent(&mut self, target: &Self::Handle); /// Remove all the children from node and append them to new_parent. fn reparent_children(&mut self, node: &Self::Handle, new_parent: &Self::Handle); /// Returns true if the adjusted current node is an HTML integration point /// and the token is a start tag. fn is_mathml_annotation_xml_integration_point(&self, _handle: &Self::Handle) -> bool { false } /// Called whenever the line number changes. fn set_current_line(&mut self, _line_number: u64) {} /// Indicate that a `script` element is complete. fn complete_script(&mut self, _node: &Self::Handle) -> NextParserState { NextParserState::Continue } } /// Trace hooks for a garbage-collected DOM. pub trait Tracer { type Handle; /// Upon a call to `trace_handles`, the tree builder will call this method /// for each handle in its internal state. fn trace_handle(&self, node: &Self::Handle); }