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