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