/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ //! The core DOM types. Defines the basic DOM hierarchy as well as all the HTML elements. use app_units::Au; use core::nonzero::NonZero; use devtools_traits::NodeInfo; use document_loader::DocumentLoader; use dom::attr::Attr; use dom::bindings::cell::DOMRefCell; use dom::bindings::codegen::Bindings::AttrBinding::AttrMethods; use dom::bindings::codegen::Bindings::CharacterDataBinding::CharacterDataMethods; use dom::bindings::codegen::Bindings::DocumentBinding::DocumentMethods; use dom::bindings::codegen::Bindings::ElementBinding::ElementMethods; use dom::bindings::codegen::Bindings::HTMLCollectionBinding::HTMLCollectionMethods; use dom::bindings::codegen::Bindings::NamedNodeMapBinding::NamedNodeMapMethods; use dom::bindings::codegen::Bindings::NodeBinding::{NodeConstants, NodeMethods}; use dom::bindings::codegen::Bindings::NodeListBinding::NodeListMethods; use dom::bindings::codegen::Bindings::ProcessingInstructionBinding::ProcessingInstructionMethods; use dom::bindings::codegen::UnionTypes::NodeOrString; use dom::bindings::conversions::{self, DerivedFrom}; use dom::bindings::error::{Error, ErrorResult, Fallible}; use dom::bindings::global::GlobalRef; use dom::bindings::inheritance::{Castable, CharacterDataTypeId}; use dom::bindings::inheritance::{EventTargetTypeId, NodeTypeId}; use dom::bindings::js::Root; use dom::bindings::js::RootedReference; use dom::bindings::js::{JS, LayoutJS, MutNullableHeap}; use dom::bindings::reflector::{Reflectable, reflect_dom_object}; use dom::bindings::trace::JSTraceable; use dom::bindings::trace::RootedVec; use dom::bindings::xmlname::namespace_from_domstring; use dom::characterdata::CharacterData; use dom::comment::Comment; use dom::document::{Document, DocumentSource, IsHTMLDocument}; use dom::documentfragment::DocumentFragment; use dom::documenttype::DocumentType; use dom::element::{Element, ElementCreator}; use dom::eventtarget::EventTarget; use dom::htmlcollection::HTMLCollection; use dom::htmlelement::HTMLElement; use dom::nodelist::NodeList; use dom::processinginstruction::ProcessingInstruction; use dom::text::Text; use dom::virtualmethods::{VirtualMethods, vtable_for}; use dom::window::Window; use euclid::rect::Rect; use js::jsapi::{JSContext, JSObject, JSRuntime}; use layout_interface::{LayoutChan, Msg}; use libc::{self, c_void, uintptr_t}; use parse::html::parse_html_fragment; use script_traits::UntrustedNodeAddress; use selectors::matching::matches; use selectors::parser::Selector; use selectors::parser::parse_author_origin_selector_list_from_str; use std::borrow::ToOwned; use std::cell::{Cell, Ref, RefCell, RefMut}; use std::cmp::max; use std::default::Default; use std::iter::{self, FilterMap, Peekable}; use std::mem; use std::slice::ref_slice; use std::sync::Arc; use string_cache::{Atom, Namespace, QualName}; use style::properties::ComputedValues; use util::str::DOMString; use util::task_state; use uuid::Uuid; // // The basic Node structure // /// An HTML node. #[dom_struct] pub struct Node { /// The JavaScript reflector for this node. eventtarget: EventTarget, /// The parent of this node. parent_node: MutNullableHeap>, /// The first child of this node. first_child: MutNullableHeap>, /// The last child of this node. last_child: MutNullableHeap>, /// The next sibling of this node. next_sibling: MutNullableHeap>, /// The previous sibling of this node. prev_sibling: MutNullableHeap>, /// The document that this node belongs to. owner_doc: MutNullableHeap>, /// The live list of children return by .childNodes. child_list: MutNullableHeap>, /// The live count of children of this node. children_count: Cell, /// A bitfield of flags for node items. flags: Cell, /// The maximum version of any inclusive descendant of this node. inclusive_descendants_version: Cell, /// Layout information. Only the layout task may touch this data. /// /// Must be sent back to the layout task to be destroyed when this /// node is finalized. layout_data: LayoutDataRef, unique_id: DOMRefCell>>, } impl PartialEq for Node { fn eq(&self, other: &Node) -> bool { self as *const Node == &*other } } bitflags! { #[doc = "Flags for node items."] #[derive(JSTraceable, HeapSizeOf)] flags NodeFlags: u8 { #[doc = "Specifies whether this node is in a document."] const IS_IN_DOC = 0x01, #[doc = "Specifies whether this node _must_ be reflowed regardless of style differences."] const HAS_CHANGED = 0x02, #[doc = "Specifies whether this node needs style recalc on next reflow."] const IS_DIRTY = 0x04, #[doc = "Specifies whether this node has descendants (inclusive of itself) which \ have changed since the last reflow."] const HAS_DIRTY_DESCENDANTS = 0x08, // TODO: find a better place to keep this (#4105) // https://critic.hoppipolla.co.uk/showcomment?chain=8873 // Perhaps using a Set in Document? #[doc = "Specifies whether or not there is an authentic click in progress on \ this element."] const CLICK_IN_PROGRESS = 0x10, #[doc = "Specifies whether this node is focusable and whether it is supposed \ to be reachable with using sequential focus navigation."] const SEQUENTIALLY_FOCUSABLE = 0x20, } } impl NodeFlags { pub fn new() -> NodeFlags { HAS_CHANGED | IS_DIRTY | HAS_DIRTY_DESCENDANTS } } impl Drop for Node { #[allow(unsafe_code)] fn drop(&mut self) { self.layout_data.dispose(self); } } /// suppress observers flag /// https://dom.spec.whatwg.org/#concept-node-insert /// https://dom.spec.whatwg.org/#concept-node-remove #[derive(Copy, Clone, HeapSizeOf)] enum SuppressObserver { Suppressed, Unsuppressed } /// Layout data that is shared between the script and layout tasks. #[derive(HeapSizeOf)] pub struct SharedLayoutData { /// The results of CSS styling for this node. pub style: Option>, } /// Encapsulates the abstract layout data. #[derive(HeapSizeOf)] pub struct LayoutData { _shared_data: SharedLayoutData, #[ignore_heap_size_of = "TODO(#6910) Box value that should be counted but the type lives in layout"] _data: NonZero<*const ()>, } #[allow(unsafe_code)] unsafe impl Send for LayoutData {} #[derive(HeapSizeOf)] pub struct LayoutDataRef { data_cell: RefCell>, } no_jsmanaged_fields!(LayoutDataRef); impl LayoutDataRef { pub fn new() -> LayoutDataRef { LayoutDataRef { data_cell: RefCell::new(None), } } /// Sends layout data, if any, back to the layout task to be destroyed. pub fn dispose(&self, node: &Node) { debug_assert!(task_state::get().is_script()); if let Some(layout_data) = mem::replace(&mut *self.data_cell.borrow_mut(), None) { let win = window_from_node(node); let LayoutChan(chan) = win.layout_chan(); chan.send(Msg::ReapLayoutData(layout_data)).unwrap() } } /// Borrows the layout data immutably, *assuming that there are no mutators*. Bad things will /// happen if you try to mutate the layout data while this is held. This is the only thread- /// safe layout data accessor. #[inline] #[allow(unsafe_code)] pub unsafe fn borrow_unchecked(&self) -> *const Option { debug_assert!(task_state::get().is_layout()); self.data_cell.as_unsafe_cell().get() as *const _ } /// Borrows the layout data immutably. This function is *not* thread-safe. #[inline] pub fn borrow(&self) -> Ref> { debug_assert!(task_state::get().is_layout()); self.data_cell.borrow() } /// Borrows the layout data mutably. This function is *not* thread-safe. /// /// FIXME(pcwalton): We should really put this behind a `MutLayoutView` phantom type, to /// prevent CSS selector matching from mutably accessing nodes it's not supposed to and racing /// on it. This has already resulted in one bug! #[inline] pub fn borrow_mut(&self) -> RefMut> { debug_assert!(task_state::get().is_layout()); self.data_cell.borrow_mut() } } impl Node { /// Adds a new child to the end of this node's list of children. /// /// Fails unless `new_child` is disconnected from the tree. fn add_child(&self, new_child: &Node, before: Option<&Node>) { assert!(new_child.parent_node.get().is_none()); assert!(new_child.prev_sibling.get().is_none()); assert!(new_child.next_sibling.get().is_none()); match before { Some(ref before) => { assert!(before.parent_node.get().r() == Some(self)); let prev_sibling = before.GetPreviousSibling(); match prev_sibling { None => { assert!(Some(*before) == self.first_child.get().r()); self.first_child.set(Some(new_child)); }, Some(ref prev_sibling) => { prev_sibling.next_sibling.set(Some(new_child)); new_child.prev_sibling.set(Some(prev_sibling.r())); }, } before.prev_sibling.set(Some(new_child)); new_child.next_sibling.set(Some(before)); }, None => { let last_child = self.GetLastChild(); match last_child { None => self.first_child.set(Some(new_child)), Some(ref last_child) => { assert!(last_child.next_sibling.get().is_none()); last_child.next_sibling.set(Some(new_child)); new_child.prev_sibling.set(Some(&last_child)); } } self.last_child.set(Some(new_child)); }, } new_child.parent_node.set(Some(self)); let parent_in_doc = self.is_in_doc(); for node in new_child.traverse_preorder() { node.set_flag(IS_IN_DOC, parent_in_doc); vtable_for(&&*node).bind_to_tree(parent_in_doc); } let document = new_child.owner_doc(); document.content_and_heritage_changed(new_child, NodeDamage::OtherNodeDamage); } /// Removes the given child from this node's list of children. /// /// Fails unless `child` is a child of this node. fn remove_child(&self, child: &Node) { assert!(child.parent_node.get().r() == Some(self)); let prev_sibling = child.GetPreviousSibling(); match prev_sibling { None => { self.first_child.set(child.next_sibling.get().r()); } Some(ref prev_sibling) => { prev_sibling.next_sibling.set(child.next_sibling.get().r()); } } let next_sibling = child.GetNextSibling(); match next_sibling { None => { self.last_child.set(child.prev_sibling.get().r()); } Some(ref next_sibling) => { next_sibling.prev_sibling.set(child.prev_sibling.get().r()); } } child.prev_sibling.set(None); child.next_sibling.set(None); child.parent_node.set(None); let parent_in_doc = self.is_in_doc(); for node in child.traverse_preorder() { node.set_flag(IS_IN_DOC, false); vtable_for(&&*node).unbind_from_tree(parent_in_doc); node.layout_data.dispose(&node); } self.owner_doc().content_and_heritage_changed(self, NodeDamage::OtherNodeDamage); child.owner_doc().content_and_heritage_changed(child, NodeDamage::OtherNodeDamage); } } pub struct QuerySelectorIterator { selectors: Vec, iterator: TreeIterator, } impl<'a> QuerySelectorIterator { fn new(iter: TreeIterator, selectors: Vec) -> QuerySelectorIterator { QuerySelectorIterator { selectors: selectors, iterator: iter, } } } impl<'a> Iterator for QuerySelectorIterator { type Item = Root; fn next(&mut self) -> Option> { let selectors = &self.selectors; // TODO(cgaebel): Is it worth it to build a bloom filter here // (instead of passing `None`)? Probably. self.iterator.by_ref().filter_map(|node| { if let Some(element) = Root::downcast(node) { if matches(selectors, &element, None) { return Some(Root::upcast(element)); } } None }).next() } } impl Node { pub fn teardown(&self) { self.layout_data.dispose(self); for kid in self.children() { kid.teardown(); } } /// Dumps the subtree rooted at this node, for debugging. pub fn dump(&self) { self.dump_indent(0); } /// Dumps the node tree, for debugging, with indentation. pub fn dump_indent(&self, indent: u32) { let mut s = String::new(); for _ in 0..indent { s.push_str(" "); } s.push_str(&*self.debug_str()); debug!("{:?}", s); // FIXME: this should have a pure version? for kid in self.children() { kid.dump_indent(indent + 1) } } /// Returns a string that describes this node. pub fn debug_str(&self) -> String { format!("{:?}", self.type_id()) } pub fn is_in_doc(&self) -> bool { self.flags.get().contains(IS_IN_DOC) } /// Returns the type ID of this node. pub fn type_id(&self) -> NodeTypeId { match *self.eventtarget.type_id() { EventTargetTypeId::Node(type_id) => type_id, _ => unreachable!(), } } // https://dom.spec.whatwg.org/#concept-node-length pub fn len(&self) -> u32 { match self.type_id() { NodeTypeId::DocumentType => 0, NodeTypeId::CharacterData(_) => { self.downcast::().unwrap().Length() }, _ => self.children_count(), } } // https://dom.spec.whatwg.org/#concept-tree-index pub fn index(&self) -> u32 { self.preceding_siblings().count() as u32 } pub fn children_count(&self) -> u32 { self.children_count.get() } #[inline] pub fn is_doctype(&self) -> bool { self.type_id() == NodeTypeId::DocumentType } pub fn get_flag(&self, flag: NodeFlags) -> bool { self.flags.get().contains(flag) } pub fn set_flag(&self, flag: NodeFlags, value: bool) { let mut flags = self.flags.get(); if value { flags.insert(flag); } else { flags.remove(flag); } self.flags.set(flags); } pub fn get_has_changed(&self) -> bool { self.get_flag(HAS_CHANGED) } pub fn set_has_changed(&self, state: bool) { self.set_flag(HAS_CHANGED, state) } pub fn get_is_dirty(&self) -> bool { self.get_flag(IS_DIRTY) } pub fn set_is_dirty(&self, state: bool) { self.set_flag(IS_DIRTY, state) } pub fn get_has_dirty_descendants(&self) -> bool { self.get_flag(HAS_DIRTY_DESCENDANTS) } pub fn set_has_dirty_descendants(&self, state: bool) { self.set_flag(HAS_DIRTY_DESCENDANTS, state) } pub fn force_dirty_ancestors(&self, damage: NodeDamage) { self.dirty_impl(damage, true) } pub fn rev_version(&self) { // The new version counter is 1 plus the max of the node's current version counter, // its descendants version, and the document's version. Normally, this will just be // the document's version, but we do have to deal with the case where the node has moved // document, so may have a higher version count than its owning document. let doc: Root = Root::upcast(self.owner_doc()); let version = max(self.get_inclusive_descendants_version(), doc.get_inclusive_descendants_version()) + 1; for ancestor in self.inclusive_ancestors() { ancestor.inclusive_descendants_version.set(version); } doc.inclusive_descendants_version.set(version); } pub fn dirty(&self, damage: NodeDamage) { self.dirty_impl(damage, false) } pub fn dirty_impl(&self, damage: NodeDamage, force_ancestors: bool) { // 0. Set version counter self.rev_version(); // 1. Dirty self. match damage { NodeDamage::NodeStyleDamaged => {} NodeDamage::OtherNodeDamage => self.set_has_changed(true), } if self.get_is_dirty() && !force_ancestors { return } // 2. Dirty descendants. fn dirty_subtree(node: &Node) { // Stop if this subtree is already dirty. if node.get_is_dirty() { return } node.set_flag(IS_DIRTY | HAS_DIRTY_DESCENDANTS, true); for kid in node.children() { dirty_subtree(kid.r()); } } dirty_subtree(self); // 4. Dirty ancestors. for ancestor in self.ancestors() { if !force_ancestors && ancestor.get_has_dirty_descendants() { break } ancestor.set_has_dirty_descendants(true); } } /// The maximum version number of this node's descendants, including itself pub fn get_inclusive_descendants_version(&self) -> u64 { self.inclusive_descendants_version.get() } /// Iterates over this node and all its descendants, in preorder. pub fn traverse_preorder(&self) -> TreeIterator { TreeIterator::new(self) } pub fn inclusively_following_siblings(&self) -> NodeSiblingIterator { NodeSiblingIterator { current: Some(Root::from_ref(self)), } } pub fn inclusively_preceding_siblings(&self) -> ReverseSiblingIterator { ReverseSiblingIterator { current: Some(Root::from_ref(self)), } } pub fn is_inclusive_ancestor_of(&self, parent: &Node) -> bool { self == parent || parent.ancestors().any(|ancestor| ancestor.r() == self) } pub fn following_siblings(&self) -> NodeSiblingIterator { NodeSiblingIterator { current: self.GetNextSibling(), } } pub fn preceding_siblings(&self) -> ReverseSiblingIterator { ReverseSiblingIterator { current: self.GetPreviousSibling(), } } pub fn following_nodes(&self, root: &Node) -> FollowingNodeIterator { FollowingNodeIterator { current: Some(Root::from_ref(self)), root: Root::from_ref(root), } } pub fn preceding_nodes(&self, root: &Node) -> PrecedingNodeIterator { PrecedingNodeIterator { current: Some(Root::from_ref(self)), root: Root::from_ref(root), } } pub fn descending_last_children(&self) -> LastChildIterator { LastChildIterator { current: self.GetLastChild(), } } pub fn is_parent_of(&self, child: &Node) -> bool { child.parent_node.get().map_or(false, |ref parent| parent.r() == self) } pub fn to_trusted_node_address(&self) -> TrustedNodeAddress { TrustedNodeAddress(&*self as *const Node as *const libc::c_void) } pub fn get_bounding_content_box(&self) -> Rect { window_from_node(self).content_box_query(self.to_trusted_node_address()) } pub fn get_content_boxes(&self) -> Vec> { window_from_node(self).content_boxes_query(self.to_trusted_node_address()) } pub fn get_client_rect(&self) -> Rect { window_from_node(self).client_rect_query(self.to_trusted_node_address()) } // https://dom.spec.whatwg.org/#dom-childnode-before pub fn before(&self, nodes: Vec) -> ErrorResult { // Step 1. let parent = &self.parent_node; // Step 2. let parent = match parent.get() { None => return Ok(()), Some(parent) => parent, }; // Step 3. let viable_previous_sibling = first_node_not_in(self.preceding_siblings(), &nodes); // Step 4. let node = try!(self.owner_doc().node_from_nodes_and_strings(nodes)); // Step 5. let viable_previous_sibling = match viable_previous_sibling { Some(ref viable_previous_sibling) => viable_previous_sibling.next_sibling.get(), None => parent.first_child.get(), }; // Step 6. try!(Node::pre_insert(&node, &parent, viable_previous_sibling.r())); Ok(()) } // https://dom.spec.whatwg.org/#dom-childnode-after pub fn after(&self, nodes: Vec) -> ErrorResult { // Step 1. let parent = &self.parent_node; // Step 2. let parent = match parent.get() { None => return Ok(()), Some(parent) => parent, }; // Step 3. let viable_next_sibling = first_node_not_in(self.following_siblings(), &nodes); // Step 4. let node = try!(self.owner_doc().node_from_nodes_and_strings(nodes)); // Step 5. try!(Node::pre_insert(&node, &parent, viable_next_sibling.r())); Ok(()) } // https://dom.spec.whatwg.org/#dom-childnode-replacewith pub fn replace_with(&self, nodes: Vec) -> ErrorResult { match self.parent_node.get() { None => { // Step 1. Ok(()) }, Some(ref parent_node) => { // Step 2. let doc = self.owner_doc(); let node = try!(doc.node_from_nodes_and_strings(nodes)); // Step 3. parent_node.ReplaceChild(node.r(), self).map(|_| ()) }, } } // https://dom.spec.whatwg.org/#dom-parentnode-prepend pub fn prepend(&self, nodes: Vec) -> ErrorResult { // Step 1. let doc = self.owner_doc(); let node = try!(doc.node_from_nodes_and_strings(nodes)); // Step 2. let first_child = self.first_child.get(); Node::pre_insert(node.r(), self, first_child.r()).map(|_| ()) } // https://dom.spec.whatwg.org/#dom-parentnode-append pub fn append(&self, nodes: Vec) -> ErrorResult { // Step 1. let doc = self.owner_doc(); let node = try!(doc.node_from_nodes_and_strings(nodes)); // Step 2. self.AppendChild(node.r()).map(|_| ()) } // https://dom.spec.whatwg.org/#dom-parentnode-queryselector pub fn query_selector(&self, selectors: DOMString) -> Fallible>> { // Step 1. match parse_author_origin_selector_list_from_str(&selectors) { // Step 2. Err(()) => Err(Error::Syntax), // Step 3. Ok(ref selectors) => { Ok(self.traverse_preorder().filter_map(Root::downcast).find(|element| { matches(selectors, element, None) })) } } } /// https://dom.spec.whatwg.org/#scope-match-a-selectors-string /// Get an iterator over all nodes which match a set of selectors /// Be careful not to do anything which may manipulate the DOM tree /// whilst iterating, otherwise the iterator may be invalidated. pub fn query_selector_iter(&self, selectors: DOMString) -> Fallible { // Step 1. match parse_author_origin_selector_list_from_str(&selectors) { // Step 2. Err(()) => Err(Error::Syntax), // Step 3. Ok(selectors) => { Ok(QuerySelectorIterator::new(self.traverse_preorder(), selectors)) } } } // https://dom.spec.whatwg.org/#dom-parentnode-queryselectorall #[allow(unsafe_code)] pub fn query_selector_all(&self, selectors: DOMString) -> Fallible> { let window = window_from_node(self); let iter = try!(self.query_selector_iter(selectors)); Ok(NodeList::new_simple_list(window.r(), iter)) } pub fn ancestors(&self) -> AncestorIterator { AncestorIterator { current: self.GetParentNode() } } pub fn inclusive_ancestors(&self) -> AncestorIterator { AncestorIterator { current: Some(Root::from_ref(self)) } } pub fn owner_doc(&self) -> Root { self.owner_doc.get().unwrap() } pub fn set_owner_doc(&self, document: &Document) { self.owner_doc.set(Some(document)); } pub fn is_in_html_doc(&self) -> bool { self.owner_doc().is_html_document() } pub fn children(&self) -> NodeSiblingIterator { NodeSiblingIterator { current: self.GetFirstChild(), } } pub fn rev_children(&self) -> ReverseSiblingIterator { ReverseSiblingIterator { current: self.GetLastChild(), } } pub fn child_elements(&self) -> ChildElementIterator { self.children().filter_map(Root::downcast as fn(_) -> _).peekable() } pub fn remove_self(&self) { if let Some(ref parent) = self.GetParentNode() { Node::remove(self, parent.r(), SuppressObserver::Unsuppressed); } } pub fn get_unique_id(&self) -> String { if self.unique_id.borrow().is_none() { let mut unique_id = self.unique_id.borrow_mut(); *unique_id = Some(Box::new(Uuid::new_v4())); } self.unique_id.borrow().as_ref().unwrap().to_simple_string() } pub fn summarize(&self) -> NodeInfo { NodeInfo { uniqueId: self.get_unique_id(), baseURI: String::from(self.BaseURI()), parent: self.GetParentNode().map(|node| node.get_unique_id()).unwrap_or("".to_owned()), nodeType: self.NodeType(), namespaceURI: String::new(), //FIXME nodeName: String::from(self.NodeName()), numChildren: self.ChildNodes().Length() as usize, //FIXME doctype nodes only name: String::new(), publicId: String::new(), systemId: String::new(), attrs: self.downcast().map(Element::summarize).unwrap_or(vec![]), isDocumentElement: self.owner_doc() .GetDocumentElement() .map(|elem| elem.upcast::() == self) .unwrap_or(false), shortValue: self.GetNodeValue().map(String::from).unwrap_or_default(), //FIXME: truncate incompleteValue: false, //FIXME: reflect truncation } } // https://dvcs.w3.org/hg/innerhtml/raw-file/tip/index.html#dfn-concept-parse-fragment pub fn parse_fragment(&self, markup: DOMString) -> Fallible> { let context_document = document_from_node(self); let fragment = DocumentFragment::new(context_document.r()); if context_document.is_html_document() { parse_html_fragment(self.upcast(), markup, fragment.upcast()); } else { // FIXME: XML case unimplemented!(); } Ok(fragment) } /// Used by `HTMLTableSectionElement::InsertRow` and `HTMLTableRowElement::InsertCell` pub fn insert_cell_or_row(&self, index: i32, get_items: F, new_child: G) -> Fallible> where F: Fn() -> Root, G: Fn() -> Root, I: DerivedFrom + DerivedFrom + Reflectable, { if index < -1 { return Err(Error::IndexSize); } let tr = new_child(); let after_node = if index == -1 { None } else { match get_items().elements_iter() .map(Root::upcast::) .map(Some) .chain(iter::once(None)) .nth(index as usize) { None => return Err(Error::IndexSize), Some(node) => node, } }; { let tr_node = tr.upcast::(); try!(self.InsertBefore(tr_node, after_node.r())); } Ok(Root::upcast::(tr)) } /// Used by `HTMLTableSectionElement::DeleteRow` and `HTMLTableRowElement::DeleteCell` pub fn delete_cell_or_row(&self, index: i32, get_items: F, is_delete_type: G) -> ErrorResult where F: Fn() -> Root, G: Fn(&Element) -> bool { let element = match index { index if index < -1 => return Err(Error::IndexSize), -1 => { let last_child = self.upcast::().GetLastChild(); match last_child.and_then(|node| node.inclusively_preceding_siblings() .filter_map(Root::downcast::) .filter(|elem| is_delete_type(elem)) .next()) { Some(element) => element, None => return Ok(()), } }, index => match get_items().Item(index as u32) { Some(element) => element, None => return Err(Error::IndexSize), }, }; element.upcast::().remove_self(); Ok(()) } } /// Iterate through `nodes` until we find a `Node` that is not in `not_in` fn first_node_not_in(mut nodes: I, not_in: &[NodeOrString]) -> Option> where I: Iterator> { nodes.find(|node| { not_in.iter().all(|n| { match *n { NodeOrString::eNode(ref n) => n != node, _ => true, } }) }) } /// If the given untrusted node address represents a valid DOM node in the given runtime, /// returns it. #[allow(unsafe_code)] pub fn from_untrusted_node_address(_runtime: *mut JSRuntime, candidate: UntrustedNodeAddress) -> Root { unsafe { // https://github.com/servo/servo/issues/6383 let candidate: uintptr_t = mem::transmute(candidate.0); // let object: *mut JSObject = jsfriendapi::bindgen::JS_GetAddressableObject(runtime, // candidate); let object: *mut JSObject = mem::transmute(candidate); if object.is_null() { panic!("Attempted to create a `JS` from an invalid pointer!") } let boxed_node = conversions::private_from_object(object) as *const Node; Root::from_ref(&*boxed_node) } } #[allow(unsafe_code)] pub trait LayoutNodeHelpers { unsafe fn type_id_for_layout(&self) -> NodeTypeId; unsafe fn parent_node_ref(&self) -> Option>; unsafe fn first_child_ref(&self) -> Option>; unsafe fn last_child_ref(&self) -> Option>; unsafe fn prev_sibling_ref(&self) -> Option>; unsafe fn next_sibling_ref(&self) -> Option>; unsafe fn owner_doc_for_layout(&self) -> LayoutJS; unsafe fn is_element_for_layout(&self) -> bool; unsafe fn get_flag(&self, flag: NodeFlags) -> bool; unsafe fn set_flag(&self, flag: NodeFlags, value: bool); unsafe fn children_count(&self) -> u32; unsafe fn layout_data(&self) -> Ref>; unsafe fn layout_data_mut(&self) -> RefMut>; unsafe fn layout_data_unchecked(&self) -> *const Option; } impl LayoutNodeHelpers for LayoutJS { #[inline] #[allow(unsafe_code)] unsafe fn type_id_for_layout(&self) -> NodeTypeId { (*self.unsafe_get()).type_id() } #[inline] #[allow(unsafe_code)] unsafe fn is_element_for_layout(&self) -> bool { (*self.unsafe_get()).is::() } #[inline] #[allow(unsafe_code)] unsafe fn parent_node_ref(&self) -> Option> { (*self.unsafe_get()).parent_node.get_inner_as_layout() } #[inline] #[allow(unsafe_code)] unsafe fn first_child_ref(&self) -> Option> { (*self.unsafe_get()).first_child.get_inner_as_layout() } #[inline] #[allow(unsafe_code)] unsafe fn last_child_ref(&self) -> Option> { (*self.unsafe_get()).last_child.get_inner_as_layout() } #[inline] #[allow(unsafe_code)] unsafe fn prev_sibling_ref(&self) -> Option> { (*self.unsafe_get()).prev_sibling.get_inner_as_layout() } #[inline] #[allow(unsafe_code)] unsafe fn next_sibling_ref(&self) -> Option> { (*self.unsafe_get()).next_sibling.get_inner_as_layout() } #[inline] #[allow(unsafe_code)] unsafe fn owner_doc_for_layout(&self) -> LayoutJS { (*self.unsafe_get()).owner_doc.get_inner_as_layout().unwrap() } #[inline] #[allow(unsafe_code)] unsafe fn get_flag(&self, flag: NodeFlags) -> bool { (*self.unsafe_get()).flags.get().contains(flag) } #[inline] #[allow(unsafe_code)] unsafe fn set_flag(&self, flag: NodeFlags, value: bool) { let this = self.unsafe_get(); let mut flags = (*this).flags.get(); if value { flags.insert(flag); } else { flags.remove(flag); } (*this).flags.set(flags); } #[inline] #[allow(unsafe_code)] unsafe fn children_count(&self) -> u32 { (*self.unsafe_get()).children_count.get() } #[inline] #[allow(unsafe_code)] unsafe fn layout_data(&self) -> Ref> { (*self.unsafe_get()).layout_data.borrow() } #[inline] #[allow(unsafe_code)] unsafe fn layout_data_mut(&self) -> RefMut> { (*self.unsafe_get()).layout_data.borrow_mut() } #[inline] #[allow(unsafe_code)] unsafe fn layout_data_unchecked(&self) -> *const Option { (*self.unsafe_get()).layout_data.borrow_unchecked() } } // // Iteration and traversal // pub type ChildElementIterator = Peekable) -> Option>>>; pub struct NodeSiblingIterator { current: Option>, } impl Iterator for NodeSiblingIterator { type Item = Root; fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; self.current = current.GetNextSibling(); Some(current) } } pub struct ReverseSiblingIterator { current: Option>, } impl Iterator for ReverseSiblingIterator { type Item = Root; fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; self.current = current.GetPreviousSibling(); Some(current) } } pub struct FollowingNodeIterator { current: Option>, root: Root, } impl Iterator for FollowingNodeIterator { type Item = Root; // https://dom.spec.whatwg.org/#concept-tree-following fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; if let Some(first_child) = current.GetFirstChild() { self.current = Some(first_child); return current.GetFirstChild() } if self.root == current { self.current = None; return None; } if let Some(next_sibling) = current.GetNextSibling() { self.current = Some(next_sibling); return current.GetNextSibling() } for ancestor in current.inclusive_ancestors() { if self.root == ancestor { break; } if let Some(next_sibling) = ancestor.GetNextSibling() { self.current = Some(next_sibling); return ancestor.GetNextSibling() } } self.current = None; None } } pub struct PrecedingNodeIterator { current: Option>, root: Root, } impl Iterator for PrecedingNodeIterator { type Item = Root; // https://dom.spec.whatwg.org/#concept-tree-preceding fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; if self.root == current { self.current = None; return None } let node = current; if let Some(previous_sibling) = node.GetPreviousSibling() { if self.root == previous_sibling { self.current = None; return None } if let Some(last_child) = previous_sibling.descending_last_children().last() { self.current = Some(last_child); return previous_sibling.descending_last_children().last() } self.current = Some(previous_sibling); return node.GetPreviousSibling() }; if let Some(parent_node) = node.GetParentNode() { self.current = Some(parent_node); return node.GetParentNode() } self.current = None; None } } pub struct LastChildIterator { current: Option>, } impl Iterator for LastChildIterator { type Item = Root; fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; self.current = current.GetLastChild(); Some(current) } } pub struct AncestorIterator { current: Option>, } impl Iterator for AncestorIterator { type Item = Root; fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; self.current = current.GetParentNode(); Some(current) } } pub struct TreeIterator { current: Option>, depth: usize, } impl TreeIterator { fn new(root: &Node) -> TreeIterator { TreeIterator { current: Some(Root::from_ref(root)), depth: 0, } } } impl Iterator for TreeIterator { type Item = Root; // https://dom.spec.whatwg.org/#concept-tree-order fn next(&mut self) -> Option> { let current = match self.current.take() { None => return None, Some(current) => current, }; if let Some(first_child) = current.GetFirstChild() { self.current = Some(first_child); self.depth += 1; return Some(current); }; for ancestor in current.inclusive_ancestors() { if self.depth == 0 { break; } if let Some(next_sibling) = ancestor.GetNextSibling() { self.current = Some(next_sibling); return Some(current); } self.depth -= 1; } debug_assert!(self.depth == 0); self.current = None; Some(current) } } /// Specifies whether children must be recursively cloned or not. #[derive(Copy, Clone, PartialEq, HeapSizeOf)] pub enum CloneChildrenFlag { CloneChildren, DoNotCloneChildren } fn as_uintptr(t: &T) -> uintptr_t { t as *const T as uintptr_t } impl Node { pub fn reflect_node + Reflectable> (node: Box, document: &Document, wrap_fn: extern "Rust" fn(*mut JSContext, GlobalRef, Box) -> Root) -> Root { let window = document.window(); reflect_dom_object(node, GlobalRef::Window(window), wrap_fn) } pub fn new_inherited(doc: &Document) -> Node { Node::new_(NodeFlags::new(), Some(doc)) } #[allow(unrooted_must_root)] pub fn new_document_node() -> Node { Node::new_(NodeFlags::new() | IS_IN_DOC, None) } #[allow(unrooted_must_root)] fn new_(flags: NodeFlags, doc: Option<&Document>) -> Node { Node { eventtarget: EventTarget::new_inherited(), parent_node: Default::default(), first_child: Default::default(), last_child: Default::default(), next_sibling: Default::default(), prev_sibling: Default::default(), owner_doc: MutNullableHeap::new(doc), child_list: Default::default(), children_count: Cell::new(0u32), flags: Cell::new(flags), inclusive_descendants_version: Cell::new(0), layout_data: LayoutDataRef::new(), unique_id: DOMRefCell::new(None), } } // https://dom.spec.whatwg.org/#concept-node-adopt pub fn adopt(node: &Node, document: &Document) { // Step 1. let old_doc = node.owner_doc(); // Step 2. node.remove_self(); if &*old_doc != document { // Step 3. for descendant in node.traverse_preorder() { descendant.set_owner_doc(document); } // Step 4. for descendant in node.traverse_preorder() { vtable_for(&descendant).adopting_steps(&old_doc); } } } // https://dom.spec.whatwg.org/#concept-node-ensure-pre-insertion-validity pub fn ensure_pre_insertion_validity(node: &Node, parent: &Node, child: Option<&Node>) -> ErrorResult { // Step 1. match parent.type_id() { NodeTypeId::Document(_) | NodeTypeId::DocumentFragment | NodeTypeId::Element(..) => (), _ => return Err(Error::HierarchyRequest) } // Step 2. if node.is_inclusive_ancestor_of(parent) { return Err(Error::HierarchyRequest); } // Step 3. if let Some(child) = child { if !parent.is_parent_of(child) { return Err(Error::NotFound); } } // Step 4-5. match node.type_id() { NodeTypeId::CharacterData(CharacterDataTypeId::Text) => { if parent.is::() { return Err(Error::HierarchyRequest); } }, NodeTypeId::DocumentType => { if !parent.is::() { return Err(Error::HierarchyRequest); } }, NodeTypeId::DocumentFragment | NodeTypeId::Element(_) | NodeTypeId::CharacterData(CharacterDataTypeId::ProcessingInstruction) | NodeTypeId::CharacterData(CharacterDataTypeId::Comment) => (), NodeTypeId::Document(_) => return Err(Error::HierarchyRequest) } // Step 6. if parent.is::() { match node.type_id() { // Step 6.1 NodeTypeId::DocumentFragment => { // Step 6.1.1(b) if node.children() .any(|c| c.is::()) { return Err(Error::HierarchyRequest); } match node.child_elements().count() { 0 => (), // Step 6.1.2 1 => { if !parent.child_elements().is_empty() { return Err(Error::HierarchyRequest); } if let Some(child) = child { if child.inclusively_following_siblings() .any(|child| child.is_doctype()) { return Err(Error::HierarchyRequest); } } }, // Step 6.1.1(a) _ => return Err(Error::HierarchyRequest), } }, // Step 6.2 NodeTypeId::Element(_) => { if !parent.child_elements().is_empty() { return Err(Error::HierarchyRequest); } if let Some(ref child) = child { if child.inclusively_following_siblings() .any(|child| child.is_doctype()) { return Err(Error::HierarchyRequest); } } }, // Step 6.3 NodeTypeId::DocumentType => { if parent.children() .any(|c| c.is_doctype()) { return Err(Error::HierarchyRequest); } match child { Some(child) => { if parent.children() .take_while(|c| c.r() != child) .any(|c| c.is::()) { return Err(Error::HierarchyRequest); } }, None => { if !parent.child_elements().is_empty() { return Err(Error::HierarchyRequest); } }, } }, NodeTypeId::CharacterData(_) => (), NodeTypeId::Document(_) => unreachable!(), } } Ok(()) } // https://dom.spec.whatwg.org/#concept-node-pre-insert pub fn pre_insert(node: &Node, parent: &Node, child: Option<&Node>) -> Fallible> { // Step 1. try!(Node::ensure_pre_insertion_validity(node, parent, child)); // Steps 2-3. let reference_child_root; let reference_child = match child { Some(child) if child == node => { reference_child_root = node.GetNextSibling(); reference_child_root.r() }, _ => child }; // Step 4. let document = document_from_node(parent); Node::adopt(node, document.r()); // Step 5. Node::insert(node, parent, reference_child, SuppressObserver::Unsuppressed); // Step 6. Ok(Root::from_ref(node)) } // https://dom.spec.whatwg.org/#concept-node-insert fn insert(node: &Node, parent: &Node, child: Option<&Node>, suppress_observers: SuppressObserver) { debug_assert!(&*node.owner_doc() == &*parent.owner_doc()); debug_assert!(child.map_or(true, |child| Some(parent) == child.GetParentNode().r())); // Steps 1-2: ranges. let mut new_nodes = RootedVec::new(); let new_nodes = if let NodeTypeId::DocumentFragment = node.type_id() { // Step 3. new_nodes.extend(node.children().map(|kid| JS::from_rooted(&kid))); // Step 4: mutation observers. // Step 5. for kid in new_nodes.r() { Node::remove(*kid, node, SuppressObserver::Suppressed); } vtable_for(&node).children_changed(&ChildrenMutation::replace_all(new_nodes.r(), &[])); new_nodes.r() } else { // Step 3. ref_slice(&node) }; // Step 6: mutation observers. let previous_sibling = match suppress_observers { SuppressObserver::Unsuppressed => { match child { Some(child) => child.GetPreviousSibling(), None => parent.GetLastChild(), } }, SuppressObserver::Suppressed => None, }; // Step 7. for kid in new_nodes { // Step 7.1. parent.add_child(*kid, child); // Step 7.2: insertion steps. } if let SuppressObserver::Unsuppressed = suppress_observers { vtable_for(&parent).children_changed( &ChildrenMutation::insert(previous_sibling.r(), new_nodes, child)); } } // https://dom.spec.whatwg.org/#concept-node-replace-all pub fn replace_all(node: Option<&Node>, parent: &Node) { // Step 1. if let Some(node) = node { Node::adopt(node, &*parent.owner_doc()); } // Step 2. let removed_nodes = parent.children().collect::>(); // Step 3. let mut added_nodes = RootedVec::new(); let added_nodes = if let Some(node) = node.as_ref() { if let NodeTypeId::DocumentFragment = node.type_id() { added_nodes.extend(node.children().map(|child| JS::from_rooted(&child))); added_nodes.r() } else { ref_slice(node) } } else { &[] as &[&Node] }; // Step 4. for child in removed_nodes.r() { Node::remove(*child, parent, SuppressObserver::Suppressed); } // Step 5. if let Some(node) = node { Node::insert(node, parent, None, SuppressObserver::Suppressed); } // Step 6: mutation observers. vtable_for(&parent).children_changed( &ChildrenMutation::replace_all(removed_nodes.r(), added_nodes)); } // https://dom.spec.whatwg.org/#concept-node-pre-remove fn pre_remove(child: &Node, parent: &Node) -> Fallible> { // Step 1. match child.GetParentNode() { Some(ref node) if node.r() != parent => return Err(Error::NotFound), None => return Err(Error::NotFound), _ => () } // Step 2. Node::remove(child, parent, SuppressObserver::Unsuppressed); // Step 3. Ok(Root::from_ref(child)) } // https://dom.spec.whatwg.org/#concept-node-remove fn remove(node: &Node, parent: &Node, suppress_observers: SuppressObserver) { assert!(node.GetParentNode().map_or(false, |node_parent| node_parent.r() == parent)); // Step 1-5: ranges. // Step 6. let old_previous_sibling = node.GetPreviousSibling(); // Steps 7-8: mutation observers. // Step 9. let old_next_sibling = node.GetNextSibling(); parent.remove_child(node); if let SuppressObserver::Unsuppressed = suppress_observers { vtable_for(&parent).children_changed( &ChildrenMutation::replace(old_previous_sibling.r(), &node, &[], old_next_sibling.r())); } } // https://dom.spec.whatwg.org/#concept-node-clone pub fn clone(node: &Node, maybe_doc: Option<&Document>, clone_children: CloneChildrenFlag) -> Root { // Step 1. let document = match maybe_doc { Some(doc) => Root::from_ref(doc), None => node.owner_doc() }; // Step 2. // XXXabinader: clone() for each node as trait? let copy: Root = match node.type_id() { NodeTypeId::DocumentType => { let doctype = node.downcast::().unwrap(); let doctype = DocumentType::new(doctype.name().clone(), Some(doctype.public_id().clone()), Some(doctype.system_id().clone()), document.r()); Root::upcast::(doctype) }, NodeTypeId::DocumentFragment => { let doc_fragment = DocumentFragment::new(document.r()); Root::upcast::(doc_fragment) }, NodeTypeId::CharacterData(CharacterDataTypeId::Comment) => { let cdata = node.downcast::().unwrap(); let comment = Comment::new(cdata.Data(), document.r()); Root::upcast::(comment) }, NodeTypeId::Document(_) => { let document = node.downcast::().unwrap(); let is_html_doc = match document.is_html_document() { true => IsHTMLDocument::HTMLDocument, false => IsHTMLDocument::NonHTMLDocument, }; let window = document.window(); let loader = DocumentLoader::new(&*document.loader()); let document = Document::new(window, Some((*document.url()).clone()), is_html_doc, None, None, DocumentSource::NotFromParser, loader); Root::upcast::(document) }, NodeTypeId::Element(..) => { let element = node.downcast::().unwrap(); let name = QualName { ns: element.namespace().clone(), local: element.local_name().clone() }; let element = Element::create(name, element.prefix().as_ref().map(|p| Atom::from(&**p)), document.r(), ElementCreator::ScriptCreated); Root::upcast::(element) }, NodeTypeId::CharacterData(CharacterDataTypeId::Text) => { let cdata = node.downcast::().unwrap(); let text = Text::new(cdata.Data(), document.r()); Root::upcast::(text) }, NodeTypeId::CharacterData(CharacterDataTypeId::ProcessingInstruction) => { let pi = node.downcast::().unwrap(); let pi = ProcessingInstruction::new(pi.Target(), pi.upcast::().Data(), document.r()); Root::upcast::(pi) }, }; // Step 3. let document = match copy.downcast::() { Some(doc) => Root::from_ref(doc), None => Root::from_ref(document.r()), }; assert!(copy.owner_doc() == document); // Step 4 (some data already copied in step 2). match node.type_id() { NodeTypeId::Document(_) => { let node_doc = node.downcast::().unwrap(); let copy_doc = copy.downcast::().unwrap(); copy_doc.set_encoding_name(node_doc.encoding_name().clone()); copy_doc.set_quirks_mode(node_doc.quirks_mode()); }, NodeTypeId::Element(..) => { let node_elem = node.downcast::().unwrap(); let copy_elem = copy.downcast::().unwrap(); for attr in node_elem.attrs().iter() { copy_elem.push_new_attribute(attr.local_name().clone(), attr.value().clone(), attr.name().clone(), attr.namespace().clone(), attr.prefix().clone()); } }, _ => () } // Step 5: cloning steps. vtable_for(&node).cloning_steps(copy.r(), maybe_doc, clone_children); // Step 6. if clone_children == CloneChildrenFlag::CloneChildren { for child in node.children() { let child_copy = Node::clone(child.r(), Some(document.r()), clone_children); let _inserted_node = Node::pre_insert(child_copy.r(), copy.r(), None); } } // Step 7. copy } pub fn collect_text_contents>>(iterator: T) -> DOMString { let mut content = String::new(); for node in iterator { match node.downcast::() { Some(text) => content.push_str(&text.upcast::().Data()), None => (), } } DOMString::from(content) } pub fn namespace_to_string(namespace: Namespace) -> Option { match namespace { ns!() => None, // FIXME(ajeffrey): convert directly from &Atom to DOMString Namespace(ref ns) => Some(DOMString::from(&**ns)) } } // https://dom.spec.whatwg.org/#locate-a-namespace pub fn locate_namespace(node: &Node, prefix: Option) -> Namespace { fn attr_defines_namespace(attr: &Attr, prefix: &Option) -> bool { *attr.namespace() == ns!(xmlns) && match (attr.prefix(), prefix) { (&Some(ref attr_prefix), &Some(ref prefix)) => attr_prefix == &atom!("xmlns") && attr.local_name() == prefix, (&None, &None) => *attr.local_name() == atom!("xmlns"), _ => false } } match node.type_id() { NodeTypeId::Element(_) => { let element = node.downcast::().unwrap(); // Step 1. if *element.namespace() != ns!() && *element.prefix() == prefix { return element.namespace().clone() } // FIXME(ajeffrey): directly convert DOMString to Atom let prefix_atom = prefix.as_ref().map(|s| Atom::from(&**s)); // Step 2. let attrs = element.attrs(); let namespace_attr = attrs.iter().find(|attr| { attr_defines_namespace(attr, &prefix_atom) }); // Steps 2.1-2. if let Some(attr) = namespace_attr { return namespace_from_domstring(Some(attr.Value())); } match node.GetParentElement() { // Step 3. None => ns!(), // Step 4. Some(parent) => Node::locate_namespace(parent.upcast(), prefix) } }, NodeTypeId::Document(_) => { match node.downcast::().unwrap().GetDocumentElement().r() { // Step 1. None => ns!(), // Step 2. Some(document_element) => { Node::locate_namespace(document_element.upcast(), prefix) } } }, NodeTypeId::DocumentType => ns!(), NodeTypeId::DocumentFragment => ns!(), _ => match node.GetParentElement() { // Step 1. None => ns!(), // Step 2. Some(parent) => Node::locate_namespace(parent.upcast(), prefix) } } } } impl NodeMethods for Node { // https://dom.spec.whatwg.org/#dom-node-nodetype fn NodeType(&self) -> u16 { match self.type_id() { NodeTypeId::CharacterData(CharacterDataTypeId::Text) => NodeConstants::TEXT_NODE, NodeTypeId::CharacterData(CharacterDataTypeId::ProcessingInstruction) => NodeConstants::PROCESSING_INSTRUCTION_NODE, NodeTypeId::CharacterData(CharacterDataTypeId::Comment) => NodeConstants::COMMENT_NODE, NodeTypeId::Document(_) => NodeConstants::DOCUMENT_NODE, NodeTypeId::DocumentType => NodeConstants::DOCUMENT_TYPE_NODE, NodeTypeId::DocumentFragment => NodeConstants::DOCUMENT_FRAGMENT_NODE, NodeTypeId::Element(_) => NodeConstants::ELEMENT_NODE, } } // https://dom.spec.whatwg.org/#dom-node-nodename fn NodeName(&self) -> DOMString { match self.type_id() { NodeTypeId::Element(..) => { self.downcast::().unwrap().TagName() } NodeTypeId::CharacterData(CharacterDataTypeId::Text) => DOMString::from("#text"), NodeTypeId::CharacterData(CharacterDataTypeId::ProcessingInstruction) => { self.downcast::().unwrap().Target() } NodeTypeId::CharacterData(CharacterDataTypeId::Comment) => DOMString::from("#comment"), NodeTypeId::DocumentType => { self.downcast::().unwrap().name().clone() }, NodeTypeId::DocumentFragment => DOMString::from("#document-fragment"), NodeTypeId::Document(_) => DOMString::from("#document") } } // https://dom.spec.whatwg.org/#dom-node-baseuri fn BaseURI(&self) -> DOMString { self.owner_doc().URL() } // https://dom.spec.whatwg.org/#dom-node-ownerdocument fn GetOwnerDocument(&self) -> Option> { match self.type_id() { NodeTypeId::CharacterData(..) | NodeTypeId::Element(..) | NodeTypeId::DocumentType | NodeTypeId::DocumentFragment => Some(self.owner_doc()), NodeTypeId::Document(_) => None } } // https://dom.spec.whatwg.org/#dom-node-parentnode fn GetParentNode(&self) -> Option> { self.parent_node.get() } // https://dom.spec.whatwg.org/#dom-node-parentelement fn GetParentElement(&self) -> Option> { self.GetParentNode().and_then(Root::downcast) } // https://dom.spec.whatwg.org/#dom-node-haschildnodes fn HasChildNodes(&self) -> bool { self.first_child.get().is_some() } // https://dom.spec.whatwg.org/#dom-node-childnodes fn ChildNodes(&self) -> Root { self.child_list.or_init(|| { let doc = self.owner_doc(); let window = doc.window(); NodeList::new_child_list(window, self) }) } // https://dom.spec.whatwg.org/#dom-node-firstchild fn GetFirstChild(&self) -> Option> { self.first_child.get() } // https://dom.spec.whatwg.org/#dom-node-lastchild fn GetLastChild(&self) -> Option> { self.last_child.get() } // https://dom.spec.whatwg.org/#dom-node-previoussibling fn GetPreviousSibling(&self) -> Option> { self.prev_sibling.get() } // https://dom.spec.whatwg.org/#dom-node-nextsibling fn GetNextSibling(&self) -> Option> { self.next_sibling.get() } // https://dom.spec.whatwg.org/#dom-node-nodevalue fn GetNodeValue(&self) -> Option { self.downcast::().map(CharacterData::Data) } // https://dom.spec.whatwg.org/#dom-node-nodevalue fn SetNodeValue(&self, val: Option) { if let Some(character_data) = self.downcast::() { character_data.SetData(val.unwrap_or_default()); } } // https://dom.spec.whatwg.org/#dom-node-textcontent fn GetTextContent(&self) -> Option { match self.type_id() { NodeTypeId::DocumentFragment | NodeTypeId::Element(..) => { let content = Node::collect_text_contents(self.traverse_preorder()); Some(content) } NodeTypeId::CharacterData(..) => { let characterdata = self.downcast::().unwrap(); Some(characterdata.Data()) } NodeTypeId::DocumentType | NodeTypeId::Document(_) => { None } } } // https://dom.spec.whatwg.org/#dom-node-textcontent fn SetTextContent(&self, value: Option) { let value = value.unwrap_or_default(); match self.type_id() { NodeTypeId::DocumentFragment | NodeTypeId::Element(..) => { // Step 1-2. let node = if value.is_empty() { None } else { Some(Root::upcast(self.owner_doc().CreateTextNode(value))) }; // Step 3. Node::replace_all(node.r(), self); } NodeTypeId::CharacterData(..) => { let characterdata = self.downcast::().unwrap(); characterdata.SetData(value); } NodeTypeId::DocumentType | NodeTypeId::Document(_) => {} } } // https://dom.spec.whatwg.org/#dom-node-insertbefore fn InsertBefore(&self, node: &Node, child: Option<&Node>) -> Fallible> { Node::pre_insert(node, self, child) } // https://dom.spec.whatwg.org/#dom-node-appendchild fn AppendChild(&self, node: &Node) -> Fallible> { Node::pre_insert(node, self, None) } // https://dom.spec.whatwg.org/#concept-node-replace fn ReplaceChild(&self, node: &Node, child: &Node) -> Fallible> { // Step 1. match self.type_id() { NodeTypeId::Document(_) | NodeTypeId::DocumentFragment | NodeTypeId::Element(..) => (), _ => return Err(Error::HierarchyRequest) } // Step 2. if node.is_inclusive_ancestor_of(self) { return Err(Error::HierarchyRequest); } // Step 3. if !self.is_parent_of(child) { return Err(Error::NotFound); } // Step 4-5. match node.type_id() { NodeTypeId::CharacterData(CharacterDataTypeId::Text) if self.is::() => return Err(Error::HierarchyRequest), NodeTypeId::DocumentType if !self.is::() => return Err(Error::HierarchyRequest), NodeTypeId::Document(_) => return Err(Error::HierarchyRequest), _ => () } // Step 6. if self.is::() { match node.type_id() { // Step 6.1 NodeTypeId::DocumentFragment => { // Step 6.1.1(b) if node.children() .any(|c| c.is::()) { return Err(Error::HierarchyRequest); } match node.child_elements().count() { 0 => (), // Step 6.1.2 1 => { if self.child_elements().any(|c| c.upcast::() != child) { return Err(Error::HierarchyRequest); } if child.following_siblings() .any(|child| child.is_doctype()) { return Err(Error::HierarchyRequest); } }, // Step 6.1.1(a) _ => return Err(Error::HierarchyRequest) } }, // Step 6.2 NodeTypeId::Element(..) => { if self.child_elements() .any(|c| c.upcast::() != child) { return Err(Error::HierarchyRequest); } if child.following_siblings() .any(|child| child.is_doctype()) { return Err(Error::HierarchyRequest); } }, // Step 6.3 NodeTypeId::DocumentType => { if self.children() .any(|c| c.is_doctype() && c.r() != child) { return Err(Error::HierarchyRequest); } if self.children() .take_while(|c| c.r() != child) .any(|c| c.is::()) { return Err(Error::HierarchyRequest); } }, NodeTypeId::CharacterData(..) => (), NodeTypeId::Document(_) => unreachable!(), } } // Ok if not caught by previous error checks. if node == child { return Ok(Root::from_ref(child)); } // Step 7-8. let child_next_sibling = child.GetNextSibling(); let node_next_sibling = node.GetNextSibling(); let reference_child = if child_next_sibling.r() == Some(node) { node_next_sibling.r() } else { child_next_sibling.r() }; // Step 9. let document = document_from_node(self); Node::adopt(node, document.r()); // Step 10. let previous_sibling = child.GetPreviousSibling(); // Step 11. Node::remove(child, self, SuppressObserver::Suppressed); // Step 12. let mut nodes = RootedVec::new(); let nodes = if node.type_id() == NodeTypeId::DocumentFragment { nodes.extend(node.children().map(|node| JS::from_rooted(&node))); nodes.r() } else { ref_slice(&node) }; // Step 13. Node::insert(node, self, reference_child, SuppressObserver::Suppressed); // Step 14. vtable_for(&self).children_changed( &ChildrenMutation::replace(previous_sibling.r(), &child, nodes, reference_child)); // Step 15. Ok(Root::from_ref(child)) } // https://dom.spec.whatwg.org/#dom-node-removechild fn RemoveChild(&self, node: &Node) -> Fallible> { Node::pre_remove(node, self) } // https://dom.spec.whatwg.org/#dom-node-normalize fn Normalize(&self) { let mut prev_text: Option> = None; for child in self.children() { match child.downcast::() { Some(text) => { let characterdata = text.upcast::(); if characterdata.Length() == 0 { Node::remove(&*child, self, SuppressObserver::Unsuppressed); } else { match prev_text { Some(ref text_node) => { let prev_characterdata = text_node.upcast::(); prev_characterdata.append_data(&**characterdata.data()); Node::remove(&*child, self, SuppressObserver::Unsuppressed); }, None => prev_text = Some(Root::from_ref(text)) } } }, None => { child.Normalize(); prev_text = None; } } } } // https://dom.spec.whatwg.org/#dom-node-clonenode fn CloneNode(&self, deep: bool) -> Root { Node::clone(self, None, if deep { CloneChildrenFlag::CloneChildren } else { CloneChildrenFlag::DoNotCloneChildren }) } // https://dom.spec.whatwg.org/#dom-node-isequalnode fn IsEqualNode(&self, maybe_node: Option<&Node>) -> bool { fn is_equal_doctype(node: &Node, other: &Node) -> bool { let doctype = node.downcast::().unwrap(); let other_doctype = other.downcast::().unwrap(); (*doctype.name() == *other_doctype.name()) && (*doctype.public_id() == *other_doctype.public_id()) && (*doctype.system_id() == *other_doctype.system_id()) } fn is_equal_element(node: &Node, other: &Node) -> bool { let element = node.downcast::().unwrap(); let other_element = other.downcast::().unwrap(); (*element.namespace() == *other_element.namespace()) && (*element.prefix() == *other_element.prefix()) && (*element.local_name() == *other_element.local_name()) && (element.attrs().len() == other_element.attrs().len()) } fn is_equal_processinginstruction(node: &Node, other: &Node) -> bool { let pi = node.downcast::().unwrap(); let other_pi = other.downcast::().unwrap(); (*pi.target() == *other_pi.target()) && (*pi.upcast::().data() == *other_pi.upcast::().data()) } fn is_equal_characterdata(node: &Node, other: &Node) -> bool { let characterdata = node.downcast::().unwrap(); let other_characterdata = other.downcast::().unwrap(); *characterdata.data() == *other_characterdata.data() } fn is_equal_element_attrs(node: &Node, other: &Node) -> bool { let element = node.downcast::().unwrap(); let other_element = other.downcast::().unwrap(); assert!(element.attrs().len() == other_element.attrs().len()); element.attrs().iter().all(|attr| { other_element.attrs().iter().any(|other_attr| { (*attr.namespace() == *other_attr.namespace()) && (attr.local_name() == other_attr.local_name()) && (**attr.value() == **other_attr.value()) }) }) } fn is_equal_node(this: &Node, node: &Node) -> bool { // Step 2. if this.type_id() != node.type_id() { return false; } match node.type_id() { // Step 3. NodeTypeId::DocumentType if !is_equal_doctype(this, node) => return false, NodeTypeId::Element(..) if !is_equal_element(this, node) => return false, NodeTypeId::CharacterData(CharacterDataTypeId::ProcessingInstruction) if !is_equal_processinginstruction(this, node) => return false, NodeTypeId::CharacterData(CharacterDataTypeId::Text) | NodeTypeId::CharacterData(CharacterDataTypeId::Comment) if !is_equal_characterdata(this, node) => return false, // Step 4. NodeTypeId::Element(..) if !is_equal_element_attrs(this, node) => return false, _ => () } // Step 5. if this.children_count() != node.children_count() { return false; } // Step 6. this.children().zip(node.children()).all(|(child, other_child)| { is_equal_node(child.r(), other_child.r()) }) } match maybe_node { // Step 1. None => false, // Step 2-6. Some(node) => is_equal_node(self, node) } } // https://dom.spec.whatwg.org/#dom-node-comparedocumentposition fn CompareDocumentPosition(&self, other: &Node) -> u16 { if self == other { // step 2. 0 } else { let mut lastself = Root::from_ref(self); let mut lastother = Root::from_ref(other); for ancestor in self.ancestors() { if ancestor.r() == other { // step 4. return NodeConstants::DOCUMENT_POSITION_CONTAINS + NodeConstants::DOCUMENT_POSITION_PRECEDING; } lastself = ancestor; } for ancestor in other.ancestors() { if ancestor.r() == self { // step 5. return NodeConstants::DOCUMENT_POSITION_CONTAINED_BY + NodeConstants::DOCUMENT_POSITION_FOLLOWING; } lastother = ancestor; } if lastself != lastother { let abstract_uint: uintptr_t = as_uintptr(&self); let other_uint: uintptr_t = as_uintptr(&*other); let random = if abstract_uint < other_uint { NodeConstants::DOCUMENT_POSITION_FOLLOWING } else { NodeConstants::DOCUMENT_POSITION_PRECEDING }; // step 3. return random + NodeConstants::DOCUMENT_POSITION_DISCONNECTED + NodeConstants::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC; } for child in lastself.traverse_preorder() { if child.r() == other { // step 6. return NodeConstants::DOCUMENT_POSITION_PRECEDING; } if child.r() == self { // step 7. return NodeConstants::DOCUMENT_POSITION_FOLLOWING; } } unreachable!() } } // https://dom.spec.whatwg.org/#dom-node-contains fn Contains(&self, maybe_other: Option<&Node>) -> bool { match maybe_other { None => false, Some(other) => self.is_inclusive_ancestor_of(other) } } // https://dom.spec.whatwg.org/#dom-node-lookupprefix fn LookupPrefix(&self, namespace: Option) -> Option { let namespace = namespace_from_domstring(namespace); // Step 1. if namespace == ns!() { return None; } // Step 2. match self.type_id() { NodeTypeId::Element(..) => { self.downcast::().unwrap().lookup_prefix(namespace) }, NodeTypeId::Document(_) => { self.downcast::().unwrap().GetDocumentElement().and_then(|element| { element.lookup_prefix(namespace) }) }, NodeTypeId::DocumentType | NodeTypeId::DocumentFragment => None, _ => { self.GetParentElement().and_then(|element| { element.lookup_prefix(namespace) }) } } } // https://dom.spec.whatwg.org/#dom-node-lookupnamespaceuri fn LookupNamespaceURI(&self, prefix: Option) -> Option { // Step 1. let prefix = match prefix { Some(ref p) if p.is_empty() => None, pre => pre }; // Step 2. Node::namespace_to_string(Node::locate_namespace(self, prefix)) } // https://dom.spec.whatwg.org/#dom-node-isdefaultnamespace fn IsDefaultNamespace(&self, namespace: Option) -> bool { // Step 1. let namespace = namespace_from_domstring(namespace); // Steps 2 and 3. Node::locate_namespace(self, None) == namespace } } /// The address of a node known to be valid. These are sent from script to layout, /// and are also used in the HTML parser interface. #[derive(Clone, PartialEq, Eq, Copy)] pub struct TrustedNodeAddress(pub *const c_void); #[allow(unsafe_code)] unsafe impl Send for TrustedNodeAddress {} pub fn document_from_node + Reflectable>(derived: &T) -> Root { derived.upcast().owner_doc() } pub fn window_from_node + Reflectable>(derived: &T) -> Root { let document = document_from_node(derived); Root::from_ref(document.window()) } impl VirtualMethods for Node { fn super_type(&self) -> Option<&VirtualMethods> { Some(self.upcast::() as &VirtualMethods) } fn children_changed(&self, mutation: &ChildrenMutation) { if let Some(ref s) = self.super_type() { s.children_changed(mutation); } match *mutation { ChildrenMutation::Append { added, .. } | ChildrenMutation::Insert { added, .. } | ChildrenMutation::Prepend { added, .. } => { self.children_count.set( self.children_count.get() + added.len() as u32); }, ChildrenMutation::Replace { added, .. } => { self.children_count.set( self.children_count.get() - 1u32 + added.len() as u32); }, ChildrenMutation::ReplaceAll { added, .. } => { self.children_count.set(added.len() as u32); }, } if let Some(list) = self.child_list.get() { list.as_children_list().children_changed(mutation); } } } /// A summary of the changes that happened to a node. #[derive(Copy, Clone, PartialEq, HeapSizeOf)] pub enum NodeDamage { /// The node's `style` attribute changed. NodeStyleDamaged, /// Other parts of a node changed; attributes, text content, etc. OtherNodeDamage, } pub enum ChildrenMutation<'a> { Append { prev: &'a Node, added: &'a [&'a Node] }, Insert { prev: &'a Node, added: &'a [&'a Node], next: &'a Node }, Prepend { added: &'a [&'a Node], next: &'a Node }, Replace { prev: Option<&'a Node>, removed: &'a Node, added: &'a [&'a Node], next: Option<&'a Node>, }, ReplaceAll { removed: &'a [&'a Node], added: &'a [&'a Node] }, } impl<'a> ChildrenMutation<'a> { fn insert(prev: Option<&'a Node>, added: &'a [&'a Node], next: Option<&'a Node>) -> ChildrenMutation<'a> { match (prev, next) { (None, None) => { ChildrenMutation::ReplaceAll { removed: &[], added: added } }, (Some(prev), None) => { ChildrenMutation::Append { prev: prev, added: added } }, (None, Some(next)) => { ChildrenMutation::Prepend { added: added, next: next } }, (Some(prev), Some(next)) => { ChildrenMutation::Insert { prev: prev, added: added, next: next } }, } } fn replace(prev: Option<&'a Node>, removed: &'a &'a Node, added: &'a [&'a Node], next: Option<&'a Node>) -> ChildrenMutation<'a> { if let (None, None) = (prev, next) { ChildrenMutation::ReplaceAll { removed: ref_slice(removed), added: added, } } else { ChildrenMutation::Replace { prev: prev, removed: *removed, added: added, next: next, } } } fn replace_all(removed: &'a [&'a Node], added: &'a [&'a Node]) -> ChildrenMutation<'a> { ChildrenMutation::ReplaceAll { removed: removed, added: added } } }