Make RepaintRegionAccumulator hold a WeakPtr to its root RenderView
[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 "LayoutState.h"
26 #include "Region.h"
27 #include "RenderBlockFlow.h"
28 #include "RenderWidget.h"
29 #include "SelectionSubtreeRoot.h"
30 #include <memory>
31 #include <wtf/HashSet.h>
32
33 #if ENABLE(SERVICE_CONTROLS)
34 #include "SelectionRectGatherer.h"
35 #endif
36
37 namespace WebCore {
38
39 class FlowThreadController;
40 class ImageQualityController;
41 class RenderLayerCompositor;
42 class RenderQuote;
43
44 class RenderView final : public RenderBlockFlow, public SelectionSubtreeRoot {
45 public:
46     RenderView(Document&, RenderStyle&&);
47     virtual ~RenderView();
48
49     WEBCORE_EXPORT bool hitTest(const HitTestRequest&, HitTestResult&);
50     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
51
52     const char* renderName() const override { return "RenderView"; }
53
54     bool requiresLayer() const override { return true; }
55
56     bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
57
58     void layout() override;
59     void updateLogicalWidth() override;
60     LogicalExtentComputedValues computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop) const override;
61
62     LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const override;
63
64     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
65     int viewHeight() const;
66     int viewWidth() const;
67     int viewLogicalWidth() const { return style().isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
68     int viewLogicalHeight() const;
69
70     LayoutUnit clientLogicalWidthForFixedPosition() const;
71     LayoutUnit clientLogicalHeightForFixedPosition() const;
72
73     float zoomFactor() const;
74
75     FrameView& frameView() const { return m_frameView; }
76
77     LayoutRect visualOverflowRect() const override;
78     LayoutRect computeRectForRepaint(const LayoutRect&, const RenderLayerModelObject* repaintContainer, RepaintContext = { }) const override;
79     void repaintRootContents();
80     void repaintViewRectangle(const LayoutRect&) const;
81     void repaintViewAndCompositedLayers();
82
83     void paint(PaintInfo&, const LayoutPoint&) override;
84     void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
85     // Return the renderer whose background style is used to paint the root background.
86     RenderElement* rendererForRootBackground() const;
87
88     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
89     void setSelection(RenderObject* start, std::optional<unsigned> startPos, RenderObject* endObject, std::optional<unsigned> endPos, SelectionRepaintMode = RepaintNewXOROld);
90     void getSelection(RenderObject*& startRenderer, std::optional<unsigned>& startOffset, RenderObject*& endRenderer, std::optional<unsigned>& endOffset) const;
91     void clearSelection();
92     RenderObject* selectionUnsplitStart() const { return m_selectionUnsplitStart; }
93     RenderObject* selectionUnsplitEnd() const { return m_selectionUnsplitEnd; }
94     IntRect selectionBounds(bool clipToVisibleContent = true) const;
95     void repaintSelection() const;
96
97     bool printing() const;
98
99     void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
100     void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
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
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         return (delta.width() == m_layoutState->m_layoutDelta.width() || m_layoutState->m_layoutDeltaXSaturated) && (delta.height() == m_layoutState->m_layoutDelta.height() || m_layoutState->m_layoutDeltaYSaturated);
128     }
129 #endif
130
131     bool doingFullRepaint() const { return frameView().needsFullRepaint(); }
132
133     // Subtree push/pop
134     void pushLayoutState(RenderObject&);
135     void pushLayoutStateForPagination(RenderBlockFlow&);
136     void popLayoutState(RenderObject&) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
137
138     // Returns true if layoutState should be used for its cached offset and clip.
139     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
140     LayoutState* layoutState() const { return m_layoutState.get(); }
141
142     void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
143
144     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
145     void setPageLogicalHeight(LayoutUnit height)
146     {
147         if (m_pageLogicalHeight != height) {
148             m_pageLogicalHeight = height;
149             m_pageLogicalHeightChanged = true;
150         }
151     }
152     LayoutUnit pageOrViewLogicalHeight() const;
153
154     // This method is used to assign a page number only when pagination modes have
155     // a block progression. This happens with vertical-rl books for example, but it
156     // doesn't happen for normal horizontal-tb books. This is a very specialized
157     // function and should not be mistaken for a general page number API.
158     unsigned pageNumberForBlockProgressionOffset(int offset) const;
159
160     unsigned pageCount() const;
161
162     // FIXME: These functions are deprecated. No code should be added that uses these.
163     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
164     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
165     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
166     void setTruncatedAt(int y)
167     { 
168         m_legacyPrinting.m_truncatedAt = y;
169         m_legacyPrinting.m_bestTruncatedAt = 0;
170         m_legacyPrinting.m_truncatorWidth = 0;
171         m_legacyPrinting.m_forcedPageBreak = false;
172     }
173     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
174     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
175     // End deprecated functions.
176
177     // Notification that this view moved into or out of a native window.
178     void setIsInWindow(bool);
179
180     WEBCORE_EXPORT RenderLayerCompositor& compositor();
181     WEBCORE_EXPORT bool usesCompositing() const;
182
183     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
184     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
185     void setUsesFirstLineRules(bool value) { m_usesFirstLineRules = value; }
186     void setUsesFirstLetterRules(bool value) { m_usesFirstLetterRules = value; }
187
188     WEBCORE_EXPORT IntRect unscaledDocumentRect() const;
189     LayoutRect unextendedBackgroundRect() const;
190     LayoutRect backgroundRect() const;
191
192     WEBCORE_EXPORT IntRect documentRect() const;
193
194     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
195     bool rootBackgroundIsEntirelyFixed() const;
196     
197     bool hasRenderNamedFlowThreads() const;
198     bool checkTwoPassLayoutForAutoHeightRegions() const;
199     FlowThreadController& flowThreadController();
200
201     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
202
203     IntSize viewportSizeForCSSViewportUnits() const;
204
205     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
206     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
207     
208     // FIXME: see class RenderTreeInternalMutation below.
209     bool renderTreeIsBeingMutatedInternally() const { return !!m_renderTreeInternalMutationCounter; }
210
211     // FIXME: This is a work around because the current implementation of counters
212     // requires walking the entire tree repeatedly and most pages don't actually use either
213     // feature so we shouldn't take the performance hit when not needed. Long term we should
214     // rewrite the counter and quotes code.
215     void addRenderCounter() { m_renderCounterCount++; }
216     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
217     bool hasRenderCounters() { return m_renderCounterCount; }
218     
219     ImageQualityController& imageQualityController();
220
221     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
222     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
223
224     uint64_t rendererCount() const { return m_rendererCount; }
225     void didCreateRenderer() { ++m_rendererCount; }
226     void didDestroyRenderer() { --m_rendererCount; }
227
228     void updateVisibleViewportRect(const IntRect&);
229     void registerForVisibleInViewportCallback(RenderElement&);
230     void unregisterForVisibleInViewportCallback(RenderElement&);
231     void resumePausedImageAnimationsIfNeeded(IntRect visibleRect);
232     void addRendererWithPausedImageAnimations(RenderElement&);
233     void removeRendererWithPausedImageAnimations(RenderElement&);
234
235     class RepaintRegionAccumulator {
236         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
237     public:
238         RepaintRegionAccumulator(RenderView*);
239         ~RepaintRegionAccumulator();
240
241     private:
242         WeakPtr<RenderView> m_rootView;
243         bool m_wasAccumulatingRepaintRegion;
244     };
245
246     WeakPtr<RenderView> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
247
248     void scheduleLazyRepaint(RenderBox&);
249     void unscheduleLazyRepaint(RenderBox&);
250
251     void protectRenderWidgetUntilLayoutIsDone(RenderWidget& widget) { m_protectedRenderWidgets.append(&widget); }
252     void releaseProtectedRenderWidgets() { m_protectedRenderWidgets.clear(); }
253
254 #if ENABLE(CSS_SCROLL_SNAP)
255     void registerBoxWithScrollSnapPositions(const RenderBox&);
256     void unregisterBoxWithScrollSnapPositions(const RenderBox&);
257     const HashSet<const RenderBox*>& boxesWithScrollSnapPositions() { return m_boxesWithScrollSnapPositions; }
258 #endif
259
260 #if !ASSERT_DISABLED
261     bool inHitTesting() const { return m_inHitTesting; }
262 #endif
263
264 protected:
265     void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
266     const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
267     void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
268     bool requiresColumns(int desiredColumnCount) const override;
269
270 private:
271     void initializeLayoutState(LayoutState&);
272
273     void computeColumnCountAndWidth() override;
274
275     bool shouldRepaint(const LayoutRect&) const;
276     void flushAccumulatedRepaintRegion() const;
277
278     // These functions may only be accessed by LayoutStateMaintainer.
279     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
280     {
281         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
282         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.flowThreadContainingBlock()
283             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
284             m_layoutState = std::make_unique<LayoutState>(WTFMove(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged);
285             pushLayoutStateForCurrentFlowThread(renderer);
286             return true;
287         }
288         return false;
289     }
290
291     void popLayoutState()
292     {
293         popLayoutStateForCurrentFlowThread();
294         m_layoutState = WTFMove(m_layoutState->m_next);
295     }
296
297     enum class RenderTreeInternalMutation { On, Off };
298     void setRenderTreeInternalMutation(RenderTreeInternalMutation state)
299     {
300         if (state == RenderTreeInternalMutation::On)
301             ++m_renderTreeInternalMutationCounter;
302         else {
303             ASSERT(m_renderTreeInternalMutationCounter);
304             --m_renderTreeInternalMutationCounter;
305         }
306     }
307
308     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
309     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
310     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
311     // Note that even when disabled, LayoutState is still used to store layoutDelta.
312     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
313     void disableLayoutState() { m_layoutStateDisableCount++; }
314     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
315
316     void layoutContent(const LayoutState&);
317     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
318     void layoutContentToComputeOverflowInRegions(const LayoutState&);
319 #ifndef NDEBUG
320     void checkLayoutState(const LayoutState&);
321 #endif
322
323     void pushLayoutStateForCurrentFlowThread(const RenderObject&);
324     void popLayoutStateForCurrentFlowThread();
325
326     friend class LayoutStateMaintainer;
327     friend class LayoutStateDisabler;
328     friend class SubtreeLayoutStateMaintainer;
329     friend class RenderTreeInternalMutationScope;
330
331     bool isScrollableOrRubberbandableBox() const override;
332
333     void splitSelectionBetweenSubtrees(const RenderObject* startRenderer, std::optional<unsigned> startPos, const RenderObject* endRenderer, std::optional<unsigned> endPos, SelectionRepaintMode blockRepaintMode);
334     void clearSubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, OldSelectionData&) const;
335     void updateSelectionForSubtrees(RenderSubtreesMap&, SelectionRepaintMode);
336     void applySubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, const OldSelectionData&);
337     LayoutRect subtreeSelectionBounds(const SelectionSubtreeRoot&, bool clipToVisibleContent = true) const;
338     void repaintSubtreeSelection(const SelectionSubtreeRoot&) const;
339
340 private:
341     FrameView& m_frameView;
342
343     WeakPtrFactory<RenderView> m_weakFactory;
344     RenderObject* m_selectionUnsplitStart { nullptr };
345     RenderObject* m_selectionUnsplitEnd { nullptr };
346     std::optional<unsigned> m_selectionUnsplitStartPos;
347     std::optional<unsigned> m_selectionUnsplitEndPos;
348
349     // Include this RenderView.
350     uint64_t m_rendererCount { 1 };
351
352     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
353
354     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
355     struct LegacyPrinting {
356         int m_bestTruncatedAt { 0 };
357         int m_truncatedAt { 0 };
358         int m_truncatorWidth { 0 };
359         IntRect m_printRect;
360         bool m_forcedPageBreak { false };
361     };
362     LegacyPrinting m_legacyPrinting;
363     // End deprecated members.
364
365     bool shouldUsePrintingLayout() const;
366
367     void lazyRepaintTimerFired();
368
369     Timer m_lazyRepaintTimer;
370     HashSet<RenderBox*> m_renderersNeedingLazyRepaint;
371
372     std::unique_ptr<ImageQualityController> m_imageQualityController;
373     LayoutUnit m_pageLogicalHeight;
374     bool m_pageLogicalHeightChanged { false };
375     std::unique_ptr<LayoutState> m_layoutState;
376     unsigned m_layoutStateDisableCount { 0 };
377     std::unique_ptr<RenderLayerCompositor> m_compositor;
378     std::unique_ptr<FlowThreadController> m_flowThreadController;
379
380     RenderQuote* m_renderQuoteHead { nullptr };
381     unsigned m_renderCounterCount { 0 };
382     unsigned m_renderTreeInternalMutationCounter { 0 };
383
384     bool m_selectionWasCaret { false };
385     bool m_hasSoftwareFilters { false };
386     bool m_usesFirstLineRules { false };
387     bool m_usesFirstLetterRules { false };
388 #if !ASSERT_DISABLED
389     bool m_inHitTesting { false };
390 #endif
391
392     HashSet<RenderElement*> m_renderersWithPausedImageAnimation;
393     HashSet<RenderElement*> m_visibleInViewportRenderers;
394     Vector<RefPtr<RenderWidget>> m_protectedRenderWidgets;
395
396 #if ENABLE(SERVICE_CONTROLS)
397     SelectionRectGatherer m_selectionRectGatherer;
398 #endif
399 #if ENABLE(CSS_SCROLL_SNAP)
400     HashSet<const RenderBox*> m_boxesWithScrollSnapPositions;
401 #endif
402 };
403
404 // Stack-based class to assist with LayoutState push/pop
405 class LayoutStateMaintainer {
406     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
407 public:
408     // Constructor to push now.
409     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
410         : m_view(view)
411         , m_disabled(disableState)
412     {
413         push(root, offset, pageHeight, pageHeightChanged);
414     }
415
416     // Constructor to maybe push later.
417     explicit LayoutStateMaintainer(RenderView& view)
418         : m_view(view)
419     {
420     }
421
422     ~LayoutStateMaintainer()
423     {
424         ASSERT(!m_didCallPush || m_didCallPush == m_didCallPop);
425     }
426
427     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
428     {
429         ASSERT(!m_didCallPush);
430         m_didCallPush = true;
431         // We push state even if disabled, because we still need to store layoutDelta
432         m_didPushLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged);
433         if (!m_didPushLayoutState)
434             return;
435         if (m_disabled)
436             m_view.disableLayoutState();
437     }
438
439     void pop()
440     {
441         ASSERT(!m_didCallPop);
442         m_didCallPop = true;
443         if (!m_didCallPush)
444             return;
445         if (!m_didPushLayoutState)
446             return;
447         m_view.popLayoutState();
448         if (m_disabled)
449             m_view.enableLayoutState();
450     }
451
452     bool didPush() const { return m_didCallPush; }
453
454 private:
455     RenderView& m_view;
456     bool m_disabled { false };
457     bool m_didCallPush { false };
458     bool m_didCallPop { false };
459     bool m_didPushLayoutState { false };
460 };
461
462 class LayoutStateDisabler {
463     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
464 public:
465     LayoutStateDisabler(RenderView& view)
466         : m_view(view)
467     {
468         m_view.disableLayoutState();
469     }
470
471     ~LayoutStateDisabler()
472     {
473         m_view.enableLayoutState();
474     }
475
476 private:
477     RenderView& m_view;
478 };
479
480 // FIXME: This is a temporary workaround to mute unintended activities triggered by render tree mutations.
481 class RenderTreeInternalMutationScope {
482     WTF_MAKE_NONCOPYABLE(RenderTreeInternalMutationScope);
483 public:
484     RenderTreeInternalMutationScope(RenderView& view)
485         : m_view(view)
486     {
487         m_view.setRenderTreeInternalMutation(RenderView::RenderTreeInternalMutation::On);
488     }
489
490     ~RenderTreeInternalMutationScope()
491     {
492         m_view.setRenderTreeInternalMutation(RenderView::RenderTreeInternalMutation::Off);
493     }
494
495 private:
496     RenderView& m_view;
497 };
498
499 } // namespace WebCore
500
501 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderView, isRenderView())