Restrict SVG filters to accessible security origins
[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
269     int verticalScrollbarWidth(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
270     int horizontalScrollbarHeight(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
271
272     bool hasOverflowControls() const;
273     bool isPointInResizeControl(const IntPoint& absolutePoint) const;
274     bool hitTestOverflowControls(HitTestResult&, const IntPoint& localPoint);
275     IntSize offsetFromResizeCorner(const IntPoint& absolutePoint) const;
276
277     void paintOverflowControls(GraphicsContext&, const IntPoint&, const IntRect& damageRect, bool paintingOverlayControls = false);
278     void paintScrollCorner(GraphicsContext&, const IntPoint&, const IntRect& damageRect);
279     void paintResizer(GraphicsContext&, const LayoutPoint&, const LayoutRect& damageRect);
280
281     void updateScrollInfoAfterLayout();
282
283     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
284     void autoscroll(const IntPoint&);
285
286     bool canResize() const;
287     void resize(const PlatformMouseEvent&, const LayoutSize&);
288     bool inResizeMode() const { return m_inResizeMode; }
289     void setInResizeMode(bool b) { m_inResizeMode = b; }
290
291     bool isRootLayer() const { return m_isRootLayer; }
292
293     RenderLayerCompositor& compositor() const;
294     
295     // Notification from the renderer that its content changed (e.g. current frame of image changed).
296     // Allows updates of layer content without repainting.
297     void contentChanged(ContentChangeType);
298
299     bool canRender3DTransforms() const;
300
301     enum UpdateLayerPositionsFlag {
302         CheckForRepaint = 1 << 0,
303         NeedsFullRepaintInBacking = 1 << 1,
304         IsCompositingUpdateRoot = 1 << 2,
305         UpdateCompositingLayers = 1 << 3,
306         UpdatePagination = 1 << 4,
307         SeenTransformedLayer = 1 << 5,
308         Seen3DTransformedLayer = 1 << 6
309     };
310     typedef unsigned UpdateLayerPositionsFlags;
311     static const UpdateLayerPositionsFlags defaultFlags = CheckForRepaint | IsCompositingUpdateRoot | UpdateCompositingLayers;
312
313     void updateLayerPositionsAfterLayout(const RenderLayer* rootLayer, UpdateLayerPositionsFlags);
314
315     void updateLayerPositionsAfterOverflowScroll();
316     void updateLayerPositionsAfterDocumentScroll();
317
318     void positionNewlyCreatedOverflowControls();
319
320     bool hasCompositedLayerInEnclosingPaginationChain() const;
321     enum PaginationInclusionMode { ExcludeCompositedPaginatedLayers, IncludeCompositedPaginatedLayers };
322     RenderLayer* enclosingPaginationLayer(PaginationInclusionMode mode) const
323     {
324         if (mode == ExcludeCompositedPaginatedLayers && hasCompositedLayerInEnclosingPaginationChain())
325             return nullptr;
326         return m_enclosingPaginationLayer;
327     }
328
329     void updateTransform();
330     
331 #if ENABLE(CSS_COMPOSITING)
332     void updateBlendMode();
333 #endif
334
335     const LayoutSize& offsetForInFlowPosition() const { return m_offsetForInFlowPosition; }
336
337     void clearClipRectsIncludingDescendants(ClipRectsType typeToClear = AllClipRectTypes);
338     void clearClipRects(ClipRectsType typeToClear = AllClipRectTypes);
339
340     void addBlockSelectionGapsBounds(const LayoutRect&);
341     void clearBlockSelectionGapsBounds();
342     void repaintBlockSelectionGaps();
343
344     // A stacking context is a layer that has a non-auto z-index.
345     bool isStackingContext() const { return isStackingContext(&renderer().style()); }
346
347     // A stacking container can have z-order lists. All stacking contexts are
348     // stacking containers, but the converse is not true. Layers that use
349     // composited scrolling are stacking containers, but they may not
350     // necessarily be stacking contexts.
351     bool isStackingContainer() const { return isStackingContext() || needsCompositedScrolling(); }
352
353     // Gets the enclosing stacking container for this layer, excluding this
354     // layer itself.
355     RenderLayer* stackingContainer() const;
356
357     // Gets the enclosing stacking container for this layer, possibly the layer
358     // itself, if it is a stacking container.
359     RenderLayer* enclosingStackingContainer() { return isStackingContainer() ? this : stackingContainer(); }
360
361     void dirtyZOrderLists();
362     void dirtyStackingContainerZOrderLists();
363
364     Vector<RenderLayer*>* posZOrderList() const
365     {
366         ASSERT(!m_zOrderListsDirty);
367         ASSERT(isStackingContainer() || !m_posZOrderList);
368         return m_posZOrderList.get();
369     }
370
371     bool hasNegativeZOrderList() const { return negZOrderList() && negZOrderList()->size(); }
372
373     Vector<RenderLayer*>* negZOrderList() const
374     {
375         ASSERT(!m_zOrderListsDirty);
376         ASSERT(isStackingContainer() || !m_negZOrderList);
377         return m_negZOrderList.get();
378     }
379
380     void dirtyNormalFlowList();
381     Vector<RenderLayer*>* normalFlowList() const { ASSERT(!m_normalFlowListDirty); return m_normalFlowList.get(); }
382
383     // Update our normal and z-index lists.
384     void updateLayerListsIfNeeded();
385
386     // Update the normal and z-index lists of our descendants.
387     void updateDescendantsLayerListsIfNeeded(bool recursive);
388
389     // FIXME: We should ASSERT(!m_visibleContentStatusDirty) here, but see https://bugs.webkit.org/show_bug.cgi?id=71044
390     // ditto for hasVisibleDescendant(), see https://bugs.webkit.org/show_bug.cgi?id=71277
391     bool hasVisibleContent() const { return m_hasVisibleContent; }
392     bool hasVisibleDescendant() const { return m_hasVisibleDescendant; }
393
394     void setHasVisibleContent();
395     void dirtyVisibleContentStatus();
396
397     bool hasVisibleBoxDecorationsOrBackground() const;
398     bool hasVisibleBoxDecorations() const;
399
400     struct PaintedContentRequest {
401         void makeStatesUndetermined()
402         {
403             if (hasPaintedContent == RequestState::Unknown)
404                 hasPaintedContent = RequestState::Undetermined;
405
406             if (hasSubpixelAntialiasedText == RequestState::Unknown)
407                 hasSubpixelAntialiasedText = RequestState::Undetermined;
408         }
409
410         void setHasPaintedContent() { hasPaintedContent = RequestState::True; }
411         void setHasSubpixelAntialiasedText() { hasSubpixelAntialiasedText = RequestState::True; }
412
413         bool needToDeterminePaintedContentState() const { return hasPaintedContent == RequestState::Unknown; }
414         bool needToDetermineSubpixelAntialiasedTextState() const { return hasSubpixelAntialiasedText == RequestState::Unknown; }
415
416         bool probablyHasPaintedContent() const { return hasPaintedContent == RequestState::True || hasPaintedContent == RequestState::Undetermined; }
417         bool probablyHasSubpixelAntialiasedText() const { return hasSubpixelAntialiasedText == RequestState::True || hasSubpixelAntialiasedText == RequestState::Undetermined; }
418         
419         bool isSatisfied() const { return hasPaintedContent != RequestState::Unknown && hasSubpixelAntialiasedText != RequestState::Unknown; }
420
421         RequestState hasPaintedContent { RequestState::Unknown };
422         RequestState hasSubpixelAntialiasedText { RequestState::DontCare };
423     };
424
425     // Returns true if this layer has visible content (ignoring any child layers).
426     bool isVisuallyNonEmpty(PaintedContentRequest* = nullptr) const;
427     // True if this layer container renderers that paint.
428     bool hasNonEmptyChildRenderers(PaintedContentRequest&) const;
429
430     // FIXME: We should ASSERT(!m_hasSelfPaintingLayerDescendantDirty); here but we hit the same bugs as visible content above.
431     // Part of the issue is with subtree relayout: we don't check if our ancestors have some descendant flags dirty, missing some updates.
432     bool hasSelfPaintingLayerDescendant() const { return m_hasSelfPaintingLayerDescendant; }
433
434     // This returns true if we have an out of flow positioned descendant whose
435     // containing block is not a descendant of ours. If this is true, we cannot
436     // automatically opt into composited scrolling since this out of flow
437     // positioned descendant would become clipped by us, possibly altering the 
438     // rendering of the page.
439     // FIXME: We should ASSERT(!m_hasOutOfFlowPositionedDescendantDirty); here but we may hit the same bugs as visible content above.
440     bool hasOutOfFlowPositionedDescendant() const { return m_hasOutOfFlowPositionedDescendant; }
441
442     // Gets the nearest enclosing positioned ancestor layer (also includes
443     // the <html> layer and the root layer).
444     RenderLayer* enclosingAncestorForPosition(EPosition) const;
445
446     // Returns the nearest enclosing layer that is scrollable.
447     RenderLayer* enclosingScrollableLayer() const;
448
449     // The layer relative to which clipping rects for this layer are computed.
450     RenderLayer* clippingRootForPainting() const;
451
452     RenderLayer* enclosingOverflowClipLayer(IncludeSelfOrNot) const;
453
454     // Enclosing compositing layer; if includeSelf is true, may return this.
455     RenderLayer* enclosingCompositingLayer(IncludeSelfOrNot = IncludeSelf) const;
456     RenderLayer* enclosingCompositingLayerForRepaint(IncludeSelfOrNot = IncludeSelf) const;
457     // Ancestor compositing layer, excluding this.
458     RenderLayer* ancestorCompositingLayer() const { return enclosingCompositingLayer(ExcludeSelf); }
459
460     RenderLayer* enclosingFilterLayer(IncludeSelfOrNot = IncludeSelf) const;
461     RenderLayer* enclosingFilterRepaintLayer() const;
462     void setFilterBackendNeedsRepaintingInRect(const LayoutRect&);
463     bool hasAncestorWithFilterOutsets() const;
464
465     bool canUseConvertToLayerCoords() const
466     {
467         // These RenderObject have an impact on their layers' without them knowing about it.
468         return !renderer().hasTransform() && !renderer().isSVGRoot();
469     }
470
471     // FIXME: adjustForColumns allows us to position compositing layers in columns correctly, but eventually they need to be split across columns too.
472     enum ColumnOffsetAdjustment { DontAdjustForColumns, AdjustForColumns };
473     void convertToPixelSnappedLayerCoords(const RenderLayer* ancestorLayer, IntPoint& location, ColumnOffsetAdjustment adjustForColumns = DontAdjustForColumns) const;
474     LayoutPoint convertToLayerCoords(const RenderLayer* ancestorLayer, const LayoutPoint&, ColumnOffsetAdjustment adjustForColumns = DontAdjustForColumns) const;
475     LayoutSize offsetFromAncestor(const RenderLayer*, ColumnOffsetAdjustment = DontAdjustForColumns) const;
476
477     int zIndex() const { return renderer().style().zIndex(); }
478
479     enum PaintLayerFlag {
480         PaintLayerHaveTransparency                      = 1 << 0,
481         PaintLayerAppliedTransform                      = 1 << 1,
482         PaintLayerTemporaryClipRects                    = 1 << 2,
483         PaintLayerPaintingReflection                    = 1 << 3,
484         PaintLayerPaintingOverlayScrollbars             = 1 << 4,
485         PaintLayerPaintingCompositingBackgroundPhase    = 1 << 5,
486         PaintLayerPaintingCompositingForegroundPhase    = 1 << 6,
487         PaintLayerPaintingCompositingMaskPhase          = 1 << 7,
488         PaintLayerPaintingCompositingClipPathPhase      = 1 << 8,
489         PaintLayerPaintingCompositingScrollingPhase     = 1 << 9,
490         PaintLayerPaintingOverflowContents              = 1 << 10,
491         PaintLayerPaintingRootBackgroundOnly            = 1 << 11,
492         PaintLayerPaintingSkipRootBackground            = 1 << 12,
493         PaintLayerPaintingChildClippingMaskPhase        = 1 << 13,
494         PaintLayerPaintingCompositingAllPhases          = PaintLayerPaintingCompositingBackgroundPhase | PaintLayerPaintingCompositingForegroundPhase
495     };
496     
497     typedef unsigned PaintLayerFlags;
498
499     enum class SecurityOriginPaintPolicy { AnyOrigin, AccessibleOriginOnly };
500
501     // The two main functions that use the layer system.  The paint method
502     // paints the layers that intersect the damage rect from back to
503     // front.  The hitTest method looks for mouse events by walking
504     // layers that intersect the point from front to back.
505     void paint(GraphicsContext&, const LayoutRect& damageRect, const LayoutSize& subpixelOffset = LayoutSize(), PaintBehavior = PaintBehaviorNormal,
506         RenderObject* subtreePaintRoot = nullptr, PaintLayerFlags = 0, SecurityOriginPaintPolicy = SecurityOriginPaintPolicy::AnyOrigin);
507     bool hitTest(const HitTestRequest&, HitTestResult&);
508     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
509     void paintOverlayScrollbars(GraphicsContext&, const LayoutRect& damageRect, PaintBehavior, RenderObject* subtreePaintRoot = nullptr);
510
511     void paintNamedFlowThreadInsideRegion(GraphicsContext&, RenderNamedFlowFragment*, LayoutRect, LayoutPoint, PaintBehavior = PaintBehaviorNormal, PaintLayerFlags = 0);
512
513     struct ClipRectsContext {
514         ClipRectsContext(const RenderLayer* inRootLayer, ClipRectsType inClipRectsType, OverlayScrollbarSizeRelevancy inOverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize, ShouldRespectOverflowClip inRespectOverflowClip = RespectOverflowClip)
515             : rootLayer(inRootLayer)
516             , clipRectsType(inClipRectsType)
517             , overlayScrollbarSizeRelevancy(inOverlayScrollbarSizeRelevancy)
518             , respectOverflowClip(inRespectOverflowClip)
519         { }
520         const RenderLayer* rootLayer;
521         ClipRectsType clipRectsType;
522         OverlayScrollbarSizeRelevancy overlayScrollbarSizeRelevancy;
523         ShouldRespectOverflowClip respectOverflowClip;
524     };
525
526     // This method figures out our layerBounds in coordinates relative to
527     // |rootLayer}.  It also computes our background and foreground clip rects
528     // for painting/event handling.
529     // Pass offsetFromRoot if known.
530     void calculateRects(const ClipRectsContext&, const LayoutRect& paintDirtyRect, LayoutRect& layerBounds,
531         ClipRect& backgroundRect, ClipRect& foregroundRect, const LayoutSize& offsetFromRoot) const;
532
533     // Public just for RenderTreeAsText.
534     void collectFragments(LayerFragments&, const RenderLayer* rootLayer, const LayoutRect& dirtyRect,
535         PaginationInclusionMode,
536         ClipRectsType, OverlayScrollbarSizeRelevancy inOverlayScrollbarSizeRelevancy, ShouldRespectOverflowClip, const LayoutSize& offsetFromRoot,
537         const LayoutRect* layerBoundingBox = nullptr, ShouldApplyRootOffsetToFragments = IgnoreRootOffsetForFragments);
538         
539     LayoutRect childrenClipRect() const; // Returns the foreground clip rect of the layer in the document's coordinate space.
540     LayoutRect selfClipRect() const; // Returns the background clip rect of the layer in the document's coordinate space.
541     LayoutRect localClipRect(bool& clipExceedsBounds) const; // Returns the background clip rect of the layer in the local coordinate space.
542
543     // Pass offsetFromRoot if known.
544     bool intersectsDamageRect(const LayoutRect& layerBounds, const LayoutRect& damageRect, const RenderLayer* rootLayer, const LayoutSize& offsetFromRoot, const LayoutRect* cachedBoundingBox = nullptr) const;
545
546     enum CalculateLayerBoundsFlag {
547         IncludeSelfTransform                    = 1 << 0,
548         UseLocalClipRectIfPossible              = 1 << 1,
549         IncludeLayerFilterOutsets               = 1 << 2,
550         ExcludeHiddenDescendants                = 1 << 3,
551         DontConstrainForMask                    = 1 << 4,
552         IncludeCompositedDescendants            = 1 << 5,
553         UseFragmentBoxesExcludingCompositing    = 1 << 6,
554         UseFragmentBoxesIncludingCompositing    = 1 << 7,
555         DefaultCalculateLayerBoundsFlags        = IncludeSelfTransform | UseLocalClipRectIfPossible | IncludeLayerFilterOutsets | UseFragmentBoxesExcludingCompositing
556     };
557     typedef unsigned CalculateLayerBoundsFlags;
558
559     // Bounding box relative to some ancestor layer. Pass offsetFromRoot if known.
560     LayoutRect boundingBox(const RenderLayer* rootLayer, const LayoutSize& offsetFromRoot = LayoutSize(), CalculateLayerBoundsFlags = 0) const;
561     // Bounding box in the coordinates of this layer.
562     LayoutRect localBoundingBox(CalculateLayerBoundsFlags = 0) const;
563     // Deprecated: Pixel snapped bounding box relative to the root.
564     WEBCORE_EXPORT IntRect absoluteBoundingBox() const;
565     // Device pixel snapped bounding box relative to the root. absoluteBoundingBox() callers will be directed to this.
566     FloatRect absoluteBoundingBoxForPainting() const;
567
568     // Bounds used for layer overlap testing in RenderLayerCompositor.
569     LayoutRect overlapBounds() const { return overlapBoundsIncludeChildren() ? calculateLayerBounds(this, LayoutSize()) : localBoundingBox(); }
570     
571     // Takes transform animations into account, returning true if they could be cheaply computed.
572     // Unlike overlapBounds, these bounds include descendant layers.
573     bool getOverlapBoundsIncludingChildrenAccountingForTransformAnimations(LayoutRect&) const;
574
575     // If true, this layer's children are included in its bounds for overlap testing.
576     // We can't rely on the children's positions if this layer has a filter that could have moved the children's pixels around.
577     bool overlapBoundsIncludeChildren() const { return hasFilter() && renderer().style().filter().hasFilterThatMovesPixels(); }
578
579     // Can pass offsetFromRoot if known.
580     LayoutRect calculateLayerBounds(const RenderLayer* ancestorLayer, const LayoutSize& offsetFromRoot, CalculateLayerBoundsFlags = DefaultCalculateLayerBoundsFlags) const;
581     
582     // Return a cached repaint rect, computed relative to the layer renderer's containerForRepaint.
583     bool hasComputedRepaintRect() const { return m_hasComputedRepaintRect; }
584     LayoutRect repaintRect() const { ASSERT(hasComputedRepaintRect()); return m_repaintRect; }
585     LayoutRect repaintRectIncludingNonCompositingDescendants() const;
586
587     void setRepaintStatus(RepaintStatus status) { m_repaintStatus = status; }
588     RepaintStatus repaintStatus() const { return static_cast<RepaintStatus>(m_repaintStatus); }
589
590     LayoutUnit staticInlinePosition() const { return m_staticInlinePosition; }
591     LayoutUnit staticBlockPosition() const { return m_staticBlockPosition; }
592    
593     void setStaticInlinePosition(LayoutUnit position) { m_staticInlinePosition = position; }
594     void setStaticBlockPosition(LayoutUnit position) { m_staticBlockPosition = position; }
595
596 #if PLATFORM(IOS)
597     bool adjustForIOSCaretWhenScrolling() const { return m_adjustForIOSCaretWhenScrolling; }
598     void setAdjustForIOSCaretWhenScrolling(bool adjustForIOSCaretWhenScrolling) { m_adjustForIOSCaretWhenScrolling = adjustForIOSCaretWhenScrolling; }
599 #endif
600
601     bool hasTransform() const { return renderer().hasTransform(); }
602     // Note that this transform has the transform-origin baked in.
603     TransformationMatrix* transform() const { return m_transform.get(); }
604     // currentTransform computes a transform which takes accelerated animations into account. The
605     // resulting transform has transform-origin baked in. If the layer does not have a transform,
606     // returns the identity matrix.
607     TransformationMatrix currentTransform(RenderStyle::ApplyTransformOrigin = RenderStyle::IncludeTransformOrigin) const;
608     TransformationMatrix renderableTransform(PaintBehavior) const;
609     
610     // Get the perspective transform, which is applied to transformed sublayers.
611     // Returns true if the layer has a -webkit-perspective.
612     // Note that this transform has the perspective-origin baked in.
613     TransformationMatrix perspectiveTransform() const;
614     FloatPoint perspectiveOrigin() const;
615     bool preserves3D() const { return renderer().style().transformStyle3D() == TransformStyle3DPreserve3D; }
616     bool has3DTransform() const { return m_transform && !m_transform->isAffine(); }
617
618     void filterNeedsRepaint();
619     bool hasFilter() const { return renderer().hasFilter(); }
620     bool hasBackdropFilter() const
621     {
622 #if ENABLE(FILTERS_LEVEL_2)
623         return renderer().hasBackdropFilter();
624 #else
625         return false;
626 #endif
627     }
628
629 #if ENABLE(CSS_COMPOSITING)
630     bool hasBlendMode() const { return renderer().hasBlendMode(); }
631     BlendMode blendMode() const { return static_cast<BlendMode>(m_blendMode); }
632
633     bool isolatesCompositedBlending() const { return m_hasNotIsolatedCompositedBlendingDescendants && isStackingContext(); }
634     bool hasNotIsolatedCompositedBlendingDescendants() const { return m_hasNotIsolatedCompositedBlendingDescendants; }
635     void setHasNotIsolatedCompositedBlendingDescendants(bool hasNotIsolatedCompositedBlendingDescendants)
636     {
637         m_hasNotIsolatedCompositedBlendingDescendants = hasNotIsolatedCompositedBlendingDescendants;
638     }
639
640     bool isolatesBlending() const { return hasNotIsolatedBlendingDescendants() && isStackingContext(); }
641     
642     // FIXME: We should ASSERT(!m_hasNotIsolatedBlendingDescendantsStatusDirty); here but we hit the same bugs as visible content above.
643     bool hasNotIsolatedBlendingDescendants() const { return m_hasNotIsolatedBlendingDescendants; }
644     bool hasNotIsolatedBlendingDescendantsStatusDirty() const { return m_hasNotIsolatedBlendingDescendantsStatusDirty; }
645 #else
646     bool hasBlendMode() const { return false; }
647     bool isolatesCompositedBlending() const { return false; }
648     bool isolatesBlending() const { return false; }
649     bool hasNotIsolatedBlendingDescendantsStatusDirty() const { return false; }
650 #endif
651
652     bool isComposited() const { return m_backing != 0; }
653     bool hasCompositingDescendant() const { return m_hasCompositingDescendant; }
654     bool hasCompositedMask() const;
655     RenderLayerBacking* backing() const { return m_backing.get(); }
656     RenderLayerBacking* ensureBacking();
657     void clearBacking(bool layerBeingDestroyed = false);
658     GraphicsLayer* layerForScrolling() const override;
659     GraphicsLayer* layerForHorizontalScrollbar() const override;
660     GraphicsLayer* layerForVerticalScrollbar() const override;
661     GraphicsLayer* layerForScrollCorner() const override;
662     bool usesCompositedScrolling() const override;
663     bool usesAsyncScrolling() const override;
664     WEBCORE_EXPORT bool needsCompositedScrolling() const;
665
666     bool paintsWithTransparency(PaintBehavior paintBehavior) const
667     {
668         return (isTransparent() || hasBlendMode() || (isolatesBlending() && !renderer().isDocumentElementRenderer())) && ((paintBehavior & PaintBehaviorFlattenCompositingLayers) || !isComposited());
669     }
670
671     bool paintsWithTransform(PaintBehavior) const;
672     bool shouldPaintMask(PaintBehavior, PaintLayerFlags) const;
673     bool shouldApplyClipPath(PaintBehavior, PaintLayerFlags) const;
674
675     // Returns true if background phase is painted opaque in the given rect.
676     // The query rect is given in local coordinates.
677     bool backgroundIsKnownToBeOpaqueInRect(const LayoutRect&) const;
678
679     bool containsDirtyOverlayScrollbars() const { return m_containsDirtyOverlayScrollbars; }
680     void setContainsDirtyOverlayScrollbars(bool dirtyScrollbars) { m_containsDirtyOverlayScrollbars = dirtyScrollbars; }
681
682     bool paintsWithFilters() const;
683     bool requiresFullLayerImageForFilters() const;
684     FilterEffectRenderer* filterRenderer() const;
685
686 #if !ASSERT_DISABLED
687     bool layerListMutationAllowed() const { return m_layerListMutationAllowed; }
688     void setLayerListMutationAllowed(bool flag) { m_layerListMutationAllowed = flag; }
689 #endif
690
691     Element* enclosingElement() const;
692
693     enum ViewportConstrainedNotCompositedReason {
694         NoNotCompositedReason,
695         NotCompositedForBoundsOutOfView,
696         NotCompositedForNonViewContainer,
697         NotCompositedForNoVisibleContent,
698     };
699
700     void setViewportConstrainedNotCompositedReason(ViewportConstrainedNotCompositedReason reason) { m_viewportConstrainedNotCompositedReason = reason; }
701     ViewportConstrainedNotCompositedReason viewportConstrainedNotCompositedReason() const { return static_cast<ViewportConstrainedNotCompositedReason>(m_viewportConstrainedNotCompositedReason); }
702     
703     bool isRenderFlowThread() const { return renderer().isRenderFlowThread(); }
704     bool isOutOfFlowRenderFlowThread() const { return renderer().isOutOfFlowRenderFlowThread(); }
705     bool isInsideFlowThread() const { return renderer().flowThreadState() != RenderObject::NotInsideFlowThread; }
706     bool isInsideOutOfFlowThread() const { return renderer().flowThreadState() == RenderObject::InsideOutOfFlowThread; }
707     bool isDirtyRenderFlowThread() const
708     {
709         ASSERT(isRenderFlowThread());
710         return m_zOrderListsDirty || m_normalFlowListDirty;
711     }
712
713     bool isFlowThreadCollectingGraphicsLayersUnderRegions() const;
714
715     RenderLayer* enclosingFlowThreadAncestor() const;
716
717     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final { return renderer().shouldPlaceBlockDirectionScrollbarOnLeft(); }
718
719 private:
720     enum CollectLayersBehavior { StopAtStackingContexts, StopAtStackingContainers };
721
722     struct LayerPaintingInfo {
723         LayerPaintingInfo(RenderLayer* inRootLayer, const LayoutRect& inDirtyRect, PaintBehavior inPaintBehavior, const LayoutSize& inSupixelOffset, RenderObject* inSubtreePaintRoot = nullptr, OverlapTestRequestMap* inOverlapTestRequests = nullptr, bool inRequireSecurityOriginAccessForWidgets = false)
724             : rootLayer(inRootLayer)
725             , subtreePaintRoot(inSubtreePaintRoot)
726             , paintDirtyRect(inDirtyRect)
727             , subpixelOffset(inSupixelOffset)
728             , overlapTestRequests(inOverlapTestRequests)
729             , paintBehavior(inPaintBehavior)
730             , requireSecurityOriginAccessForWidgets(inRequireSecurityOriginAccessForWidgets)
731         { }
732         RenderLayer* rootLayer;
733         RenderObject* subtreePaintRoot; // only paint descendants of this object
734         LayoutRect paintDirtyRect; // relative to rootLayer;
735         LayoutSize subpixelOffset;
736         OverlapTestRequestMap* overlapTestRequests; // May be null.
737         PaintBehavior paintBehavior;
738         bool requireSecurityOriginAccessForWidgets;
739         bool clipToDirtyRect { true };
740     };
741
742     // Compute, cache and return clip rects computed with the given layer as the root.
743     Ref<ClipRects> updateClipRects(const ClipRectsContext&);
744     // Compute and return the clip rects. If useCached is true, will used previously computed clip rects on ancestors
745     // (rather than computing them all from scratch up the parent chain).
746     void calculateClipRects(const ClipRectsContext&, ClipRects&) const;
747     ClipRects* clipRects(const ClipRectsContext&) const;
748
749     void updateZOrderLists();
750     void rebuildZOrderLists();
751     void rebuildZOrderLists(CollectLayersBehavior, std::unique_ptr<Vector<RenderLayer*>>&, std::unique_ptr<Vector<RenderLayer*>>&);
752     void clearZOrderLists();
753
754     void updateNormalFlowList();
755
756     // Non-auto z-index always implies stacking context here, because StyleResolver::adjustRenderStyle already adjusts z-index
757     // based on positioning and other criteria.
758     bool isStackingContext(const RenderStyle* style) const { return !style->hasAutoZIndex() || isRootLayer() || m_forcedStackingContext; }
759
760     bool isDirtyStackingContainer() const { return m_zOrderListsDirty && isStackingContainer(); }
761
762     void setAncestorChainHasSelfPaintingLayerDescendant();
763     void dirtyAncestorChainHasSelfPaintingLayerDescendantStatus();
764
765     bool acceleratedCompositingForOverflowScrollEnabled() const;
766     void updateDescendantsAreContiguousInStackingOrder();
767     void updateDescendantsAreContiguousInStackingOrderRecursive(const HashMap<const RenderLayer*, int>&, int& minIndex, int& maxIndex, int& count, bool firstIteration);
768
769     void computeRepaintRects(const RenderLayerModelObject* repaintContainer, const RenderGeometryMap* = nullptr);
770     void computeRepaintRectsIncludingDescendants();
771     void clearRepaintRects();
772
773     LayoutRect clipRectRelativeToAncestor(RenderLayer* ancestor, LayoutSize offsetFromAncestor, const LayoutRect& constrainingRect) const;
774
775     void clipToRect(GraphicsContext&, const LayerPaintingInfo&, const ClipRect&, BorderRadiusClippingRule = IncludeSelfForBorderRadius);
776     void restoreClip(GraphicsContext&, const LayerPaintingInfo&, const ClipRect&);
777
778     bool shouldRepaintAfterLayout() const;
779
780     void updateSelfPaintingLayer();
781     void updateStackingContextsAfterStyleChange(const RenderStyle* oldStyle);
782
783     void updateScrollbarsAfterStyleChange(const RenderStyle* oldStyle);
784     void updateScrollbarsAfterLayout();
785
786     void setAncestorChainHasOutOfFlowPositionedDescendant(RenderBlock* containingBlock);
787     void dirtyAncestorChainHasOutOfFlowPositionedDescendantStatus();
788     void updateOutOfFlowPositioned(const RenderStyle* oldStyle);
789
790     void updateNeedsCompositedScrolling();
791
792     // Returns true if the position changed.
793     bool updateLayerPosition();
794
795     void updateLayerPositions(RenderGeometryMap* = nullptr, UpdateLayerPositionsFlags = defaultFlags);
796
797     enum UpdateLayerPositionsAfterScrollFlag {
798         NoFlag = 0,
799         IsOverflowScroll = 1 << 0,
800         HasSeenViewportConstrainedAncestor = 1 << 1,
801         HasSeenAncestorWithOverflowClip = 1 << 2,
802         HasChangedAncestor = 1 << 3
803     };
804     typedef unsigned UpdateLayerPositionsAfterScrollFlags;
805     void updateLayerPositionsAfterScroll(RenderGeometryMap*, UpdateLayerPositionsAfterScrollFlags = NoFlag);
806
807     ScrollOffset clampScrollOffset(const ScrollOffset&) const;
808
809     RenderLayer* enclosingPaginationLayerInSubtree(const RenderLayer* rootLayer, PaginationInclusionMode) const;
810
811     void setNextSibling(RenderLayer* next) { m_next = next; }
812     void setPreviousSibling(RenderLayer* prev) { m_previous = prev; }
813     void setParent(RenderLayer* parent);
814     void setFirstChild(RenderLayer* first) { m_first = first; }
815     void setLastChild(RenderLayer* last) { m_last = last; }
816
817     LayoutPoint renderBoxLocation() const { return is<RenderBox>(renderer()) ? downcast<RenderBox>(renderer()).location() : LayoutPoint(); }
818
819     void collectLayers(bool includeHiddenLayers, CollectLayersBehavior, std::unique_ptr<Vector<RenderLayer*>>&, std::unique_ptr<Vector<RenderLayer*>>&);
820
821     void updateCompositingAndLayerListsIfNeeded();
822
823     bool setupFontSubpixelQuantization(GraphicsContext&, bool& didQuantizeFonts);
824
825     Path computeClipPath(const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, WindRule&) const;
826
827     bool setupClipPath(GraphicsContext&, const LayerPaintingInfo&, const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, bool& rootRelativeBoundsComputed);
828
829     class FilterInfo;
830     std::pair<FilterInfo*, std::unique_ptr<FilterEffectRendererHelper>> filterPainter(GraphicsContext&, PaintLayerFlags) const;
831     bool hasFilterThatIsPainting(GraphicsContext&, PaintLayerFlags) const;
832     std::unique_ptr<FilterEffectRendererHelper> setupFilters(GraphicsContext&, LayerPaintingInfo&, PaintLayerFlags, const LayoutSize& offsetFromRoot, LayoutRect& rootRelativeBounds, bool& rootRelativeBoundsComputed);
833     void applyFilters(FilterEffectRendererHelper*, GraphicsContext& originalContext, const LayerPaintingInfo&, const LayerFragments&);
834
835     void paintLayer(GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags);
836     void paintFixedLayersInNamedFlows(GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags);
837     void paintLayerContentsAndReflection(GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags);
838     void paintLayerByApplyingTransform(GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags, const LayoutSize& translationOffset = LayoutSize());
839     void paintLayerContents(GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags);
840     void paintList(Vector<RenderLayer*>*, GraphicsContext&, const LayerPaintingInfo&, PaintLayerFlags);
841
842     void updatePaintingInfoForFragments(LayerFragments&, const LayerPaintingInfo&, PaintLayerFlags, bool shouldPaintContent, const LayoutSize& offsetFromRoot);
843     void paintBackgroundForFragments(const LayerFragments&, GraphicsContext&, GraphicsContext& transparencyLayerContext,
844         const LayoutRect& transparencyPaintDirtyRect, bool haveTransparency, const LayerPaintingInfo&, PaintBehavior, RenderObject* paintingRootForRenderer);
845     void paintForegroundForFragments(const LayerFragments&, GraphicsContext&, GraphicsContext& transparencyLayerContext,
846         const LayoutRect& transparencyPaintDirtyRect, bool haveTransparency, const LayerPaintingInfo&, PaintBehavior, RenderObject* paintingRootForRenderer,
847         bool selectionOnly);
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