Combine event and touch action regions into a single class
[WebKit-https.git] / Source / WebCore / rendering / RenderLayerBacking.h
1 /*
2  * Copyright (C) 2009, 2010, 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "FloatPoint.h"
29 #include "FloatPoint3D.h"
30 #include "GraphicsLayer.h"
31 #include "GraphicsLayerClient.h"
32 #include "RenderLayer.h"
33 #include "RenderLayerCompositor.h"
34 #include "ScrollingCoordinator.h"
35
36 namespace WebCore {
37
38 class KeyframeList;
39 class PaintedContentsInfo;
40 class RenderLayerCompositor;
41 class TiledBacking;
42 class TransformationMatrix;
43
44 enum CompositingLayerType {
45     NormalCompositingLayer, // non-tiled layer with backing store
46     TiledCompositingLayer, // tiled layer (always has backing store)
47     MediaCompositingLayer, // layer that contains an image, video, webGL or plugin
48     ContainerCompositingLayer // layer with no backing store
49 };
50
51 // RenderLayerBacking controls the compositing behavior for a single RenderLayer.
52 // It holds the various GraphicsLayers, and makes decisions about intra-layer rendering
53 // optimizations.
54 // 
55 // There is one RenderLayerBacking for each RenderLayer that is composited.
56
57 class RenderLayerBacking final : public GraphicsLayerClient {
58     WTF_MAKE_NONCOPYABLE(RenderLayerBacking); WTF_MAKE_FAST_ALLOCATED;
59 public:
60     explicit RenderLayerBacking(RenderLayer&);
61     ~RenderLayerBacking();
62
63 #if PLATFORM(IOS_FAMILY)
64     void layerWillBeDestroyed();
65 #endif
66
67     // Do cleanup while layer->backing() is still valid.
68     void willBeDestroyed();
69
70     RenderLayer& owningLayer() const { return m_owningLayer; }
71
72     void updateConfigurationAfterStyleChange();
73
74     // Returns true if layer configuration changed.
75     bool updateConfiguration();
76
77     // Update graphics layer position and bounds.
78     void updateGeometry();
79
80     // Update state the requires that descendant layers have been updated.
81     void updateAfterDescendants();
82
83     // Update contents and clipping structure.
84     void updateDrawsContent();
85     
86     void updateAfterLayout(bool needsClippingUpdate, bool needsFullRepaint);
87     
88     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
89
90     // Layer to clip children
91     bool hasClippingLayer() const { return (m_childContainmentLayer && !m_isFrameLayerWithTiledBacking); }
92     GraphicsLayer* clippingLayer() const { return !m_isFrameLayerWithTiledBacking ? m_childContainmentLayer.get() : nullptr; }
93
94     // Layer to get clipped by ancestor
95     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != nullptr; }
96     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
97
98     GraphicsLayer* contentsContainmentLayer() const { return m_contentsContainmentLayer.get(); }
99
100     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
101     GraphicsLayer* backgroundLayer() const { return m_backgroundLayer.get(); }
102     bool backgroundLayerPaintsFixedRootBackground() const { return m_backgroundLayerPaintsFixedRootBackground; }
103
104     bool requiresBackgroundLayer() const { return m_requiresBackgroundLayer; }
105     void setRequiresBackgroundLayer(bool);
106
107     bool hasScrollingLayer() const { return m_scrollContainerLayer != nullptr; }
108     GraphicsLayer* scrollContainerLayer() const { return m_scrollContainerLayer.get(); }
109     GraphicsLayer* scrolledContentsLayer() const { return m_scrolledContentsLayer.get(); }
110
111     OptionSet<ScrollCoordinationRole> coordinatedScrollingRoles() const;
112
113     void detachFromScrollingCoordinator(OptionSet<ScrollCoordinationRole>);
114
115     ScrollingNodeID scrollingNodeIDForRole(ScrollCoordinationRole role) const
116     {
117         switch (role) {
118         case ScrollCoordinationRole::Scrolling:
119             return m_scrollingNodeID;
120         case ScrollCoordinationRole::FrameHosting:
121             return m_frameHostingNodeID;
122         case ScrollCoordinationRole::ViewportConstrained:
123             return m_viewportConstrainedNodeID;
124         case ScrollCoordinationRole::Positioning:
125             return m_positioningNodeID;
126         }
127         return 0;
128     }
129
130     void setScrollingNodeIDForRole(ScrollingNodeID nodeID, ScrollCoordinationRole role)
131     {
132         switch (role) {
133         case ScrollCoordinationRole::Scrolling:
134             m_scrollingNodeID = nodeID;
135             break;
136         case ScrollCoordinationRole::FrameHosting:
137             m_frameHostingNodeID = nodeID;
138             break;
139         case ScrollCoordinationRole::ViewportConstrained:
140             m_viewportConstrainedNodeID = nodeID;
141             setIsScrollCoordinatedWithViewportConstrainedRole(nodeID);
142             break;
143         case ScrollCoordinationRole::Positioning:
144             m_positioningNodeID = nodeID;
145             break;
146         }
147     }
148
149     ScrollingNodeID scrollingNodeIDForChildren() const
150     {
151         if (m_frameHostingNodeID)
152             return m_frameHostingNodeID;
153
154         if (m_scrollingNodeID)
155             return m_scrollingNodeID;
156
157         if (m_viewportConstrainedNodeID)
158             return m_viewportConstrainedNodeID;
159
160         return m_positioningNodeID;
161     }
162
163     void setIsScrollCoordinatedWithViewportConstrainedRole(bool);
164
165     bool hasMaskLayer() const { return m_maskLayer; }
166     bool hasChildClippingMaskLayer() const { return m_childClippingMaskLayer != nullptr; }
167
168     GraphicsLayer* parentForSublayers() const;
169     GraphicsLayer* childForSuperlayers() const;
170
171     // RenderLayers with backing normally short-circuit paintLayer() because
172     // their content is rendered via callbacks from GraphicsLayer. However, the document
173     // layer is special, because it has a GraphicsLayer to act as a container for the GraphicsLayers
174     // for descendants, but its contents usually render into the window (in which case this returns true).
175     // This returns false for other layers, and when the document layer actually needs to paint into its backing store
176     // for some reason.
177     bool paintsIntoWindow() const;
178     
179     // Returns true for a composited layer that has no backing store of its own, so
180     // paints into some ancestor layer.
181     bool paintsIntoCompositedAncestor() const { return !m_requiresOwnBackingStore; }
182
183     void setRequiresOwnBackingStore(bool);
184
185     void setContentsNeedDisplay(GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
186     // r is in the coordinate space of the layer's render object
187     void setContentsNeedDisplayInRect(const LayoutRect&, GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
188
189     // Notification from the renderer that its content changed.
190     void contentChanged(ContentChangeType);
191
192     // Interface to start, finish, suspend and resume animations and transitions
193     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
194     void transitionPaused(double timeOffset, CSSPropertyID);
195     void transitionFinished(CSSPropertyID);
196
197     bool startAnimation(double timeOffset, const Animation&, const KeyframeList&);
198     void animationPaused(double timeOffset, const String& name);
199     void animationSeeked(double timeOffset, const String& name);
200     void animationFinished(const String& name);
201
202     void suspendAnimations(MonotonicTime = MonotonicTime());
203     void resumeAnimations();
204
205     LayoutRect compositedBounds() const;
206     // Returns true if changed.
207     bool setCompositedBounds(const LayoutRect&);
208     // Returns true if changed.
209     bool updateCompositedBounds();
210     
211     void updateAfterWidgetResize();
212     void positionOverflowControlsLayers();
213     
214     bool isFrameLayerWithTiledBacking() const { return m_isFrameLayerWithTiledBacking; }
215
216     WEBCORE_EXPORT TiledBacking* tiledBacking() const;
217     void adjustTiledBackingCoverage();
218     void setTiledBackingHasMargins(bool hasExtendedBackgroundOnLeftAndRight, bool hasExtendedBackgroundOnTopAndBottom);
219     
220     void updateDebugIndicators(bool showBorder, bool showRepaintCounter);
221     bool paintsSubpixelAntialiasedText() const { return m_paintsSubpixelAntialiasedText; }
222
223     // GraphicsLayerClient interface
224     void tiledBackingUsageChanged(const GraphicsLayer*, bool /*usingTiledBacking*/) override;
225     void notifyAnimationStarted(const GraphicsLayer*, const String& animationKey, MonotonicTime startTime) override;
226     void notifyFlushRequired(const GraphicsLayer*) override;
227     void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) override;
228
229     void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const FloatRect& clip, GraphicsLayerPaintBehavior) override;
230
231     float deviceScaleFactor() const override;
232     float contentsScaleMultiplierForNewTiles(const GraphicsLayer*) const override;
233
234     bool paintsOpaquelyAtNonIntegralScales(const GraphicsLayer*) const override;
235
236     float pageScaleFactor() const override;
237     float zoomedOutPageScaleFactor() const override;
238
239     void didChangePlatformLayerForLayer(const GraphicsLayer*) override;
240     bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const override;
241
242     bool isTrackingRepaints() const override;
243     bool shouldSkipLayerInDump(const GraphicsLayer*, LayerTreeAsTextBehavior) const override;
244     bool shouldDumpPropertyForLayer(const GraphicsLayer*, const char* propertyName, LayerTreeAsTextBehavior) const override;
245
246     bool shouldAggressivelyRetainTiles(const GraphicsLayer*) const override;
247     bool shouldTemporarilyRetainTileCohorts(const GraphicsLayer*) const override;
248     bool useGiantTiles() const override;
249     void logFilledVisibleFreshTile(unsigned) override;
250     bool needsPixelAligment() const override { return !m_isMainFrameRenderViewLayer; }
251
252     LayoutSize subpixelOffsetFromRenderer() const { return m_subpixelOffsetFromRenderer; }
253
254 #if PLATFORM(IOS_FAMILY)
255     bool needsIOSDumpRenderTreeMainFrameRenderViewLayerIsAlwaysOpaqueHack(const GraphicsLayer&) const override;
256 #endif
257
258 #ifndef NDEBUG
259     void verifyNotPainting() override;
260 #endif
261
262     WEBCORE_EXPORT LayoutRect contentsBox() const;
263     
264     // For informative purposes only.
265     WEBCORE_EXPORT CompositingLayerType compositingLayerType() const;
266     
267     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
268     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
269     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
270
271     bool canCompositeFilters() const { return m_canCompositeFilters; }
272 #if ENABLE(FILTERS_LEVEL_2)
273     bool canCompositeBackdropFilters() const { return m_canCompositeBackdropFilters; }
274 #endif
275
276     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
277     WEBCORE_EXPORT double backingStoreMemoryEstimate() const;
278     
279     // For testing only.
280     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
281     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
282
283     WEBCORE_EXPORT void setIsTrackingDisplayListReplay(bool);
284     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
285
286 private:
287     friend class PaintedContentsInfo;
288
289     FloatRect backgroundBoxForSimpleContainerPainting() const;
290
291     void createPrimaryGraphicsLayer();
292     void destroyGraphicsLayers();
293     
294     void willDestroyLayer(const GraphicsLayer*);
295
296     LayoutRect compositedBoundsIncludingMargin() const;
297     
298     Ref<GraphicsLayer> createGraphicsLayer(const String&, GraphicsLayer::Type = GraphicsLayer::Type::Normal);
299
300     RenderLayerModelObject& renderer() const { return m_owningLayer.renderer(); }
301     RenderBox* renderBox() const { return m_owningLayer.renderBox(); }
302     RenderLayerCompositor& compositor() const { return m_owningLayer.compositor(); }
303
304     void updateInternalHierarchy();
305     bool updateAncestorClippingLayer(bool needsAncestorClip);
306     bool updateDescendantClippingLayer(bool needsDescendantClip);
307     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
308     bool updateForegroundLayer(bool needsForegroundLayer);
309     bool updateBackgroundLayer(bool needsBackgroundLayer);
310     void updateMaskingLayer(bool hasMask, bool hasClipPath);
311     bool requiresHorizontalScrollbarLayer() const;
312     bool requiresVerticalScrollbarLayer() const;
313     bool requiresScrollCornerLayer() const;
314     bool updateScrollingLayers(bool scrollingLayers);
315     
316     void updateScrollOffset(ScrollOffset);
317     void setLocationOfScrolledContents(ScrollOffset, ScrollingLayerPositionAction);
318
319     void updateChildClippingStrategy(bool needsDescendantsClippingLayer);
320
321     void updateMaskingLayerGeometry();
322     
323     void updateRootLayerConfiguration();
324
325     void setBackgroundLayerPaintsFixedRootBackground(bool);
326
327     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
328     
329     LayoutSize contentOffsetInCompositingLayer() const;
330     // Result is transform origin in device pixels.
331     FloatPoint3D computeTransformOriginForPainting(const LayoutRect& borderBox) const;
332
333     void updateOpacity(const RenderStyle&);
334     void updateTransform(const RenderStyle&);
335     void updateFilters(const RenderStyle&);
336 #if ENABLE(FILTERS_LEVEL_2)
337     void updateBackdropFilters(const RenderStyle&);
338     void updateBackdropFiltersGeometry();
339 #endif
340 #if ENABLE(CSS_COMPOSITING)
341     void updateBlendMode(const RenderStyle&);
342 #endif
343     void updateCustomAppearance(const RenderStyle&);
344
345     // Return the opacity value that this layer should use for compositing.
346     float compositingOpacity(float rendererOpacity) const;
347     Color rendererBackgroundColor() const;
348
349     bool isMainFrameRenderViewLayer() const;
350     
351     bool paintsBoxDecorations() const;
352     bool paintsContent(RenderLayer::PaintedContentRequest&) const;
353
354     void updateDrawsContent(PaintedContentsInfo&);
355     void updateEventRegion();
356
357     // Returns true if this compositing layer has no visible content.
358     bool isSimpleContainerCompositingLayer(PaintedContentsInfo&) const;
359     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
360     bool containsPaintedContent(PaintedContentsInfo&) const;
361     // Returns true if the RenderLayer just contains an image that we can composite directly.
362     bool isDirectlyCompositedImage() const;
363     void updateImageContents(PaintedContentsInfo&);
364
365     void updateDirectlyCompositedBoxDecorations(PaintedContentsInfo&, bool& didUpdateContentsRect);
366     void updateDirectlyCompositedBackgroundColor(PaintedContentsInfo&, bool& didUpdateContentsRect);
367     void updateDirectlyCompositedBackgroundImage(PaintedContentsInfo&, bool& didUpdateContentsRect);
368
369     void resetContentsRect();
370
371     bool isPaintDestinationForDescendantLayers(RenderLayer::PaintedContentRequest&) const;
372     bool hasVisibleNonCompositedDescendants() const;
373
374     bool shouldClipCompositedBounds() const;
375
376     bool hasTiledBackingFlatteningLayer() const { return (m_childContainmentLayer && m_isFrameLayerWithTiledBacking); }
377     GraphicsLayer* tileCacheFlatteningLayer() const { return m_isFrameLayerWithTiledBacking ? m_childContainmentLayer.get() : nullptr; }
378
379     void paintIntoLayer(const GraphicsLayer*, GraphicsContext&, const IntRect& paintDirtyRect, OptionSet<PaintBehavior>, GraphicsLayerPaintingPhase);
380
381     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
382     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
383
384     bool canIssueSetNeedsDisplay() const { return !paintsIntoWindow() && !paintsIntoCompositedAncestor(); }
385     LayoutRect computeParentGraphicsLayerRect(RenderLayer* compositedAncestor, LayoutSize& ancestorClippingLayerOffset) const;
386     LayoutRect computePrimaryGraphicsLayerRect(const LayoutRect& parentGraphicsLayerRect) const;
387
388     RenderLayer& m_owningLayer;
389
390     RefPtr<GraphicsLayer> m_ancestorClippingLayer; // Only used if we are clipped by an ancestor which is not a stacking context.
391     RefPtr<GraphicsLayer> m_contentsContainmentLayer; // Only used if we have a background layer; takes the transform.
392     RefPtr<GraphicsLayer> m_graphicsLayer;
393     RefPtr<GraphicsLayer> m_foregroundLayer; // Only used in cases where we need to draw the foreground separately.
394     RefPtr<GraphicsLayer> m_backgroundLayer; // Only used in cases where we need to draw the background separately.
395     RefPtr<GraphicsLayer> m_childContainmentLayer; // Only used if we have clipping on a stacking context with compositing children, or if the layer has a tile cache.
396     RefPtr<GraphicsLayer> m_maskLayer; // Only used if we have a mask and/or clip-path.
397     RefPtr<GraphicsLayer> m_childClippingMaskLayer; // Only used if we have to clip child layers or accelerated contents with border radius or clip-path.
398
399     RefPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
400     RefPtr<GraphicsLayer> m_layerForVerticalScrollbar;
401     RefPtr<GraphicsLayer> m_layerForScrollCorner;
402
403     RefPtr<GraphicsLayer> m_scrollContainerLayer; // Only used if the layer is using composited scrolling.
404     RefPtr<GraphicsLayer> m_scrolledContentsLayer; // Only used if the layer is using composited scrolling.
405
406     LayoutRect m_compositedBounds;
407     LayoutSize m_subpixelOffsetFromRenderer; // This is the subpixel distance between the primary graphics layer and the associated renderer's bounds.
408     LayoutSize m_compositedBoundsOffsetFromGraphicsLayer; // This is the subpixel distance between the primary graphics layer and the render layer bounds.
409
410     ScrollingNodeID m_viewportConstrainedNodeID { 0 };
411     ScrollingNodeID m_scrollingNodeID { 0 };
412     ScrollingNodeID m_frameHostingNodeID { 0 };
413     ScrollingNodeID m_positioningNodeID { 0 };
414
415     bool m_artificiallyInflatedBounds { false }; // bounds had to be made non-zero to make transform-origin work
416     bool m_isMainFrameRenderViewLayer { false };
417     bool m_isFrameLayerWithTiledBacking { false };
418     bool m_requiresOwnBackingStore { true };
419     bool m_canCompositeFilters { false };
420 #if ENABLE(FILTERS_LEVEL_2)
421     bool m_canCompositeBackdropFilters { false };
422 #endif
423     bool m_backgroundLayerPaintsFixedRootBackground { false };
424     bool m_requiresBackgroundLayer { false };
425     bool m_paintsSubpixelAntialiasedText { false }; // This is for logging only.
426 };
427
428 enum CanvasCompositingStrategy {
429     UnacceleratedCanvas,
430     CanvasPaintedToLayer,
431     CanvasAsLayerContents
432 };
433 CanvasCompositingStrategy canvasCompositingStrategy(const RenderObject&);
434
435 WTF::TextStream& operator<<(WTF::TextStream&, const RenderLayerBacking&);
436
437 } // namespace WebCore