Compositing updates need to reparent scrolling tree nodes with a changed ancestor
[WebKit-https.git] / Source / WebCore / rendering / RenderLayer.h
1 /*
2  * Copyright (C) 2003, 2009, 2012, 2015 Apple Inc. All rights reserved.
3  *
4  * Portions are Copyright (C) 1998 Netscape Communications Corporation.
5  *
6  * Other contributors:
7  *   Robert O'Callahan <roc+@cs.cmu.edu>
8  *   David Baron <dbaron@fas.harvard.edu>
9  *   Christian Biesinger <cbiesinger@web.de>
10  *   Randall Jesup <rjesup@wgate.com>
11  *   Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
12  *   Josh Soref <timeless@mac.com>
13  *   Boris Zbarsky <bzbarsky@mit.edu>
14  *
15  * This library is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU Lesser General Public
17  * License as published by the Free Software Foundation; either
18  * version 2.1 of the License, or (at your option) any later version.
19  *
20  * This library is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  * Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public
26  * License along with this library; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28  *
29  * Alternatively, the contents of this file may be used under the terms
30  * of either the Mozilla Public License Version 1.1, found at
31  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
32  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
33  * (the "GPL"), in which case the provisions of the MPL or the GPL are
34  * applicable instead of those above.  If you wish to allow use of your
35  * version of this file only under the terms of one of those two
36  * licenses (the MPL or the GPL) and not to allow others to use your
37  * version of this file under the LGPL, indicate your decision by
38  * deletingthe provisions above and replace them with the notice and
39  * other provisions required by the MPL or the GPL, as the case may be.
40  * If you do not delete the provisions above, a recipient may use your
41  * version of this file under any of the LGPL, the MPL or the GPL.
42  */
43
44 #pragma once
45
46 #include "ClipRect.h"
47 #include "GraphicsLayer.h"
48 #include "LayerFragment.h"
49 #include "PaintFrequencyTracker.h"
50 #include "PaintInfo.h"
51 #include "RenderBox.h"
52 #include "RenderPtr.h"
53 #include "ScrollableArea.h"
54 #include <memory>
55 #include <wtf/WeakPtr.h>
56
57 namespace WTF {
58 class TextStream;
59 }
60
61 namespace WebCore {
62
63 class CSSFilter;
64 class ClipRects;
65 class ClipRectsCache;
66 class HitTestRequest;
67 class HitTestResult;
68 class HitTestingTransformState;
69 class RenderFragmentedFlow;
70 class RenderGeometryMap;
71 class RenderLayerBacking;
72 class RenderLayerCompositor;
73 class RenderLayerFilters;
74 class RenderMarquee;
75 class RenderReplica;
76 class RenderScrollbarPart;
77 class RenderStyle;
78 class RenderView;
79 class Scrollbar;
80 class TransformationMatrix;
81
82 enum BorderRadiusClippingRule { IncludeSelfForBorderRadius, DoNotIncludeSelfForBorderRadius };
83 enum IncludeSelfOrNot { IncludeSelf, ExcludeSelf };
84
85 enum RepaintStatus {
86     NeedsNormalRepaint,
87     NeedsFullRepaint,
88     NeedsFullRepaintForPositionedMovementLayout
89 };
90
91 enum ClipRectsType {
92     PaintingClipRects, // Relative to painting ancestor. Used for painting.
93     RootRelativeClipRects, // Relative to the ancestor treated as the root (e.g. transformed layer). Used for hit testing.
94     AbsoluteClipRects, // Relative to the RenderView's layer. Used for compositing overlap testing.
95     NumCachedClipRectsTypes,
96     AllClipRectTypes,
97     TemporaryClipRects
98 };
99
100 enum ShouldRespectOverflowClip {
101     IgnoreOverflowClip,
102     RespectOverflowClip
103 };
104
105 enum ShouldApplyRootOffsetToFragments {
106     ApplyRootOffsetToFragments,
107     IgnoreRootOffsetForFragments
108 };
109
110 enum class RequestState {
111     Unknown,
112     DontCare,
113     False,
114     True,
115     Undetermined
116 };
117
118 struct ScrollRectToVisibleOptions {
119     SelectionRevealMode revealMode { SelectionRevealMode::Reveal };
120     const ScrollAlignment& alignX { ScrollAlignment::alignCenterIfNeeded };
121     const ScrollAlignment& alignY { ScrollAlignment::alignCenterIfNeeded };
122     ShouldAllowCrossOriginScrolling shouldAllowCrossOriginScrolling { ShouldAllowCrossOriginScrolling::No };
123 };
124
125 class RenderLayer final : public ScrollableArea {
126     WTF_MAKE_FAST_ALLOCATED;
127 public:
128     friend class RenderReplica;
129     friend class RenderLayerFilters;
130
131     explicit RenderLayer(RenderLayerModelObject&);
132     virtual ~RenderLayer();
133
134 #if PLATFORM(IOS_FAMILY)
135     // Called before the renderer's widget (if any) has been nulled out.
136     void willBeDestroyed();
137 #endif
138     String name() const;
139
140     Page& page() const { return renderer().page(); }
141     RenderLayerModelObject& renderer() const { return m_renderer; }
142     RenderBox* renderBox() const { return is<RenderBox>(renderer()) ? &downcast<RenderBox>(renderer()) : nullptr; }
143
144     RenderLayer* parent() const { return m_parent; }
145     RenderLayer* previousSibling() const { return m_previous; }
146     RenderLayer* nextSibling() const { return m_next; }
147     RenderLayer* firstChild() const { return m_first; }
148     RenderLayer* lastChild() const { return m_last; }
149     bool isDescendantOf(const RenderLayer&) const;
150
151     // This does an ancestor tree walk. Avoid it!
152     const RenderLayer* root() const
153     {
154         const RenderLayer* curr = this;
155         while (curr->parent())
156             curr = curr->parent();
157         return curr;
158     }
159
160     void addChild(RenderLayer& newChild, RenderLayer* beforeChild = nullptr);
161     void removeChild(RenderLayer&);
162
163     void insertOnlyThisLayer();
164     void removeOnlyThisLayer();
165
166     bool isNormalFlowOnly() const { return m_isNormalFlowOnly; }
167     bool isStackingContext() const { return m_isStackingContext; }
168
169     // Gets the enclosing stacking context for this layer, excluding this layer itself.
170     RenderLayer* stackingContext() const;
171
172     // Gets the enclosing stacking container for this layer, possibly the layer
173     // itself, if it is a stacking container.
174     RenderLayer* enclosingStackingContext() { return isStackingContext() ? this : stackingContext(); }
175
176     RenderLayer* paintOrderParent() const;
177
178     void dirtyNormalFlowList();
179     void dirtyZOrderLists();
180     void dirtyStackingContextZOrderLists();
181
182     bool normalFlowListDirty() const { return m_normalFlowListDirty; }
183     bool zOrderListsDirty() const { return m_zOrderListsDirty; }
184
185 #if !ASSERT_DISABLED
186     bool layerListMutationAllowed() const { return m_layerListMutationAllowed; }
187     void setLayerListMutationAllowed(bool flag) { m_layerListMutationAllowed = flag; }
188 #endif
189
190 private:
191     // These flags propagate in paint order (z-order tree).
192     enum class Compositing {
193         HasDescendantNeedingRequirementsTraversal           = 1 << 0, // Need to do the overlap-testing tree walk because hierarchy or geometry changed.
194         HasDescendantNeedingBackingOrHierarchyTraversal     = 1 << 1, // Need to update geometry, configuration and update the GraphicsLayer tree.
195
196         // Things that trigger HasDescendantNeedingRequirementsTraversal
197         NeedsPaintOrderChildrenUpdate                       = 1 << 2, // The paint order children of this layer changed (gained/lost child, order change).
198         NeedsPostLayoutUpdate                               = 1 << 3, // Needs compositing to be re-evaluated after layout (it depends on geometry).
199         DescendantsNeedRequirementsTraversal                = 1 << 4, // Something changed that forces computeCompositingRequirements to traverse all descendant layers.
200         SubsequentLayersNeedRequirementsTraversal           = 1 << 5, // Something changed that forces computeCompositingRequirements to traverse all layers later in paint order.
201
202         // Things that trigger HasDescendantNeedingBackingOrHierarchyTraversal
203         NeedsGeometryUpdate                                 = 1 << 6, // This layer needs a geometry update.
204         NeedsConfigurationUpdate                            = 1 << 7, // This layer needs a configuration update (updating its internal compositing hierarchy).
205         NeedsScrollingTreeUpdate                            = 1 << 8, // Something changed that requires this layer's scrolling tree node to be updated.
206         NeedsLayerConnection                                = 1 << 9, // This layer needs hookup with its parents or children.
207         ChildrenNeedGeometryUpdate                          = 1 << 10, // This layer's composited children need a geometry update.
208         DescendantsNeedBackingAndHierarchyTraversal         = 1 << 11, // Something changed that forces us to traverse all descendant layers in updateBackingAndHierarchy.
209     };
210
211     static constexpr OptionSet<Compositing> computeCompositingRequirementsFlags()
212     {
213         return {
214             Compositing::NeedsPaintOrderChildrenUpdate,
215             Compositing::NeedsPostLayoutUpdate,
216             Compositing::DescendantsNeedRequirementsTraversal,
217             Compositing::SubsequentLayersNeedRequirementsTraversal,
218         };
219     }
220
221     static constexpr OptionSet<Compositing> updateBackingOrHierarchyFlags()
222     {
223         return {
224             Compositing::NeedsLayerConnection,
225             Compositing::NeedsGeometryUpdate,
226             Compositing::NeedsConfigurationUpdate,
227             Compositing::NeedsScrollingTreeUpdate,
228             Compositing::ChildrenNeedGeometryUpdate,
229             Compositing::DescendantsNeedBackingAndHierarchyTraversal,
230         };
231     }
232
233     void setAncestorsHaveCompositingDirtyFlag(Compositing);
234
235 public:
236     bool hasDescendantNeedingCompositingRequirementsTraversal() const { return m_compositingDirtyBits.contains(Compositing::HasDescendantNeedingRequirementsTraversal); }
237     bool hasDescendantNeedingUpdateBackingOrHierarchyTraversal() const { return m_compositingDirtyBits.contains(Compositing::HasDescendantNeedingBackingOrHierarchyTraversal); }
238
239     bool needsCompositingPaintOrderChildrenUpdate() const { return m_compositingDirtyBits.contains(Compositing::NeedsPaintOrderChildrenUpdate); }
240     bool needsPostLayoutCompositingUpdate() const { return m_compositingDirtyBits.contains(Compositing::NeedsPostLayoutUpdate); }
241     bool descendantsNeedCompositingRequirementsTraversal() const { return m_compositingDirtyBits.contains(Compositing::DescendantsNeedRequirementsTraversal); }
242     bool subsequentLayersNeedCompositingRequirementsTraversal() const { return m_compositingDirtyBits.contains(Compositing::SubsequentLayersNeedRequirementsTraversal); }
243
244     bool needsCompositingLayerConnection() const { return m_compositingDirtyBits.contains(Compositing::NeedsLayerConnection); }
245     bool needsCompositingGeometryUpdate() const { return m_compositingDirtyBits.contains(Compositing::NeedsGeometryUpdate); }
246     bool needsCompositingConfigurationUpdate() const { return m_compositingDirtyBits.contains(Compositing::NeedsConfigurationUpdate); }
247     bool needsScrollingTreeUpdate() const { return m_compositingDirtyBits.contains(Compositing::NeedsScrollingTreeUpdate); }
248     bool childrenNeedCompositingGeometryUpdate() const { return m_compositingDirtyBits.contains(Compositing::ChildrenNeedGeometryUpdate); }
249     bool descendantsNeedUpdateBackingAndHierarchyTraversal() const { return m_compositingDirtyBits.contains(Compositing::DescendantsNeedBackingAndHierarchyTraversal); }
250
251     template<Compositing V>
252     void setRequirementsTraversalDirtyBit()
253     {
254         m_compositingDirtyBits.add(V);
255         setAncestorsHaveCompositingDirtyFlag(Compositing::HasDescendantNeedingRequirementsTraversal);
256     }
257
258     void setNeedsCompositingPaintOrderChildrenUpdate() { setRequirementsTraversalDirtyBit<Compositing::NeedsPaintOrderChildrenUpdate>(); }
259     void setNeedsPostLayoutCompositingUpdate() { setRequirementsTraversalDirtyBit<Compositing::NeedsPostLayoutUpdate>(); }
260     void setDescendantsNeedCompositingRequirementsTraversal() { setRequirementsTraversalDirtyBit<Compositing::DescendantsNeedRequirementsTraversal>(); }
261     void setSubsequentLayersNeedCompositingRequirementsTraversal() { setRequirementsTraversalDirtyBit<Compositing::SubsequentLayersNeedRequirementsTraversal>(); }
262
263     void setNeedsPostLayoutCompositingUpdateOnAncestors() { setAncestorsHaveCompositingDirtyFlag(Compositing::NeedsPostLayoutUpdate); }
264
265     template<Compositing V>
266     void setBackingAndHierarchyTraversalDirtyBit()
267     {
268         m_compositingDirtyBits.add(V);
269         setAncestorsHaveCompositingDirtyFlag(Compositing::HasDescendantNeedingBackingOrHierarchyTraversal);
270     }
271
272     void setNeedsCompositingLayerConnection() { setBackingAndHierarchyTraversalDirtyBit<Compositing::NeedsLayerConnection>(); }
273     void setNeedsCompositingGeometryUpdate() { setBackingAndHierarchyTraversalDirtyBit<Compositing::NeedsGeometryUpdate>(); }
274     void setNeedsCompositingConfigurationUpdate() { setBackingAndHierarchyTraversalDirtyBit<Compositing::NeedsConfigurationUpdate>(); }
275     void setNeedsScrollingTreeUpdate() { setBackingAndHierarchyTraversalDirtyBit<Compositing::NeedsScrollingTreeUpdate>(); }
276     void setChildrenNeedCompositingGeometryUpdate() { setBackingAndHierarchyTraversalDirtyBit<Compositing::ChildrenNeedGeometryUpdate>(); }
277     void setDescendantsNeedUpdateBackingAndHierarchyTraversal() { setBackingAndHierarchyTraversalDirtyBit<Compositing::DescendantsNeedBackingAndHierarchyTraversal>(); }
278
279     void setNeedsCompositingGeometryUpdateOnAncestors() { setAncestorsHaveCompositingDirtyFlag(Compositing::NeedsGeometryUpdate); }
280
281     bool needsCompositingRequirementsTraversal() const { return m_compositingDirtyBits.containsAny(computeCompositingRequirementsFlags()); }
282     void clearCompositingRequirementsTraversalState()
283     {
284         m_compositingDirtyBits.remove(Compositing::HasDescendantNeedingRequirementsTraversal);
285         m_compositingDirtyBits.remove(computeCompositingRequirementsFlags());
286     }
287
288     bool needsUpdateBackingOrHierarchyTraversal() const { return m_compositingDirtyBits.containsAny(updateBackingOrHierarchyFlags()); }
289     void clearUpdateBackingOrHierarchyTraversalState()
290     {
291         m_compositingDirtyBits.remove(Compositing::HasDescendantNeedingBackingOrHierarchyTraversal);
292         m_compositingDirtyBits.remove(updateBackingOrHierarchyFlags());
293     }
294
295     bool needsAnyCompositingTraversal() const { return !m_compositingDirtyBits.isEmpty(); }
296     void clearCompositingPaintOrderState() { m_compositingDirtyBits = { }; }
297
298     class LayerList {
299         friend class RenderLayer;
300     public:
301         using iterator = RenderLayer**;
302         using const_iterator = RenderLayer * const *;
303         using reverse_iterator = std::reverse_iterator<iterator>;
304         using const_reverse_iterator = std::reverse_iterator<const_iterator>;
305
306         iterator begin() { return m_layerList ? m_layerList->begin() : nullptr; }
307         iterator end() { return m_layerList ? m_layerList->end() : nullptr; }
308
309         reverse_iterator rbegin() { return reverse_iterator(end()); }
310         reverse_iterator rend() { return reverse_iterator(begin()); }
311
312         const_iterator begin() const { return m_layerList ? m_layerList->begin() : nullptr; }
313         const_iterator end() const { return m_layerList ? m_layerList->end() : nullptr; }
314
315         const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); }
316         const_reverse_iterator rend() const { return const_reverse_iterator(begin()); }
317
318         size_t size() const { return m_layerList ? m_layerList->size() : 0; }
319
320     private:
321         LayerList(Vector<RenderLayer*>* layerList)
322             : m_layerList(layerList)
323         {
324         }
325         
326         Vector<RenderLayer*>* m_layerList;
327     };
328
329     LayerList normalFlowLayers() const
330     {
331         ASSERT(!m_normalFlowListDirty);
332         return LayerList(m_normalFlowList.get());
333     }
334
335     LayerList positiveZOrderLayers() const
336     {
337         ASSERT(!m_zOrderListsDirty);
338         ASSERT(isStackingContext() || !m_posZOrderList);
339         return LayerList(m_posZOrderList.get());
340     }
341
342     bool hasNegativeZOrderLayers() const
343     {
344         return m_negZOrderList && m_negZOrderList->size();
345     }
346
347     LayerList negativeZOrderLayers() const
348     {
349         ASSERT(!m_zOrderListsDirty);
350         ASSERT(isStackingContext() || !m_negZOrderList);
351         return LayerList(m_negZOrderList.get());
352     }
353
354     // Update our normal and z-index lists.
355     void updateLayerListsIfNeeded();
356     void updateDescendantDependentFlags();
357     bool descendantDependentFlagsAreDirty() const
358     {
359         return m_visibleDescendantStatusDirty || m_visibleContentStatusDirty || m_hasSelfPaintingLayerDescendantDirty
360 #if ENABLE(CSS_COMPOSITING)
361             || m_hasNotIsolatedBlendingDescendantsStatusDirty
362 #endif
363         ;
364     }
365
366     void repaintIncludingDescendants();
367
368     // Indicate that the layer contents need to be repainted. Only has an effect
369     // if layer compositing is being used.
370     void setBackingNeedsRepaint(GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
371
372     // The rect is in the coordinate space of the layer's render object.
373     void setBackingNeedsRepaintInRect(const LayoutRect&, GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
374     void repaintIncludingNonCompositingDescendants(RenderLayerModelObject* repaintContainer);
375
376     void styleChanged(StyleDifference, const RenderStyle* oldStyle);
377
378     RenderMarquee* marquee() const { return m_marquee.get(); }
379
380     bool isSelfPaintingLayer() const { return m_isSelfPaintingLayer; }
381
382     bool cannotBlitToWindow() const;
383
384     bool isTransparent() const { return renderer().isTransparent() || renderer().hasMask(); }
385
386     bool hasReflection() const { return renderer().hasReflection(); }
387     bool isReflection() const { return renderer().isReplica(); }
388     RenderReplica* reflection() const { return m_reflection.get(); }
389     RenderLayer* reflectionLayer() const;
390     bool isReflectionLayer(const RenderLayer&) const;
391
392     const LayoutPoint& location() const { return m_topLeft; }
393     void setLocation(const LayoutPoint& p) { m_topLeft = p; }
394
395     const IntSize& size() const { return m_layerSize; }
396     void setSize(const IntSize& size) { m_layerSize = size; } // Only public for RenderTreeAsText.
397
398     LayoutRect rect() const { return LayoutRect(location(), size()); }
399
400     int scrollWidth() const;
401     int scrollHeight() const;
402
403     void panScrollFromPoint(const IntPoint&);
404
405     // Scrolling methods for layers that can scroll their overflow.
406     void scrollByRecursively(const IntSize& delta, ScrollableArea** scrolledArea = nullptr);
407
408     WEBCORE_EXPORT void scrollToOffset(const ScrollOffset&, ScrollClamping = ScrollClamping::Clamped);
409     void scrollToXOffset(int x, ScrollClamping clamping = ScrollClamping::Clamped) { scrollToOffset(ScrollOffset(x, scrollOffset().y()), clamping); }
410     void scrollToYOffset(int y, ScrollClamping clamping = ScrollClamping::Clamped) { scrollToOffset(ScrollOffset(scrollOffset().x(), y), clamping); }
411
412     void scrollToXPosition(int x, ScrollClamping = ScrollClamping::Clamped);
413     void scrollToYPosition(int y, ScrollClamping = ScrollClamping::Clamped);
414
415     void setPostLayoutScrollPosition(Optional<ScrollPosition>);
416     void applyPostLayoutScrollPositionIfNeeded();
417
418     ScrollOffset scrollOffset() const { return scrollOffsetFromPosition(m_scrollPosition); }
419     IntSize scrollableContentsSize() const;
420
421     void availableContentSizeChanged(AvailableSizeChangeReason) override;
422
423     // "absoluteRect" is in scaled document coordinates.
424     void scrollRectToVisible(const LayoutRect& absoluteRect, bool insideFixed, const ScrollRectToVisibleOptions&);
425
426     bool scrollsOverflow() const;
427     bool hasScrollbars() const { return m_hBar || m_vBar; }
428     void setHasHorizontalScrollbar(bool);
429     void setHasVerticalScrollbar(bool);
430
431     Ref<Scrollbar> createScrollbar(ScrollbarOrientation);
432     void destroyScrollbar(ScrollbarOrientation);
433
434     bool hasHorizontalScrollbar() const { return horizontalScrollbar(); }
435     bool hasVerticalScrollbar() const { return verticalScrollbar(); }
436
437     // ScrollableArea overrides
438     ScrollPosition scrollPosition() const override { return m_scrollPosition; }
439
440     Scrollbar* horizontalScrollbar() const override { return m_hBar.get(); }
441     Scrollbar* verticalScrollbar() const override { return m_vBar.get(); }
442     ScrollableArea* enclosingScrollableArea() const override;
443     bool isScrollableOrRubberbandable() override;
444     bool hasScrollableOrRubberbandableAncestor() override;
445 #if ENABLE(CSS_SCROLL_SNAP)
446     void updateSnapOffsets() override;
447 #endif
448
449 #if PLATFORM(IOS_FAMILY)
450 #if ENABLE(IOS_TOUCH_EVENTS)
451     bool handleTouchEvent(const PlatformTouchEvent&) override;
452 #endif
453     
454     void didStartScroll() override;
455     void didEndScroll() override;
456     void didUpdateScroll() override;
457     void setIsUserScroll(bool isUserScroll) override { m_inUserScroll = isUserScroll; }
458
459     bool isInUserScroll() const { return m_inUserScroll; }
460
461     bool requiresScrollBoundsOriginUpdate() const { return m_requiresScrollBoundsOriginUpdate; }
462     void setRequiresScrollBoundsOriginUpdate(bool requiresUpdate = true) { m_requiresScrollBoundsOriginUpdate = requiresUpdate; }
463 #endif
464
465     // Returns true when the layer could do touch scrolling, but doesn't look at whether there is actually scrollable overflow.
466     bool canUseCompositedScrolling() const;
467     // Returns true when there is actually scrollable overflow (requires layout to be up-to-date).
468     bool hasCompositedScrollableOverflow() const;
469
470     int verticalScrollbarWidth(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
471     int horizontalScrollbarHeight(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
472
473     bool hasOverflowControls() const;
474     bool isPointInResizeControl(const IntPoint& absolutePoint) const;
475     bool hitTestOverflowControls(HitTestResult&, const IntPoint& localPoint);
476     IntSize offsetFromResizeCorner(const IntPoint& absolutePoint) const;
477
478     void paintOverflowControls(GraphicsContext&, const IntPoint&, const IntRect& damageRect, bool paintingOverlayControls = false);
479     void paintScrollCorner(GraphicsContext&, const IntPoint&, const IntRect& damageRect);
480     void paintResizer(GraphicsContext&, const LayoutPoint&, const LayoutRect& damageRect);
481
482     void updateScrollInfoAfterLayout();
483
484     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
485     void autoscroll(const IntPoint&);
486
487     bool canResize() const;
488     void resize(const PlatformMouseEvent&, const LayoutSize&);
489     bool inResizeMode() const { return m_inResizeMode; }
490     void setInResizeMode(bool b) { m_inResizeMode = b; }
491
492     bool isRenderViewLayer() const { return m_isRenderViewLayer; }
493     bool isForcedStackingContext() const { return m_forcedStackingContext; }
494
495     RenderLayerCompositor& compositor() const;
496     
497     // Notification from the renderer that its content changed (e.g. current frame of image changed).
498     // Allows updates of layer content without repainting.
499     void contentChanged(ContentChangeType);
500
501     bool canRender3DTransforms() const;
502
503     enum UpdateLayerPositionsFlag {
504         CheckForRepaint                 = 1 << 0,
505         NeedsFullRepaintInBacking       = 1 << 1,
506         UpdatePagination                = 1 << 2,
507         SeenTransformedLayer            = 1 << 3,
508         Seen3DTransformedLayer          = 1 << 4,
509     };
510     static constexpr OptionSet<UpdateLayerPositionsFlag> updateLayerPositionsDefaultFlags() { return { CheckForRepaint }; }
511
512     void updateLayerPositionsAfterLayout(const RenderLayer* rootLayer, OptionSet<UpdateLayerPositionsFlag>);
513
514     void updateLayerPositionsAfterOverflowScroll();
515     void updateLayerPositionsAfterDocumentScroll();
516
517     bool hasCompositedLayerInEnclosingPaginationChain() const;
518     enum PaginationInclusionMode { ExcludeCompositedPaginatedLayers, IncludeCompositedPaginatedLayers };
519     RenderLayer* enclosingPaginationLayer(PaginationInclusionMode mode) const
520     {
521         if (mode == ExcludeCompositedPaginatedLayers && hasCompositedLayerInEnclosingPaginationChain())
522             return nullptr;
523         return m_enclosingPaginationLayer.get();
524     }
525
526     void updateTransform();
527     
528 #if ENABLE(CSS_COMPOSITING)
529     void updateBlendMode();
530 #endif
531
532     const LayoutSize& offsetForInFlowPosition() const { return m_offsetForInFlowPosition; }
533
534     void clearClipRectsIncludingDescendants(ClipRectsType typeToClear = AllClipRectTypes);
535     void clearClipRects(ClipRectsType typeToClear = AllClipRectTypes);
536
537     void addBlockSelectionGapsBounds(const LayoutRect&);
538     void clearBlockSelectionGapsBounds();
539     void repaintBlockSelectionGaps();
540
541     // FIXME: We should ASSERT(!m_visibleContentStatusDirty) here, but see https://bugs.webkit.org/show_bug.cgi?id=71044
542     // ditto for hasVisibleDescendant(), see https://bugs.webkit.org/show_bug.cgi?id=71277
543     bool hasVisibleContent() const { return m_hasVisibleContent; }
544     bool hasVisibleDescendant() const { return m_hasVisibleDescendant; }
545
546     void setHasVisibleContent();
547     void dirtyVisibleContentStatus();
548
549     bool hasVisibleBoxDecorationsOrBackground() const;
550     bool hasVisibleBoxDecorations() const;
551
552     struct PaintedContentRequest {
553         void makeStatesUndetermined()
554         {
555             if (hasPaintedContent == RequestState::Unknown)
556                 hasPaintedContent = RequestState::Undetermined;
557
558             if (hasSubpixelAntialiasedText == RequestState::Unknown)
559                 hasSubpixelAntialiasedText = RequestState::Undetermined;
560         }
561
562         void setHasPaintedContent() { hasPaintedContent = RequestState::True; }
563         void setHasSubpixelAntialiasedText() { hasSubpixelAntialiasedText = RequestState::True; }
564
565         bool needToDeterminePaintedContentState() const { return hasPaintedContent == RequestState::Unknown; }
566         bool needToDetermineSubpixelAntialiasedTextState() const { return hasSubpixelAntialiasedText == RequestState::Unknown; }
567
568         bool probablyHasPaintedContent() const { return hasPaintedContent == RequestState::True || hasPaintedContent == RequestState::Undetermined; }
569         bool probablyHasSubpixelAntialiasedText() const { return hasSubpixelAntialiasedText == RequestState::True || hasSubpixelAntialiasedText == RequestState::Undetermined; }
570         
571         bool isSatisfied() const { return hasPaintedContent != RequestState::Unknown && hasSubpixelAntialiasedText != RequestState::Unknown; }
572
573         RequestState hasPaintedContent { RequestState::Unknown };
574         RequestState hasSubpixelAntialiasedText { RequestState::DontCare };
575     };
576
577     // Returns true if this layer has visible content (ignoring any child layers).
578     bool isVisuallyNonEmpty(PaintedContentRequest* = nullptr) const;
579     // True if this layer container renderers that paint.
580     bool hasNonEmptyChildRenderers(PaintedContentRequest&) const;
581
582     // FIXME: We should ASSERT(!m_hasSelfPaintingLayerDescendantDirty); here but we hit the same bugs as visible content above.
583     // Part of the issue is with subtree relayout: we don't check if our ancestors have some descendant flags dirty, missing some updates.
584     bool hasSelfPaintingLayerDescendant() const { return m_hasSelfPaintingLayerDescendant; }
585
586     // Gets the nearest enclosing positioned ancestor layer (also includes
587     // the <html> layer and the root layer).
588     RenderLayer* enclosingAncestorForPosition(PositionType) const;
589
590     // Returns the nearest enclosing layer that is scrollable.
591     RenderLayer* enclosingScrollableLayer() const;
592
593     // The layer relative to which clipping rects for this layer are computed.
594     RenderLayer* clippingRootForPainting() const;
595
596     RenderLayer* enclosingOverflowClipLayer(IncludeSelfOrNot) const;
597
598     // Enclosing compositing layer; if includeSelf is true, may return this.
599     RenderLayer* enclosingCompositingLayer(IncludeSelfOrNot = IncludeSelf) const;
600     RenderLayer* enclosingCompositingLayerForRepaint(IncludeSelfOrNot = IncludeSelf) const;
601     // Ancestor compositing layer, excluding this.
602     RenderLayer* ancestorCompositingLayer() const { return enclosingCompositingLayer(ExcludeSelf); }
603
604     RenderLayer* enclosingFilterLayer(IncludeSelfOrNot = IncludeSelf) const;
605     RenderLayer* enclosingFilterRepaintLayer() const;
606     void setFilterBackendNeedsRepaintingInRect(const LayoutRect&);
607     bool hasAncestorWithFilterOutsets() const;
608
609     bool canUseConvertToLayerCoords() const
610     {
611         // These RenderObject have an impact on their layers' without them knowing about it.
612         return !renderer().hasTransform() && !renderer().isSVGRoot();
613     }
614
615     // FIXME: adjustForColumns allows us to position compositing layers in columns correctly, but eventually they need to be split across columns too.
616     enum ColumnOffsetAdjustment { DontAdjustForColumns, AdjustForColumns };
617     void convertToPixelSnappedLayerCoords(const RenderLayer* ancestorLayer, IntPoint& location, ColumnOffsetAdjustment adjustForColumns = DontAdjustForColumns) const;
618     LayoutPoint convertToLayerCoords(const RenderLayer* ancestorLayer, const LayoutPoint&, ColumnOffsetAdjustment adjustForColumns = DontAdjustForColumns) const;
619     LayoutSize offsetFromAncestor(const RenderLayer*, ColumnOffsetAdjustment = DontAdjustForColumns) const;
620
621     int zIndex() const { return renderer().style().zIndex(); }
622
623     enum PaintLayerFlag {
624         PaintLayerHaveTransparency                      = 1 << 0,
625         PaintLayerAppliedTransform                      = 1 << 1,
626         PaintLayerTemporaryClipRects                    = 1 << 2,
627         PaintLayerPaintingReflection                    = 1 << 3,
628         PaintLayerPaintingOverlayScrollbars             = 1 << 4,
629         PaintLayerPaintingCompositingBackgroundPhase    = 1 << 5,
630         PaintLayerPaintingCompositingForegroundPhase    = 1 << 6,
631         PaintLayerPaintingCompositingMaskPhase          = 1 << 7,
632         PaintLayerPaintingCompositingClipPathPhase      = 1 << 8,
633         PaintLayerPaintingCompositingScrollingPhase     = 1 << 9,
634         PaintLayerPaintingOverflowContents              = 1 << 10,
635         PaintLayerPaintingRootBackgroundOnly            = 1 << 11,
636         PaintLayerPaintingSkipRootBackground            = 1 << 12,
637         PaintLayerPaintingChildClippingMaskPhase        = 1 << 13,
638     };
639     static constexpr OptionSet<PaintLayerFlag> paintLayerPaintingCompositingAllPhasesFlags() { return { PaintLayerPaintingCompositingBackgroundPhase,  PaintLayerPaintingCompositingForegroundPhase }; }
640
641     enum class SecurityOriginPaintPolicy { AnyOrigin, AccessibleOriginOnly };
642
643     // The two main functions that use the layer system.  The paint method
644     // paints the layers that intersect the damage rect from back to
645     // front.  The hitTest method looks for mouse events by walking
646     // layers that intersect the point from front to back.
647     void paint(GraphicsContext&, const LayoutRect& damageRect, const LayoutSize& subpixelOffset = LayoutSize(), OptionSet<PaintBehavior> = PaintBehavior::Normal,
648         RenderObject* subtreePaintRoot = nullptr, OptionSet<PaintLayerFlag> = { }, SecurityOriginPaintPolicy = SecurityOriginPaintPolicy::AnyOrigin);
649     bool hitTest(const HitTestRequest&, HitTestResult&);
650     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
651     void paintOverlayScrollbars(GraphicsContext&, const LayoutRect& damageRect, OptionSet<PaintBehavior>, RenderObject* subtreePaintRoot = nullptr);
652
653     struct ClipRectsContext {
654         ClipRectsContext(const RenderLayer* inRootLayer, ClipRectsType inClipRectsType, OverlayScrollbarSizeRelevancy inOverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize, ShouldRespectOverflowClip inRespectOverflowClip = RespectOverflowClip)
655             : rootLayer(inRootLayer)
656             , clipRectsType(inClipRectsType)
657             , overlayScrollbarSizeRelevancy(inOverlayScrollbarSizeRelevancy)
658             , respectOverflowClip(inRespectOverflowClip)
659         { }
660         const RenderLayer* rootLayer;
661         ClipRectsType clipRectsType;
662         OverlayScrollbarSizeRelevancy overlayScrollbarSizeRelevancy;
663         ShouldRespectOverflowClip respectOverflowClip;
664     };
665
666     // This method figures out our layerBounds in coordinates relative to
667     // |rootLayer}.  It also computes our background and foreground clip rects
668     // for painting/event handling.
669     // Pass offsetFromRoot if known.
670     void calculateRects(const ClipRectsContext&, const LayoutRect& paintDirtyRect, LayoutRect& layerBounds,
671         ClipRect& backgroundRect, ClipRect& foregroundRect, const LayoutSize& offsetFromRoot) const;
672
673     // Public just for RenderTreeAsText.
674     void collectFragments(LayerFragments&, const RenderLayer* rootLayer, const LayoutRect& dirtyRect,
675         PaginationInclusionMode,
676         ClipRectsType, OverlayScrollbarSizeRelevancy inOverlayScrollbarSizeRelevancy, ShouldRespectOverflowClip, const LayoutSize& offsetFromRoot,
677         const LayoutRect* layerBoundingBox = nullptr, ShouldApplyRootOffsetToFragments = IgnoreRootOffsetForFragments);
678         
679     LayoutRect childrenClipRect() const; // Returns the foreground clip rect of the layer in the document's coordinate space.
680     LayoutRect selfClipRect() const; // Returns the background clip rect of the layer in the document's coordinate space.
681     LayoutRect localClipRect(bool& clipExceedsBounds) const; // Returns the background clip rect of the layer in the local coordinate space.
682
683     // Pass offsetFromRoot if known.
684     bool intersectsDamageRect(const LayoutRect& layerBounds, const LayoutRect& damageRect, const RenderLayer* rootLayer, const LayoutSize& offsetFromRoot, const LayoutRect* cachedBoundingBox = nullptr) const;
685
686     enum CalculateLayerBoundsFlag {
687         IncludeSelfTransform                    = 1 << 0,
688         UseLocalClipRectIfPossible              = 1 << 1,
689         IncludeFilterOutsets                    = 1 << 2,
690         IncludePaintedFilterOutsets             = 1 << 3,
691         ExcludeHiddenDescendants                = 1 << 4,
692         DontConstrainForMask                    = 1 << 5,
693         IncludeCompositedDescendants            = 1 << 6,
694         UseFragmentBoxesExcludingCompositing    = 1 << 7,
695         UseFragmentBoxesIncludingCompositing    = 1 << 8,
696     };
697     static constexpr OptionSet<CalculateLayerBoundsFlag> defaultCalculateLayerBoundsFlags() { return { IncludeSelfTransform, UseLocalClipRectIfPossible, IncludePaintedFilterOutsets, UseFragmentBoxesExcludingCompositing }; }
698
699     // Bounding box relative to some ancestor layer. Pass offsetFromRoot if known.
700     LayoutRect boundingBox(const RenderLayer* rootLayer, const LayoutSize& offsetFromRoot = LayoutSize(), OptionSet<CalculateLayerBoundsFlag> = { }) const;
701     // Bounding box in the coordinates of this layer.
702     LayoutRect localBoundingBox(OptionSet<CalculateLayerBoundsFlag> = { }) const;
703     // Deprecated: Pixel snapped bounding box relative to the root.
704     WEBCORE_EXPORT IntRect absoluteBoundingBox() const;
705     // Device pixel snapped bounding box relative to the root. absoluteBoundingBox() callers will be directed to this.
706     FloatRect absoluteBoundingBoxForPainting() const;
707
708     // Bounds used for layer overlap testing in RenderLayerCompositor.
709     LayoutRect overlapBounds() const;
710     
711     // Takes transform animations into account, returning true if they could be cheaply computed.
712     // Unlike overlapBounds, these bounds include descendant layers.
713     bool getOverlapBoundsIncludingChildrenAccountingForTransformAnimations(LayoutRect&, OptionSet<CalculateLayerBoundsFlag> additionalFlags = { }) const;
714
715     // If true, this layer's children are included in its bounds for overlap testing.
716     // We can't rely on the children's positions if this layer has a filter that could have moved the children's pixels around.
717     bool overlapBoundsIncludeChildren() const { return hasFilter() && renderer().style().filter().hasFilterThatMovesPixels(); }
718
719     // Can pass offsetFromRoot if known.
720     LayoutRect calculateLayerBounds(const RenderLayer* ancestorLayer, const LayoutSize& offsetFromRoot, OptionSet<CalculateLayerBoundsFlag> = defaultCalculateLayerBoundsFlags()) const;
721     
722     // Return a cached repaint rect, computed relative to the layer renderer's containerForRepaint.
723     bool hasComputedRepaintRects() const { return renderer().hasRepaintLayoutRects(); }
724     LayoutRect repaintRectIncludingNonCompositingDescendants() const;
725
726     void setRepaintStatus(RepaintStatus status) { m_repaintStatus = status; }
727     RepaintStatus repaintStatus() const { return static_cast<RepaintStatus>(m_repaintStatus); }
728
729     LayoutUnit staticInlinePosition() const { return m_staticInlinePosition; }
730     LayoutUnit staticBlockPosition() const { return m_staticBlockPosition; }
731    
732     void setStaticInlinePosition(LayoutUnit position) { m_staticInlinePosition = position; }
733     void setStaticBlockPosition(LayoutUnit position) { m_staticBlockPosition = position; }
734
735 #if PLATFORM(IOS_FAMILY)
736     bool adjustForIOSCaretWhenScrolling() const { return m_adjustForIOSCaretWhenScrolling; }
737     void setAdjustForIOSCaretWhenScrolling(bool adjustForIOSCaretWhenScrolling) { m_adjustForIOSCaretWhenScrolling = adjustForIOSCaretWhenScrolling; }
738 #endif
739
740     bool hasTransform() const { return renderer().hasTransform(); }
741     // Note that this transform has the transform-origin baked in.
742     TransformationMatrix* transform() const { return m_transform.get(); }
743     // currentTransform computes a transform which takes accelerated animations into account. The
744     // resulting transform has transform-origin baked in. If the layer does not have a transform,
745     // returns the identity matrix.
746     TransformationMatrix currentTransform(RenderStyle::ApplyTransformOrigin = RenderStyle::IncludeTransformOrigin) const;
747     TransformationMatrix renderableTransform(OptionSet<PaintBehavior>) const;
748     
749     // Get the perspective transform, which is applied to transformed sublayers.
750     // Returns true if the layer has a -webkit-perspective.
751     // Note that this transform has the perspective-origin baked in.
752     TransformationMatrix perspectiveTransform() const;
753     FloatPoint perspectiveOrigin() const;
754     bool preserves3D() const { return renderer().style().transformStyle3D() == TransformStyle3D::Preserve3D; }
755     bool has3DTransform() const { return m_transform && !m_transform->isAffine(); }
756
757     void filterNeedsRepaint();
758     bool hasFilter() const { return renderer().hasFilter(); }
759     bool hasBackdropFilter() const
760     {
761 #if ENABLE(FILTERS_LEVEL_2)
762         return renderer().hasBackdropFilter();
763 #else
764         return false;
765 #endif
766     }
767
768 #if ENABLE(CSS_COMPOSITING)
769     bool hasBlendMode() const { return renderer().hasBlendMode(); }
770     BlendMode blendMode() const { return static_cast<BlendMode>(m_blendMode); }
771
772     bool isolatesCompositedBlending() const { return m_hasNotIsolatedCompositedBlendingDescendants && isStackingContext(); }
773     bool hasNotIsolatedCompositedBlendingDescendants() const { return m_hasNotIsolatedCompositedBlendingDescendants; }
774     void setHasNotIsolatedCompositedBlendingDescendants(bool hasNotIsolatedCompositedBlendingDescendants)
775     {
776         m_hasNotIsolatedCompositedBlendingDescendants = hasNotIsolatedCompositedBlendingDescendants;
777     }
778
779     bool isolatesBlending() const { return hasNotIsolatedBlendingDescendants() && isStackingContext(); }
780     
781     // FIXME: We should ASSERT(!m_hasNotIsolatedBlendingDescendantsStatusDirty); here but we hit the same bugs as visible content above.
782     bool hasNotIsolatedBlendingDescendants() const { return m_hasNotIsolatedBlendingDescendants; }
783     bool hasNotIsolatedBlendingDescendantsStatusDirty() const { return m_hasNotIsolatedBlendingDescendantsStatusDirty; }
784 #else
785     bool hasBlendMode() const { return false; }
786     bool isolatesCompositedBlending() const { return false; }
787     bool isolatesBlending() const { return false; }
788     bool hasNotIsolatedBlendingDescendantsStatusDirty() const { return false; }
789 #endif
790
791     bool isComposited() const { return m_backing != nullptr; }
792     bool hasCompositingDescendant() const { return m_hasCompositingDescendant; }
793     bool hasCompositedMask() const;
794
795     RenderLayerBacking* backing() const { return m_backing.get(); }
796     RenderLayerBacking* ensureBacking();
797     void clearBacking(bool layerBeingDestroyed = false);
798
799     GraphicsLayer* layerForScrolling() const override;
800     GraphicsLayer* layerForHorizontalScrollbar() const override;
801     GraphicsLayer* layerForVerticalScrollbar() const override;
802     GraphicsLayer* layerForScrollCorner() const override;
803
804     bool usesCompositedScrolling() const override;
805     bool usesAsyncScrolling() const override;
806
807     bool paintsWithTransparency(OptionSet<PaintBehavior> paintBehavior) const
808     {
809         return (isTransparent() || hasBlendMode() || (isolatesBlending() && !renderer().isDocumentElementRenderer())) && ((paintBehavior & PaintBehavior::FlattenCompositingLayers) || !isComposited());
810     }
811
812     bool paintsWithTransform(OptionSet<PaintBehavior>) const;
813     bool shouldPaintMask(OptionSet<PaintBehavior>, OptionSet<PaintLayerFlag>) const;
814     bool shouldApplyClipPath(OptionSet<PaintBehavior>, OptionSet<PaintLayerFlag>) const;
815
816     // Returns true if background phase is painted opaque in the given rect.
817     // The query rect is given in local coordinates.
818     bool backgroundIsKnownToBeOpaqueInRect(const LayoutRect&) const;
819
820     bool scrollingMayRevealBackground() const;
821
822     bool containsDirtyOverlayScrollbars() const { return m_containsDirtyOverlayScrollbars; }
823     void setContainsDirtyOverlayScrollbars(bool dirtyScrollbars) { m_containsDirtyOverlayScrollbars = dirtyScrollbars; }
824
825     bool paintsWithFilters() const;
826     bool requiresFullLayerImageForFilters() const;
827
828     Element* enclosingElement() const;
829
830     enum ViewportConstrainedNotCompositedReason {
831         NoNotCompositedReason,
832         NotCompositedForBoundsOutOfView,
833         NotCompositedForNonViewContainer,
834         NotCompositedForNoVisibleContent,
835     };
836
837     void setViewportConstrainedNotCompositedReason(ViewportConstrainedNotCompositedReason reason) { m_viewportConstrainedNotCompositedReason = reason; }
838     ViewportConstrainedNotCompositedReason viewportConstrainedNotCompositedReason() const { return static_cast<ViewportConstrainedNotCompositedReason>(m_viewportConstrainedNotCompositedReason); }
839     
840     bool isRenderFragmentedFlow() const { return renderer().isRenderFragmentedFlow(); }
841     bool isOutOfFlowRenderFragmentedFlow() const { return renderer().isOutOfFlowRenderFragmentedFlow(); }
842     bool isInsideFragmentedFlow() const { return renderer().fragmentedFlowState() != RenderObject::NotInsideFragmentedFlow; }
843     bool isDirtyRenderFragmentedFlow() const
844     {
845         ASSERT(isRenderFragmentedFlow());
846         return zOrderListsDirty() || normalFlowListDirty();
847     }
848
849     RenderLayer* enclosingFragmentedFlowAncestor() const;
850
851     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final { return renderer().shouldPlaceBlockDirectionScrollbarOnLeft(); }
852
853     void simulateFrequentPaint() { SinglePaintFrequencyTracking { m_paintFrequencyTracker }; }
854     bool paintingFrequently() const { return m_paintFrequencyTracker.paintingFrequently(); }
855
856 private:
857
858     void setNextSibling(RenderLayer* next) { m_next = next; }
859     void setPreviousSibling(RenderLayer* prev) { m_previous = prev; }
860     void setParent(RenderLayer*);
861     void setFirstChild(RenderLayer* first) { m_first = first; }
862     void setLastChild(RenderLayer* last) { m_last = last; }
863     
864     void dirtyPaintOrderListsOnChildChange(RenderLayer&);
865
866     bool shouldBeNormalFlowOnly() const;
867     bool shouldBeStackingContext() const;
868     
869     // Return true if changed.
870     bool setIsNormalFlowOnly(bool);
871     bool setIsStackingContext(bool);
872
873     bool isDirtyStackingContext() const { return m_zOrderListsDirty && isStackingContext(); }
874
875     void updateZOrderLists();
876     void rebuildZOrderLists();
877     void rebuildZOrderLists(std::unique_ptr<Vector<RenderLayer*>>&, std::unique_ptr<Vector<RenderLayer*>>&);
878     void collectLayers(bool includeHiddenLayers, std::unique_ptr<Vector<RenderLayer*>>&, std::unique_ptr<Vector<RenderLayer*>>&);
879     void clearZOrderLists();
880
881     void updateNormalFlowList();
882
883     struct LayerPaintingInfo {
884         LayerPaintingInfo(RenderLayer* inRootLayer, const LayoutRect& inDirtyRect, OptionSet<PaintBehavior> inPaintBehavior, const LayoutSize& inSubpixelOffset, RenderObject* inSubtreePaintRoot = nullptr, OverlapTestRequestMap* inOverlapTestRequests = nullptr, bool inRequireSecurityOriginAccessForWidgets = false)
885             : rootLayer(inRootLayer)
886             , subtreePaintRoot(inSubtreePaintRoot)
887             , paintDirtyRect(inDirtyRect)
888             , subpixelOffset(inSubpixelOffset)
889             , overlapTestRequests(inOverlapTestRequests)
890             , paintBehavior(inPaintBehavior)
891             , requireSecurityOriginAccessForWidgets(inRequireSecurityOriginAccessForWidgets)
892         { }
893
894         RenderLayer* rootLayer;
895         RenderObject* subtreePaintRoot; // Only paint descendants of this object.
896         LayoutRect paintDirtyRect; // Relative to rootLayer;
897         LayoutSize subpixelOffset;
898         OverlapTestRequestMap* overlapTestRequests; // May be null.
899         OptionSet<PaintBehavior> paintBehavior;
900         bool requireSecurityOriginAccessForWidgets;
901         bool clipToDirtyRect { true };
902     };
903
904     // Compute, cache and return clip rects computed with the given layer as the root.
905     Ref<ClipRects> updateClipRects(const ClipRectsContext&);
906     // Compute and return the clip rects. If useCached is true, will used previously computed clip rects on ancestors
907     // (rather than computing them all from scratch up the parent chain).
908     void calculateClipRects(const ClipRectsContext&, ClipRects&) const;
909     ClipRects* clipRects(const ClipRectsContext&) const;
910
911     void setAncestorChainHasSelfPaintingLayerDescendant();
912     void dirtyAncestorChainHasSelfPaintingLayerDescendantStatus();
913
914     void computeRepaintRects(const RenderLayerModelObject* repaintContainer, const RenderGeometryMap* = nullptr);
915     void computeRepaintRectsIncludingDescendants();
916     void clearRepaintRects();
917
918     LayoutRect clipRectRelativeToAncestor(RenderLayer* ancestor, LayoutSize offsetFromAncestor, const LayoutRect& constrainingRect) const;
919
920     void clipToRect(GraphicsContext&, const LayerPaintingInfo&, const ClipRect&, BorderRadiusClippingRule = IncludeSelfForBorderRadius);
921     void restoreClip(GraphicsContext&, const LayerPaintingInfo&, const ClipRect&);
922
923     bool shouldRepaintAfterLayout() const;
924
925     void updateSelfPaintingLayer();
926
927     void updateScrollbarsAfterStyleChange(const RenderStyle* oldStyle);
928     void updateScrollbarsAfterLayout();
929
930     // Returns true if the position changed.
931     bool updateLayerPosition();
932
933     void updateLayerPositions(RenderGeometryMap* = nullptr, OptionSet<UpdateLayerPositionsFlag> = updateLayerPositionsDefaultFlags());
934
935     enum UpdateLayerPositionsAfterScrollFlag {
936         IsOverflowScroll                        = 1 << 0,
937         HasSeenViewportConstrainedAncestor      = 1 << 1,
938         HasSeenAncestorWithOverflowClip         = 1 << 2,
939         HasChangedAncestor                      = 1 << 3,
940     };
941     void updateLayerPositionsAfterScroll(RenderGeometryMap*, OptionSet<UpdateLayerPositionsAfterScrollFlag> = { });
942
943     ScrollOffset clampScrollOffset(const ScrollOffset&) const;
944
945     RenderLayer* enclosingPaginationLayerInSubtree(const RenderLayer* rootLayer, PaginationInclusionMode) const;
946
947     LayoutPoint renderBoxLocation() const { return is<RenderBox>(renderer()) ? downcast<RenderBox>(renderer()).location() : LayoutPoint(); }
948
949     bool setupFontSubpixelQuantization(GraphicsContext&, bool& didQuantizeFonts);
950
951     Path computeClipPath(const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, WindRule&) const;
952
953     bool setupClipPath(GraphicsContext&, const LayerPaintingInfo&, const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, bool& rootRelativeBoundsComputed);
954
955     void ensureLayerFilters();
956     void clearLayerFilters();
957
958     RenderLayerFilters* filtersForPainting(GraphicsContext&, OptionSet<PaintLayerFlag>) const;
959     GraphicsContext* setupFilters(GraphicsContext& destinationContext, LayerPaintingInfo&, OptionSet<PaintLayerFlag>, const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, bool& rootRelativeBoundsComputed);
960     void applyFilters(GraphicsContext& originalContext, const LayerPaintingInfo&, const LayerFragments&);
961
962     void paintLayer(GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>);
963     void paintLayerContentsAndReflection(GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>);
964     void paintLayerByApplyingTransform(GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>, const LayoutSize& translationOffset = LayoutSize());
965     void paintLayerContents(GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>);
966     void paintList(LayerList, GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>);
967
968     void updatePaintingInfoForFragments(LayerFragments&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>, bool shouldPaintContent, const LayoutSize& offsetFromRoot);
969     void paintBackgroundForFragments(const LayerFragments&, GraphicsContext&, GraphicsContext& transparencyLayerContext,
970         const LayoutRect& transparencyPaintDirtyRect, bool haveTransparency, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
971     void paintForegroundForFragments(const LayerFragments&, GraphicsContext&, GraphicsContext& transparencyLayerContext,
972         const LayoutRect& transparencyPaintDirtyRect, bool haveTransparency, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
973     void paintForegroundForFragmentsWithPhase(PaintPhase, const LayerFragments&, GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
974     void paintOutlineForFragments(const LayerFragments&, GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
975     void paintOverflowControlsForFragments(const LayerFragments&, GraphicsContext&, const LayerPaintingInfo&);
976     void paintMaskForFragments(const LayerFragments&, GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
977     void paintChildClippingMaskForFragments(const LayerFragments&, GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintBehavior>, RenderObject* paintingRootForRenderer);
978     void paintTransformedLayerIntoFragments(GraphicsContext&, const LayerPaintingInfo&, OptionSet<PaintLayerFlag>);
979
980     RenderLayer* transparentPaintingAncestor();
981     void beginTransparencyLayers(GraphicsContext&, const LayerPaintingInfo&, const LayoutRect& dirtyRect);
982
983     RenderLayer* hitTestLayer(RenderLayer* rootLayer, RenderLayer* containerLayer, const HitTestRequest&, HitTestResult&,
984         const LayoutRect& hitTestRect, const HitTestLocation&, bool appliedTransform,
985         const HitTestingTransformState* = nullptr, double* zOffset = nullptr);
986     RenderLayer* hitTestLayerByApplyingTransform(RenderLayer* rootLayer, RenderLayer* containerLayer, const HitTestRequest&, HitTestResult&,
987         const LayoutRect& hitTestRect, const HitTestLocation&, const HitTestingTransformState* = nullptr, double* zOffset = nullptr,
988         const LayoutSize& translationOffset = LayoutSize());
989     RenderLayer* hitTestList(LayerList, RenderLayer* rootLayer, const HitTestRequest&, HitTestResult&,
990         const LayoutRect& hitTestRect, const HitTestLocation&,
991         const HitTestingTransformState*, double* zOffsetForDescendants, double* zOffset,
992         const HitTestingTransformState* unflattenedTransformState, bool depthSortDescendants);
993
994     Ref<HitTestingTransformState> createLocalTransformState(RenderLayer* rootLayer, RenderLayer* containerLayer,
995         const LayoutRect& hitTestRect, const HitTestLocation&,
996         const HitTestingTransformState* containerTransformState,
997         const LayoutSize& translationOffset = LayoutSize()) const;
998     
999     bool hitTestContents(const HitTestRequest&, HitTestResult&, const LayoutRect& layerBounds, const HitTestLocation&, HitTestFilter) const;
1000     bool hitTestContentsForFragments(const LayerFragments&, const HitTestRequest&, HitTestResult&, const HitTestLocation&, HitTestFilter, bool& insideClipRect) const;
1001     bool hitTestResizerInFragments(const LayerFragments&, const HitTestLocation&) const;
1002     RenderLayer* hitTestTransformedLayerInFragments(RenderLayer* rootLayer, RenderLayer* containerLayer, const HitTestRequest&, HitTestResult&,
1003         const LayoutRect& hitTestRect, const HitTestLocation&, const HitTestingTransformState* = nullptr, double* zOffset = nullptr);
1004
1005     bool listBackgroundIsKnownToBeOpaqueInRect(const LayerList&, const LayoutRect&) const;
1006
1007     void computeScrollDimensions();
1008     bool hasHorizontalOverflow() const;
1009     bool hasVerticalOverflow() const;
1010     bool hasScrollableHorizontalOverflow() const;
1011     bool hasScrollableVerticalOverflow() const;
1012
1013     bool showsOverflowControls() const;
1014
1015     bool shouldBeSelfPaintingLayer() const;
1016
1017     int scrollOffset(ScrollbarOrientation) const override;
1018     
1019     // ScrollableArea interface
1020     void invalidateScrollbarRect(Scrollbar&, const IntRect&) override;
1021     void invalidateScrollCornerRect(const IntRect&) override;
1022     bool isActive() const override;
1023     bool isScrollCornerVisible() const override;
1024     IntRect scrollCornerRect() const override;
1025     IntRect convertFromScrollbarToContainingView(const Scrollbar&, const IntRect&) const override;
1026     IntRect convertFromContainingViewToScrollbar(const Scrollbar&, const IntRect&) const override;
1027     IntPoint convertFromScrollbarToContainingView(const Scrollbar&, const IntPoint&) const override;
1028     IntPoint convertFromContainingViewToScrollbar(const Scrollbar&, const IntPoint&) const override;
1029     int scrollSize(ScrollbarOrientation) const override;
1030     void setScrollOffset(const ScrollOffset&) override;
1031
1032     IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const override;
1033     IntSize visibleSize() const override;
1034     IntSize contentsSize() const override;
1035     IntSize overhangAmount() const override;
1036     IntPoint lastKnownMousePosition() const override;
1037     bool isHandlingWheelEvent() const override;
1038     bool shouldSuspendScrollAnimations() const override;
1039     IntRect scrollableAreaBoundingBox(bool* isInsideFixed = nullptr) const override;
1040     bool isRubberBandInProgress() const override;
1041     bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override;
1042 #if ENABLE(CSS_SCROLL_SNAP)
1043     bool isScrollSnapInProgress() const override;
1044 #endif
1045     bool usesMockScrollAnimator() const override;
1046     void logMockScrollAnimatorMessage(const String&) const override;
1047
1048 #if ENABLE(IOS_TOUCH_EVENTS)
1049     void registerAsTouchEventListenerForScrolling();
1050     void unregisterAsTouchEventListenerForScrolling();
1051 #endif
1052
1053     // Rectangle encompassing the scroll corner and resizer rect.
1054     LayoutRect scrollCornerAndResizerRect() const;
1055
1056     // NOTE: This should only be called by the overridden setScrollOffset from ScrollableArea.
1057     void scrollTo(const ScrollPosition&);
1058     void updateCompositingLayersAfterScroll();
1059
1060     IntSize scrollbarOffset(const Scrollbar&) const;
1061     
1062     void updateScrollableAreaSet(bool hasOverflow);
1063     
1064     bool allowsCurrentScroll() const;
1065
1066     void dirtyAncestorChainVisibleDescendantStatus();
1067     void setAncestorChainHasVisibleDescendant();
1068
1069     bool has3DTransformedDescendant() const { return m_has3DTransformedDescendant; }
1070
1071     bool hasTransformedAncestor() const { return m_hasTransformedAncestor; }
1072     bool has3DTransformedAncestor() const { return m_has3DTransformedAncestor; }
1073
1074     void dirty3DTransformedDescendantStatus();
1075     // Both updates the status, and returns true if descendants of this have 3d.
1076     bool update3DTransformedDescendantStatus();
1077
1078     void createReflection();
1079     void removeReflection();
1080
1081     RenderStyle createReflectionStyle();
1082     bool paintingInsideReflection() const { return m_paintingInsideReflection; }
1083     void setPaintingInsideReflection(bool b) { m_paintingInsideReflection = b; }
1084
1085     void updateFiltersAfterStyleChange();
1086     void updateFilterPaintingStrategy();
1087
1088 #if ENABLE(CSS_COMPOSITING)
1089     void updateAncestorChainHasBlendingDescendants();
1090     void dirtyAncestorChainHasBlendingDescendants();
1091 #endif
1092
1093     Ref<ClipRects> parentClipRects(const ClipRectsContext&) const;
1094     ClipRect backgroundClipRect(const ClipRectsContext&) const;
1095
1096     RenderLayer* enclosingTransformedAncestor() const;
1097
1098     LayoutRect getRectToExpose(const LayoutRect& visibleRect, const LayoutRect& exposeRect, bool insideFixed, const ScrollAlignment& alignX, const ScrollAlignment& alignY) const;
1099
1100     // Convert a point in absolute coords into layer coords, taking transforms into account
1101     LayoutPoint absoluteToContents(const LayoutPoint&) const;
1102
1103     void positionOverflowControls(const IntSize&);
1104     void updateScrollCornerStyle();
1105     void clearScrollCorner();
1106     void updateResizerStyle();
1107     void clearResizer();
1108
1109     void drawPlatformResizerImage(GraphicsContext&, const LayoutRect& resizerCornerRect);
1110
1111     void updatePagination();
1112
1113     void setHasCompositingDescendant(bool b)  { m_hasCompositingDescendant = b; }
1114     
1115     enum class IndirectCompositingReason {
1116         None,
1117         Stacking,
1118         Overlap,
1119         BackgroundLayer,
1120         GraphicalEffect, // opacity, mask, filter, transform etc.
1121         Perspective,
1122         Preserve3D
1123     };
1124     
1125     void setIndirectCompositingReason(IndirectCompositingReason reason) { m_indirectCompositingReason = static_cast<unsigned>(reason); }
1126     IndirectCompositingReason indirectCompositingReason() const { return static_cast<IndirectCompositingReason>(m_indirectCompositingReason); }
1127     bool mustCompositeForIndirectReasons() const { return m_indirectCompositingReason; }
1128
1129     friend class RenderLayerBacking;
1130     friend class RenderLayerCompositor;
1131     friend class RenderLayerModelObject;
1132
1133     LayoutUnit overflowTop() const;
1134     LayoutUnit overflowBottom() const;
1135     LayoutUnit overflowLeft() const;
1136     LayoutUnit overflowRight() const;
1137
1138     IntRect rectForHorizontalScrollbar(const IntRect& borderBoxRect) const;
1139     IntRect rectForVerticalScrollbar(const IntRect& borderBoxRect) const;
1140
1141     LayoutUnit verticalScrollbarStart(int minX, int maxX) const;
1142     LayoutUnit horizontalScrollbarStart(int minX) const;
1143
1144     bool overflowControlsIntersectRect(const IntRect& localRect) const;
1145
1146     OptionSet<Compositing> m_compositingDirtyBits;
1147
1148     const bool m_isRenderViewLayer : 1;
1149     const bool m_forcedStackingContext : 1;
1150
1151     bool m_isNormalFlowOnly : 1;
1152     bool m_isStackingContext : 1;
1153
1154     bool m_zOrderListsDirty : 1;
1155     bool m_normalFlowListDirty: 1;
1156     bool m_hadNegativeZOrderList : 1;
1157
1158     // Keeps track of whether the layer is currently resizing, so events can cause resizing to start and stop.
1159     bool m_inResizeMode : 1;
1160
1161     bool m_scrollDimensionsDirty : 1;
1162     bool m_isSelfPaintingLayer : 1;
1163
1164     // If have no self-painting descendants, we don't have to walk our children during painting. This can lead to
1165     // significant savings, especially if the tree has lots of non-self-painting layers grouped together (e.g. table cells).
1166     bool m_hasSelfPaintingLayerDescendant : 1;
1167     bool m_hasSelfPaintingLayerDescendantDirty : 1;
1168
1169     bool m_usedTransparency : 1; // Tracks whether we need to close a transparent layer, i.e., whether
1170                                  // we ended up painting this layer or any descendants (and therefore need to
1171                                  // blend).
1172     bool m_paintingInsideReflection : 1;  // A state bit tracking if we are painting inside a replica.
1173     bool m_inOverflowRelayout : 1;
1174     unsigned m_repaintStatus : 2; // RepaintStatus
1175
1176     bool m_visibleContentStatusDirty : 1;
1177     bool m_hasVisibleContent : 1;
1178     bool m_visibleDescendantStatusDirty : 1;
1179     bool m_hasVisibleDescendant : 1;
1180     bool m_registeredScrollableArea : 1;
1181     bool m_isFixedIntersectingViewport : 1;
1182
1183     bool m_3DTransformedDescendantStatusDirty : 1;
1184     bool m_has3DTransformedDescendant : 1;  // Set on a stacking context layer that has 3D descendants anywhere
1185                                             // in a preserves3D hierarchy. Hint to do 3D-aware hit testing.
1186     bool m_hasCompositingDescendant : 1; // In the z-order tree.
1187
1188     bool m_hasTransformedAncestor : 1;
1189     bool m_has3DTransformedAncestor : 1;
1190
1191     unsigned m_indirectCompositingReason : 3;
1192     unsigned m_viewportConstrainedNotCompositedReason : 2;
1193
1194 #if PLATFORM(IOS_FAMILY)
1195     bool m_adjustForIOSCaretWhenScrolling : 1;
1196 #if ENABLE(IOS_TOUCH_EVENTS)
1197     bool m_registeredAsTouchEventListenerForScrolling : 1;
1198 #endif
1199     bool m_inUserScroll : 1;
1200     bool m_requiresScrollBoundsOriginUpdate : 1;
1201 #endif
1202
1203     bool m_containsDirtyOverlayScrollbars : 1;
1204     bool m_updatingMarqueePosition : 1;
1205
1206 #if !ASSERT_DISABLED
1207     bool m_layerListMutationAllowed : 1;
1208 #endif
1209
1210 #if ENABLE(CSS_COMPOSITING)
1211     unsigned m_blendMode : 5;
1212     bool m_hasNotIsolatedCompositedBlendingDescendants : 1;
1213     bool m_hasNotIsolatedBlendingDescendants : 1;
1214     bool m_hasNotIsolatedBlendingDescendantsStatusDirty : 1;
1215 #endif
1216
1217     RenderLayerModelObject& m_renderer;
1218
1219     RenderLayer* m_parent { nullptr };
1220     RenderLayer* m_previous { nullptr };
1221     RenderLayer* m_next { nullptr };
1222     RenderLayer* m_first { nullptr };
1223     RenderLayer* m_last { nullptr };
1224
1225     // For layers that establish stacking contexts, m_posZOrderList holds a sorted list of all the
1226     // descendant layers within the stacking context that have z-indices of 0 or greater
1227     // (auto will count as 0). m_negZOrderList holds descendants within our stacking context with negative
1228     // z-indices.
1229     std::unique_ptr<Vector<RenderLayer*>> m_posZOrderList;
1230     std::unique_ptr<Vector<RenderLayer*>> m_negZOrderList;
1231
1232     // This list contains child layers that cannot create stacking contexts and appear in normal flow order.
1233     std::unique_ptr<Vector<RenderLayer*>> m_normalFlowList;
1234
1235     // Our current relative position offset.
1236     LayoutSize m_offsetForInFlowPosition;
1237
1238     // Our (x,y) coordinates are in our parent layer's coordinate space.
1239     LayoutPoint m_topLeft;
1240
1241     // The layer's width/height
1242     IntSize m_layerSize;
1243
1244     ScrollPosition m_scrollPosition;
1245     Optional<ScrollPosition> m_postLayoutScrollPosition;
1246
1247     // The width/height of our scrolled area.
1248     IntSize m_scrollSize;
1249
1250     // For layers with overflow, we have a pair of scrollbars.
1251     RefPtr<Scrollbar> m_hBar;
1252     RefPtr<Scrollbar> m_vBar;
1253
1254     std::unique_ptr<ClipRectsCache> m_clipRectsCache;
1255     
1256     IntPoint m_cachedOverlayScrollbarOffset;
1257
1258     std::unique_ptr<RenderMarquee> m_marquee; // Used for <marquee>.
1259     
1260     // Cached normal flow values for absolute positioned elements with static left/top values.
1261     LayoutUnit m_staticInlinePosition;
1262     LayoutUnit m_staticBlockPosition;
1263
1264     std::unique_ptr<TransformationMatrix> m_transform;
1265     
1266     // May ultimately be extended to many replicas (with their own paint order).
1267     RenderPtr<RenderReplica> m_reflection;
1268
1269     // Renderers to hold our custom scroll corner and resizer.
1270     RenderPtr<RenderScrollbarPart> m_scrollCorner;
1271     RenderPtr<RenderScrollbarPart> m_resizer;
1272
1273     // Pointer to the enclosing RenderLayer that caused us to be paginated. It is 0 if we are not paginated.
1274     WeakPtr<RenderLayer> m_enclosingPaginationLayer;
1275
1276     IntRect m_blockSelectionGapsBounds;
1277
1278     std::unique_ptr<RenderLayerFilters> m_filters;
1279     std::unique_ptr<RenderLayerBacking> m_backing;
1280     
1281     PaintFrequencyTracker m_paintFrequencyTracker;
1282 };
1283
1284 inline void RenderLayer::clearZOrderLists()
1285 {
1286     ASSERT(!isStackingContext());
1287     ASSERT(layerListMutationAllowed());
1288
1289     m_posZOrderList = nullptr;
1290     m_negZOrderList = nullptr;
1291 }
1292
1293 inline void RenderLayer::updateZOrderLists()
1294 {
1295     if (!m_zOrderListsDirty)
1296         return;
1297
1298     if (!isStackingContext()) {
1299         clearZOrderLists();
1300         m_zOrderListsDirty = false;
1301         return;
1302     }
1303
1304     rebuildZOrderLists();
1305 }
1306
1307 inline RenderLayer* RenderLayer::paintOrderParent() const
1308 {
1309     return m_isNormalFlowOnly ? m_parent : stackingContext();
1310 }
1311
1312 #if !ASSERT_DISABLED
1313 class LayerListMutationDetector {
1314 public:
1315     LayerListMutationDetector(RenderLayer& layer)
1316         : m_layer(layer)
1317         , m_previousMutationAllowedState(layer.layerListMutationAllowed())
1318     {
1319         m_layer.setLayerListMutationAllowed(false);
1320     }
1321     
1322     ~LayerListMutationDetector()
1323     {
1324         m_layer.setLayerListMutationAllowed(m_previousMutationAllowedState);
1325     }
1326
1327 private:
1328     RenderLayer& m_layer;
1329     bool m_previousMutationAllowedState;
1330 };
1331 #endif
1332
1333 void makeMatrixRenderable(TransformationMatrix&, bool has3DRendering);
1334
1335 bool compositedWithOwnBackingStore(const RenderLayer&);
1336
1337 WTF::TextStream& operator<<(WTF::TextStream&, const RenderLayer&);
1338
1339 } // namespace WebCore
1340
1341 #if ENABLE(TREE_DEBUGGING)
1342 // Outside the WebCore namespace for ease of invocation from lldb.
1343 void showLayerTree(const WebCore::RenderLayer*);
1344 void showPaintOrderTree(const WebCore::RenderLayer*);
1345 void showLayerTree(const WebCore::RenderObject*);
1346 #endif