931b87edecda9dc3c00126182b13e4138de5e97b
[WebKit-https.git] / Source / WebCore / rendering / RenderView.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2006 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 #ifndef RenderView_h
23 #define RenderView_h
24
25 #include "FrameView.h"
26 #include "LayoutState.h"
27 #include "PODFreeListArena.h"
28 #include "Region.h"
29 #include "RenderBlockFlow.h"
30 #include <wtf/HashSet.h>
31 #include <wtf/OwnPtr.h>
32
33 namespace WebCore {
34
35 class FlowThreadController;
36 class ImageQualityController;
37 class RenderLayerCompositor;
38 class RenderQuote;
39
40 class RenderView final : public RenderBlockFlow {
41 public:
42     RenderView(Document&, PassRef<RenderStyle>);
43     virtual ~RenderView();
44
45     bool hitTest(const HitTestRequest&, HitTestResult&);
46     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
47
48     virtual const char* renderName() const override { return "RenderView"; }
49
50     virtual bool requiresLayer() const override { return true; }
51
52     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
53
54     virtual void layout() override;
55     virtual void updateLogicalWidth() override;
56     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
57
58     virtual LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const override;
59
60     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
61     int viewHeight() const;
62     int viewWidth() const;
63     int viewLogicalWidth() const { return style().isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
64     int viewLogicalHeight() const;
65
66     LayoutUnit clientLogicalWidthForFixedPosition() const;
67     LayoutUnit clientLogicalHeightForFixedPosition() const;
68
69     float zoomFactor() const;
70
71     FrameView& frameView() const { return m_frameView; }
72
73     virtual LayoutRect visualOverflowRect() const override;
74     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const override;
75     void repaintRootContents();
76     void repaintViewRectangle(const LayoutRect&) const;
77     void repaintViewAndCompositedLayers();
78
79     virtual void paint(PaintInfo&, const LayoutPoint&) override;
80     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
81
82     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
83     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
84     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
85     void clearSelection();
86     RenderObject* selectionStart() const { return m_selectionStart; }
87     RenderObject* selectionEnd() const { return m_selectionEnd; }
88     IntRect selectionBounds(bool clipToVisibleContent = true) const;
89     void selectionStartEnd(int& startPos, int& endPos) const;
90     void repaintSelection() const;
91
92     bool printing() const;
93
94     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
95     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
96
97     void setMaximalOutlineSize(int o);
98     int maximalOutlineSize() const { return m_maximalOutlineSize; }
99
100     LayoutRect viewRect() const;
101
102     // layoutDelta is used transiently during layout to store how far an object has moved from its
103     // last layout location, in order to repaint correctly.
104     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
105     LayoutSize layoutDelta() const
106     {
107         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
108     }
109     void addLayoutDelta(const LayoutSize& delta) 
110     {
111         if (m_layoutState) {
112             m_layoutState->m_layoutDelta += delta;
113 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
114             m_layoutState->m_layoutDeltaXSaturated |= m_layoutState->m_layoutDelta.width() == LayoutUnit::max() || m_layoutState->m_layoutDelta.width() == LayoutUnit::min();
115             m_layoutState->m_layoutDeltaYSaturated |= m_layoutState->m_layoutDelta.height() == LayoutUnit::max() || m_layoutState->m_layoutDelta.height() == LayoutUnit::min();
116 #endif
117         }
118     }
119     
120 #if !ASSERT_DISABLED
121     bool layoutDeltaMatches(const LayoutSize& delta)
122     {
123         if (!m_layoutState)
124             return false;
125 #if ENABLE(SATURATED_LAYOUT_ARITHMETIC)
126         return (delta.width() == m_layoutState->m_layoutDelta.width() || m_layoutState->m_layoutDeltaXSaturated) && (delta.height() == m_layoutState->m_layoutDelta.height() || m_layoutState->m_layoutDeltaYSaturated);
127 #else
128         return delta == m_layoutState->m_layoutDelta;
129 #endif
130     }
131 #endif
132
133     bool doingFullRepaint() const { return frameView().needsFullRepaint(); }
134
135     // Subtree push/pop
136     void pushLayoutState(RenderObject&);
137     void popLayoutState(RenderObject&) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
138
139     bool shouldDisableLayoutStateForSubtree(RenderObject*) const;
140
141     // Returns true if layoutState should be used for its cached offset and clip.
142     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
143     LayoutState* layoutState() const { return m_layoutState.get(); }
144
145     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
146
147     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
148     void setPageLogicalHeight(LayoutUnit height)
149     {
150         if (m_pageLogicalHeight != height) {
151             m_pageLogicalHeight = height;
152             m_pageLogicalHeightChanged = true;
153         }
154     }
155     LayoutUnit pageOrViewLogicalHeight() const;
156
157     // FIXME: These functions are deprecated. No code should be added that uses these.
158     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
159     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
160     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
161     void setTruncatedAt(int y)
162     { 
163         m_legacyPrinting.m_truncatedAt = y;
164         m_legacyPrinting.m_bestTruncatedAt = 0;
165         m_legacyPrinting.m_truncatorWidth = 0;
166         m_legacyPrinting.m_forcedPageBreak = false;
167     }
168     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
169     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
170     // End deprecated functions.
171
172     // Notification that this view moved into or out of a native window.
173     void setIsInWindow(bool);
174
175     RenderLayerCompositor& compositor();
176     bool usesCompositing() const;
177
178     IntRect unscaledDocumentRect() const;
179     LayoutRect backgroundRect(RenderBox* backgroundRenderer) const;
180
181     IntRect documentRect() const;
182
183     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
184     bool rootBackgroundIsEntirelyFixed() const;
185     
186     bool hasRenderNamedFlowThreads() const;
187     bool checkTwoPassLayoutForAutoHeightRegions() const;
188     FlowThreadController& flowThreadController();
189
190     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
191
192     IntervalArena* intervalArena();
193
194     IntSize viewportSize() const;
195
196     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
197     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
198
199     // FIXME: This is a work around because the current implementation of counters
200     // requires walking the entire tree repeatedly and most pages don't actually use either
201     // feature so we shouldn't take the performance hit when not needed. Long term we should
202     // rewrite the counter and quotes code.
203     void addRenderCounter() { m_renderCounterCount++; }
204     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
205     bool hasRenderCounters() { return m_renderCounterCount; }
206     
207     IntRect pixelSnappedLayoutOverflowRect() const { return pixelSnappedIntRect(layoutOverflowRect()); }
208
209     ImageQualityController& imageQualityController();
210
211 #if ENABLE(CSS_FILTERS)
212     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
213     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
214 #endif
215
216     uint64_t rendererCount() const { return m_rendererCount; }
217     void didCreateRenderer() { ++m_rendererCount; }
218     void didDestroyRenderer() { --m_rendererCount; }
219
220     void resumePausedImageAnimationsIfNeeded();
221     void addRendererWithPausedImageAnimations(RenderElement&);
222     void removeRendererWithPausedImageAnimations(RenderElement&);
223
224     class RepaintRegionAccumulator {
225         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
226     public:
227         RepaintRegionAccumulator(RenderView*);
228         ~RepaintRegionAccumulator();
229
230     private:
231         RenderView* m_rootView;
232         bool m_wasAccumulatingRepaintRegion;
233     };
234
235 protected:
236     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const override;
237     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
238     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
239     virtual bool requiresColumns(int desiredColumnCount) const override;
240     
241 private:
242     void initializeLayoutState(LayoutState&);
243
244     virtual void computeColumnCountAndWidth() override;
245     virtual ColumnInfo::PaginationUnit paginationUnit() const override;
246
247     bool shouldRepaint(const LayoutRect&) const;
248     void flushAccumulatedRepaintRegion() const;
249
250     // These functions may only be accessed by LayoutStateMaintainer.
251     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
252     {
253         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
254         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.hasColumns() || renderer.flowThreadContainingBlock()
255             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
256             pushLayoutStateForCurrentFlowThread(renderer);
257             m_layoutState = std::make_unique<LayoutState>(std::move(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged, colInfo);
258             return true;
259         }
260         return false;
261     }
262
263     void popLayoutState()
264     {
265         m_layoutState = std::move(m_layoutState->m_next);
266         popLayoutStateForCurrentFlowThread();
267     }
268
269     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
270     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
271     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
272     // Note that even when disabled, LayoutState is still used to store layoutDelta.
273     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
274     void disableLayoutState() { m_layoutStateDisableCount++; }
275     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
276
277     void layoutContent(const LayoutState&);
278     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
279     void layoutContentToComputeOverflowInRegions(const LayoutState&);
280 #ifndef NDEBUG
281     void checkLayoutState(const LayoutState&);
282 #endif
283
284     void pushLayoutStateForCurrentFlowThread(const RenderObject&);
285     void popLayoutStateForCurrentFlowThread();
286     
287     friend class LayoutStateMaintainer;
288     friend class LayoutStateDisabler;
289
290 private:
291     FrameView& m_frameView;
292
293     RenderObject* m_selectionStart;
294     RenderObject* m_selectionEnd;
295     int m_selectionStartPos;
296     int m_selectionEndPos;
297
298     uint64_t m_rendererCount;
299
300     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
301
302     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
303     struct LegacyPrinting {
304         LegacyPrinting()
305             : m_bestTruncatedAt(0)
306             , m_truncatedAt(0)
307             , m_truncatorWidth(0)
308             , m_forcedPageBreak(false)
309         { }
310
311         int m_bestTruncatedAt;
312         int m_truncatedAt;
313         int m_truncatorWidth;
314         IntRect m_printRect;
315         bool m_forcedPageBreak;
316     };
317     LegacyPrinting m_legacyPrinting;
318     // End deprecated members.
319
320     int m_maximalOutlineSize; // Used to apply a fudge factor to dirty-rect checks on blocks/tables.
321
322     bool shouldUsePrintingLayout() const;
323
324     OwnPtr<ImageQualityController> m_imageQualityController;
325     LayoutUnit m_pageLogicalHeight;
326     bool m_pageLogicalHeightChanged;
327     std::unique_ptr<LayoutState> m_layoutState;
328     unsigned m_layoutStateDisableCount;
329     OwnPtr<RenderLayerCompositor> m_compositor;
330     OwnPtr<FlowThreadController> m_flowThreadController;
331     RefPtr<IntervalArena> m_intervalArena;
332
333     RenderQuote* m_renderQuoteHead;
334     unsigned m_renderCounterCount;
335
336     bool m_selectionWasCaret;
337 #if ENABLE(CSS_FILTERS)
338     bool m_hasSoftwareFilters;
339 #endif
340
341     HashSet<RenderElement*> m_renderersWithPausedImageAnimation;
342 };
343
344 RENDER_OBJECT_TYPE_CASTS(RenderView, isRenderView())
345
346 // Stack-based class to assist with LayoutState push/pop
347 class LayoutStateMaintainer {
348     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
349 public:
350     // Constructor to push now.
351     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
352         : m_view(view)
353         , m_disabled(disableState)
354         , m_didStart(false)
355         , m_didEnd(false)
356         , m_didCreateLayoutState(false)
357     {
358         push(root, offset, pageHeight, pageHeightChanged, colInfo);
359     }
360
361     // Constructor to maybe push later.
362     explicit LayoutStateMaintainer(RenderView& view)
363         : m_view(view)
364         , m_disabled(false)
365         , m_didStart(false)
366         , m_didEnd(false)
367         , m_didCreateLayoutState(false)
368     {
369     }
370
371     ~LayoutStateMaintainer()
372     {
373         ASSERT(m_didStart == m_didEnd);   // if this fires, it means that someone did a push(), but forgot to pop().
374     }
375
376     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
377     {
378         ASSERT(!m_didStart);
379         // We push state even if disabled, because we still need to store layoutDelta
380         m_didCreateLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged, colInfo);
381         if (m_disabled && m_didCreateLayoutState)
382             m_view.disableLayoutState();
383         m_didStart = true;
384     }
385
386     void pop()
387     {
388         if (m_didStart) {
389             ASSERT(!m_didEnd);
390             if (m_didCreateLayoutState) {
391                 m_view.popLayoutState();
392                 if (m_disabled)
393                     m_view.enableLayoutState();
394             }
395             
396             m_didEnd = true;
397         }
398     }
399
400     bool didPush() const { return m_didStart; }
401
402 private:
403     RenderView& m_view;
404     bool m_disabled : 1;        // true if the offset and clip part of layoutState is disabled
405     bool m_didStart : 1;        // true if we did a push or disable
406     bool m_didEnd : 1;          // true if we popped or re-enabled
407     bool m_didCreateLayoutState : 1; // true if we actually made a layout state.
408 };
409
410 class LayoutStateDisabler {
411     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
412 public:
413     LayoutStateDisabler(RenderView* view)
414         : m_view(view)
415     {
416         if (m_view)
417             m_view->disableLayoutState();
418     }
419
420     ~LayoutStateDisabler()
421     {
422         if (m_view)
423             m_view->enableLayoutState();
424     }
425 private:
426     RenderView* m_view;
427 };
428
429 inline Frame& RenderObject::frame() const
430 {
431     return view().frameView().frame();
432 }
433
434 } // namespace WebCore
435
436 #endif // RenderView_h