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