Auto merge of #19751 - servo:selectors, r=bholley

Clean up the selectors crate for a new crates.io release

<!-- Reviewable:start -->
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/19751)
<!-- Reviewable:end -->

components/malloc_size_of/Cargo.toml

@@ -17,6 +17,7 @@ cssparser = "0.23.0"
 euclid = "0.16"
 hashglobe = { path = "../hashglobe" }
 mozjs = { version = "0.1.8", features = ["promises"], optional = true }
+selectors = { path = "../selectors" }
 servo_arc = { path = "../servo_arc" }
 smallbitvec = "1.0.3"
 smallvec = "0.6"

components/malloc_size_of/lib.rs

@@ -49,6 +49,7 @@ extern crate euclid;
 extern crate hashglobe;
 #[cfg(feature = "servo")]
 extern crate mozjs as js;
+extern crate selectors;
 extern crate servo_arc;
 extern crate smallbitvec;
 extern crate smallvec;
@@ -640,6 +641,13 @@ impl<T: MallocSizeOf, U> MallocSizeOf for euclid::TypedVector2D<T, U> {
     }
 }
 
+impl MallocSizeOf for selectors::parser::AncestorHashes {
+    fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize {
+        let selectors::parser::AncestorHashes { ref packed_hashes } = *self;
+        packed_hashes.size_of(ops)
+    }
+}
+
 #[cfg(feature = "servo")]
 impl<Static: string_cache::StaticAtomSet> MallocSizeOf for string_cache::Atom<Static> {
     fn size_of(&self, _ops: &mut MallocSizeOfOps) -> usize {

components/selectors/Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 
 name = "selectors"
-version = "0.19.0" # Not yet published
-authors = ["Simon Sapin <simon.sapin@exyr.org>", "Alan Jeffrey <ajeffrey@mozilla.com>"]
+version = "0.19.0"
+authors = ["The Servo Project Developers"]
 documentation = "https://docs.rs/selectors/"
 
 description = "CSS Selectors matching for Rust"
@@ -15,11 +15,8 @@ build = "build.rs"
 [lib]
 name = "selectors"
 path = "lib.rs"
-# https://github.com/servo/servo/issues/16710
-doctest = false
 
 [features]
-gecko_like_types = []
 bench = []
 
 [dependencies]
@@ -28,15 +25,10 @@ matches = "0.1"
 cssparser = "0.23.0"
 log = "0.3"
 fnv = "1.0"
-malloc_size_of = { path = "../malloc_size_of" }
-malloc_size_of_derive = { path = "../malloc_size_of_derive" }
 phf = "0.7.18"
 precomputed-hash = "0.1"
-servo_arc = { path = "../servo_arc" }
+servo_arc = { version = "0.1", path = "../servo_arc" }
 smallvec = "0.6"
 
-[dev-dependencies]
-size_of_test = {path = "../size_of_test"}
-
 [build-dependencies]
 phf_codegen = "0.7.18"

components/selectors/gecko_like_types.rs

@@ -1,28 +0,0 @@
-/* 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/. */
-
-//! These types need to have the same size and alignment as the respectively corresponding
-//! types in components/style/gecko/selector_parser.rs
-
-#[derive(Clone, Debug, Eq, PartialEq)]
-#[allow(dead_code)]
-pub enum PseudoClass {
-    Bare,
-    String(Box<[u16]>),
-    Dir(Box<()>),
-    MozAny(Box<[()]>),
-}
-
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub enum PseudoElement {
-    A,
-    B,
-    Tree(Box<[String]>),
-}
-
-#[derive(Clone, Debug, Default, Eq, PartialEq)]
-pub struct Atom(usize);
-
-#[derive(Clone, Eq, PartialEq)]
-pub struct Impl;

components/selectors/lib.rs

@@ -10,11 +10,8 @@
 #[macro_use] extern crate log;
 #[macro_use] extern crate matches;
 extern crate fnv;
-extern crate malloc_size_of;
-#[macro_use] extern crate malloc_size_of_derive;
 extern crate phf;
 extern crate precomputed_hash;
-#[cfg(test)] #[macro_use] extern crate size_of_test;
 extern crate servo_arc;
 extern crate smallvec;
 
@@ -25,8 +22,6 @@ pub mod context;
 pub mod matching;
 mod nth_index_cache;
 pub mod parser;
-#[cfg(test)] mod size_of_tests;
-#[cfg(any(test, feature = "gecko_like_types"))] pub mod gecko_like_types;
 pub mod sink;
 mod tree;
 pub mod visitor;

components/selectors/parser.rs

@@ -19,7 +19,7 @@ use std::borrow::{Borrow, Cow};
 use std::fmt::{self, Display, Debug, Write};
 use std::iter::Rev;
 use std::slice;
-use visitor::SelectorVisitor;
+pub use visitor::{Visit, SelectorVisitor};
 
 /// A trait that represents a pseudo-element.
 pub trait PseudoElement : Sized + ToCss {
@@ -86,17 +86,17 @@ macro_rules! with_all_bounds {
         pub trait SelectorImpl: Clone + Sized + 'static {
             type ExtraMatchingData: Sized + Default + 'static;
             type AttrValue: $($InSelector)*;
-            type Identifier: $($InSelector)* + PrecomputedHash;
-            type ClassName: $($InSelector)* + PrecomputedHash;
-            type LocalName: $($InSelector)* + Borrow<Self::BorrowedLocalName> + PrecomputedHash;
-            type NamespaceUrl: $($CommonBounds)* + Default + Borrow<Self::BorrowedNamespaceUrl> + PrecomputedHash;
+            type Identifier: $($InSelector)*;
+            type ClassName: $($InSelector)*;
+            type LocalName: $($InSelector)* + Borrow<Self::BorrowedLocalName>;
+            type NamespaceUrl: $($CommonBounds)* + Default + Borrow<Self::BorrowedNamespaceUrl>;
             type NamespacePrefix: $($InSelector)* + Default;
             type BorrowedNamespaceUrl: ?Sized + Eq;
             type BorrowedLocalName: ?Sized + Eq;
 
             /// non tree-structural pseudo-classes
             /// (see: https://drafts.csswg.org/selectors/#structural-pseudos)
-            type NonTSPseudoClass: $($CommonBounds)* + Sized + ToCss + SelectorMethods<Impl = Self>;
+            type NonTSPseudoClass: $($CommonBounds)* + Sized + ToCss;
 
             /// pseudo-elements
             type PseudoElement: $($CommonBounds)* + PseudoElement<Impl = Self>;
@@ -266,7 +266,7 @@ where
 /// off the upper bits) at the expense of making the fourth somewhat more
 /// complicated to assemble, because we often bail out before checking all the
 /// hashes.
-#[derive(Clone, Debug, Eq, MallocSizeOf, PartialEq)]
+#[derive(Clone, Debug, Eq, PartialEq)]
 pub struct AncestorHashes {
     pub packed_hashes: [u32; 3],
 }
@@ -275,14 +275,24 @@ impl AncestorHashes {
     pub fn new<Impl: SelectorImpl>(
         selector: &Selector<Impl>,
         quirks_mode: QuirksMode,
-    ) -> Self {
+    ) -> Self
+        where Impl::Identifier: PrecomputedHash,
+              Impl::ClassName: PrecomputedHash,
+              Impl::LocalName: PrecomputedHash,
+              Impl::NamespaceUrl: PrecomputedHash,
+    {
         Self::from_iter(selector.iter(), quirks_mode)
     }
 
     fn from_iter<Impl: SelectorImpl>(
         iter: SelectorIter<Impl>,
         quirks_mode: QuirksMode,
-    ) -> Self {
+    ) -> Self
+        where Impl::Identifier: PrecomputedHash,
+              Impl::ClassName: PrecomputedHash,
+              Impl::LocalName: PrecomputedHash,
+              Impl::NamespaceUrl: PrecomputedHash,
+    {
         // Compute ancestor hashes for the bloom filter.
         let mut hashes = [0u32; 4];
         let mut hash_iter = AncestorIter::new(iter)
@@ -316,15 +326,7 @@ impl AncestorHashes {
     }
 }
 
-pub trait SelectorMethods {
-    type Impl: SelectorImpl;
-
-    fn visit<V>(&self, visitor: &mut V) -> bool
-    where
-        V: SelectorVisitor<Impl = Self::Impl>;
-}
-
-impl<Impl: SelectorImpl> SelectorMethods for Selector<Impl> {
+impl<Impl: SelectorImpl> Visit for Selector<Impl> where Impl::NonTSPseudoClass: Visit<Impl=Impl> {
     type Impl = Impl;
 
     fn visit<V>(&self, visitor: &mut V) -> bool
@@ -354,7 +356,7 @@ impl<Impl: SelectorImpl> SelectorMethods for Selector<Impl> {
     }
 }
 
-impl<Impl: SelectorImpl> SelectorMethods for Component<Impl> {
+impl<Impl: SelectorImpl> Visit for Component<Impl> where Impl::NonTSPseudoClass: Visit<Impl=Impl> {
     type Impl = Impl;
 
     fn visit<V>(&self, visitor: &mut V) -> bool
@@ -789,7 +791,12 @@ pub enum Component<Impl: SelectorImpl> {
 
 impl<Impl: SelectorImpl> Component<Impl> {
     /// Compute the ancestor hash to check against the bloom filter.
-    fn ancestor_hash(&self, quirks_mode: QuirksMode) -> Option<u32> {
+    fn ancestor_hash(&self, quirks_mode: QuirksMode) -> Option<u32>
+        where Impl::Identifier: PrecomputedHash,
+              Impl::ClassName: PrecomputedHash,
+              Impl::LocalName: PrecomputedHash,
+              Impl::NamespaceUrl: PrecomputedHash,
+    {
         match *self {
             Component::LocalName(LocalName { ref name, ref lower_name }) => {
                 // Only insert the local-name into the filter if it's all
@@ -1998,7 +2005,7 @@ pub mod tests {
         }
     }
 
-    impl SelectorMethods for PseudoClass {
+    impl Visit for PseudoClass {
         type Impl = DummySelectorImpl;
 
         fn visit<V>(&self, _visitor: &mut V) -> bool
@@ -2068,12 +2075,6 @@ pub mod tests {
         }
     }
 
-    impl PrecomputedHash for DummyAtom {
-        fn precomputed_hash(&self) -> u32 {
-            return 0
-        }
-    }
-
     impl<'i> Parser<'i> for DummyParser {
         type Impl = DummySelectorImpl;
         type Error = SelectorParseErrorKind<'i>;

components/selectors/size_of_tests.rs

@@ -1,74 +0,0 @@
-/* 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/. */
-
-use cssparser::ToCss;
-use gecko_like_types;
-use gecko_like_types::*;
-use parser;
-use parser::*;
-use precomputed_hash::PrecomputedHash;
-use std::fmt;
-use visitor::SelectorVisitor;
-
-size_of_test!(size_of_selector, Selector<Impl>, 8);
-size_of_test!(size_of_pseudo_element, gecko_like_types::PseudoElement, 24);
-
-size_of_test!(size_of_component, Component<Impl>, 32);
-size_of_test!(size_of_pseudo_class, PseudoClass, 24);
-
-impl parser::PseudoElement for gecko_like_types::PseudoElement {
-    type Impl = Impl;
-}
-
-// Boilerplate
-
-impl SelectorImpl for Impl {
-    type ExtraMatchingData = u64;
-    type AttrValue = Atom;
-    type Identifier = Atom;
-    type ClassName = Atom;
-    type LocalName = Atom;
-    type NamespaceUrl = Atom;
-    type NamespacePrefix = Atom;
-    type BorrowedLocalName = Atom;
-    type BorrowedNamespaceUrl = Atom;
-    type NonTSPseudoClass = PseudoClass;
-    type PseudoElement = gecko_like_types::PseudoElement;
-
-    #[inline]
-    fn is_active_or_hover(_pseudo_class: &Self::NonTSPseudoClass) -> bool {
-        unimplemented!()
-    }
-}
-
-impl SelectorMethods for PseudoClass {
-    type Impl = Impl;
-
-    fn visit<V>(&self, _visitor: &mut V) -> bool
-        where V: SelectorVisitor<Impl = Self::Impl> { unimplemented!() }
-}
-
-impl ToCss for PseudoClass {
-    fn to_css<W>(&self, _: &mut W) -> fmt::Result where W: fmt::Write { unimplemented!() }
-}
-
-impl ToCss for gecko_like_types::PseudoElement {
-    fn to_css<W>(&self, _: &mut W) -> fmt::Result where W: fmt::Write { unimplemented!() }
-}
-
-impl fmt::Display for Atom {
-    fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result { unimplemented!() }
-}
-
-impl From<String> for Atom {
-    fn from(_: String) -> Self { unimplemented!() }
-}
-
-impl<'a> From<&'a str> for Atom {
-    fn from(_: &'a str) -> Self { unimplemented!() }
-}
-
-impl PrecomputedHash for Atom {
-    fn precomputed_hash(&self) -> u32 { unimplemented!() }
-}

components/selectors/tree.rs

@@ -15,7 +15,7 @@ use std::fmt::Debug;
 /// Opaque representation of an Element, for identity comparisons. We use
 /// NonZeroPtrMut to get the NonZero optimization.
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
-pub struct OpaqueElement(pub NonZeroPtrMut<()>);
+pub struct OpaqueElement(NonZeroPtrMut<()>);
 
 impl OpaqueElement {
     /// Creates a new OpaqueElement from an arbitrarily-typed pointer.

components/selectors/visitor.rs

@@ -44,3 +44,31 @@ pub trait SelectorVisitor {
         true
     }
 }
+
+/// Enables traversing selector components stored in various types
+pub trait Visit {
+    /// The type parameter of selector component types.
+    type Impl: SelectorImpl;
+
+    /// Traverse selector components inside `self`.
+    ///
+    /// Implementations of this method should call `SelectorVisitor` methods
+    /// or other impls of `Visit` as appropriate based on the fields of `Self`.
+    ///
+    /// A return value of `false` indicates terminating the traversal.
+    /// It should be propagated with an early return.
+    /// On the contrary, `true` indicates that all fields of `self` have been traversed:
+    ///
+    /// ```rust,ignore
+    /// if !visitor.visit_simple_selector(&self.some_simple_selector) {
+    ///     return false;
+    /// }
+    /// if !self.some_component.visit(visitor) {
+    ///     return false;
+    /// }
+    /// true
+    /// ```
+    fn visit<V>(&self, visitor: &mut V) -> bool
+    where
+        V: SelectorVisitor<Impl = Self::Impl>;
+}

components/servo_arc/Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "servo_arc"
-version = "0.0.1"
+version = "0.1.0"
 authors = ["The Servo Project Developers"]
 license = "MPL-2.0"
-publish = false
+repository = "https://github.com/servo/servo"
+description = "A fork of std::sync::Arc with some extra functionality and without weak references"
 
 [lib]
 name = "servo_arc"

components/servo_arc/lib.rs

@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Fork of Arc for Servo. This has the following advantages over std::Arc:
+//! Fork of Arc for Servo. This has the following advantages over std::sync::Arc:
 //!
 //! * We don't waste storage on the weak reference count.
 //! * We don't do extra RMU operations to handle the possibility of weak references.

components/style/gecko/selector_parser.rs

@@ -12,7 +12,7 @@ use gecko_bindings::sugar::ownership::{HasBoxFFI, HasFFI, HasSimpleFFI};
 use invalidation::element::document_state::InvalidationMatchingData;
 use selector_parser::{Direction, SelectorParser};
 use selectors::SelectorList;
-use selectors::parser::{self as selector_parser, Selector, SelectorMethods, SelectorParseErrorKind};
+use selectors::parser::{self as selector_parser, Selector, Visit, SelectorParseErrorKind};
 use selectors::visitor::SelectorVisitor;
 use std::fmt;
 use string_cache::{Atom, Namespace, WeakAtom, WeakNamespace};
@@ -113,7 +113,7 @@ impl ToCss for NonTSPseudoClass {
     }
 }
 
-impl SelectorMethods for NonTSPseudoClass {
+impl Visit for NonTSPseudoClass {
     type Impl = SelectorImpl;
 
     fn visit<V>(&self, visitor: &mut V) -> bool

components/style/invalidation/element/invalidation_map.rs

@@ -15,7 +15,7 @@ use selector_parser::Direction;
 use selector_parser::SelectorImpl;
 use selectors::attr::NamespaceConstraint;
 use selectors::parser::{Combinator, Component};
-use selectors::parser::{Selector, SelectorIter, SelectorMethods};
+use selectors::parser::{Selector, SelectorIter, Visit};
 use selectors::visitor::SelectorVisitor;
 use smallvec::SmallVec;
 

components/style/servo/selector_parser.rs

@@ -19,7 +19,7 @@ use properties::PropertyFlags;
 use properties::longhands::display::computed_value::T as Display;
 use selector_parser::{AttrValue as SelectorAttrValue, PseudoElementCascadeType, SelectorParser};
 use selectors::attr::{AttrSelectorOperation, NamespaceConstraint, CaseSensitivity};
-use selectors::parser::{SelectorMethods, SelectorParseErrorKind};
+use selectors::parser::{Visit, SelectorParseErrorKind};
 use selectors::visitor::SelectorVisitor;
 use std::fmt;
 use std::mem;
@@ -312,7 +312,7 @@ impl ToCss for NonTSPseudoClass {
     }
 }
 
-impl SelectorMethods for NonTSPseudoClass {
+impl Visit for NonTSPseudoClass {
     type Impl = SelectorImpl;
 
 

components/style/stylist.rs

@@ -31,7 +31,7 @@ use selectors::bloom::{BloomFilter, NonCountingBloomFilter};
 use selectors::matching::{ElementSelectorFlags, matches_selector, MatchingContext, MatchingMode};
 use selectors::matching::VisitedHandlingMode;
 use selectors::parser::{AncestorHashes, Combinator, Component, Selector};
-use selectors::parser::{SelectorIter, SelectorMethods};
+use selectors::parser::{SelectorIter, Visit};
 use selectors::visitor::SelectorVisitor;
 use servo_arc::{Arc, ArcBorrow};
 use shared_lock::{Locked, SharedRwLockReadGuard, StylesheetGuards};