Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WebCore / rendering / RenderView.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2006, 2015 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 #ifndef RenderView_h
23 #define RenderView_h
24
25 #include "FrameView.h"
26 #include "LayoutState.h"
27 #include "Region.h"
28 #include "RenderBlockFlow.h"
29 #include "RenderWidget.h"
30 #include "SelectionSubtreeRoot.h"
31 #include <memory>
32 #include <wtf/HashSet.h>
33
34 #if ENABLE(SERVICE_CONTROLS)
35 #include "SelectionRectGatherer.h"
36 #endif
37
38 namespace WebCore {
39
40 class FlowThreadController;
41 class ImageQualityController;
42 class RenderLayerCompositor;
43 class RenderQuote;
44
45 class RenderView final : public RenderBlockFlow, public SelectionSubtreeRoot {
46 public:
47     RenderView(Document&, Ref<RenderStyle>&&);
48     virtual ~RenderView();
49
50     WEBCORE_EXPORT bool hitTest(const HitTestRequest&, HitTestResult&);
51     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
52
53     virtual const char* renderName() const override { return "RenderView"; }
54
55     virtual bool requiresLayer() const override { return true; }
56
57     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
58
59     virtual void layout() override;
60     virtual void updateLogicalWidth() override;
61     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
62
63     virtual LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const override;
64
65     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
66     int viewHeight() const;
67     int viewWidth() const;
68     int viewLogicalWidth() const { return style().isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
69     int viewLogicalHeight() const;
70
71     LayoutUnit clientLogicalWidthForFixedPosition() const;
72     LayoutUnit clientLogicalHeightForFixedPosition() const;
73
74     float zoomFactor() const;
75
76     FrameView& frameView() const { return m_frameView; }
77
78     virtual LayoutRect visualOverflowRect() const override;
79     virtual LayoutRect computeRectForRepaint(const LayoutRect&, const RenderLayerModelObject* repaintContainer, bool fixed = false) const override;
80     void repaintRootContents();
81     void repaintViewRectangle(const LayoutRect&) const;
82     void repaintViewAndCompositedLayers();
83
84     virtual void paint(PaintInfo&, const LayoutPoint&) override;
85     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
86
87     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
88     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
89     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
90     void clearSelection();
91     RenderObject* selectionUnsplitStart() const { return m_selectionUnsplitStart; }
92     RenderObject* selectionUnsplitEnd() const { return m_selectionUnsplitEnd; }
93     IntRect selectionBounds(bool clipToVisibleContent = true) const;
94     void repaintSelection() const;
95
96     bool printing() const;
97
98     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
99     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
100
101     void setMaximalOutlineSize(float);
102     float maximalOutlineSize() const { return m_maximalOutlineSize; }
103
104     LayoutRect viewRect() const;
105
106     // layoutDelta is used transiently during layout to store how far an object has moved from its
107     // last layout location, in order to repaint correctly.
108     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
109     LayoutSize layoutDelta() const
110     {
111         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
112     }
113     void addLayoutDelta(const LayoutSize& delta) 
114     {
115         if (m_layoutState) {
116             m_layoutState->m_layoutDelta += delta;
117 #if !ASSERT_DISABLED
118             m_layoutState->m_layoutDeltaXSaturated |= m_layoutState->m_layoutDelta.width() == LayoutUnit::max() || m_layoutState->m_layoutDelta.width() == LayoutUnit::min();
119             m_layoutState->m_layoutDeltaYSaturated |= m_layoutState->m_layoutDelta.height() == LayoutUnit::max() || m_layoutState->m_layoutDelta.height() == LayoutUnit::min();
120 #endif
121         }
122     }
123
124 #if !ASSERT_DISABLED
125     bool layoutDeltaMatches(const LayoutSize& delta)
126     {
127         if (!m_layoutState)
128             return false;
129         return (delta.width() == m_layoutState->m_layoutDelta.width() || m_layoutState->m_layoutDeltaXSaturated) && (delta.height() == m_layoutState->m_layoutDelta.height() || m_layoutState->m_layoutDeltaYSaturated);
130     }
131 #endif
132
133     bool doingFullRepaint() const { return frameView().needsFullRepaint(); }
134
135     // Subtree push/pop
136     void pushLayoutState(RenderObject&);
137     void popLayoutState(RenderObject&) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
138
139     bool shouldDisableLayoutStateForSubtree(RenderObject*) const;
140
141     // Returns true if layoutState should be used for its cached offset and clip.
142     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
143     LayoutState* layoutState() const { return m_layoutState.get(); }
144
145     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
146
147     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
148     void setPageLogicalHeight(LayoutUnit height)
149     {
150         if (m_pageLogicalHeight != height) {
151             m_pageLogicalHeight = height;
152             m_pageLogicalHeightChanged = true;
153         }
154     }
155     LayoutUnit pageOrViewLogicalHeight() const;
156
157     // This method is used to assign a page number only when pagination modes have
158     // a block progression. This happens with vertical-rl books for example, but it
159     // doesn't happen for normal horizontal-tb books. This is a very specialized
160     // function and should not be mistaken for a general page number API.
161     unsigned pageNumberForBlockProgressionOffset(int offset) const;
162
163     unsigned pageCount() const;
164
165     // FIXME: These functions are deprecated. No code should be added that uses these.
166     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
167     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
168     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
169     void setTruncatedAt(int y)
170     { 
171         m_legacyPrinting.m_truncatedAt = y;
172         m_legacyPrinting.m_bestTruncatedAt = 0;
173         m_legacyPrinting.m_truncatorWidth = 0;
174         m_legacyPrinting.m_forcedPageBreak = false;
175     }
176     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
177     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
178     // End deprecated functions.
179
180     // Notification that this view moved into or out of a native window.
181     void setIsInWindow(bool);
182
183     WEBCORE_EXPORT RenderLayerCompositor& compositor();
184     WEBCORE_EXPORT bool usesCompositing() const;
185
186     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
187     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
188     void setUsesFirstLineRules(bool value) { m_usesFirstLineRules = value; }
189     void setUsesFirstLetterRules(bool value) { m_usesFirstLetterRules = value; }
190
191     WEBCORE_EXPORT IntRect unscaledDocumentRect() const;
192     LayoutRect unextendedBackgroundRect() const;
193     LayoutRect backgroundRect() const;
194
195     WEBCORE_EXPORT IntRect documentRect() const;
196
197     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
198     bool rootBackgroundIsEntirelyFixed() const;
199     
200     bool hasRenderNamedFlowThreads() const;
201     bool checkTwoPassLayoutForAutoHeightRegions() const;
202     FlowThreadController& flowThreadController();
203
204     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
205
206     IntSize viewportSizeForCSSViewportUnits() const;
207
208     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
209     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
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         RenderView* m_rootView;
243         bool m_wasAccumulatingRepaintRegion;
244     };
245
246     void scheduleLazyRepaint(RenderBox&);
247     void unscheduleLazyRepaint(RenderBox&);
248
249     void protectRenderWidgetUntilLayoutIsDone(RenderWidget& widget) { m_protectedRenderWidgets.append(&widget); }
250     void releaseProtectedRenderWidgets() { m_protectedRenderWidgets.clear(); }
251
252 #if ENABLE(CSS_SCROLL_SNAP)
253     void registerBoxWithScrollSnapCoordinates(const RenderBox&);
254     void unregisterBoxWithScrollSnapCoordinates(const RenderBox&);
255     const HashSet<const RenderBox*>& boxesWithScrollSnapCoordinates() { return m_boxesWithScrollSnapCoordinates; }
256 #endif
257
258 protected:
259     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
260     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
261     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
262     virtual bool requiresColumns(int desiredColumnCount) const override;
263
264 private:
265     void initializeLayoutState(LayoutState&);
266
267     virtual void computeColumnCountAndWidth() override;
268
269     bool shouldRepaint(const LayoutRect&) const;
270     void flushAccumulatedRepaintRegion() const;
271
272     // These functions may only be accessed by LayoutStateMaintainer.
273     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
274     {
275         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
276         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.flowThreadContainingBlock()
277             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
278             m_layoutState = std::make_unique<LayoutState>(WTFMove(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged);
279             pushLayoutStateForCurrentFlowThread(renderer);
280             return true;
281         }
282         return false;
283     }
284
285     void popLayoutState()
286     {
287         popLayoutStateForCurrentFlowThread();
288         m_layoutState = WTFMove(m_layoutState->m_next);
289     }
290
291     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
292     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
293     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
294     // Note that even when disabled, LayoutState is still used to store layoutDelta.
295     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
296     void disableLayoutState() { m_layoutStateDisableCount++; }
297     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
298
299     void layoutContent(const LayoutState&);
300     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
301     void layoutContentToComputeOverflowInRegions(const LayoutState&);
302 #ifndef NDEBUG
303     void checkLayoutState(const LayoutState&);
304 #endif
305
306     void pushLayoutStateForCurrentFlowThread(const RenderObject&);
307     void popLayoutStateForCurrentFlowThread();
308
309     friend class LayoutStateMaintainer;
310     friend class LayoutStateDisabler;
311     friend class SubtreeLayoutStateMaintainer;
312
313     virtual bool isScrollableOrRubberbandableBox() const override;
314
315     void splitSelectionBetweenSubtrees(const RenderObject* startRenderer, int startPos, const RenderObject* endRenderer, int endPos, SelectionRepaintMode blockRepaintMode);
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     RenderObject* m_selectionUnsplitStart;
326     RenderObject* m_selectionUnsplitEnd;
327     int m_selectionUnsplitStartPos;
328     int m_selectionUnsplitEndPos;
329
330     // Include this RenderView.
331     uint64_t m_rendererCount { 1 };
332
333     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
334
335     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
336     struct LegacyPrinting {
337         LegacyPrinting()
338             : m_bestTruncatedAt(0)
339             , m_truncatedAt(0)
340             , m_truncatorWidth(0)
341             , m_forcedPageBreak(false)
342         { }
343
344         int m_bestTruncatedAt;
345         int m_truncatedAt;
346         int m_truncatorWidth;
347         IntRect m_printRect;
348         bool m_forcedPageBreak;
349     };
350     LegacyPrinting m_legacyPrinting;
351     // End deprecated members.
352
353     // Used to inflate compositing layers and repaint rects.
354     float m_maximalOutlineSize { 0 };
355
356     bool shouldUsePrintingLayout() const;
357
358     void lazyRepaintTimerFired();
359
360     Timer m_lazyRepaintTimer;
361     HashSet<RenderBox*> m_renderersNeedingLazyRepaint;
362
363     std::unique_ptr<ImageQualityController> m_imageQualityController;
364     LayoutUnit m_pageLogicalHeight;
365     bool m_pageLogicalHeightChanged;
366     std::unique_ptr<LayoutState> m_layoutState;
367     unsigned m_layoutStateDisableCount;
368     std::unique_ptr<RenderLayerCompositor> m_compositor;
369     std::unique_ptr<FlowThreadController> m_flowThreadController;
370
371     RenderQuote* m_renderQuoteHead;
372     unsigned m_renderCounterCount;
373
374     bool m_selectionWasCaret;
375     bool m_hasSoftwareFilters;
376     bool m_usesFirstLineRules { false };
377     bool m_usesFirstLetterRules { false };
378
379     HashSet<RenderElement*> m_renderersWithPausedImageAnimation;
380     HashSet<RenderElement*> m_visibleInViewportRenderers;
381     Vector<RefPtr<RenderWidget>> m_protectedRenderWidgets;
382
383 #if ENABLE(SERVICE_CONTROLS)
384     SelectionRectGatherer m_selectionRectGatherer;
385 #endif
386 #if ENABLE(CSS_SCROLL_SNAP)
387     HashSet<const RenderBox*> m_boxesWithScrollSnapCoordinates;
388 #endif
389 };
390
391 // Stack-based class to assist with LayoutState push/pop
392 class LayoutStateMaintainer {
393     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
394 public:
395     // Constructor to push now.
396     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
397         : m_view(view)
398         , m_disabled(disableState)
399     {
400         push(root, offset, pageHeight, pageHeightChanged);
401     }
402
403     // Constructor to maybe push later.
404     explicit LayoutStateMaintainer(RenderView& view)
405         : m_view(view)
406     {
407     }
408
409     ~LayoutStateMaintainer()
410     {
411         ASSERT(!m_didCallPush || m_didCallPush == m_didCallPop);
412     }
413
414     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
415     {
416         ASSERT(!m_didCallPush);
417         m_didCallPush = true;
418         // We push state even if disabled, because we still need to store layoutDelta
419         m_didPushLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged);
420         if (!m_didPushLayoutState)
421             return;
422         if (m_disabled)
423             m_view.disableLayoutState();
424     }
425
426     void pop()
427     {
428         ASSERT(!m_didCallPop);
429         m_didCallPop = true;
430         if (!m_didCallPush)
431             return;
432         if (!m_didPushLayoutState)
433             return;
434         m_view.popLayoutState();
435         if (m_disabled)
436             m_view.enableLayoutState();
437     }
438
439     bool didPush() const { return m_didCallPush; }
440
441 private:
442     RenderView& m_view;
443     bool m_disabled { false };
444     bool m_didCallPush { false };
445     bool m_didCallPop { false };
446     bool m_didPushLayoutState { false };
447 };
448
449 class LayoutStateDisabler {
450     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
451 public:
452     LayoutStateDisabler(RenderView& view)
453         : m_view(view)
454     {
455         m_view.disableLayoutState();
456     }
457
458     ~LayoutStateDisabler()
459     {
460         m_view.enableLayoutState();
461     }
462
463 private:
464     RenderView& m_view;
465 };
466
467 } // namespace WebCore
468
469 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderView, isRenderView())
470
471 #endif // RenderView_h