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