First step of PaintInvalidator implementation

third_party/WebKit/Source/core/layout/LayoutObject.h

 /*
  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
  *           (C) 2000 Dirk Mueller (mueller@kde.org)
  *           (C) 2004 Allan Sandfeld Jensen (kde@carewolf.com)
  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ skipping 50 matching lines @@
 class LayoutFlowThread;
 class LayoutGeometryMap;
 class LayoutMultiColumnSpannerPlaceholder;
 class LayoutView;
 class ObjectPaintProperties;
 class PaintLayer;
 class PseudoStyleRequest;
 class TransformState;
 
 struct PaintInfo;
+struct PaintInvalidatorContext;
 
 enum CursorDirective {
     SetCursorBasedOnStyle,
     SetCursor,
     DoNotSetCursor
 };
 
 enum HitTestFilter {
     HitTestAll,
     HitTestSelf,
@@ skipping 1218 matching lines @@
     LayoutRect previousPaintInvalidationRectIncludingCompositedScrolling(const LayoutBoxModelObject& paintInvalidationContainer) const;
     LayoutSize previousPaintInvalidationRectSize() const { return previousPaintInvalidationRect().size(); }
 
     // Called when the previous paint invalidation rect(s) is no longer valid.
     virtual void clearPreviousPaintInvalidationRects();
 
     // Only adjusts if the paint invalidation container is not a composited scroller.
     void adjustPreviousPaintInvalidationForScrollIfNeeded(const DoubleSize& scrollDelta);
 
     // The previous position of the top-left corner of the object in its previous paint backing.
-    const LayoutPoint& previousPositionFromPaintInvalidationBacking() const
-    {
-        ASSERT(!RuntimeEnabledFeatures::slimmingPaintInvalidationEnabled());
-        return m_previousPositionFromPaintInvalidationBacking;
-    }
-    void setPreviousPositionFromPaintInvalidationBacking(const LayoutPoint& positionFromPaintInvalidationBacking)
-    {
-        ASSERT(!RuntimeEnabledFeatures::slimmingPaintInvalidationEnabled());
-        m_previousPositionFromPaintInvalidationBacking = positionFromPaintInvalidationBacking;
-    }
+    const LayoutPoint& previousPositionFromPaintInvalidationBacking() const { return m_previousPositionFromPaintInvalidationBacking; }
+    void setPreviousPositionFromPaintInvalidationBacking(const LayoutPoint& positionFromPaintInvalidationBacking) { m_previousPositionFromPaintInvalidationBacking = positionFromPaintInvalidationBacking; }
 
     bool paintOffsetChanged(const LayoutPoint& newPaintOffset) const
     {
         ASSERT(RuntimeEnabledFeatures::slimmingPaintInvalidationEnabled());
         return m_previousPositionFromPaintInvalidationBacking != uninitializedPaintOffset() && m_previousPositionFromPaintInvalidationBacking != newPaintOffset;
     }
     void setPreviousPaintOffset(const LayoutPoint& paintOffset)
     {
         ASSERT(RuntimeEnabledFeatures::slimmingPaintInvalidationEnabled());
         m_previousPositionFromPaintInvalidationBacking = paintOffset;
     }
 
     PaintInvalidationReason fullPaintInvalidationReason() const { return m_bitfields.fullPaintInvalidationReason(); }
     bool shouldDoFullPaintInvalidation() const { return m_bitfields.fullPaintInvalidationReason() != PaintInvalidationNone; }
     void setShouldDoFullPaintInvalidation(PaintInvalidationReason = PaintInvalidationFull);
     void clearShouldDoFullPaintInvalidation() { m_bitfields.setFullPaintInvalidationReason(PaintInvalidationNone); }
 
-    virtual void clearPaintInvalidationFlags(const PaintInvalidationState&);
+    virtual void clearPaintInvalidationFlags();
 
     bool mayNeedPaintInvalidation() const { return m_bitfields.mayNeedPaintInvalidation(); }
     void setMayNeedPaintInvalidation();
 
     bool mayNeedPaintInvalidationSubtree() const { return m_bitfields.mayNeedPaintInvalidationSubtree(); }
     void setMayNeedPaintInvalidationSubtree();
 
     bool shouldInvalidateSelection() const { return m_bitfields.shouldInvalidateSelection(); }
     void setShouldInvalidateSelection();
 
@@ skipping 23 matching lines @@
 
     // Sets painting layer needsRepaint, then calls invaldiateDisplayItemClient().
     // Should use this version when PaintInvalidationState is available.
     void setPaintingLayerNeedsRepaintAndInvalidateDisplayItemClient(const PaintInvalidationState&, const DisplayItemClient&, PaintInvalidationReason) const;
 
     // The caller should ensure the painting layer has been setNeedsRepaint before calling this function.
     void invalidateDisplayItemClient(const DisplayItemClient&, PaintInvalidationReason) const;
 
     void invalidateDisplayItemClientsIncludingNonCompositingDescendants(PaintInvalidationReason) const;
 
+    // New version to replace the above old version.
+    virtual PaintInvalidationReason invalidatePaintIfNeeded(const PaintInvalidatorContext&) const;
+
+    // When this object is invalidated for paint, this method is called to invalidate any DisplayItemClients
+    // owned by this object, including the object itself, LayoutText/LayoutInline line boxes, etc.,
+    // not including children which will be invalidated normally during invalidateTreeIfNeeded() and
+    // parts which are invalidated separately (e.g. scrollbars).
+    // The caller should ensure the painting layer has been setNeedsRepaint before calling this function.
+    virtual void invalidateDisplayItemClients(PaintInvalidationReason) const;
+
+    const LayoutRect& previousPaintInvalidationRect() const { return m_previousPaintInvalidationRect; }
+
+    virtual bool hasNonCompositedScrollbars() const { return false; }
+
     // Called before anonymousChild.setStyle(). Override to set custom styles for the child.
     virtual void updateAnonymousChildStyle(const LayoutObject& anonymousChild, ComputedStyle& style) const { }
 
     // Painters can use const methods only, except for these explicitly declared methods.
     class MutableForPainting {
     public:
         void setPreviousPaintOffset(const LayoutPoint& paintOffset) { m_layoutObject.setPreviousPaintOffset(paintOffset); }
-        PaintInvalidationReason invalidatePaintIfNeeded(const PaintInvalidationState& paintInvalidationState) { return m_layoutObject.invalidatePaintIfNeeded(paintInvalidationState); }
-        void clearPaintInvalidationFlags(const PaintInvalidationState& paintInvalidationState) { m_layoutObject.clearPaintInvalidationFlags(paintInvalidationState); }
-        void setShouldDoDelayedFullPaintInvalidation() { m_layoutObject.setShouldDoFullPaintInvalidation(PaintInvalidationDelayedFull); }
+        void clearPaintInvalidationFlags() { m_layoutObject.clearPaintInvalidationFlags(); }
+        void setShouldDoFullPaintInvalidation(PaintInvalidationReason reason) { m_layoutObject.setShouldDoFullPaintInvalidation(reason); }
+
+        void setPreviousPaintInvalidationRect(const LayoutRect& r) { m_layoutObject.setPreviousPaintInvalidationRect(r); }
+        void setPreviousPositionFromPaintInvalidationBacking(const LayoutPoint& p) { m_layoutObject.setPreviousPositionFromPaintInvalidationBacking(p); }
+        void setPreviousBoxDecorationBackgroundObscured(bool b) { m_layoutObject.setPreviousBoxDecorationBackgroundObscured(b); }
 
     private:
         friend class PaintPropertyTreeBuilder;
         // The following two functions can be called from PaintPropertyTreeBuilder only.
         ObjectPaintProperties& ensureObjectPaintProperties() { return m_layoutObject.ensureObjectPaintProperties(); }
         ObjectPaintProperties* objectPaintProperties() { return const_cast<ObjectPaintProperties*>(m_layoutObject.objectPaintProperties()); }
 
         friend class LayoutObject;
         MutableForPainting(const LayoutObject& layoutObject) : m_layoutObject(const_cast<LayoutObject&>(layoutObject)) { }
 
         LayoutObject& m_layoutObject;
     };
     MutableForPainting getMutableForPainting() const { return MutableForPainting(*this); }
 
     void setIsScrollAnchorObject() { m_bitfields.setIsScrollAnchorObject(true); }
     // Clears the IsScrollAnchorObject bit, unless any ScrollAnchor still refers to us.
     void maybeClearIsScrollAnchorObject();
 
     void clearChildNeedsOverflowRecalcAfterStyleChange() { m_bitfields.setChildNeedsOverflowRecalcAfterStyleChange(false); }
 
     bool compositedScrollsWithRespectTo(const LayoutBoxModelObject& paintInvalidationContainer) const;
     IntSize scrollAdjustmentForPaintInvalidation(const LayoutBoxModelObject& paintInvalidationContainer) const;
 
+    bool previousBoxDecorationBackgroundObscured() const { return m_bitfields.previousBoxDecorationBackgroundObscured(); }
+    void setPreviousBoxDecorationBackgroundObscured(bool b) { m_bitfields.setPreviousBoxDecorationBackgroundObscured(b); }
+
 protected:
     enum LayoutObjectType {
         LayoutObjectBr,
         LayoutObjectCanvas,
         LayoutObjectFieldset,
         LayoutObjectCounter,
         LayoutObjectDetailsMarker,
         LayoutObjectEmbeddedObject,
         LayoutObjectFileUploadControl,
         LayoutObjectFrame,
@@ skipping 100 matching lines @@
     // be a container for child elements. Any rect wholly contained by containerRect can be
     // skipped.
     virtual void addLayerHitTestRects(LayerHitTestRects&, const PaintLayer* currentLayer, const LayoutPoint& layerOffset, const LayoutRect& containerRect) const;
 
     // Add hit-test rects for this layoutObject only to the provided list. layerOffset is the offset
     // of this layoutObject within the current layer that should be used for each result.
     virtual void computeSelfHitTestRects(Vector<LayoutRect>&, const LayoutPoint& layerOffset) const { }
 
     void setPreviousPaintInvalidationRect(const LayoutRect& rect) { m_previousPaintInvalidationRect = rect; }
 
-    virtual PaintInvalidationReason getPaintInvalidationReason(const PaintInvalidationState&,
-        const LayoutRect& oldPaintInvalidationRect, const LayoutPoint& oldPositionFromPaintInvalidationBacking,
-        const LayoutRect& newPaintInvalidationRect, const LayoutPoint& newPositionFromPaintInvalidationBacking) const;
-
-    // This function tries to minimize the amount of invalidation
-    // generated by invalidating the "difference" between |oldBounds|
-    // and |newBounds|. This means invalidating the union of the
-    // previous rectangles but not their intersection.
-    //
-    // The use case is when an element only requires a paint
-    // invalidation (which means that its content didn't change)
-    // and its bounds changed but its location didn't.
-    //
-    // If we don't meet the criteria for an incremental paint, the
-    // alternative is a full paint invalidation.
-    virtual void incrementallyInvalidatePaint(const LayoutBoxModelObject& paintInvalidationContainer, const LayoutRect& oldBounds, const LayoutRect& newBounds, const LayoutPoint& positionFromPaintInvalidationBacking);
-
-    virtual bool hasNonCompositedScrollbars() const { return false; }
-
 #if ENABLE(ASSERT)
     virtual bool paintInvalidationStateIsDirty() const
     {
         return shouldCheckForPaintInvalidationRegardlessOfPaintInvalidationState();
     }
 #endif
 
     // This function walks the descendants of |this|, following a
     // layout ordering.
     //
     // The ordering is important for PaintInvalidationState, as
     // it requires to be called following a descendant/container
     // relationship.
     //
     // The function is overridden to handle special children
     // (e.g. percentage height descendants or reflections).
     virtual void invalidatePaintOfSubtreesIfNeeded(const PaintInvalidationState& childPaintInvalidationState);
 
     // This function generates the invalidation for this object only.
     // It doesn't recurse into other object, as this is handled
     // by invalidatePaintOfSubtreesIfNeeded.
     virtual PaintInvalidationReason invalidatePaintIfNeeded(const PaintInvalidationState&);
 
-    // When this object is invalidated for paint, this method is called to invalidate any DisplayItemClients
-    // owned by this object, including the object itself, LayoutText/LayoutInline line boxes, etc.,
-    // not including children which will be invalidated normally during invalidateTreeIfNeeded() and
-    // parts which are invalidated separately (e.g. scrollbars).
-    // The caller should ensure the painting layer has been setNeedsRepaint before calling this function.
-    virtual void invalidateDisplayItemClients(PaintInvalidationReason) const;
-
-    // Sets painting layer needsRepaint, then calls invalidateDisplayItemClients().
-    // Should use this version when PaintInvalidationState is available.
-    void invalidateDisplayItemClientsWithPaintInvalidationState(const PaintInvalidationState&, PaintInvalidationReason) const;
-
     void setIsBackgroundAttachmentFixedObject(bool);
 
     void clearSelfNeedsOverflowRecalcAfterStyleChange() { m_bitfields.setSelfNeedsOverflowRecalcAfterStyleChange(false); }
     void setEverHadLayout() { m_bitfields.setEverHadLayout(true); }
 
     // Remove this object and all descendants from the containing LayoutFlowThread.
     void removeFromLayoutFlowThread();
 
     bool containsInlineWithOutlineAndContinuation() const { return m_bitfields.containsInlineWithOutlineAndContinuation(); }
     void setContainsInlineWithOutlineAndContinuation(bool b) { m_bitfields.setContainsInlineWithOutlineAndContinuation(b); }
 
-    const LayoutRect& previousPaintInvalidationRect() const { return m_previousPaintInvalidationRect; }
-
 private:
-    // This function generates a full invalidation, which
-    // means invalidating both |oldBounds| and |newBounds|.
-    //
-    // This is the default choice when generating an invalidation,
-    // as it is always correct, albeit it may force some extra painting.
-    void fullyInvalidatePaint(const LayoutBoxModelObject& paintInvalidationContainer, PaintInvalidationReason, const LayoutRect& oldBounds, const LayoutRect& newBounds);
-
     // Adjusts a paint invalidation rect in the space of |m_previousPaintInvalidationRect| and |m_previousPositionFromPaintInvalidationBacking|
     // to be in the space of the |paintInvalidationContainer|,
     // if needed. They can be different only if |paintInvalidationContainer| is a composited scroller.
     void adjustInvalidationRectForCompositedScrolling(LayoutRect&, const LayoutBoxModelObject& paintInvalidationContainer) const;
 
     void clearLayoutRootIfNeeded() const;
 
     bool isInert() const;
 
     void updateImage(StyleImage*, StyleImage*);
 
     void scheduleRelayout();
 
     void updateShapeImage(const ShapeValue*, const ShapeValue*);
     void updateFillImages(const FillLayer* oldLayers, const FillLayer& newLayers);
     void updateCursorImages(const CursorList* oldCursors, const CursorList* newCursors);
 
     void setNeedsOverflowRecalcAfterStyleChange();
 
     // FIXME: This should be 'markContaingBoxChainForOverflowRecalc when we make LayoutBox
     // recomputeOverflow-capable. crbug.com/437012 and crbug.com/434700.
     inline void markAncestorsForOverflowRecalcIfNeeded();
 
     inline void markAncestorsForPaintInvalidation();
 
-    inline void invalidateSelectionIfNeeded(const LayoutBoxModelObject& paintInvalidationContainer, const PaintInvalidationState&, PaintInvalidationReason);
-
     inline void invalidateContainerPreferredLogicalWidths();
 
     void invalidatePaintIncludingNonSelfPaintingLayerDescendantsInternal(const LayoutBoxModelObject& paintInvalidationContainer);
 
     // The caller should ensure the painting layer has been setNeedsRepaint before calling this function.
     void invalidatePaintOfPreviousPaintInvalidationRect(const LayoutBoxModelObject& paintInvalidationContainer, PaintInvalidationReason);
 
-    LayoutRect previousSelectionRectForPaintInvalidation() const;
-    void setPreviousSelectionRectForPaintInvalidation(const LayoutRect&);
-
     LayoutObject* containerForAbsolutePosition(const LayoutBoxModelObject* ancestor = nullptr, bool* ancestorSkipped = nullptr, bool* filterOrReflectionSkipped = nullptr) const;
 
     const LayoutBoxModelObject* enclosingCompositedContainer() const;
 
     LayoutFlowThread* locateFlowThreadContainingBlock() const;
     void removeFromLayoutFlowThreadRecursive(LayoutFlowThread*);
 
     ComputedStyle* cachedFirstLineStyle() const;
     StyleDifference adjustStyleDifference(StyleDifference) const;
 
@@ skipping 96 matching lines @@
             , m_everHadLayout(false)
             , m_ancestorLineBoxDirty(false)
             , m_hasPendingResourceUpdate(false)
             , m_isInsideFlowThread(false)
             , m_subtreeChangeListenerRegistered(false)
             , m_notifiedOfSubtreeChange(false)
             , m_consumesSubtreeChangeNotification(false)
             , m_childrenInline(false)
             , m_containsInlineWithOutlineAndContinuation(false)
             , m_alwaysCreateLineBoxesForLayoutInline(false)
-            , m_lastBoxDecorationBackgroundObscured(false)
+            , m_previousBoxDecorationBackgroundObscured(false)
             , m_isBackgroundAttachmentFixedObject(false)
             , m_isScrollAnchorObject(false)
             , m_positionedState(IsStaticallyPositioned)
             , m_selectionState(SelectionNone)
             , m_boxDecorationBackgroundState(NoBoxDecorationBackground)
             , m_fullPaintInvalidationReason(PaintInvalidationNone)
         {
         }
 
         // 32 bits have been used in the first word, and 16 in the second.
@@ skipping 114 matching lines @@
         // from LayoutBlock
         ADD_BOOLEAN_BITFIELD(childrenInline, ChildrenInline);
 
         // from LayoutBlockFlow
         ADD_BOOLEAN_BITFIELD(containsInlineWithOutlineAndContinuation, ContainsInlineWithOutlineAndContinuation);
 
         // from LayoutInline
         ADD_BOOLEAN_BITFIELD(alwaysCreateLineBoxesForLayoutInline, AlwaysCreateLineBoxesForLayoutInline);
 
         // For slimming-paint.
-        ADD_BOOLEAN_BITFIELD(lastBoxDecorationBackgroundObscured, LastBoxDecorationBackgroundObscured);
+        ADD_BOOLEAN_BITFIELD(previousBoxDecorationBackgroundObscured, PreviousBoxDecorationBackgroundObscured);
 
         ADD_BOOLEAN_BITFIELD(isBackgroundAttachmentFixedObject, IsBackgroundAttachmentFixedObject);
         ADD_BOOLEAN_BITFIELD(isScrollAnchorObject, IsScrollAnchorObject);
 
     private:
         // This is the cached 'position' value of this object
         // (see ComputedStyle::position).
         unsigned m_positionedState : 2; // PositionedState
         unsigned m_selectionState : 3; // SelectionState
         // Mutable for getter which lazily update this field.
@@ skipping 275 matching lines @@
 void showTree(const blink::LayoutObject*);
 void showLineTree(const blink::LayoutObject*);
 void showLayoutTree(const blink::LayoutObject* object1);
 // We don't make object2 an optional parameter so that showLayoutTree
 // can be called from gdb easily.
 void showLayoutTree(const blink::LayoutObject* object1, const blink::LayoutObject* object2);
 
 #endif
 
 #endif // LayoutObject_h