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