Sibling invalidation sets

Source/core/css/invalidation/InvalidationSet.h

 /*
  * Copyright (C) 2014 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 10 matching lines @@
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef DescendantInvalidationSet_h
-#define DescendantInvalidationSet_h
+#ifndef InvalidationSet_h
+#define InvalidationSet_h
 
 #include "core/CoreExport.h"
 #include "platform/heap/Handle.h"
 #include "wtf/Forward.h"
 #include "wtf/HashSet.h"
 #include "wtf/RefCounted.h"
 #include "wtf/RefPtr.h"
 #include "wtf/text/AtomicStringHash.h"
 #include "wtf/text/StringHash.h"
 
 namespace blink {
 
 class Element;
 class TracedValue;
 
 // Tracks data to determine which elements of a DOM subtree need to have style
 // recalculated.

[esprehn, 2015/09/10 08:54:53]

comment needs updating?

[Eric Willigers, 2015/09/15 05:39:17]

Done.

-class CORE_EXPORT DescendantInvalidationSet final : public RefCountedWillBeGarbageCollected<DescendantInvalidationSet> {
-    WTF_MAKE_NONCOPYABLE(DescendantInvalidationSet);
+class CORE_EXPORT InvalidationSet final : public RefCountedWillBeGarbageCollected<InvalidationSet> {

[rune, 2015/09/10 13:54:50]

Could we do the DescendantInvalidationSet -> InvalidationSet renaming in a
separate CL?

[Eric Willigers, 2015/09/14 07:20:24]

Done.

+    WTF_MAKE_NONCOPYABLE(InvalidationSet);
 public:
-    static PassRefPtrWillBeRawPtr<DescendantInvalidationSet> create()
+    static PassRefPtrWillBeRawPtr<InvalidationSet> create()
     {
-        return adoptRefWillBeNoop(new DescendantInvalidationSet);
+        return adoptRefWillBeNoop(new InvalidationSet);
     }
 
     static void cacheTracingFlag();
 
     bool invalidatesElement(Element&) const;
 
-    void combine(const DescendantInvalidationSet& other);
+    void combine(const InvalidationSet& other);
 
     void addClass(const AtomicString& className);
     void addId(const AtomicString& id);
     void addTagName(const AtomicString& tagName);
     void addAttribute(const AtomicString& attributeLocalName);
 
+    const InvalidationSet* descendants() const { return m_descendantInvalidationSet.get(); }
+
+    InvalidationSet& ensureInvalidationSet();

[Timothy Loh, 2015/09/10 06:09:40]

awkward name

[Eric Willigers, 2015/09/14 07:20:24]

Renamed to ensureDescendantInvalidationSet

+
+    void setAppliesDirectly() { m_appliesDirectly = true; }
+    bool appliesDirectly() const { return m_appliesDirectly; }
+
     void setWholeSubtreeInvalid();
     bool wholeSubtreeInvalid() const { return m_allDescendantsMightBeInvalid; }
 
     void setTreeBoundaryCrossing() { m_treeBoundaryCrossing = true; }
     bool treeBoundaryCrossing() const { return m_treeBoundaryCrossing; }
 
     void setInsertionPointCrossing() { m_insertionPointCrossing = true; }
     bool insertionPointCrossing() const { return m_insertionPointCrossing; }
 
     void setCustomPseudoInvalid() { m_customPseudoInvalid = true; }
     bool customPseudoInvalid() const { return m_customPseudoInvalid; }
 
+    unsigned maxDirectAdjacentSelectors() const { return m_maxDirectAdjacentSelectors; }
+    void setMaxDirectAdjacentSelectors(unsigned value) { m_maxDirectAdjacentSelectors = std::max(value, m_maxDirectAdjacentSelectors); }
+
     bool isEmpty() const { return !m_classes && !m_ids && !m_tagNames && !m_attributes && !m_customPseudoInvalid; }
 
     DECLARE_TRACE();
 
     void toTracedValue(TracedValue*) const;
 
 #ifndef NDEBUG
     void show() const;
 #endif
 
 private:
-    DescendantInvalidationSet();
+    InvalidationSet();
 
     WillBeHeapHashSet<AtomicString>& ensureClassSet();
     WillBeHeapHashSet<AtomicString>& ensureIdSet();
     WillBeHeapHashSet<AtomicString>& ensureTagNameSet();
     WillBeHeapHashSet<AtomicString>& ensureAttributeSet();
 
     // FIXME: optimize this if it becomes a memory issue.
     OwnPtrWillBeMember<WillBeHeapHashSet<AtomicString>> m_classes;
     OwnPtrWillBeMember<WillBeHeapHashSet<AtomicString>> m_ids;
     OwnPtrWillBeMember<WillBeHeapHashSet<AtomicString>> m_tagNames;
     OwnPtrWillBeMember<WillBeHeapHashSet<AtomicString>> m_attributes;
 
+    // Only for sibling invalidation sets, indicates the maximum possible number of siblings affected.
+    unsigned m_maxDirectAdjacentSelectors;
+
+    // Only for sibling invalidation sets, indicates the descendants of siblings.
+    RefPtrWillBeMember<InvalidationSet> m_descendantInvalidationSet;
+
+    // Indicates the sibling/descendant itself is invalid.
+    unsigned m_appliesDirectly : 1;

[esprehn, 2015/09/10 08:54:53]

I'm not a fan of special cases like this where it can be yourself or your kids,
why do you need this?

[rune, 2015/09/10 13:54:50]

This is an optimization for the case where a feature occurs in non-leftmore
compounds only. For instance given the selector:

.a .b { }

We currently create an invalidation set for .a containing .b, but we currently
don't know if there was also a selector like ".a {}" which requires a
LocalStyleChange on the element which gets .a set. So currently, we always do a
LocalStyleChange for the element which gets an invalidation set scheduled.

I don't know if this optimization is more important for sibling invalidation
sets, but I would like to see that optimization as a separate CL.

+
     // If true, all descendants might be invalidated, so a full subtree recalc is required.
     unsigned m_allDescendantsMightBeInvalid : 1;
 
     // If true, all descendants which are custom pseudo elements must be invalidated.
     unsigned m_customPseudoInvalid : 1;
 
     // If true, the invalidation must traverse into ShadowRoots with this set.
     unsigned m_treeBoundaryCrossing : 1;
 
     // If true, insertion point descendants must be invalidated.
     unsigned m_insertionPointCrossing : 1;
+
+    friend class RuleFeatureSetTest;
 };
 
+using InvalidationSetVector = WillBeHeapVector<RefPtrWillBeMember<InvalidationSet>, 8>;
+
 } // namespace blink
 
-#endif // DescendantInvalidationSet_h
+#endif // InvalidationSet_h