Introduce VirtualMethods::children_changed()

This virtual method mimics the behaviour of mutation observers and make it more
viable than the older child_inserted(), which didn't cover removed nodes and
was called as many times as there were inserted nodes.

A few other shortcomings where remove_child() was called directly instead of
Node::remove() were also fixed while at it.

components/script/dom/htmlscriptelement.rs

@@ -27,7 +27,8 @@ use dom::eventtarget::{EventTarget, EventTargetTypeId};
 use dom::event::{Event, EventBubbles, EventCancelable, EventHelpers};
 use dom::element::ElementTypeId;
 use dom::htmlelement::{HTMLElement, HTMLElementTypeId};
-use dom::node::{Node, NodeHelpers, NodeTypeId, document_from_node, window_from_node, CloneChildrenFlag};
+use dom::node::{ChildrenMutation, CloneChildrenFlag, Node, NodeHelpers};
+use dom::node::{NodeTypeId, document_from_node, window_from_node};
 use dom::servohtmlparser::ServoHTMLParserHelpers;
 use dom::virtualmethods::VirtualMethods;
 use dom::window::{WindowHelpers, ScriptHelpers};
@@ -564,9 +565,9 @@ impl<'a> VirtualMethods for &'a HTMLScriptElement {
         }
     }
 
-    fn child_inserted(&self, child: &Node) {
+    fn children_changed(&self, mutation: &ChildrenMutation) {
         if let Some(ref s) = self.super_type() {
-            s.child_inserted(child);
+            s.children_changed(mutation);
         }
         let node = NodeCast::from_ref(*self);
         if !self.parser_inserted.get() && node.is_in_doc() {

components/script/dom/htmlstyleelement.rs

@@ -11,7 +11,8 @@ use dom::document::Document;
 use dom::eventtarget::{EventTarget, EventTargetTypeId};
 use dom::element::{ElementTypeId, AttributeHandlers};
 use dom::htmlelement::{HTMLElement, HTMLElementTypeId};
-use dom::node::{Node, NodeHelpers, NodeTypeId, window_from_node};
+use dom::node::{ChildrenMutation, Node, NodeHelpers, NodeTypeId};
+use dom::node::window_from_node;
 use dom::virtualmethods::VirtualMethods;
 use dom::window::WindowHelpers;
 use layout_interface::{LayoutChan, Msg};
@@ -86,11 +87,10 @@ impl<'a> VirtualMethods for &'a HTMLStyleElement {
         Some(htmlelement as &VirtualMethods)
     }
 
-    fn child_inserted(&self, child: &Node) {
+    fn children_changed(&self, mutation: &ChildrenMutation) {
         if let Some(ref s) = self.super_type() {
-            s.child_inserted(child);
+            s.children_changed(mutation);
         }
-
         let node = NodeCast::from_ref(*self);
         if node.is_in_doc() {
             self.parse_own_css();

components/script/dom/htmltextareaelement.rs

@@ -11,7 +11,7 @@ use dom::bindings::codegen::Bindings::HTMLTextAreaElementBinding::HTMLTextAreaEl
 use dom::bindings::codegen::Bindings::NodeBinding::NodeMethods;
 use dom::bindings::codegen::InheritTypes::{ElementCast, EventTargetCast, HTMLElementCast, NodeCast};
 use dom::bindings::codegen::InheritTypes::{HTMLTextAreaElementDerived, HTMLFieldSetElementDerived};
-use dom::bindings::codegen::InheritTypes::{KeyboardEventCast, TextDerived};
+use dom::bindings::codegen::InheritTypes::KeyboardEventCast;
 use dom::bindings::global::GlobalRef;
 use dom::bindings::js::{LayoutJS, Root};
 use dom::bindings::refcounted::Trusted;
@@ -23,8 +23,8 @@ use dom::element::ElementTypeId;
 use dom::htmlelement::{HTMLElement, HTMLElementTypeId};
 use dom::htmlformelement::FormControl;
 use dom::keyboardevent::KeyboardEvent;
-use dom::node::{DisabledStateHelpers, Node, NodeHelpers, NodeDamage, NodeTypeId};
+use dom::node::{ChildrenMutation, DisabledStateHelpers, Node, NodeDamage};
-use dom::node::{document_from_node, window_from_node};
+use dom::node::{NodeHelpers, NodeTypeId, document_from_node, window_from_node};
 use textinput::{TextInput, Lines, KeyReaction};
 use dom::virtualmethods::VirtualMethods;
 use dom::window::WindowHelpers;
@@ -330,12 +330,11 @@ impl<'a> VirtualMethods for &'a HTMLTextAreaElement {
         }
     }
 
-    fn child_inserted(&self, child: &Node) {
+    fn children_changed(&self, mutation: &ChildrenMutation) {
-        if let Some(s) = self.super_type() {
+        if let Some(ref s) = self.super_type() {
-            s.child_inserted(child);
+            s.children_changed(mutation);
         }
-
+        if !self.value_changed.get() {
-        if child.is_text() && !self.value_changed.get() {
             self.reset();
         }
     }

components/script/dom/htmltitleelement.rs

@@ -13,7 +13,7 @@ use dom::document::{Document, DocumentHelpers};
 use dom::eventtarget::{EventTarget, EventTargetTypeId};
 use dom::element::ElementTypeId;
 use dom::htmlelement::{HTMLElement, HTMLElementTypeId};
-use dom::node::{Node, NodeHelpers, NodeTypeId};
+use dom::node::{ChildrenMutation, Node, NodeHelpers, NodeTypeId};
 use dom::text::Text;
 use dom::virtualmethods::VirtualMethods;
 use util::str::DOMString;
@@ -75,15 +75,13 @@ impl<'a> VirtualMethods for &'a HTMLTitleElement {
         Some(htmlelement as &VirtualMethods)
     }
 
-    fn child_inserted(&self, child: &Node) {
+    fn children_changed(&self, mutation: &ChildrenMutation) {
         if let Some(ref s) = self.super_type() {
-            s.child_inserted(child);
+            s.children_changed(mutation);
         }
-
         let node = NodeCast::from_ref(*self);
         if node.is_in_doc() {
-            let document = node.owner_doc();
+            node.owner_doc().title_changed();
-            document.r().title_changed();
         }
     }
 

components/script/dom/node.rs

@@ -67,6 +67,7 @@ use std::cell::{Cell, RefCell, Ref, RefMut};
 use std::default::Default;
 use std::iter::{FilterMap, Peekable};
 use std::mem;
+use std::slice::ref_slice;
 use std::sync::Arc;
 use uuid;
 use string_cache::{Atom, Namespace, QualName};
@@ -282,42 +283,11 @@ pub enum NodeTypeId {
 }
 
 trait PrivateNodeHelpers {
-    fn node_inserted(self);
-    fn node_removed(self, parent_in_doc: bool);
     fn add_child(self, new_child: &Node, before: Option<&Node>);
     fn remove_child(self, child: &Node);
 }
 
 impl<'a> PrivateNodeHelpers for &'a Node {
-    // https://dom.spec.whatwg.org/#node-is-inserted
-    fn node_inserted(self) {
-        assert!(self.parent_node.get().is_some());
-        let document = document_from_node(self);
-        let is_in_doc = self.is_in_doc();
-
-        for node in self.traverse_preorder() {
-            vtable_for(&node.r()).bind_to_tree(is_in_doc);
-        }
-
-        let parent = self.parent_node.get().map(Root::from_rooted);
-        parent.r().map(|parent| vtable_for(&parent).child_inserted(self));
-        document.r().content_and_heritage_changed(self, NodeDamage::OtherNodeDamage);
-    }
-
-    // https://dom.spec.whatwg.org/#node-is-removed
-    fn node_removed(self, parent_in_doc: bool) {
-        assert!(self.parent_node.get().is_none());
-        for node in self.traverse_preorder() {
-            node.r().set_flag(IS_IN_DOC, false);
-            vtable_for(&node.r()).unbind_from_tree(parent_in_doc);
-        }
-        self.layout_data.dispose(self);
-    }
-
-    //
-    // Pointer stitching
-    //
-
     /// Adds a new child to the end of this node's list of children.
     ///
     /// Fails unless `new_child` is disconnected from the tree.
@@ -358,6 +328,14 @@ impl<'a> PrivateNodeHelpers for &'a Node {
         }
 
         new_child.parent_node.set(Some(JS::from_ref(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.
@@ -387,6 +365,15 @@ impl<'a> PrivateNodeHelpers for &'a Node {
         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);
+        }
+        child.layout_data.dispose(child);
+        let document = child.owner_doc();
+        document.content_and_heritage_changed(child, NodeDamage::OtherNodeDamage);
     }
 }
 
@@ -971,9 +958,8 @@ impl<'a> NodeHelpers for &'a Node {
     }
 
     fn remove_self(self) {
-        match self.parent_node.get() {
+        if let Some(ref parent) = self.GetParentNode() {
-            Some(parent) => parent.root().r().remove_child(self),
+            Node::remove(self, parent.r(), SuppressObserver::Unsuppressed);
-            None => ()
         }
     }
 
@@ -1643,110 +1629,79 @@ impl Node {
               parent: &Node,
               child: Option<&Node>,
               suppress_observers: SuppressObserver) {
-        fn do_insert(node: &Node, parent: &Node, child: Option<&Node>) {
+        debug_assert!(&*node.owner_doc() == &*parent.owner_doc());
-            parent.add_child(node, child);
+        debug_assert!(child.map_or(true, |child| Some(parent) == child.GetParentNode().r()));
-            let is_in_doc = parent.is_in_doc();
+
-            for kid in node.traverse_preorder() {
+        // Steps 1-2: ranges.
-                let mut flags = kid.r().flags.get();
+        let mut new_nodes = RootedVec::new();
-                if is_in_doc {
+        let new_nodes = if let NodeTypeId::DocumentFragment = node.type_id() {
-                    flags.insert(IS_IN_DOC);
+            // Step 3.
-                } else {
+            new_nodes.extend(node.children().map(|kid| JS::from_rooted(&kid)));
-                    flags.remove(IS_IN_DOC);
+            // Step 4: mutation observers.
-                }
+            // Step 5.
-                kid.r().flags.set(flags);
+            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 {
-        fn fire_observer_if_necessary(node: &Node, suppress_observers: SuppressObserver) {
+            vtable_for(&parent).children_changed(
-            match suppress_observers {
+                &ChildrenMutation::insert(previous_sibling.r(), new_nodes, child));
-                SuppressObserver::Unsuppressed => node.node_inserted(),
-                SuppressObserver::Suppressed => ()
-            }
-        }
-
-        // XXX assert owner_doc
-        // Step 1-3: ranges.
-
-        match node.type_id() {
-            NodeTypeId::DocumentFragment => {
-                // Step 4.
-                // Step 5: DocumentFragment, mutation records.
-                // Step 6: DocumentFragment.
-                let kids: Vec<Root<Node>> = node.children().collect();
-                for kid in &kids {
-                    Node::remove(kid.r(), node, SuppressObserver::Suppressed);
-                }
-
-                // Step 7: mutation records.
-                // Step 8.
-                for kid in &kids {
-                    do_insert(kid.r(), parent, child);
-                }
-
-                for kid in kids {
-                    fire_observer_if_necessary(kid.r(), suppress_observers);
-                }
-            }
-            _ => {
-                // Step 4.
-                // Step 5: DocumentFragment, mutation records.
-                // Step 6: DocumentFragment.
-                // Step 7: mutation records.
-                // Step 8.
-                do_insert(node, parent, child);
-                // Step 9.
-                fire_observer_if_necessary(node, suppress_observers);
-            }
         }
     }
 
     // https://dom.spec.whatwg.org/#concept-node-replace-all
     pub fn replace_all(node: Option<&Node>, parent: &Node) {
         // Step 1.
-        match node {
+        if let Some(node) = node {
-            Some(node) => {
+            Node::adopt(node, &*parent.owner_doc());
-                let document = document_from_node(parent);
-                Node::adopt(node, document.r());
-            }
-            None => (),
         }
-
         // Step 2.
-        let mut removed_nodes: RootedVec<JS<Node>> = RootedVec::new();
+        let mut removed_nodes = RootedVec::new();
-        for child in parent.children() {
+        removed_nodes.extend(parent.children().map(|child| JS::from_rooted(&child)));
-            removed_nodes.push(JS::from_rooted(&child));
-        }
-
         // Step 3.
-        let added_nodes = match node {
+        let mut added_nodes = RootedVec::new();
-            None => vec!(),
+        let added_nodes = if let Some(node) = node.as_ref() {
-            Some(node) => match node.type_id() {
+            if let NodeTypeId::DocumentFragment = node.type_id() {
-                NodeTypeId::DocumentFragment => node.children().collect(),
+                added_nodes.extend(node.children().map(|child| JS::from_rooted(&child)));
-                _ => vec!(Root::from_ref(node)),
+                added_nodes.r()
-            },
+            } else {
+                ref_slice(node)
+            }
+        } else {
+            &[] as &[&Node]
         };
-
         // Step 4.
-        for child in parent.children() {
+        for child in removed_nodes.r() {
-            Node::remove(child.r(), parent, SuppressObserver::Suppressed);
+            Node::remove(*child, parent, SuppressObserver::Suppressed);
         }
-
         // Step 5.
-        match node {
+        if let Some(node) = node {
-            Some(node) => Node::insert(node, parent, None, SuppressObserver::Suppressed),
+            Node::insert(node, parent, None, SuppressObserver::Suppressed);
-            None => (),
-        }
-
-        // Step 6: mutation records.
-
-        // Step 7.
-        let parent_in_doc = parent.is_in_doc();
-        for removed_node in removed_nodes.iter() {
-            removed_node.root().r().node_removed(parent_in_doc);
-        }
-        for added_node in added_nodes {
-            added_node.r().node_inserted();
         }
+        // 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
@@ -1766,16 +1721,22 @@ impl Node {
     }
 
     // https://dom.spec.whatwg.org/#concept-node-remove
-    fn remove(node: &Node, parent: &Node, _suppress_observers: SuppressObserver) {
+    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-7: mutation observers.
+        // Step 6.
-        // Step 8.
+        let old_previous_sibling = node.GetPreviousSibling();
-        parent.remove_child(node);
+        // Steps 7-8: mutation observers.
-
         // Step 9.
-        node.node_removed(parent.is_in_doc());
+        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
@@ -2280,36 +2241,31 @@ impl<'a> NodeMethods for &'a Node {
         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<JS<Node>> = RootedVec::new();
+        let mut nodes = RootedVec::new();
-        if node.type_id() == NodeTypeId::DocumentFragment {
+        let nodes = if node.type_id() == NodeTypeId::DocumentFragment {
-            // Collect fragment children before Step 11,
+            nodes.extend(node.children().map(|node| JS::from_rooted(&node)));
-            // because Node::insert removes a DocumentFragment's children,
+            nodes.r()
-            // and we need them in Step 13.
-            // Issue filed against the spec:
-            // https://www.w3.org/Bugs/Public/show_bug.cgi?id=28330
-            for child_node in node.children() {
-                nodes.push(JS::from_rooted(&child_node));
-            }
         } else {
-            nodes.push(JS::from_ref(node));
+            ref_slice(&node)
-        }
+        };
 
-        {
+        // Step 13.
-            // Step 10.
+        Node::insert(node, self, reference_child, SuppressObserver::Suppressed);
-            Node::remove(child, self, SuppressObserver::Suppressed);
-
-            // Step 11.
-            Node::insert(node, self, reference_child, SuppressObserver::Suppressed);
-        }
-
-        // Step 13: mutation records.
-        child.node_removed(self.is_in_doc());
-        for child_node in &*nodes {
-            child_node.root().r().node_inserted();
-        }
 
         // Step 14.
+        vtable_for(&self).children_changed(
+            &ChildrenMutation::replace(previous_sibling.r(),
+                                       &child, nodes,
+                                       reference_child));
+
+        // Step 15.
         Ok(Root::from_ref(child))
     }
 
@@ -2327,14 +2283,14 @@ impl<'a> NodeMethods for &'a Node {
                 Some(text) => {
                     let characterdata: &CharacterData = CharacterDataCast::from_ref(text);
                     if characterdata.Length() == 0 {
-                        self.remove_child(child.r());
+                        Node::remove(&*child, self, SuppressObserver::Unsuppressed);
                     } else {
                         match prev_text {
                             Some(ref text_node) => {
                                 let prev_characterdata =
                                     CharacterDataCast::from_ref(text_node.r());
                                 prev_characterdata.append_data(&**characterdata.data());
-                                self.remove_child(child.r());
+                                Node::remove(&*child, self, SuppressObserver::Unsuppressed);
                             },
                             None => prev_text = Some(Root::from_ref(text))
                         }
@@ -2640,3 +2596,61 @@ pub enum NodeDamage {
     /// 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 }
+    }
+}

components/script/dom/virtualmethods.rs

@@ -35,7 +35,8 @@ use dom::document::Document;
 use dom::element::ElementTypeId;
 use dom::event::Event;
 use dom::htmlelement::HTMLElementTypeId;
-use dom::node::{Node, NodeHelpers, NodeTypeId, CloneChildrenFlag};
+use dom::node::{ChildrenMutation, CloneChildrenFlag, Node, NodeHelpers};
+use dom::node::NodeTypeId;
 
 use util::str::DOMString;
 
@@ -97,10 +98,10 @@ pub trait VirtualMethods {
         }
     }
 
-    /// Called on the parent when a node is added to its child list.
+    /// Called on the parent when its children are changed.
-    fn child_inserted(&self, child: &Node) {
+    fn children_changed(&self, mutation: &ChildrenMutation) {
         if let Some(ref s) = self.super_type() {
-            s.child_inserted(child);
+            s.children_changed(mutation);
         }
     }
 

components/script/lib.rs

@@ -19,6 +19,7 @@
 #![feature(nonzero)]
 #![feature(owned_ascii_ext)]
 #![feature(plugin)]
+#![feature(ref_slice)]
 #![feature(rc_unique)]
 #![feature(slice_chars)]
 #![feature(str_utf16)]