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