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