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