021a79d2a431865a4817451824e92a748602b595
[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/ListHashSet.h>
30 #include <wtf/OwnPtr.h>
31
32 namespace WebCore {
33
34 class RenderNamedFlowThread;
35 class RenderWidget;
36
37 #if USE(ACCELERATED_COMPOSITING)
38 class RenderLayerCompositor;
39 #endif
40
41 typedef ListHashSet<RenderNamedFlowThread*> RenderNamedFlowThreadList;
42
43 class RenderView : public RenderBlock {
44 public:
45     RenderView(Node*, FrameView*);
46     virtual ~RenderView();
47
48     virtual const char* renderName() const { return "RenderView"; }
49
50     virtual bool isRenderView() const { return true; }
51
52     virtual bool requiresLayer() const { return true; }
53
54     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const;
55
56     virtual void layout();
57     virtual void computeLogicalWidth();
58     virtual void computeLogicalHeight();
59     virtual void computePreferredLogicalWidths();
60
61     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
62     int viewHeight() const;
63     int viewWidth() const;
64     int viewLogicalWidth() const { return style()->isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
65     int viewLogicalHeight() const;
66
67     float zoomFactor() const;
68
69     FrameView* frameView() const { return m_frameView; }
70
71     virtual void computeRectForRepaint(RenderBoxModelObject* repaintContainer, LayoutRect&, bool fixed = false) const;
72     virtual void repaintViewRectangle(const LayoutRect&, bool immediate = false);
73     // Repaint the view, and all composited layers that intersect the given absolute rectangle.
74     // FIXME: ideally we'd never have to do this, if all repaints are container-relative.
75     virtual void repaintRectangleInViewAndCompositedLayers(const LayoutRect&, bool immediate = false);
76
77     virtual void paint(PaintInfo&, const LayoutPoint&);
78     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) OVERRIDE;
79
80     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
81     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
82     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
83     void clearSelection();
84     RenderObject* selectionStart() const { return m_selectionStart; }
85     RenderObject* selectionEnd() const { return m_selectionEnd; }
86     IntRect selectionBounds(bool clipToVisibleContent = true) const;
87     void selectionStartEnd(int& startPos, int& endPos) const;
88
89     bool printing() const;
90
91     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const;
92     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const;
93
94 #if USE(ACCELERATED_COMPOSITING)
95     void setMaximalOutlineSize(int o);
96 #else
97     void setMaximalOutlineSize(int o) { m_maximalOutlineSize = o; }
98 #endif
99     int maximalOutlineSize() const { return m_maximalOutlineSize; }
100
101     virtual LayoutRect viewRect() const OVERRIDE;
102
103     void updateWidgetPositions();
104     void addWidget(RenderWidget*);
105     void removeWidget(RenderWidget*);
106     
107     void notifyWidgets(WidgetNotification);
108
109     // layoutDelta is used transiently during layout to store how far an object has moved from its
110     // last layout location, in order to repaint correctly.
111     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
112     LayoutSize layoutDelta() const
113     {
114         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
115     }
116     void addLayoutDelta(const LayoutSize& delta) 
117     {
118         if (m_layoutState)
119             m_layoutState->m_layoutDelta += delta;
120     }
121
122     bool doingFullRepaint() const { return m_frameView->needsFullRepaint(); }
123
124     // Subtree push/pop
125     void pushLayoutState(RenderObject*);
126     void popLayoutState(RenderObject*) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
127
128     bool shouldDisableLayoutStateForSubtree(RenderObject*) const;
129
130     // Returns true if layoutState should be used for its cached offset and clip.
131     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
132     LayoutState* layoutState() const { return m_layoutState; }
133
134     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
135
136     unsigned pageLogicalHeight() const { return m_pageLogicalHeight; }
137     void setPageLogicalHeight(unsigned height)
138     {
139         if (m_pageLogicalHeight != height) {
140             m_pageLogicalHeight = height;
141             m_pageLogicalHeightChanged = true;
142         }
143     }
144
145     // FIXME: These functions are deprecated. No code should be added that uses these.
146     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
147     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
148     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
149     void setTruncatedAt(int y)
150     { 
151         m_legacyPrinting.m_truncatedAt = y;
152         m_legacyPrinting.m_bestTruncatedAt = 0;
153         m_legacyPrinting.m_truncatorWidth = 0;
154         m_legacyPrinting.m_forcedPageBreak = false;
155     }
156     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
157     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
158     // End deprecated functions.
159
160     // Notifications that this view became visible in a window, or will be
161     // removed from the window.
162     void didMoveOnscreen();
163     void willMoveOffscreen();
164
165 #if USE(ACCELERATED_COMPOSITING)
166     RenderLayerCompositor* compositor();
167     bool usesCompositing() const;
168 #endif
169
170     IntRect unscaledDocumentRect() const;
171     LayoutRect backgroundRect(RenderBox* backgroundRenderer) const;
172
173     IntRect documentRect() const;
174
175     RenderNamedFlowThread* ensureRenderFlowThreadWithName(const AtomicString&);
176     bool hasRenderNamedFlowThreads() const { return m_renderNamedFlowThreadList && !m_renderNamedFlowThreadList->isEmpty(); }
177     void layoutRenderNamedFlowThreads();
178     bool isRenderNamedFlowThreadOrderDirty() const { return m_isRenderNamedFlowThreadOrderDirty; }
179     void setIsRenderNamedFlowThreadOrderDirty(bool dirty)
180     {
181         m_isRenderNamedFlowThreadOrderDirty = dirty;
182         if (dirty)
183             setNeedsLayout(true);
184     }
185     const RenderNamedFlowThreadList* renderNamedFlowThreadList() const { return m_renderNamedFlowThreadList.get(); }
186
187     RenderFlowThread* currentRenderFlowThread() const { return m_currentRenderFlowThread; }
188     void setCurrentRenderFlowThread(RenderFlowThread* flowThread) { m_currentRenderFlowThread = flowThread; }
189
190     void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
191
192     IntervalArena* intervalArena();
193
194     IntSize viewportSize() const { return document()->viewportSize(); }
195 protected:
196     virtual void mapLocalToContainer(RenderBoxModelObject* repaintContainer, bool useTransforms, bool fixed, TransformState&, bool* wasFixed = 0) const;
197     virtual void mapAbsoluteToLocalPoint(bool fixed, bool useTransforms, TransformState&) const;
198     virtual bool requiresColumns(int desiredColumnCount) const OVERRIDE;
199
200 private:
201     virtual void calcColumnWidth() OVERRIDE;
202     virtual ColumnInfo::PaginationUnit paginationUnit() const OVERRIDE;
203
204     bool shouldRepaint(const LayoutRect&) const;
205
206     // These functions may only be accessed by LayoutStateMaintainer.
207     void pushLayoutState(RenderFlowThread*, bool regionsChanged);
208     bool pushLayoutState(RenderBox* renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
209     {
210         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
211         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer->hasColumns() || renderer->inRenderFlowThread()
212             || m_layoutState->lineGrid() || (renderer->style()->lineGrid() != RenderStyle::initialLineGrid() && renderer->isBlockFlow())) {
213             m_layoutState = new (renderArena()) LayoutState(m_layoutState, renderer, offset, pageHeight, pageHeightChanged, colInfo);
214             return true;
215         }
216         return false;
217     }
218
219     void popLayoutState()
220     {
221         LayoutState* state = m_layoutState;
222         m_layoutState = state->m_next;
223         state->destroy(renderArena());
224     }
225
226     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
227     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
228     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
229     // Note that even when disabled, LayoutState is still used to store layoutDelta.
230     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
231     void disableLayoutState() { m_layoutStateDisableCount++; }
232     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
233
234     size_t getRetainedWidgets(Vector<RenderWidget*>&);
235     void releaseWidgets(Vector<RenderWidget*>&);
236     
237     friend class LayoutStateMaintainer;
238     friend class LayoutStateDisabler;
239
240 protected:
241     FrameView* m_frameView;
242
243     RenderObject* m_selectionStart;
244     RenderObject* m_selectionEnd;
245     int m_selectionStartPos;
246     int m_selectionEndPos;
247
248     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
249     struct LegacyPrinting {
250         LegacyPrinting()
251             : m_bestTruncatedAt(0)
252             , m_truncatedAt(0)
253             , m_truncatorWidth(0)
254             , m_forcedPageBreak(false)
255         { }
256
257         int m_bestTruncatedAt;
258         int m_truncatedAt;
259         int m_truncatorWidth;
260         IntRect m_printRect;
261         bool m_forcedPageBreak;
262     };
263     LegacyPrinting m_legacyPrinting;
264     // End deprecated members.
265
266     int m_maximalOutlineSize; // Used to apply a fudge factor to dirty-rect checks on blocks/tables.
267
268     typedef HashSet<RenderWidget*> RenderWidgetSet;
269     RenderWidgetSet m_widgets;
270     
271 private:
272     unsigned m_pageLogicalHeight;
273     bool m_pageLogicalHeightChanged;
274     bool m_isRenderNamedFlowThreadOrderDirty;
275     LayoutState* m_layoutState;
276     unsigned m_layoutStateDisableCount;
277 #if USE(ACCELERATED_COMPOSITING)
278     OwnPtr<RenderLayerCompositor> m_compositor;
279 #endif
280     OwnPtr<RenderNamedFlowThreadList> m_renderNamedFlowThreadList;
281     RenderFlowThread* m_currentRenderFlowThread;
282     RefPtr<IntervalArena> m_intervalArena;
283 };
284
285 inline RenderView* toRenderView(RenderObject* object)
286 {
287     ASSERT(!object || object->isRenderView());
288     return static_cast<RenderView*>(object);
289 }
290
291 inline const RenderView* toRenderView(const RenderObject* object)
292 {
293     ASSERT(!object || object->isRenderView());
294     return static_cast<const RenderView*>(object);
295 }
296
297 // This will catch anyone doing an unnecessary cast.
298 void toRenderView(const RenderView*);
299
300
301 ALWAYS_INLINE RenderView* RenderObject::view() const
302 {
303     return toRenderView(document()->renderer());
304 }
305
306 // Stack-based class to assist with LayoutState push/pop
307 class LayoutStateMaintainer {
308     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
309 public:
310     // ctor to push now
311     LayoutStateMaintainer(RenderView* view, RenderBox* root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
312         : m_view(view)
313         , m_disabled(disableState)
314         , m_didStart(false)
315         , m_didEnd(false)
316         , m_didCreateLayoutState(false)
317     {
318         push(root, offset, pageHeight, pageHeightChanged, colInfo);
319     }
320     
321     // ctor to maybe push later
322     LayoutStateMaintainer(RenderView* view)
323         : m_view(view)
324         , m_disabled(false)
325         , m_didStart(false)
326         , m_didEnd(false)
327         , m_didCreateLayoutState(false)
328     {
329     }
330     
331     LayoutStateMaintainer(RenderView* view, RenderFlowThread* flowThread, bool regionsChanged)
332         : m_view(view)
333         , m_disabled(false)
334         , m_didStart(false)
335         , m_didEnd(false)
336         , m_didCreateLayoutState(false)
337     {
338         push(flowThread, regionsChanged);
339     }
340     
341     ~LayoutStateMaintainer()
342     {
343         ASSERT(m_didStart == m_didEnd);   // if this fires, it means that someone did a push(), but forgot to pop().
344     }
345
346     void push(RenderBox* root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false, ColumnInfo* colInfo = 0)
347     {
348         ASSERT(!m_didStart);
349         // We push state even if disabled, because we still need to store layoutDelta
350         m_didCreateLayoutState = m_view->pushLayoutState(root, offset, pageHeight, pageHeightChanged, colInfo);
351         if (m_disabled && m_didCreateLayoutState)
352             m_view->disableLayoutState();
353         m_didStart = true;
354     }
355     
356     void push(RenderFlowThread* flowThread, bool regionsChanged)
357     {
358         ASSERT(!m_didStart);
359         m_view->pushLayoutState(flowThread, regionsChanged);
360         m_didCreateLayoutState = true;
361         m_didStart = true;
362     }
363
364     void pop()
365     {
366         if (m_didStart) {
367             ASSERT(!m_didEnd);
368             if (m_didCreateLayoutState) {
369                 m_view->popLayoutState();
370                 if (m_disabled)
371                     m_view->enableLayoutState();
372             }
373             
374             m_didEnd = true;
375         }
376     }
377
378     bool didPush() const { return m_didStart; }
379
380 private:
381     RenderView* m_view;
382     bool m_disabled : 1;        // true if the offset and clip part of layoutState is disabled
383     bool m_didStart : 1;        // true if we did a push or disable
384     bool m_didEnd : 1;          // true if we popped or re-enabled
385     bool m_didCreateLayoutState : 1; // true if we actually made a layout state.
386 };
387
388 class LayoutStateDisabler {
389     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
390 public:
391     LayoutStateDisabler(RenderView* view)
392         : m_view(view)
393     {
394         if (m_view)
395             m_view->disableLayoutState();
396     }
397
398     ~LayoutStateDisabler()
399     {
400         if (m_view)
401             m_view->enableLayoutState();
402     }
403 private:
404     RenderView* m_view;
405 };
406
407 } // namespace WebCore
408
409 #endif // RenderView_h