WeakPtrFactory should populate m_ref lazily.
[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 #include <wtf/ListHashSet.h>
33
34 #if ENABLE(SERVICE_CONTROLS)
35 #include "SelectionRectGatherer.h"
36 #endif
37
38 namespace WebCore {
39
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     bool pushLayoutStateForPaginationIfNeeded(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     void setPageLogicalSize(LayoutSize);
145     LayoutUnit pageOrViewLogicalHeight() const;
146
147     // This method is used to assign a page number only when pagination modes have
148     // a block progression. This happens with vertical-rl books for example, but it
149     // doesn't happen for normal horizontal-tb books. This is a very specialized
150     // function and should not be mistaken for a general page number API.
151     unsigned pageNumberForBlockProgressionOffset(int offset) const;
152
153     unsigned pageCount() const;
154
155     // FIXME: These functions are deprecated. No code should be added that uses these.
156     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
157     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
158     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
159     void setTruncatedAt(int y)
160     { 
161         m_legacyPrinting.m_truncatedAt = y;
162         m_legacyPrinting.m_bestTruncatedAt = 0;
163         m_legacyPrinting.m_truncatorWidth = 0;
164         m_legacyPrinting.m_forcedPageBreak = false;
165     }
166     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
167     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
168     // End deprecated functions.
169
170     // Notification that this view moved into or out of a native window.
171     void setIsInWindow(bool);
172
173     WEBCORE_EXPORT RenderLayerCompositor& compositor();
174     WEBCORE_EXPORT bool usesCompositing() const;
175
176     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
177     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
178     void setUsesFirstLineRules(bool value) { m_usesFirstLineRules = value; }
179     void setUsesFirstLetterRules(bool value) { m_usesFirstLetterRules = value; }
180
181     WEBCORE_EXPORT IntRect unscaledDocumentRect() const;
182     LayoutRect unextendedBackgroundRect() const;
183     LayoutRect backgroundRect() const;
184
185     WEBCORE_EXPORT IntRect documentRect() const;
186
187     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
188     bool rootBackgroundIsEntirelyFixed() const;
189
190     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
191
192     IntSize viewportSizeForCSSViewportUnits() const;
193
194     bool hasQuotesNeedingUpdate() const { return m_hasQuotesNeedingUpdate; }
195     void setHasQuotesNeedingUpdate(bool b) { m_hasQuotesNeedingUpdate = b; }
196
197     // FIXME: see class RenderTreeInternalMutation below.
198     bool renderTreeIsBeingMutatedInternally() const { return !!m_renderTreeInternalMutationCounter; }
199
200     // FIXME: This is a work around because the current implementation of counters
201     // requires walking the entire tree repeatedly and most pages don't actually use either
202     // feature so we shouldn't take the performance hit when not needed. Long term we should
203     // rewrite the counter code.
204     void addRenderCounter() { m_renderCounterCount++; }
205     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
206     bool hasRenderCounters() { return m_renderCounterCount; }
207     
208     ImageQualityController& imageQualityController();
209
210     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
211     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
212
213     uint64_t rendererCount() const { return m_rendererCount; }
214     void didCreateRenderer() { ++m_rendererCount; }
215     void didDestroyRenderer() { --m_rendererCount; }
216
217     void updateVisibleViewportRect(const IntRect&);
218     void registerForVisibleInViewportCallback(RenderElement&);
219     void unregisterForVisibleInViewportCallback(RenderElement&);
220     void resumePausedImageAnimationsIfNeeded(IntRect visibleRect);
221     void addRendererWithPausedImageAnimations(RenderElement&, CachedImage&);
222     void removeRendererWithPausedImageAnimations(RenderElement&);
223     void removeRendererWithPausedImageAnimations(RenderElement&, CachedImage&);
224
225     class RepaintRegionAccumulator {
226         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
227     public:
228         RepaintRegionAccumulator(RenderView*);
229         ~RepaintRegionAccumulator();
230
231     private:
232         WeakPtr<RenderView> m_rootView;
233         bool m_wasAccumulatingRepaintRegion;
234     };
235
236     WeakPtr<RenderView> createWeakPtr() { return m_weakFactory.createWeakPtr(*this); }
237
238     void scheduleLazyRepaint(RenderBox&);
239     void unscheduleLazyRepaint(RenderBox&);
240
241     void protectRenderWidgetUntilLayoutIsDone(RenderWidget& widget) { m_protectedRenderWidgets.append(&widget); }
242     void releaseProtectedRenderWidgets() { m_protectedRenderWidgets.clear(); }
243
244 #if ENABLE(CSS_SCROLL_SNAP)
245     void registerBoxWithScrollSnapPositions(const RenderBox&);
246     void unregisterBoxWithScrollSnapPositions(const RenderBox&);
247     const HashSet<const RenderBox*>& boxesWithScrollSnapPositions() { return m_boxesWithScrollSnapPositions; }
248 #endif
249
250 #if !ASSERT_DISABLED
251     bool inHitTesting() const { return m_inHitTesting; }
252 #endif
253
254 protected:
255     void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
256     const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
257     void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
258     bool requiresColumns(int desiredColumnCount) const override;
259
260 private:
261     void initializeLayoutState(LayoutState&);
262
263     void computeColumnCountAndWidth() override;
264
265     bool shouldRepaint(const LayoutRect&) const;
266     void flushAccumulatedRepaintRegion() const;
267
268     // These functions may only be accessed by LayoutStateMaintainer.
269     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
270     {
271         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
272         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.flowThreadContainingBlock()
273             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
274             m_layoutState = std::make_unique<LayoutState>(WTFMove(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged);
275             return true;
276         }
277         return false;
278     }
279
280     void popLayoutState()
281     {
282         m_layoutState = WTFMove(m_layoutState->m_next);
283     }
284
285     enum class RenderTreeInternalMutation { On, Off };
286     void setRenderTreeInternalMutation(RenderTreeInternalMutation state)
287     {
288         if (state == RenderTreeInternalMutation::On)
289             ++m_renderTreeInternalMutationCounter;
290         else {
291             ASSERT(m_renderTreeInternalMutationCounter);
292             --m_renderTreeInternalMutationCounter;
293         }
294     }
295
296     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
297     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
298     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
299     // Note that even when disabled, LayoutState is still used to store layoutDelta.
300     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
301     void disableLayoutState() { m_layoutStateDisableCount++; }
302     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
303
304     void layoutContent(const LayoutState&);
305 #ifndef NDEBUG
306     void checkLayoutState(const LayoutState&);
307 #endif
308
309     friend class LayoutStateMaintainer;
310     friend class LayoutStateDisabler;
311     friend class SubtreeLayoutStateMaintainer;
312     friend class RenderTreeInternalMutationScope;
313
314     bool isScrollableOrRubberbandableBox() const override;
315
316     void clearSubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, OldSelectionData&) const;
317     void updateSelectionForSubtrees(RenderSubtreesMap&, SelectionRepaintMode);
318     void applySubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, const OldSelectionData&);
319     LayoutRect subtreeSelectionBounds(const SelectionSubtreeRoot&, bool clipToVisibleContent = true) const;
320     void repaintSubtreeSelection(const SelectionSubtreeRoot&) const;
321
322 private:
323     FrameView& m_frameView;
324
325     WeakPtrFactory<RenderView> m_weakFactory;
326     RenderObject* m_selectionUnsplitStart { nullptr };
327     RenderObject* m_selectionUnsplitEnd { nullptr };
328     std::optional<unsigned> m_selectionUnsplitStartPos;
329     std::optional<unsigned> m_selectionUnsplitEndPos;
330
331     // Include this RenderView.
332     uint64_t m_rendererCount { 1 };
333
334     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
335
336     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
337     struct LegacyPrinting {
338         int m_bestTruncatedAt { 0 };
339         int m_truncatedAt { 0 };
340         int m_truncatorWidth { 0 };
341         IntRect m_printRect;
342         bool m_forcedPageBreak { false };
343     };
344     LegacyPrinting m_legacyPrinting;
345     // End deprecated members.
346
347     bool shouldUsePrintingLayout() const;
348
349     void lazyRepaintTimerFired();
350
351     Timer m_lazyRepaintTimer;
352     HashSet<RenderBox*> m_renderersNeedingLazyRepaint;
353
354     std::unique_ptr<ImageQualityController> m_imageQualityController;
355     std::optional<LayoutSize> m_pageLogicalSize;
356     bool m_pageLogicalHeightChanged { false };
357     std::unique_ptr<LayoutState> m_layoutState;
358     unsigned m_layoutStateDisableCount { 0 };
359     std::unique_ptr<RenderLayerCompositor> m_compositor;
360
361     bool m_hasQuotesNeedingUpdate { false };
362
363     unsigned m_renderCounterCount { 0 };
364     unsigned m_renderTreeInternalMutationCounter { 0 };
365
366     bool m_selectionWasCaret { false };
367     bool m_hasSoftwareFilters { false };
368     bool m_usesFirstLineRules { false };
369     bool m_usesFirstLetterRules { false };
370 #if !ASSERT_DISABLED
371     bool m_inHitTesting { false };
372 #endif
373
374     HashMap<RenderElement*, Vector<CachedImage*>> m_renderersWithPausedImageAnimation;
375     HashSet<RenderElement*> m_visibleInViewportRenderers;
376     Vector<RefPtr<RenderWidget>> m_protectedRenderWidgets;
377
378 #if ENABLE(SERVICE_CONTROLS)
379     SelectionRectGatherer m_selectionRectGatherer;
380 #endif
381 #if ENABLE(CSS_SCROLL_SNAP)
382     HashSet<const RenderBox*> m_boxesWithScrollSnapPositions;
383 #endif
384 };
385
386 // Stack-based class to assist with LayoutState push/pop
387 class LayoutStateMaintainer {
388     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
389 public:
390     // Constructor to push now.
391     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
392         : m_view(view)
393         , m_disabled(disableState)
394     {
395         push(root, offset, pageHeight, pageHeightChanged);
396     }
397
398     // Constructor to maybe push later.
399     explicit LayoutStateMaintainer(RenderView& view)
400         : m_view(view)
401     {
402     }
403
404     ~LayoutStateMaintainer()
405     {
406         ASSERT(!m_didCallPush || m_didCallPush == m_didCallPop);
407     }
408
409     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
410     {
411         ASSERT(!m_didCallPush);
412         m_didCallPush = true;
413         // We push state even if disabled, because we still need to store layoutDelta
414         m_didPushLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged);
415         if (!m_didPushLayoutState)
416             return;
417         if (m_disabled)
418             m_view.disableLayoutState();
419     }
420
421     void pop()
422     {
423         ASSERT(!m_didCallPop);
424         m_didCallPop = true;
425         if (!m_didCallPush)
426             return;
427         if (!m_didPushLayoutState)
428             return;
429         m_view.popLayoutState();
430         if (m_disabled)
431             m_view.enableLayoutState();
432     }
433
434     bool didPush() const { return m_didCallPush; }
435
436 private:
437     RenderView& m_view;
438     bool m_disabled { false };
439     bool m_didCallPush { false };
440     bool m_didCallPop { false };
441     bool m_didPushLayoutState { false };
442 };
443
444 class LayoutStateDisabler {
445     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
446 public:
447     LayoutStateDisabler(RenderView& view)
448         : m_view(view)
449     {
450         m_view.disableLayoutState();
451     }
452
453     ~LayoutStateDisabler()
454     {
455         m_view.enableLayoutState();
456     }
457
458 private:
459     RenderView& m_view;
460 };
461
462 // FIXME: This is a temporary workaround to mute unintended activities triggered by render tree mutations.
463 class RenderTreeInternalMutationScope {
464     WTF_MAKE_NONCOPYABLE(RenderTreeInternalMutationScope);
465 public:
466     RenderTreeInternalMutationScope(RenderView& view)
467         : m_view(view)
468     {
469         m_view.setRenderTreeInternalMutation(RenderView::RenderTreeInternalMutation::On);
470     }
471
472     ~RenderTreeInternalMutationScope()
473     {
474         m_view.setRenderTreeInternalMutation(RenderView::RenderTreeInternalMutation::Off);
475     }
476
477 private:
478     RenderView& m_view;
479 };
480
481 } // namespace WebCore
482
483 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderView, isRenderView())