Move interfaces into markup5ever

- Moves `TreeSink` into markup5ever, and applies to xhtml5ever.
- Renames `QName` from xml5ever to `QualName`.
- Adds `prefix` field to `QualName`.
- Moves `Attributes` into markup5ever

Author: Ygg01

html5ever/src/driver.rs

@@ -9,18 +9,18 @@
 
 //! High-level interface to the parser.
 
-use tokenizer::{Attribute, Tokenizer, TokenizerOpts, TokenizerResult};
 use tokenizer::buffer_queue::BufferQueue;
+use tokenizer::{Tokenizer, TokenizerOpts, TokenizerResult};
 use tree_builder::{TreeBuilderOpts, TreeBuilder, TreeSink};
 
 use std::borrow::Cow;
 use std::mem;
 
 use encoding::{self, EncodingRef};
-use QualName;
 use tendril;
 use tendril::{StrTendril, ByteTendril};
 use tendril::stream::{TendrilSink, Utf8LossyDecoder, LossyDecoder};
+use markup5ever::{Attribute, QualName};
 
 /// All-encompassing options struct for the parser.
 #[derive(Clone, Default)]

html5ever/src/lib.rs

@@ -24,7 +24,6 @@
 extern crate phf;
 
 pub use markup5ever::*;
-pub use tokenizer::Attribute;
 pub use driver::{ParseOpts, parse_document, parse_fragment, Parser};
 
 pub use serialize::serialize;

html5ever/src/rcdom.rs

@@ -25,7 +25,7 @@ use std::rc::{Rc, Weak};
 use tendril::StrTendril;
 
 use QualName;
-use tokenizer::Attribute;
+use markup5ever::Attribute;
 use tree_builder::{TreeSink, QuirksMode, NodeOrText, AppendNode, AppendText};
 use tree_builder;
 use serialize::{Serializable, Serializer};
@@ -193,6 +193,10 @@ impl TreeSink for RcDom {
         same_node(&x, &y)
     }
 
