Set proper TextureMapperLayer::m_contentsLayer in updateImageBacking
[WebKit-https.git] / Source / WebCore / rendering / RenderView.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2006, 2015-2016 Apple Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #pragma once
23
24 #include "FrameView.h"
25 #include "Region.h"
26 #include "RenderBlockFlow.h"
27 #include "RenderWidget.h"
28 #include "SelectionRangeData.h"
29 #include <memory>
30 #include <wtf/HashSet.h>
31 #include <wtf/ListHashSet.h>
32
33 namespace WebCore {
34
35 class ImageQualityController;
36 class RenderLayerCompositor;
37 class RenderLayoutState;
38 class RenderQuote;
39
40 class RenderView final : public RenderBlockFlow {
41     WTF_MAKE_ISO_ALLOCATED(RenderView);
42 public:
43     RenderView(Document&, RenderStyle&&);
44     virtual ~RenderView();
45
46     const char* renderName() const override { return "RenderView"; }
47
48     bool requiresLayer() const override { return true; }
49
50     bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
51
52     void layout() override;
53     void updateLogicalWidth() override;
54     LogicalExtentComputedValues computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop) const override;
55
56     LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const override;
57
58     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
59     int viewHeight() const;
60     int viewWidth() const;
61     int viewLogicalWidth() const { return style().isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
62     int viewLogicalHeight() const;
63
64     LayoutUnit clientLogicalWidthForFixedPosition() const;
65     LayoutUnit clientLogicalHeightForFixedPosition() const;
66
67     float zoomFactor() const;
68
69     FrameView& frameView() const { return m_frameView; }
70
71     Optional<LayoutRect> computeVisibleRectInContainer(const LayoutRect&, const RenderLayerModelObject* container, VisibleRectContext) const override;
72     void repaintRootContents();
73     void repaintViewRectangle(const LayoutRect&) const;
74     void repaintViewAndCompositedLayers();
75
76     void paint(PaintInfo&, const LayoutPoint&) override;
77     void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
78     // Return the renderer whose background style is used to paint the root background.
79     RenderElement* rendererForRootBackground() const;
80
81     SelectionRangeData& selection() { return m_selection; }
82
83     bool printing() const;
84
85     void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
86     void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
87
88     LayoutRect viewRect() const;
89
90     void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
91
92     void setPageLogicalSize(LayoutSize);
93     LayoutUnit pageOrViewLogicalHeight() const;
94
95     // This method is used to assign a page number only when pagination modes have
96     // a block progression. This happens with vertical-rl books for example, but it
97     // doesn't happen for normal horizontal-tb books. This is a very specialized
98     // function and should not be mistaken for a general page number API.
99     unsigned pageNumberForBlockProgressionOffset(int offset) const;
100
101     unsigned pageCount() const;
102
103     // FIXME: These functions are deprecated. No code should be added that uses these.
104     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
105     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
106     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
107     void setTruncatedAt(int y)
108     { 
109         m_legacyPrinting.m_truncatedAt = y;
110         m_legacyPrinting.m_bestTruncatedAt = 0;
111         m_legacyPrinting.m_truncatorWidth = 0;
112         m_legacyPrinting.m_forcedPageBreak = false;
113     }
114     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
115     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
116     // End deprecated functions.
117
118     // Notification that this view moved into or out of a native window.
119     void setIsInWindow(bool);
120
121     WEBCORE_EXPORT RenderLayerCompositor& compositor();
122     WEBCORE_EXPORT bool usesCompositing() const;
123
124     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
125     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
126     void setUsesFirstLineRules(bool value) { m_usesFirstLineRules = value; }
127     void setUsesFirstLetterRules(bool value) { m_usesFirstLetterRules = value; }
128
129     WEBCORE_EXPORT IntRect unscaledDocumentRect() const;
130     LayoutRect unextendedBackgroundRect() const;
131     LayoutRect backgroundRect() const;
132
133     WEBCORE_EXPORT IntRect documentRect() const;
134
135     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
136     bool rootBackgroundIsEntirelyFixed() const;
137
138     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
139
140     IntSize viewportSizeForCSSViewportUnits() const;
141
142     bool hasQuotesNeedingUpdate() const { return m_hasQuotesNeedingUpdate; }
143     void setHasQuotesNeedingUpdate(bool b) { m_hasQuotesNeedingUpdate = b; }
144
145     // FIXME: This is a work around because the current implementation of counters
146     // requires walking the entire tree repeatedly and most pages don't actually use either
147     // feature so we shouldn't take the performance hit when not needed. Long term we should
148     // rewrite the counter code.
149     void addRenderCounter() { ++m_renderCounterCount; }
150     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); --m_renderCounterCount; }
151     bool hasRenderCounters() const { return m_renderCounterCount; }
152
153     void incrementRendersWithOutline() { ++m_renderersWithOutlineCount; }
154     void decrementRendersWithOutline() { ASSERT(m_renderersWithOutlineCount > 0); --m_renderersWithOutlineCount; }
155     bool hasRenderersWithOutline() const { return m_renderersWithOutlineCount; }
156
157     ImageQualityController& imageQualityController();
158
159     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
160     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
161
162     uint64_t rendererCount() const { return m_rendererCount; }
163     void didCreateRenderer() { ++m_rendererCount; }
164     void didDestroyRenderer() { --m_rendererCount; }
165
166     void updateVisibleViewportRect(const IntRect&);
167     void registerForVisibleInViewportCallback(RenderElement&);
168     void unregisterForVisibleInViewportCallback(RenderElement&);
169     void resumePausedImageAnimationsIfNeeded(const IntRect& visibleRect);
170     void addRendererWithPausedImageAnimations(RenderElement&, CachedImage&);
171     void removeRendererWithPausedImageAnimations(RenderElement&);
172     void removeRendererWithPausedImageAnimations(RenderElement&, CachedImage&);
173
174     class RepaintRegionAccumulator {
175         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
176     public:
177         RepaintRegionAccumulator(RenderView*);
178         ~RepaintRegionAccumulator();
179
180     private:
181         WeakPtr<RenderView> m_rootView;
182         bool m_wasAccumulatingRepaintRegion;
183     };
184
185     void scheduleLazyRepaint(RenderBox&);
186     void unscheduleLazyRepaint(RenderBox&);
187     
188     void layerChildrenChangedDuringStyleChange(RenderLayer&);
189     RenderLayer* takeStyleChangeLayerTreeMutationRoot();
190
191     void protectRenderWidgetUntilLayoutIsDone(RenderWidget& widget) { m_protectedRenderWidgets.append(&widget); }
192     void releaseProtectedRenderWidgets() { m_protectedRenderWidgets.clear(); }
193
194 #if ENABLE(CSS_SCROLL_SNAP)
195     void registerBoxWithScrollSnapPositions(const RenderBox&);
196     void unregisterBoxWithScrollSnapPositions(const RenderBox&);
197     const HashSet<const RenderBox*>& boxesWithScrollSnapPositions() { return m_boxesWithScrollSnapPositions; }
198 #endif
199
200 protected:
201     void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
202     const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
203     void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
204     bool requiresColumns(int desiredColumnCount) const override;
205
206 private:
207     void computeColumnCountAndWidth() override;
208
209     bool shouldRepaint(const LayoutRect&) const;
210     void flushAccumulatedRepaintRegion() const;
211
212     void layoutContent(const RenderLayoutState&);
213
214     bool isScrollableOrRubberbandableBox() const override;
215
216 private:
217     FrameView& m_frameView;
218
219     // Include this RenderView.
220     uint64_t m_rendererCount { 1 };
221
222     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
223     SelectionRangeData m_selection;
224
225     WeakPtr<RenderLayer> m_styleChangeLayerMutationRoot;
226
227     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
228     struct LegacyPrinting {
229         int m_bestTruncatedAt { 0 };
230         int m_truncatedAt { 0 };
231         int m_truncatorWidth { 0 };
232         IntRect m_printRect;
233         bool m_forcedPageBreak { false };
234     };
235     LegacyPrinting m_legacyPrinting;
236     // End deprecated members.
237
238     bool shouldUsePrintingLayout() const;
239
240     void lazyRepaintTimerFired();
241
242     Timer m_lazyRepaintTimer;
243     HashSet<RenderBox*> m_renderersNeedingLazyRepaint;
244
245     std::unique_ptr<ImageQualityController> m_imageQualityController;
246     Optional<LayoutSize> m_pageLogicalSize;
247     bool m_pageLogicalHeightChanged { false };
248     std::unique_ptr<RenderLayerCompositor> m_compositor;
249
250     bool m_hasQuotesNeedingUpdate { false };
251
252     unsigned m_renderCounterCount { 0 };
253     unsigned m_renderersWithOutlineCount { 0 };
254
255     bool m_hasSoftwareFilters { false };
256     bool m_usesFirstLineRules { false };
257     bool m_usesFirstLetterRules { false };
258
259     HashMap<RenderElement*, Vector<CachedImage*>> m_renderersWithPausedImageAnimation;
260     HashSet<RenderElement*> m_visibleInViewportRenderers;
261     Vector<RefPtr<RenderWidget>> m_protectedRenderWidgets;
262
263 #if ENABLE(CSS_SCROLL_SNAP)
264     HashSet<const RenderBox*> m_boxesWithScrollSnapPositions;
265 #endif
266 };
267
268 } // namespace WebCore
269
270 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderView, isRenderView())