[New Multicolumn] columnNumberForOffset is not patched for new multicolumn code yet.
[WebKit-https.git] / Source / WebCore / rendering / RenderView.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2006 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 "PODFreeListArena.h"
28 #include "Region.h"
29 #include "RenderBlockFlow.h"
30 #include <memory>
31 #include <wtf/HashSet.h>
32
33 namespace WebCore {
34
35 class FlowThreadController;
36 class ImageQualityController;
37 class RenderLayerCompositor;
38 class RenderQuote;
39
40 class RenderView final : public RenderBlockFlow {
41 public:
42     RenderView(Document&, PassRef<RenderStyle>);
43     virtual ~RenderView();
44
45     bool hitTest(const HitTestRequest&, HitTestResult&);
46     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
47
48     virtual const char* renderName() const override { return "RenderView"; }
49
50     virtual bool requiresLayer() const override { return true; }
51
52     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
53
54     virtual void layout() override;
55     virtual void updateLogicalWidth() override;
56     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
57
58     virtual 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     virtual LayoutRect visualOverflowRect() const override;
74     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const override;
75     void repaintRootContents();
76     void repaintViewRectangle(const LayoutRect&) const;
77     void repaintViewAndCompositedLayers();
78
79     virtual void paint(PaintInfo&, const LayoutPoint&) override;
80     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
81
82     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
83     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
84     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
85     void clearSelection();
86     RenderObject* selectionStart() const { return m_selectionStart; }
87     RenderObject* selectionEnd() const { return m_selectionEnd; }
88     IntRect selectionBounds(bool clipToVisibleContent = true) const;
89     void selectionStartEnd(int& startPos, int& endPos) const;
90     void repaintSelection() const;
91
92     bool printing() const;
93
94     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
95     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
96
97     void setMaximalOutlineSize(int o);
98     int maximalOutlineSize() const { return m_maximalOutlineSize; }
99
100     LayoutRect viewRect() const;
101
102     // layoutDelta is used transiently during layout to store how far an object has moved from its
103     // last layout location, in order to repaint correctly.
104     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
105     LayoutSize layoutDelta() const
106     {
107         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
108     }
109     void addLayoutDelta(const LayoutSize& delta) 
110     {
111         if (m_layoutState) {
112             m_layoutState->m_layoutDelta += delta;
113 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
114             m_layoutState->m_layoutDeltaXSaturated |= m_layoutState->m_layoutDelta.width() == LayoutUnit::max() || m_layoutState->m_layoutDelta.width() == LayoutUnit::min();
115             m_layoutState->m_layoutDeltaYSaturated |= m_layoutState->m_layoutDelta.height() == LayoutUnit::max() || m_layoutState->m_layoutDelta.height() == LayoutUnit::min();
116 #endif
117         }
118     }
119     
120 #if !ASSERT_DISABLED
121     bool layoutDeltaMatches(const LayoutSize& delta)
122     {
123         if (!m_layoutState)
124             return false;
125 #if ENABLE(SATURATED_LAYOUT_ARITHMETIC)
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 #else
128         return delta == m_layoutState->m_layoutDelta;
129 #endif
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     // FIXME: These functions are deprecated. No code should be added that uses these.
164     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
165     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
166     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
167     void setTruncatedAt(int y)
168     { 
169         m_legacyPrinting.m_truncatedAt = y;
170         m_legacyPrinting.m_bestTruncatedAt = 0;
171         m_legacyPrinting.m_truncatorWidth = 0;
172         m_legacyPrinting.m_forcedPageBreak = false;
173     }
174     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
175     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
176     // End deprecated functions.
177
178     // Notification that this view moved into or out of a native window.
179     void setIsInWindow(bool);
180
181     RenderLayerCompositor& compositor();
182     bool usesCompositing() const;
183
184     IntRect unscaledDocumentRect() const;
185     LayoutRect unextendedBackgroundRect(RenderBox* backgroundRenderer) const;
186     LayoutRect backgroundRect(RenderBox* backgroundRenderer) const;
187
188     IntRect documentRect() const;
189
190     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
191     bool rootBackgroundIsEntirelyFixed() const;
192     
193     bool hasRenderNamedFlowThreads() const;
194     bool checkTwoPassLayoutForAutoHeightRegions() const;
195     FlowThreadController& flowThreadController();
196
197     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
198
199     IntervalArena* intervalArena();
200
201     IntSize viewportSize() const;
202
203     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
204     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
205
206     // FIXME: This is a work around because the current implementation of counters
207     // requires walking the entire tree repeatedly and most pages don't actually use either
208     // feature so we shouldn't take the performance hit when not needed. Long term we should
209     // rewrite the counter and quotes code.
210     void addRenderCounter() { m_renderCounterCount++; }
211     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
212     bool hasRenderCounters() { return m_renderCounterCount; }
213     
214     IntRect pixelSnappedLayoutOverflowRect() const { return pixelSnappedIntRect(layoutOverflowRect()); }
215
216     ImageQualityController& imageQualityController();
217
218 #if ENABLE(CSS_FILTERS)
219     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
220     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
221 #endif
222
223     uint64_t rendererCount() const { return m_rendererCount; }
224     void didCreateRenderer() { ++m_rendererCount; }
225     void didDestroyRenderer() { --m_rendererCount; }
226
227     void resumePausedImageAnimationsIfNeeded();
228     void addRendererWithPausedImageAnimations(RenderElement&);
229     void removeRendererWithPausedImageAnimations(RenderElement&);
230
231     class RepaintRegionAccumulator {
232         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
233     public:
234         RepaintRegionAccumulator(RenderView*);
235         ~RepaintRegionAccumulator();
236
237     private:
238         RenderView* m_rootView;
239         bool m_wasAccumulatingRepaintRegion;
240     };
241
242 protected:
243     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const override;
244     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
245     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
246     virtual bool requiresColumns(int desiredColumnCount) const override;
247
248 private:
249     void initializeLayoutState(LayoutState&);
250
251     virtual void computeColumnCountAndWidth() override;
252     virtual ColumnInfo::PaginationUnit paginationUnit() const override;
253
254     bool shouldRepaint(const LayoutRect&) const;
255     void flushAccumulatedRepaintRegion() const;
256
257     // These functions may only be accessed by LayoutStateMaintainer.
258     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
259     {
260         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
261         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.hasColumns() || renderer.flowThreadContainingBlock()
262             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
263             m_layoutState = std::make_unique<LayoutState>(std::move(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged, colInfo);
264             pushLayoutStateForCurrentFlowThread(renderer);
265             return true;
266         }
267         return false;
268     }
269
270     void popLayoutState()
271     {
272         popLayoutStateForCurrentFlowThread();
273         m_layoutState = std::move(m_layoutState->m_next);
274     }
275
276     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
277     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
278     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
279     // Note that even when disabled, LayoutState is still used to store layoutDelta.
280     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
281     void disableLayoutState() { m_layoutStateDisableCount++; }
282     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
283
284     void layoutContent(const LayoutState&);
285     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
286     void layoutContentToComputeOverflowInRegions(const LayoutState&);
287 #ifndef NDEBUG
288     void checkLayoutState(const LayoutState&);
289 #endif
290
291     void pushLayoutStateForCurrentFlowThread(const RenderObject&);
292     void popLayoutStateForCurrentFlowThread();
293     
294     friend class LayoutStateMaintainer;
295     friend class LayoutStateDisabler;
296
297 private:
298     FrameView& m_frameView;
299
300     RenderObject* m_selectionStart;
301     RenderObject* m_selectionEnd;
302     int m_selectionStartPos;
303     int m_selectionEndPos;
304
305     uint64_t m_rendererCount;
306
307     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
308
309     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
310     struct LegacyPrinting {
311         LegacyPrinting()
312             : m_bestTruncatedAt(0)
313             , m_truncatedAt(0)
314             , m_truncatorWidth(0)
315             , m_forcedPageBreak(false)
316         { }
317
318         int m_bestTruncatedAt;
319         int m_truncatedAt;
320         int m_truncatorWidth;
321         IntRect m_printRect;
322         bool m_forcedPageBreak;
323     };
324     LegacyPrinting m_legacyPrinting;
325     // End deprecated members.
326
327     int m_maximalOutlineSize; // Used to apply a fudge factor to dirty-rect checks on blocks/tables.
328
329     bool shouldUsePrintingLayout() const;
330
331     std::unique_ptr<ImageQualityController> m_imageQualityController;
332     LayoutUnit m_pageLogicalHeight;
333     bool m_pageLogicalHeightChanged;
334     std::unique_ptr<LayoutState> m_layoutState;
335     unsigned m_layoutStateDisableCount;
336     std::unique_ptr<RenderLayerCompositor> m_compositor;
337     std::unique_ptr<FlowThreadController> m_flowThreadController;
338     RefPtr<IntervalArena> m_intervalArena;
339
340     RenderQuote* m_renderQuoteHead;
341     unsigned m_renderCounterCount;
342
343     bool m_selectionWasCaret;
344 #if ENABLE(CSS_FILTERS)
345     bool m_hasSoftwareFilters;
346 #endif
347
348     HashSet<RenderElement*> m_renderersWithPausedImageAnimation;
349 };
350
351 RENDER_OBJECT_TYPE_CASTS(RenderView, isRenderView())
352
353 // Stack-based class to assist with LayoutState push/pop
354 class LayoutStateMaintainer {
355     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
356 public:
357     // Constructor to push now.
358     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
359         : m_view(view)
360         , m_disabled(disableState)
361         , m_didStart(false)
362         , m_didEnd(false)
363         , m_didCreateLayoutState(false)
364     {
365         push(root, offset, pageHeight, pageHeightChanged, colInfo);
366     }
367
368     // Constructor to maybe push later.
369     explicit LayoutStateMaintainer(RenderView& view)
370         : m_view(view)
371         , m_disabled(false)
372         , m_didStart(false)
373         , m_didEnd(false)
374         , m_didCreateLayoutState(false)
375     {
376     }
377
378     ~LayoutStateMaintainer()
379     {
380         ASSERT(m_didStart == m_didEnd);   // if this fires, it means that someone did a push(), but forgot to pop().
381     }
382
383     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = nullptr)
384     {
385         ASSERT(!m_didStart);
386         // We push state even if disabled, because we still need to store layoutDelta
387         m_didCreateLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged, colInfo);
388         if (m_disabled && m_didCreateLayoutState)
389             m_view.disableLayoutState();
390         m_didStart = true;
391     }
392
393     void pop()
394     {
395         if (m_didStart) {
396             ASSERT(!m_didEnd);
397             if (m_didCreateLayoutState) {
398                 m_view.popLayoutState();
399                 if (m_disabled)
400                     m_view.enableLayoutState();
401             }
402             
403             m_didEnd = true;
404         }
405     }
406
407     bool didPush() const { return m_didStart; }
408
409 private:
410     RenderView& m_view;
411     bool m_disabled : 1;        // true if the offset and clip part of layoutState is disabled
412     bool m_didStart : 1;        // true if we did a push or disable
413     bool m_didEnd : 1;          // true if we popped or re-enabled
414     bool m_didCreateLayoutState : 1; // true if we actually made a layout state.
415 };
416
417 class LayoutStateDisabler {
418     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
419 public:
420     LayoutStateDisabler(RenderView* view)
421         : m_view(view)
422     {
423         if (m_view)
424             m_view->disableLayoutState();
425     }
426
427     ~LayoutStateDisabler()
428     {
429         if (m_view)
430             m_view->enableLayoutState();
431     }
432 private:
433     RenderView* m_view;
434 };
435
436 inline Frame& RenderObject::frame() const
437 {
438     return view().frameView().frame();
439 }
440
441 } // namespace WebCore
442
443 #endif // RenderView_h