+    fn same_node_ref(&self, x: &Handle, y: &Handle) -> bool {
+        same_node(x, y)
+    }
+
     fn elem_name(&self, target: Handle) -> QualName {
         // FIXME: rust-lang/rust#22252
         if let Element(ref name, _, _) = target.borrow().node {
@@ -202,6 +206,14 @@ impl TreeSink for RcDom {
         }
     }
 
+    fn elem_name_ref(&self, target: &Handle) -> QualName {
+        return match target.borrow().node {
+            Element(ref name, _, _) => name.clone(),
+            _ => panic!("not an element!"),
+        };
+    }
+
+
     fn create_element(&mut self, name: QualName, attrs: Vec<Attribute>) -> Handle {
         let info = match name {
             qualname!(html, "script") => Script(false),
@@ -223,6 +235,11 @@ impl TreeSink for RcDom {
         new_node(Comment(text))
     }
 
+    #[allow(unused_variables)]
+    fn create_pi(&mut self, target: StrTendril, data: StrTendril) -> Handle{
+        panic!(" HTML files, can't create PI")
+    }
+
     fn has_parent_node(&self, node: Handle) -> bool {
         let node = node.borrow();
         node.parent.is_some()

html5ever/src/tokenizer/interface.rs

@@ -11,8 +11,9 @@ use tokenizer::states;
 
 use std::borrow::Cow;
 
-use {LocalName, QualName};
+use {LocalName};
 use tendril::StrTendril;
+use markup5ever::interface::Attribute;
 
 pub use self::TagKind::{StartTag, EndTag};
 pub use self::Token::{DoctypeToken, TagToken, CommentToken, CharacterTokens};
@@ -39,18 +40,6 @@ impl Doctype {
     }
 }
 
-/// A tag attribute.
-///
-/// The namespace on the attribute name is almost always ns!("").
-/// The tokenizer creates all attributes this way, but the tree
-/// builder will adjust certain attribute names inside foreign
-/// content (MathML, SVG).
-#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug)]
-pub struct Attribute {
-    pub name: QualName,
-    pub value: StrTendril,
-}
-
 #[derive(PartialEq, Eq, Hash, Copy, Clone, Debug)]
 pub enum TagKind {
     StartTag,

html5ever/src/tokenizer/mod.rs

@@ -9,7 +9,7 @@
 
 //! The HTML5 tokenizer.
 
-pub use self::interface::{Doctype, Attribute, TagKind, StartTag, EndTag, Tag};
+pub use self::interface::{Doctype, TagKind, StartTag, EndTag, Tag};
 pub use self::interface::{Token, DoctypeToken, TagToken, CommentToken};
 pub use self::interface::{CharacterTokens, NullCharacterToken, EOFToken, ParseError};
 pub use self::interface::{TokenSink, TokenSinkResult};
@@ -34,6 +34,8 @@ use std::collections::BTreeMap;
 use {LocalName, QualName};
 use tendril::StrTendril;
 use markup5ever::SmallCharSet;
+use markup5ever::interface::{Attribute};
+pub use markup5ever::util::buffer_queue::{BufferQueue, SetResult, FromSet, NotFromSet};
 
 pub mod buffer_queue;
 pub mod states;

html5ever/src/tree_builder/actions.rs

@@ -14,10 +14,10 @@
 
 use tree_builder::types::*;
 use tree_builder::tag_sets::*;
-use tree_builder::interface::{TreeSink, QuirksMode, NodeOrText, AppendNode, AppendText};
+use markup5ever::interface::{Attribute, TreeSink, QuirksMode, NodeOrText, AppendNode, AppendText};
 use tree_builder::rules::TreeBuilderStep;
 
-use tokenizer::{Attribute, Tag, StartTag, EndTag};
+use tokenizer::{Tag, StartTag, EndTag};
 use tokenizer::states::{RawData, RawKind};
 
 use util::str::to_escaped_string;
@@ -568,7 +568,7 @@ impl<Handle, Sink> TreeBuilderActions<Handle>
 
     fn generate_implied_end_except(&mut self, except: LocalName) {
         self.generate_implied_end(|p| match p {
-            QualName { ns: ns!(html), ref local } if *local == except => false,
+            QualName { ns: ns!(html), ref local, .. } if *local == except => false,
             _ => cursory_implied_end(p),
         });
     }
@@ -667,7 +667,7 @@ impl<Handle, Sink> TreeBuilderActions<Handle>
                 node = ctx;
             }
             let name = match self.sink.elem_name(node.clone()) {
-                QualName { ns: ns!(html), local } => local,
+                QualName { ns: ns!(html), local, .. } => local,
                 _ => continue,
             };
             match name {

html5ever/src/tree_builder/data.rs

@@ -8,7 +8,7 @@
 // except according to those terms.
 
 use tokenizer::Doctype;
-use tree_builder::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
+use markup5ever::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
 
 use std::ascii::AsciiExt;
 use tendril::StrTendril;

html5ever/src/tree_builder/mod.rs

@@ -11,9 +11,9 @@
 
 //! The HTML5 tree builder.
 
-pub use self::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
-pub use self::interface::{NodeOrText, AppendNode, AppendText};
-pub use self::interface::{TreeSink, Tracer};
+pub use markup5ever::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
+pub use markup5ever::interface::{NodeOrText, AppendNode, AppendText};
+pub use markup5ever::interface::{TreeSink, Tracer};
 
 use self::types::*;
 use self::actions::TreeBuilderActions;
@@ -34,8 +34,7 @@ use std::borrow::Cow::Borrowed;
 use std::collections::VecDeque;
 
 #[macro_use] mod tag_sets;
-// "pub" is a workaround for rust#18241 (?)
-pub mod interface;
+
 mod data;
 mod types;
 mod actions;
@@ -222,7 +221,7 @@ impl<Handle, Sink> TreeBuilder<Handle, Sink>
     pub fn tokenizer_state_for_context_elem(&self) -> tok_state::State {
         let elem = self.context_elem.clone().expect("no context element");
         let name = match self.sink.elem_name(elem) {
-            QualName { ns: ns!(html), local } => local,
+            QualName { ns: ns!(html), local, .. } => local,
             _ => return tok_state::Data
         };
         match name {
@@ -280,7 +279,7 @@ impl<Handle, Sink> TreeBuilder<Handle, Sink>
         println!("dump_state on {}", label);
         print!("    open_elems:");
         for node in self.open_elems.iter() {
-            let QualName { ns, local } = self.sink.elem_name(node.clone());
+            let QualName { ns, local, .. } = self.sink.elem_name(node.clone());
             match ns {
                 ns!(html) => print!(" {}", &local[..]),
                 _ => panic!(),
@@ -292,7 +291,7 @@ impl<Handle, Sink> TreeBuilder<Handle, Sink>
             match entry {
                 &Marker => print!(" Marker"),
                 &Element(ref h, _) => {
-                    let QualName { ns, local } = self.sink.elem_name(h.clone());
+                    let QualName { ns, local, .. } = self.sink.elem_name(h.clone());
                     match ns {
                         ns!(html) => print!(" {}", &local[..]),
                         _ => panic!(),
@@ -501,9 +500,9 @@ impl<Handle, Sink> TokenSink
 #[cfg(test)]
 #[allow(non_snake_case)]
 mod test {
-    use super::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
-    use super::interface::{NodeOrText, AppendNode, AppendText};
-    use super::interface::{TreeSink, Tracer};
+    use markup5ever::interface::{QuirksMode, Quirks, LimitedQuirks, NoQuirks};
+    use markup5ever::interface::{NodeOrText, AppendNode, AppendText};
+    use markup5ever::interface::{TreeSink, Tracer};
 
     use super::types::*;
     use super::actions::TreeBuilderActions;
@@ -528,7 +527,7 @@ mod test {
 
     use driver::*;
     use super::{TreeBuilderOpts, TreeBuilder};
-    use tokenizer::Attribute;
+    use markup5ever::Attribute;
     use rcdom::{Node, Handle, RcDom, NodeEnum, ElementEnum};
 
     pub struct LineCountingDOM {
@@ -564,10 +563,18 @@ mod test {
             self.rcdom.same_node(x, y)
         }
 
+        fn same_node_ref(&self, x: &Handle, y: &Handle) -> bool {
+            self.rcdom.same_node_ref(x, y)
+        }
+
         fn elem_name(&self, target: Handle) -> QualName {
             self.rcdom.elem_name(target)
         }
 
+        fn elem_name_ref(&self, target: &Handle) -> QualName {
+            self.rcdom.elem_name_ref(target)
+        }
+
         fn create_element(&mut self, name: QualName, attrs: Vec<Attribute>) -> Handle {
             self.line_vec.push((name.clone(), self.current_line));
             self.rcdom.create_element(name, attrs)
@@ -577,6 +584,10 @@ mod test {
             self.rcdom.create_comment(text)
         }
 
+        fn create_pi(&mut self, target: StrTendril, content: StrTendril) -> Handle {
+            self.rcdom.create_pi(target, content)
+        }
+
         fn has_parent_node(&self, node: Handle) -> bool {
             let node = node.borrow();
             node.parent.is_some()

html5ever/src/tree_builder/rules.rs

@@ -12,9 +12,7 @@
 use tree_builder::types::*;
 use tree_builder::tag_sets::*;
 use tree_builder::actions::{NoPush, Push, TreeBuilderActions};
-use tree_builder::interface::{TreeSink, Quirks, AppendNode};
-
-use tokenizer::{Attribute, EndTag, StartTag, Tag};
+use tokenizer::{EndTag, StartTag, Tag};
 use tokenizer::states::{Rcdata, Rawtext, ScriptData, Plaintext};
 
 use QualName;
@@ -26,6 +24,7 @@ use std::borrow::Cow::Borrowed;
 use std::borrow::ToOwned;
 
 use tendril::{StrTendril, SliceExt};
+use markup5ever::interface::{Attribute, TreeSink, Quirks, AppendNode};
 
 fn any_not_whitespace(x: &StrTendril) -> bool {
     // FIXME: this might be much faster as a byte scan

markup5ever/Cargo.toml

@@ -17,6 +17,7 @@ heap_size = ["heapsize", "heapsize_derive", "string_cache/heapsize"]
 [dependencies]
 string_cache = "0.5"
 phf = "0.7"
+tendril = "0.2"
 heapsize = { version = "0.3", optional = true }
 heapsize_derive = { version = "0.1", optional = true }