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