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