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