Apply FINAL to the RenderObject hierarchy.
[WebKit-https.git] / Source / WebCore / rendering / RenderView.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2006 Apple Computer, 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 "RenderBlock.h"
29 #include <wtf/OwnPtr.h>
30
31 namespace WebCore {
32
33 class FlowThreadController;
34 class RenderQuote;
35 class RenderWidget;
36
37 #if USE(ACCELERATED_COMPOSITING)
38 class RenderLayerCompositor;
39 #endif
40
41 #if ENABLE(CSS_SHADERS) && USE(3D_GRAPHICS)
42 class CustomFilterGlobalContext;
43 #endif
44
45 class RenderView FINAL : public RenderBlock {
46 public:
47     explicit RenderView(Document*);
48     virtual ~RenderView();
49
50     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 isRenderView() const OVERRIDE { return true; }
56
57     virtual bool requiresLayer() const OVERRIDE { return true; }
58
59     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const OVERRIDE;
60
61     virtual void layout() OVERRIDE;
62     virtual void updateLogicalWidth() OVERRIDE;
63     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const OVERRIDE;
64
65     virtual LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const OVERRIDE;
66
67     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
68     int viewHeight() const;
69     int viewWidth() const;
70     int viewLogicalWidth() const { return style()->isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
71     int viewLogicalHeight() const;
72
73     float zoomFactor() const;
74
75     FrameView* frameView() const { return m_frameView; }
76
77     virtual LayoutRect visualOverflowRect() const OVERRIDE;
78     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const OVERRIDE;
79     void repaintViewRectangle(const LayoutRect&, bool immediate = false) const;
80     // Repaint the view, and all composited layers that intersect the given absolute rectangle.
81     // FIXME: ideally we'd never have to do this, if all repaints are container-relative.
82     void repaintRectangleInViewAndCompositedLayers(const LayoutRect&, bool immediate = false);
83     void repaintViewAndCompositedLayers();
84
85     virtual void paint(PaintInfo&, const LayoutPoint&);
86     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) OVERRIDE;
87
88     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
89     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
90     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
91     void clearSelection();
92     RenderObject* selectionStart() const { return m_selectionStart; }
93     RenderObject* selectionEnd() const { return m_selectionEnd; }
94     IntRect selectionBounds(bool clipToVisibleContent = true) const;
95     void selectionStartEnd(int& startPos, int& endPos) const;
96     void repaintSelection() const;
97
98     bool printing() const;
99
100     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const;
101     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const;
102
103 #if USE(ACCELERATED_COMPOSITING)
104     void setMaximalOutlineSize(int o);
105 #else
106     void setMaximalOutlineSize(int o) { m_maximalOutlineSize = o; }
107 #endif
108     int maximalOutlineSize() const { return m_maximalOutlineSize; }
109
110     virtual LayoutRect viewRect() const OVERRIDE;
111
112     void updateWidgetPositions();
113     void addWidget(RenderWidget*);
114     void removeWidget(RenderWidget*);
115     
116     void notifyWidgets(WidgetNotification);
117
118     // layoutDelta is used transiently during layout to store how far an object has moved from its
119     // last layout location, in order to repaint correctly.
120     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
121     LayoutSize layoutDelta() const
122     {
123         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
124     }
125     void addLayoutDelta(const LayoutSize& delta) 
126     {
127         if (m_layoutState) {
128             m_layoutState->m_layoutDelta += delta;
129 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
130             m_layoutState->m_layoutDeltaXSaturated |= m_layoutState->m_layoutDelta.width() == LayoutUnit::max() || m_layoutState->m_layoutDelta.width() == LayoutUnit::min();
131             m_layoutState->m_layoutDeltaYSaturated |= m_layoutState->m_layoutDelta.height() == LayoutUnit::max() || m_layoutState->m_layoutDelta.height() == LayoutUnit::min();
132 #endif
133         }
134     }
135     
136 #if !ASSERT_DISABLED
137     bool layoutDeltaMatches(const LayoutSize& delta)
138     {
139         if (!m_layoutState)
140             return false;
141 #if ENABLE(SATURATED_LAYOUT_ARITHMETIC)
142         return (delta.width() == m_layoutState->m_layoutDelta.width() || m_layoutState->m_layoutDeltaXSaturated) && (delta.height() == m_layoutState->m_layoutDelta.height() || m_layoutState->m_layoutDeltaYSaturated);
143 #else
144         return delta == m_layoutState->m_layoutDelta;
145 #endif
146     }
147 #endif
148
149     bool doingFullRepaint() const { return m_frameView->needsFullRepaint(); }
150
151     // Subtree push/pop
152     void pushLayoutState(RenderObject*);
153     void popLayoutState(RenderObject*) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
154
155     bool shouldDisableLayoutStateForSubtree(RenderObject*) const;
156
157     // Returns true if layoutState should be used for its cached offset and clip.
158     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
159     LayoutState* layoutState() const { return m_layoutState; }
160
161     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
162
163     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
164     void setPageLogicalHeight(LayoutUnit height)
165     {
166         if (m_pageLogicalHeight != height) {
167             m_pageLogicalHeight = height;
168             m_pageLogicalHeightChanged = true;
169         }
170     }
171     LayoutUnit pageOrViewLogicalHeight() const;
172
173     // FIXME: These functions are deprecated. No code should be added that uses these.
174     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
175     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
176     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
177     void setTruncatedAt(int y)
178     { 
179         m_legacyPrinting.m_truncatedAt = y;
180         m_legacyPrinting.m_bestTruncatedAt = 0;
181         m_legacyPrinting.m_truncatorWidth = 0;
182         m_legacyPrinting.m_forcedPageBreak = false;
183     }
184     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
185     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
186     // End deprecated functions.
187
188     // Notification that this view moved into or out of a native window.
189     void setIsInWindow(bool);
190
191 #if USE(ACCELERATED_COMPOSITING)
192     RenderLayerCompositor* compositor();
193     bool usesCompositing() const;
194 #endif
195
196 #if ENABLE(CSS_SHADERS) && USE(3D_GRAPHICS)
197     CustomFilterGlobalContext* customFilterGlobalContext();
198 #endif
199
200     IntRect unscaledDocumentRect() const;
201     LayoutRect backgroundRect(RenderBox* backgroundRenderer) const;
202
203     IntRect documentRect() const;
204
205     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
206     bool rootBackgroundIsEntirelyFixed() const;
207     
208     bool hasRenderNamedFlowThreads() const;
209     bool checkTwoPassLayoutForAutoHeightRegions() const;
210     FlowThreadController* flowThreadController();
211
212     void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
213
214     IntervalArena* intervalArena();
215
216     IntSize viewportSize() const { return document()->viewportSize(); }
217
218     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
219     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
220
221     // FIXME: This is a work around because the current implementation of counters
222     // requires walking the entire tree repeatedly and most pages don't actually use either
223     // feature so we shouldn't take the performance hit when not needed. Long term we should
224     // rewrite the counter and quotes code.
225     void addRenderCounter() { m_renderCounterCount++; }
226     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
227     bool hasRenderCounters() { return m_renderCounterCount; }
228     
229     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) OVERRIDE;
230
231     IntRect pixelSnappedLayoutOverflowRect() const { return pixelSnappedIntRect(layoutOverflowRect()); }
232
233 protected:
234     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const OVERRIDE;
235     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const OVERRIDE;
236     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const;
237     virtual bool requiresColumns(int desiredColumnCount) const OVERRIDE;
238     
239 private:
240     bool initializeLayoutState(LayoutState&);
241
242     virtual void calcColumnWidth() OVERRIDE;
243     virtual ColumnInfo::PaginationUnit paginationUnit() const OVERRIDE;
244
245     bool shouldRepaint(const LayoutRect&) const;
246
247     // These functions may only be accessed by LayoutStateMaintainer.
248     bool pushLayoutState(RenderBox* renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
249     {
250         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
251         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer->hasColumns() || renderer->flowThreadContainingBlock()
252             || m_layoutState->lineGrid() || (renderer->style()->lineGrid() != RenderStyle::initialLineGrid() && renderer->isBlockFlow())
253 #if ENABLE(CSS_SHAPES)
254             || (renderer->isRenderBlock() && toRenderBlock(renderer)->shapeInsideInfo())
255             || (m_layoutState->shapeInsideInfo() && renderer->isRenderBlock() && !toRenderBlock(renderer)->allowsShapeInsideInfoSharing())
256 #endif
257             ) {
258             pushLayoutStateForCurrentFlowThread(renderer);
259             m_layoutState = new (renderArena()) LayoutState(m_layoutState, renderer, offset, pageHeight, pageHeightChanged, colInfo);
260             return true;
261         }
262         return false;
263     }
264
265     void popLayoutState()
266     {
267         LayoutState* state = m_layoutState;
268         m_layoutState = state->m_next;
269         state->destroy(renderArena());
270         popLayoutStateForCurrentFlowThread();
271     }
272
273     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
274     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
275     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
276     // Note that even when disabled, LayoutState is still used to store layoutDelta.
277     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
278     void disableLayoutState() { m_layoutStateDisableCount++; }
279     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
280
281     void layoutContent(const LayoutState&);
282     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
283 #ifndef NDEBUG
284     void checkLayoutState(const LayoutState&);
285 #endif
286
287     size_t getRetainedWidgets(Vector<RenderWidget*>&);
288     void releaseWidgets(Vector<RenderWidget*>&);
289
290     void pushLayoutStateForCurrentFlowThread(const RenderObject*);
291     void popLayoutStateForCurrentFlowThread();
292     
293     friend class LayoutStateMaintainer;
294     friend class LayoutStateDisabler;
295
296 protected:
297     FrameView* m_frameView;
298
299     RenderObject* m_selectionStart;
300     RenderObject* m_selectionEnd;
301     int m_selectionStartPos;
302     int m_selectionEndPos;
303
304     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
305     struct LegacyPrinting {
306         LegacyPrinting()
307             : m_bestTruncatedAt(0)
308             , m_truncatedAt(0)
309             , m_truncatorWidth(0)
310             , m_forcedPageBreak(false)
311         { }
312
313         int m_bestTruncatedAt;
314         int m_truncatedAt;
315         int m_truncatorWidth;
316         IntRect m_printRect;
317         bool m_forcedPageBreak;
318     };
319     LegacyPrinting m_legacyPrinting;
320     // End deprecated members.
321
322     int m_maximalOutlineSize; // Used to apply a fudge factor to dirty-rect checks on blocks/tables.
323
324     typedef HashSet<RenderWidget*> RenderWidgetSet;
325     RenderWidgetSet m_widgets;
326
327 private:
328     bool shouldUsePrintingLayout() const;
329
330     LayoutUnit m_pageLogicalHeight;
331     bool m_pageLogicalHeightChanged;
332     LayoutState* m_layoutState;
333     unsigned m_layoutStateDisableCount;
334 #if USE(ACCELERATED_COMPOSITING)
335     OwnPtr<RenderLayerCompositor> m_compositor;
336 #endif
337 #if ENABLE(CSS_SHADERS) && USE(3D_GRAPHICS)
338     OwnPtr<CustomFilterGlobalContext> m_customFilterGlobalContext;
339 #endif
340     OwnPtr<FlowThreadController> m_flowThreadController;
341     RefPtr<IntervalArena> m_intervalArena;
342
343     RenderQuote* m_renderQuoteHead;
344     unsigned m_renderCounterCount;
345
346     bool m_selectionWasCaret;
347 };
348
349 inline RenderView* toRenderView(RenderObject* object)
350 {
351     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderView());
352     return static_cast<RenderView*>(object);
353 }
354
355 inline const RenderView* toRenderView(const RenderObject* object)
356 {
357     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderView());
358     return static_cast<const RenderView*>(object);
359 }
360
361 // This will catch anyone doing an unnecessary cast.
362 void toRenderView(const RenderView*);
363
364 ALWAYS_INLINE RenderView* Document::renderView() const
365 {
366     return toRenderView(renderer());
367 }
368
369 // Stack-based class to assist with LayoutState push/pop
370 class LayoutStateMaintainer {
371     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
372 public:
373     // ctor to push now
374     LayoutStateMaintainer(RenderView* view, RenderBox* root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
375         : m_view(view)
376         , m_disabled(disableState)
377         , m_didStart(false)
378         , m_didEnd(false)
379         , m_didCreateLayoutState(false)
380     {
381         push(root, offset, pageHeight, pageHeightChanged, colInfo);
382     }
383     
384     // ctor to maybe push later
385     LayoutStateMaintainer(RenderView* view)
386         : m_view(view)
387         , m_disabled(false)
388         , m_didStart(false)
389         , m_didEnd(false)
390         , m_didCreateLayoutState(false)
391     {
392     }
393
394     ~LayoutStateMaintainer()
395     {
396         ASSERT(m_didStart == m_didEnd);   // if this fires, it means that someone did a push(), but forgot to pop().
397     }
398
399     void push(RenderBox* root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
400     {
401         ASSERT(!m_didStart);
402         // We push state even if disabled, because we still need to store layoutDelta
403         m_didCreateLayoutState = m_view->pushLayoutState(root, offset, pageHeight, pageHeightChanged, colInfo);
404         if (m_disabled && m_didCreateLayoutState)
405             m_view->disableLayoutState();
406         m_didStart = true;
407     }
408
409     void pop()
410     {
411         if (m_didStart) {
412             ASSERT(!m_didEnd);
413             if (m_didCreateLayoutState) {
414                 m_view->popLayoutState();
415                 if (m_disabled)
416                     m_view->enableLayoutState();
417             }
418             
419             m_didEnd = true;
420         }
421     }
422
423     bool didPush() const { return m_didStart; }
424
425 private:
426     RenderView* m_view;
427     bool m_disabled : 1;        // true if the offset and clip part of layoutState is disabled
428     bool m_didStart : 1;        // true if we did a push or disable
429     bool m_didEnd : 1;          // true if we popped or re-enabled
430     bool m_didCreateLayoutState : 1; // true if we actually made a layout state.
431 };
432
433 class LayoutStateDisabler {
434     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
435 public:
436     LayoutStateDisabler(RenderView* view)
437         : m_view(view)
438     {
439         if (m_view)
440             m_view->disableLayoutState();
441     }
442
443     ~LayoutStateDisabler()
444     {
445         if (m_view)
446             m_view->enableLayoutState();
447     }
448 private:
449     RenderView* m_view;
450 };
451
452 class FragmentationDisabler {
453     WTF_MAKE_NONCOPYABLE(FragmentationDisabler);
454 public:
455     FragmentationDisabler(RenderObject* root);
456     ~FragmentationDisabler();
457 private:
458     RenderObject* m_root;
459     RenderObject::FlowThreadState m_flowThreadState;
460     bool m_fragmenting;
461 #ifndef NDEBUG
462     LayoutState* m_layoutState;
463 #endif
464 };
465
466 } // namespace WebCore
467
468 #endif // RenderView_h