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