Add ASSERTs to avoid querying dirtied z-index or normal flow lists on RenderLayer
[WebKit.git] / Source / WebCore / rendering / RenderLayer.h
1 /*
2  * Copyright (C) 2003, 2009 Apple Inc. All rights reserved.
3  *
4  * Portions are Copyright (C) 1998 Netscape Communications Corporation.
5  *
6  * Other contributors:
7  *   Robert O'Callahan <roc+@cs.cmu.edu>
8  *   David Baron <dbaron@fas.harvard.edu>
9  *   Christian Biesinger <cbiesinger@web.de>
10  *   Randall Jesup <rjesup@wgate.com>
11  *   Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
12  *   Josh Soref <timeless@mac.com>
13  *   Boris Zbarsky <bzbarsky@mit.edu>
14  *
15  * This library is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU Lesser General Public
17  * License as published by the Free Software Foundation; either
18  * version 2.1 of the License, or (at your option) any later version.
19  *
20  * This library is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  * Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public
26  * License along with this library; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28  *
29  * Alternatively, the contents of this file may be used under the terms
30  * of either the Mozilla Public License Version 1.1, found at
31  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
32  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
33  * (the "GPL"), in which case the provisions of the MPL or the GPL are
34  * applicable instead of those above.  If you wish to allow use of your
35  * version of this file only under the terms of one of those two
36  * licenses (the MPL or the GPL) and not to allow others to use your
37  * version of this file under the LGPL, indicate your decision by
38  * deletingthe provisions above and replace them with the notice and
39  * other provisions required by the MPL or the GPL, as the case may be.
40  * If you do not delete the provisions above, a recipient may use your
41  * version of this file under any of the LGPL, the MPL or the GPL.
42  */
43
44 #ifndef RenderLayer_h
45 #define RenderLayer_h
46
47 #include "PaintInfo.h"
48 #include "RenderBox.h"
49 #include "ScrollableArea.h"
50 #include <wtf/OwnPtr.h>
51
52 #if ENABLE(CSS_FILTERS)
53 #include "RenderLayerFilterInfo.h"
54 #endif
55
56 namespace WebCore {
57
58 #if ENABLE(CSS_FILTERS)
59 class FilterEffectRenderer;
60 #endif
61 class HitTestRequest;
62 class HitTestResult;
63 class HitTestingTransformState;
64 class RenderMarquee;
65 class RenderReplica;
66 class RenderScrollbarPart;
67 class RenderStyle;
68 class RenderView;
69 class Scrollbar;
70 class TransformationMatrix;
71
72 #if USE(ACCELERATED_COMPOSITING)
73 class RenderLayerBacking;
74 class RenderLayerCompositor;
75 #endif
76
77 enum BorderRadiusClippingRule { IncludeSelfForBorderRadius, DoNotIncludeSelfForBorderRadius };
78
79 enum RepaintStatus {
80     NeedsNormalRepaint = 0,
81     NeedsFullRepaint = 1 << 0,
82     NeedsFullRepaintForPositionedMovementLayout = 1 << 1
83 };
84
85 class ClipRect {
86 public:
87     ClipRect()
88     : m_hasRadius(false)
89     { }
90     
91     ClipRect(const LayoutRect& rect)
92     : m_rect(rect)
93     , m_hasRadius(false)
94     { }
95     
96     const LayoutRect& rect() const { return m_rect; }
97     void setRect(const LayoutRect& rect) { m_rect = rect; }
98
99     bool hasRadius() const { return m_hasRadius; }
100     void setHasRadius(bool hasRadius) { m_hasRadius = hasRadius; }
101
102     bool operator==(const ClipRect& other) const { return rect() == other.rect() && hasRadius() == other.hasRadius(); }
103     bool operator!=(const ClipRect& other) const { return rect() != other.rect() || hasRadius() != other.hasRadius(); }
104
105     void intersect(const LayoutRect& other) { m_rect.intersect(other); }
106     void intersect(const ClipRect& other)
107     {
108         m_rect.intersect(other.rect());
109         if (other.hasRadius())
110             m_hasRadius = true;
111     }
112     void move(LayoutUnit x, LayoutUnit y) { m_rect.move(x, y); }
113
114     bool isEmpty() const { return m_rect.isEmpty(); }
115     bool intersects(const LayoutRect& rect) { return m_rect.intersects(rect); }
116
117 private:
118     LayoutRect m_rect;
119     bool m_hasRadius;
120 };
121
122 inline ClipRect intersection(const ClipRect& a, const ClipRect& b)
123 {
124     ClipRect c = a;
125     c.intersect(b);
126     return c;
127 }
128
129 class ClipRects {
130 public:
131     ClipRects()
132         : m_refCnt(0)
133         , m_fixed(false)
134     {
135     }
136
137     ClipRects(const LayoutRect& r)
138         : m_overflowClipRect(r)
139         , m_fixedClipRect(r)
140         , m_posClipRect(r)
141         , m_refCnt(0)
142         , m_fixed(false)
143     {
144     }
145
146     ClipRects(const ClipRects& other)
147         : m_overflowClipRect(other.overflowClipRect())
148         , m_fixedClipRect(other.fixedClipRect())
149         , m_posClipRect(other.posClipRect())
150         , m_refCnt(0)
151         , m_fixed(other.fixed())
152     {
153     }
154
155     void reset(const LayoutRect& r)
156     {
157         m_overflowClipRect = r;
158         m_fixedClipRect = r;
159         m_posClipRect = r;
160         m_fixed = false;
161     }
162     
163     const ClipRect& overflowClipRect() const { return m_overflowClipRect; }
164     void setOverflowClipRect(const ClipRect& r) { m_overflowClipRect = r; }
165
166     const ClipRect& fixedClipRect() const { return m_fixedClipRect; }
167     void setFixedClipRect(const ClipRect&r) { m_fixedClipRect = r; }
168
169     const ClipRect& posClipRect() const { return m_posClipRect; }
170     void setPosClipRect(const ClipRect& r) { m_posClipRect = r; }
171
172     bool fixed() const { return m_fixed; }
173     void setFixed(bool fixed) { m_fixed = fixed; }
174
175     void ref() { m_refCnt++; }
176     void deref(RenderArena* renderArena) { if (--m_refCnt == 0) destroy(renderArena); }
177
178     void destroy(RenderArena*);
179
180     // Overloaded new operator.
181     void* operator new(size_t, RenderArena*);
182
183     // Overridden to prevent the normal delete from being called.
184     void operator delete(void*, size_t);
185
186     bool operator==(const ClipRects& other) const
187     {
188         return m_overflowClipRect == other.overflowClipRect() &&
189                m_fixedClipRect == other.fixedClipRect() &&
190                m_posClipRect == other.posClipRect() &&
191                m_fixed == other.fixed();
192     }
193
194     ClipRects& operator=(const ClipRects& other)
195     {
196         m_overflowClipRect = other.overflowClipRect();
197         m_fixedClipRect = other.fixedClipRect();
198         m_posClipRect = other.posClipRect();
199         m_fixed = other.fixed();
200         return *this;
201     }
202
203 private:
204     // The normal operator new is disallowed on all render objects.
205     void* operator new(size_t) throw();
206
207 private:
208     ClipRect m_overflowClipRect;
209     ClipRect m_fixedClipRect;
210     ClipRect m_posClipRect;
211     unsigned m_refCnt : 31;
212     bool m_fixed : 1;
213 };
214
215 class RenderLayer : public ScrollableArea {
216 public:
217     friend class RenderReplica;
218
219     RenderLayer(RenderBoxModelObject*);
220     ~RenderLayer();
221
222     RenderBoxModelObject* renderer() const { return m_renderer; }
223     RenderBox* renderBox() const { return m_renderer && m_renderer->isBox() ? toRenderBox(m_renderer) : 0; }
224     RenderLayer* parent() const { return m_parent; }
225     RenderLayer* previousSibling() const { return m_previous; }
226     RenderLayer* nextSibling() const { return m_next; }
227     RenderLayer* firstChild() const { return m_first; }
228     RenderLayer* lastChild() const { return m_last; }
229
230     void addChild(RenderLayer* newChild, RenderLayer* beforeChild = 0);
231     RenderLayer* removeChild(RenderLayer*);
232
233     void removeOnlyThisLayer();
234     void insertOnlyThisLayer();
235
236     void repaintIncludingDescendants();
237
238 #if USE(ACCELERATED_COMPOSITING)
239     // Indicate that the layer contents need to be repainted. Only has an effect
240     // if layer compositing is being used,
241     void setBackingNeedsRepaint();
242     void setBackingNeedsRepaintInRect(const LayoutRect&); // r is in the coordinate space of the layer's render object
243     void repaintIncludingNonCompositingDescendants(RenderBoxModelObject* repaintContainer);
244 #endif
245
246     void styleChanged(StyleDifference, const RenderStyle* oldStyle);
247
248     RenderMarquee* marquee() const { return m_marquee; }
249
250     bool isNormalFlowOnly() const { return m_isNormalFlowOnly; }
251     bool isSelfPaintingLayer() const;
252
253     bool cannotBlitToWindow() const;
254
255     bool isTransparent() const;
256     RenderLayer* transparentPaintingAncestor();
257     void beginTransparencyLayers(GraphicsContext*, const RenderLayer* rootLayer, const LayoutRect& paintDirtyRect, PaintBehavior);
258
259     bool hasReflection() const { return renderer()->hasReflection(); }
260     bool isReflection() const { return renderer()->isReplica(); }
261     RenderReplica* reflection() const { return m_reflection; }
262     RenderLayer* reflectionLayer() const;
263
264     const RenderLayer* root() const
265     {
266         const RenderLayer* curr = this;
267         while (curr->parent())
268             curr = curr->parent();
269         return curr;
270     }
271     
272     const LayoutPoint& location() const { return m_topLeft; }
273     void setLocation(LayoutUnit x, LayoutUnit y) { m_topLeft = LayoutPoint(x, y); }
274
275     const IntSize& size() const { return m_layerSize; }
276     void setSize(const IntSize& size) { m_layerSize = size; }
277
278     LayoutRect rect() const { return LayoutRect(location(), size()); }
279
280     int scrollWidth() const;
281     int scrollHeight() const;
282
283     void panScrollFromPoint(const LayoutPoint&);
284
285     enum ScrollOffsetClamping {
286         ScrollOffsetUnclamped,
287         ScrollOffsetClamped
288     };
289
290     // Scrolling methods for layers that can scroll their overflow.
291     void scrollByRecursively(int xDelta, int yDelta, ScrollOffsetClamping = ScrollOffsetUnclamped);
292
293     int scrollXOffset() const { return m_scrollOffset.width() + scrollOrigin().x(); }
294     int scrollYOffset() const { return m_scrollOffset.height() + scrollOrigin().y(); }
295     IntSize scrollOffset() const { return IntSize(scrollXOffset(), scrollYOffset()); }
296
297     void scrollToOffset(int, int, ScrollOffsetClamping = ScrollOffsetUnclamped);
298     void scrollToXOffset(int x, ScrollOffsetClamping clamp = ScrollOffsetUnclamped) { scrollToOffset(x, scrollYOffset(), clamp); }
299     void scrollToYOffset(int y, ScrollOffsetClamping clamp = ScrollOffsetUnclamped) { scrollToOffset(scrollXOffset(), y, clamp); }
300
301     void scrollRectToVisible(const LayoutRect&, const ScrollAlignment& alignX, const ScrollAlignment& alignY);
302
303     LayoutRect getRectToExpose(const LayoutRect& visibleRect, const LayoutRect& exposeRect, const ScrollAlignment& alignX, const ScrollAlignment& alignY);
304
305     bool scrollsOverflow() const;
306     bool allowsScrolling() const; // Returns true if at least one scrollbar is visible and enabled.
307     bool hasScrollbars() const { return m_hBar || m_vBar; }
308     void setHasHorizontalScrollbar(bool);
309     void setHasVerticalScrollbar(bool);
310
311     PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
312     void destroyScrollbar(ScrollbarOrientation);
313
314     bool hasHorizontalScrollbar() const { return horizontalScrollbar(); }
315     bool hasVerticalScrollbar() const { return verticalScrollbar(); }
316
317     // ScrollableArea overrides
318     virtual Scrollbar* horizontalScrollbar() const { return m_hBar.get(); }
319     virtual Scrollbar* verticalScrollbar() const { return m_vBar.get(); }
320     virtual ScrollableArea* enclosingScrollableArea() const;
321
322     int verticalScrollbarWidth(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
323     int horizontalScrollbarHeight(OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
324
325     bool hasOverflowControls() const;
326     bool isPointInResizeControl(const IntPoint& absolutePoint) const;
327     bool hitTestOverflowControls(HitTestResult&, const IntPoint& localPoint);
328     IntSize offsetFromResizeCorner(const IntPoint& absolutePoint) const;
329
330     void paintOverflowControls(GraphicsContext*, const IntPoint&, const IntRect& damageRect, bool paintingOverlayControls = false);
331     void paintScrollCorner(GraphicsContext*, const IntPoint&, const IntRect& damageRect);
332     void paintResizer(GraphicsContext*, const IntPoint&, const IntRect& damageRect);
333
334     void updateScrollInfoAfterLayout();
335
336     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
337     void autoscroll();
338
339     void resize(const PlatformMouseEvent&, const LayoutSize&);
340     bool inResizeMode() const { return m_inResizeMode; }
341     void setInResizeMode(bool b) { m_inResizeMode = b; }
342
343     bool isRootLayer() const { return renderer()->isRenderView(); }
344     
345 #if USE(ACCELERATED_COMPOSITING)
346     RenderLayerCompositor* compositor() const;
347     
348     // Notification from the renderer that its content changed (e.g. current frame of image changed).
349     // Allows updates of layer content without repainting.
350     void contentChanged(ContentChangeType);
351 #endif
352
353     bool canRender3DTransforms() const;
354
355     void updateLayerPosition();
356     
357     enum UpdateLayerPositionsFlag {
358         CheckForRepaint = 1,
359         IsCompositingUpdateRoot = 1 << 1,
360         UpdateCompositingLayers = 1 << 2,
361         UpdatePagination = 1 << 3
362     };
363     typedef unsigned UpdateLayerPositionsFlags;
364     static const UpdateLayerPositionsFlags defaultFlags = CheckForRepaint | IsCompositingUpdateRoot | UpdateCompositingLayers;
365     // Providing |cachedOffset| prevents a outlineBoxForRepaint from walking back to the root for each layer in our subtree.
366     // This is an optimistic optimization that is not guaranteed to succeed.
367     void updateLayerPositions(LayoutPoint* offsetFromRoot, UpdateLayerPositionsFlags = defaultFlags);
368
369     void updateTransform();
370
371     void relativePositionOffset(LayoutUnit& relX, LayoutUnit& relY) const { relX += m_relativeOffset.width(); relY += m_relativeOffset.height(); }
372     const LayoutSize& relativePositionOffset() const { return m_relativeOffset; }
373
374     void clearClipRectsIncludingDescendants();
375     void clearClipRects();
376
377     void addBlockSelectionGapsBounds(const LayoutRect&);
378     void clearBlockSelectionGapsBounds();
379     void repaintBlockSelectionGaps();
380
381     // Get the enclosing stacking context for this layer.  A stacking context is a layer
382     // that has a non-auto z-index.
383     RenderLayer* stackingContext() const;
384     bool isStackingContext() const { return !hasAutoZIndex() || renderer()->isRenderView(); }
385
386     void dirtyZOrderLists();
387     void dirtyStackingContextZOrderLists();
388
389     Vector<RenderLayer*>* posZOrderList() const
390     {
391         ASSERT(!m_zOrderListsDirty);
392         ASSERT(isStackingContext() || !m_posZOrderList);
393         return m_posZOrderList;
394     }
395
396     Vector<RenderLayer*>* negZOrderList() const
397     {
398         ASSERT(!m_zOrderListsDirty);
399         ASSERT(isStackingContext() || !m_negZOrderList);
400         return m_negZOrderList;
401     }
402
403     void dirtyNormalFlowList();
404     Vector<RenderLayer*>* normalFlowList() const { ASSERT(!m_normalFlowListDirty); return m_normalFlowList; }
405
406     // Update our normal and z-index lists.
407     void updateLayerListsIfNeeded();
408
409     // FIXME: We should ASSERT(!m_visibleContentStatusDirty) here, but see https://bugs.webkit.org/show_bug.cgi?id=71044
410     // ditto for hasVisibleDescendant(), see https://bugs.webkit.org/show_bug.cgi?id=71277
411     bool hasVisibleContent() const { return m_hasVisibleContent; }
412     bool hasVisibleDescendant() const { return m_hasVisibleDescendant; }
413     void setHasVisibleContent(bool);
414     void dirtyVisibleContentStatus();
415
416     // Gets the nearest enclosing positioned ancestor layer (also includes
417     // the <html> layer and the root layer).
418     RenderLayer* enclosingPositionedAncestor() const;
419
420     // Returns the nearest enclosing layer that is scrollable.
421     RenderLayer* enclosingScrollableLayer() const;
422
423     // The layer relative to which clipping rects for this layer are computed.
424     RenderLayer* clippingRoot() const;
425
426 #if USE(ACCELERATED_COMPOSITING)
427     // Enclosing compositing layer; if includeSelf is true, may return this.
428     RenderLayer* enclosingCompositingLayer(bool includeSelf = true) const;
429     RenderLayer* enclosingCompositingLayerForRepaint(bool includeSelf = true) const;
430     // Ancestor compositing layer, excluding this.
431     RenderLayer* ancestorCompositingLayer() const { return enclosingCompositingLayer(false); }
432 #endif
433
434 #if ENABLE(CSS_FILTERS)
435     RenderLayer* enclosingFilterLayer(bool includeSelf = true) const;
436     RenderLayer* enclosingFilterRepaintLayer() const;
437     void setFilterBackendNeedsRepaintingInRect(const LayoutRect&, bool immediate);
438 #endif
439
440     void convertToPixelSnappedLayerCoords(const RenderLayer* ancestorLayer, IntPoint& location) const;
441     void convertToPixelSnappedLayerCoords(const RenderLayer* ancestorLayer, IntRect&) const;
442     void convertToLayerCoords(const RenderLayer* ancestorLayer, LayoutPoint& location) const;
443     void convertToLayerCoords(const RenderLayer* ancestorLayer, LayoutRect&) const;
444
445     bool hasAutoZIndex() const { return renderer()->style()->hasAutoZIndex(); }
446     int zIndex() const { return renderer()->style()->zIndex(); }
447
448     enum PaintLayerFlag {
449         PaintLayerHaveTransparency = 1,
450         PaintLayerAppliedTransform = 1 << 1,
451         PaintLayerTemporaryClipRects = 1 << 2,
452         PaintLayerPaintingReflection = 1 << 3,
453         PaintLayerPaintingOverlayScrollbars = 1 << 4,
454         PaintLayerPaintingCompositingBackgroundPhase = 1 << 5,
455         PaintLayerPaintingCompositingForegroundPhase = 1 << 6,
456         PaintLayerPaintingCompositingMaskPhase = 1 << 7,
457         PaintLayerPaintingCompositingAllPhases = (PaintLayerPaintingCompositingBackgroundPhase | PaintLayerPaintingCompositingForegroundPhase | PaintLayerPaintingCompositingMaskPhase)
458     };
459     
460     typedef unsigned PaintLayerFlags;
461
462     // The two main functions that use the layer system.  The paint method
463     // paints the layers that intersect the damage rect from back to
464     // front.  The hitTest method looks for mouse events by walking
465     // layers that intersect the point from front to back.
466     void paint(GraphicsContext*, const LayoutRect& damageRect, PaintBehavior = PaintBehaviorNormal, RenderObject* paintingRoot = 0,
467         RenderRegion* = 0, PaintLayerFlags = 0);
468     bool hitTest(const HitTestRequest&, HitTestResult&);
469     void paintOverlayScrollbars(GraphicsContext*, const LayoutRect& damageRect, PaintBehavior, RenderObject* paintingRoot);
470
471     // This method figures out our layerBounds in coordinates relative to
472     // |rootLayer}.  It also computes our background and foreground clip rects
473     // for painting/event handling.
474     void calculateRects(const RenderLayer* rootLayer, RenderRegion*, const LayoutRect& paintDirtyRect, LayoutRect& layerBounds,
475                         ClipRect& backgroundRect, ClipRect& foregroundRect, ClipRect& outlineRect,
476                         bool temporaryClipRects = false, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
477
478     // Compute and cache clip rects computed with the given layer as the root
479     void updateClipRects(const RenderLayer* rootLayer, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize);
480     // Compute and return the clip rects. If useCached is true, will used previously computed clip rects on ancestors
481     // (rather than computing them all from scratch up the parent chain).
482     void calculateClipRects(const RenderLayer* rootLayer, RenderRegion*, ClipRects&, bool useCached = false, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
483     ClipRects* clipRects() const { return m_clipRects; }
484
485     LayoutRect childrenClipRect() const; // Returns the foreground clip rect of the layer in the document's coordinate space.
486     LayoutRect selfClipRect() const; // Returns the background clip rect of the layer in the document's coordinate space.
487     LayoutRect localClipRect() const; // Returns the background clip rect of the layer in the local coordinate space.
488
489     bool intersectsDamageRect(const LayoutRect& layerBounds, const LayoutRect& damageRect, const RenderLayer* rootLayer) const;
490
491     // Bounding box relative to some ancestor layer.
492     LayoutRect boundingBox(const RenderLayer* rootLayer) const;
493     // Bounding box in the coordinates of this layer.
494     LayoutRect localBoundingBox() const;
495     // Pixel snapped bounding box relative to the root.
496     IntRect absoluteBoundingBox() const;
497
498     enum CalculateLayerBoundsFlag {
499         IncludeSelfTransform = 1 << 0,
500         UseLocalClipRectIfPossible = 1 << 1,
501         IncludeLayerFilterOutsets = 1 << 2,
502         DefaultCalculateLayerBoundsFlags =  IncludeSelfTransform | UseLocalClipRectIfPossible | IncludeLayerFilterOutsets
503     };
504     typedef unsigned CalculateLayerBoundsFlags;
505     static IntRect calculateLayerBounds(const RenderLayer*, const RenderLayer* ancestorLayer, CalculateLayerBoundsFlags = DefaultCalculateLayerBoundsFlags);
506     
507     void updateHoverActiveState(const HitTestRequest&, HitTestResult&);
508
509     // WARNING: This method returns the offset for the parent as this is what updateLayerPositions expects.
510     LayoutPoint computeOffsetFromRoot(bool& hasLayerOffset) const;
511
512     // Return a cached repaint rect, computed relative to the layer renderer's containerForRepaint.
513     LayoutRect repaintRect() const { return m_repaintRect; }
514     LayoutRect repaintRectIncludingDescendants() const;
515
516     enum UpdateLayerPositionsAfterScrollFlag {
517         NoFlag = 0,
518         HasSeenFixedPositionedAncestor = 1 << 0,
519         HasSeenAncestorWithOverflowClip = 1 << 1
520     };
521
522     typedef unsigned UpdateLayerPositionsAfterScrollFlags;
523     void updateLayerPositionsAfterScroll(UpdateLayerPositionsAfterScrollFlags = NoFlag);
524     void setRepaintStatus(RepaintStatus status) { m_repaintStatus = status; }
525
526     LayoutUnit staticInlinePosition() const { return m_staticInlinePosition; }
527     LayoutUnit staticBlockPosition() const { return m_staticBlockPosition; }
528    
529     void setStaticInlinePosition(LayoutUnit position) { m_staticInlinePosition = position; }
530     void setStaticBlockPosition(LayoutUnit position) { m_staticBlockPosition = position; }
531
532     bool hasTransform() const { return renderer()->hasTransform(); }
533     // Note that this transform has the transform-origin baked in.
534     TransformationMatrix* transform() const { return m_transform.get(); }
535     // currentTransform computes a transform which takes accelerated animations into account. The
536     // resulting transform has transform-origin baked in. If the layer does not have a transform,
537     // returns the identity matrix.
538     TransformationMatrix currentTransform() const;
539     TransformationMatrix renderableTransform(PaintBehavior) const;
540     
541     // Get the perspective transform, which is applied to transformed sublayers.
542     // Returns true if the layer has a -webkit-perspective.
543     // Note that this transform has the perspective-origin baked in.
544     TransformationMatrix perspectiveTransform() const;
545     FloatPoint perspectiveOrigin() const;
546     bool preserves3D() const { return renderer()->style()->transformStyle3D() == TransformStyle3DPreserve3D; }
547     bool has3DTransform() const { return m_transform && !m_transform->isAffine(); }
548
549 #if ENABLE(CSS_FILTERS)
550     virtual void filterNeedsRepaint();
551     bool hasFilter() const { return renderer()->hasFilter(); }
552 #else
553     bool hasFilter() const { return false; }
554 #endif
555
556     // Overloaded new operator. Derived classes must override operator new
557     // in order to allocate out of the RenderArena.
558     void* operator new(size_t, RenderArena*);
559
560     // Overridden to prevent the normal delete from being called.
561     void operator delete(void*, size_t);
562
563 #if USE(ACCELERATED_COMPOSITING)
564     bool isComposited() const { return m_backing != 0; }
565     bool hasCompositedMask() const;
566     RenderLayerBacking* backing() const { return m_backing.get(); }
567     RenderLayerBacking* ensureBacking();
568     void clearBacking(bool layerBeingDestroyed = false);
569     virtual GraphicsLayer* layerForHorizontalScrollbar() const;
570     virtual GraphicsLayer* layerForVerticalScrollbar() const;
571     virtual GraphicsLayer* layerForScrollCorner() const;
572 #else
573     bool isComposited() const { return false; }
574     bool hasCompositedMask() const { return false; }
575 #endif
576
577     bool paintsWithTransparency(PaintBehavior paintBehavior) const
578     {
579         return isTransparent() && ((paintBehavior & PaintBehaviorFlattenCompositingLayers) || !isComposited());
580     }
581
582     bool paintsWithTransform(PaintBehavior) const;
583
584     bool containsDirtyOverlayScrollbars() const { return m_containsDirtyOverlayScrollbars; }
585     void setContainsDirtyOverlayScrollbars(bool dirtyScrollbars) { m_containsDirtyOverlayScrollbars = dirtyScrollbars; }
586
587 #if ENABLE(CSS_FILTERS)
588     bool paintsWithFilters() const;
589     bool requiresFullLayerImageForFilters() const;
590     FilterEffectRenderer* filterRenderer() const 
591     {
592         RenderLayerFilterInfo* filterInfo = this->filterInfo();
593         return filterInfo ? filterInfo->renderer() : 0;
594     }
595     
596     RenderLayerFilterInfo* filterInfo() const { return hasFilterInfo() ? RenderLayerFilterInfo::filterInfoForRenderLayer(this) : 0; }
597     RenderLayerFilterInfo* ensureFilterInfo() { return RenderLayerFilterInfo::createFilterInfoForRenderLayerIfNeeded(this); }
598     void removeFilterInfoIfNeeded() 
599     {
600         if (hasFilterInfo())
601             RenderLayerFilterInfo::removeFilterInfoForRenderLayer(this); 
602     }
603     
604     bool hasFilterInfo() const { return m_hasFilterInfo; }
605     void setHasFilterInfo(bool hasFilterInfo) { m_hasFilterInfo = hasFilterInfo; }
606 #endif
607
608 #if !ASSERT_DISABLED
609     bool layerListMutationAllowed() const { return m_layerListMutationAllowed; }
610     void setLayerListMutationAllowed(bool flag) { m_layerListMutationAllowed = flag; }
611 #endif
612
613 private:
614     void updateZOrderLists();
615     void rebuildZOrderLists();
616     void clearZOrderLists();
617
618     void updateNormalFlowList();
619
620     bool isDirtyStackingContext() const { return m_zOrderListsDirty && isStackingContext(); }
621
622     void computeRepaintRects(LayoutPoint* offsetFromRoot = 0);
623     void clearRepaintRects();
624
625     void clipToRect(RenderLayer* rootLayer, GraphicsContext*, const LayoutRect& paintDirtyRect, const ClipRect&,
626                     BorderRadiusClippingRule = IncludeSelfForBorderRadius);
627     void restoreClip(GraphicsContext*, const LayoutRect& paintDirtyRect, const ClipRect&);
628
629     bool shouldRepaintAfterLayout() const;
630
631     void updateScrollbarsAfterStyleChange(const RenderStyle* oldStyle);
632     void updateScrollbarsAfterLayout();
633
634     friend IntSize RenderBox::scrolledContentOffset() const;
635     IntSize scrolledContentOffset() const { return scrollOffset() + m_scrollOverflow; }
636
637     // The normal operator new is disallowed on all render objects.
638     void* operator new(size_t) throw();
639
640     void setNextSibling(RenderLayer* next) { m_next = next; }
641     void setPreviousSibling(RenderLayer* prev) { m_previous = prev; }
642     void setParent(RenderLayer* parent);
643     void setFirstChild(RenderLayer* first) { m_first = first; }
644     void setLastChild(RenderLayer* last) { m_last = last; }
645
646     LayoutPoint renderBoxLocation() const { return renderer()->isBox() ? toRenderBox(renderer())->location() : LayoutPoint(); }
647     LayoutUnit renderBoxX() const { return renderBoxLocation().x(); }
648     LayoutUnit renderBoxY() const { return renderBoxLocation().y(); }
649
650     void collectLayers(bool includeHiddenLayers, Vector<RenderLayer*>*&, Vector<RenderLayer*>*&);
651
652     void updateCompositingAndLayerListsIfNeeded();
653
654     void paintLayer(RenderLayer* rootLayer, GraphicsContext*, const LayoutRect& paintDirtyRect,
655                     PaintBehavior, RenderObject* paintingRoot, RenderRegion* = 0, OverlapTestRequestMap* = 0,
656                     PaintLayerFlags = 0);
657     void paintLayerContentsAndReflection(RenderLayer* rootLayer, GraphicsContext*, const LayoutRect& paintDirtyRect,
658                     PaintBehavior, RenderObject* paintingRoot, RenderRegion* = 0, OverlapTestRequestMap* = 0,
659                     PaintLayerFlags = 0);
660     void paintLayerContents(RenderLayer* rootLayer, GraphicsContext*, const LayoutRect& paintDirtyRect,
661                     PaintBehavior, RenderObject* paintingRoot, RenderRegion* = 0, OverlapTestRequestMap* = 0,
662                     PaintLayerFlags = 0);
663     void paintList(Vector<RenderLayer*>*, RenderLayer* rootLayer, GraphicsContext* p,
664                    const LayoutRect& paintDirtyRect, PaintBehavior,
665                    RenderObject* paintingRoot, RenderRegion*, OverlapTestRequestMap*,
666                    PaintLayerFlags);
667     void paintPaginatedChildLayer(RenderLayer* childLayer, RenderLayer* rootLayer, GraphicsContext*,
668                                   const LayoutRect& paintDirtyRect, PaintBehavior,
669                                   RenderObject* paintingRoot, RenderRegion*, OverlapTestRequestMap*,
670                                   PaintLayerFlags);
671     void paintChildLayerIntoColumns(RenderLayer* childLayer, RenderLayer* rootLayer, GraphicsContext*,
672                                     const LayoutRect& paintDirtyRect, PaintBehavior,
673                                     RenderObject* paintingRoot, RenderRegion*, OverlapTestRequestMap*,
674                                     PaintLayerFlags, const Vector<RenderLayer*>& columnLayers, size_t columnIndex);
675
676     RenderLayer* hitTestLayer(RenderLayer* rootLayer, RenderLayer* containerLayer, const HitTestRequest& request, HitTestResult& result,
677                               const LayoutRect& hitTestRect, const LayoutPoint& hitTestPoint, bool appliedTransform,
678                               const HitTestingTransformState* transformState = 0, double* zOffset = 0);
679     RenderLayer* hitTestList(Vector<RenderLayer*>*, RenderLayer* rootLayer, const HitTestRequest& request, HitTestResult& result,
680                              const LayoutRect& hitTestRect, const LayoutPoint& hitTestPoint,
681                              const HitTestingTransformState* transformState, double* zOffsetForDescendants, double* zOffset,
682                              const HitTestingTransformState* unflattenedTransformState, bool depthSortDescendants);
683     RenderLayer* hitTestPaginatedChildLayer(RenderLayer* childLayer, RenderLayer* rootLayer, const HitTestRequest& request, HitTestResult& result,
684                                             const LayoutRect& hitTestRect, const LayoutPoint& hitTestPoint,
685                                             const HitTestingTransformState* transformState, double* zOffset);
686     RenderLayer* hitTestChildLayerColumns(RenderLayer* childLayer, RenderLayer* rootLayer, const HitTestRequest& request, HitTestResult& result,
687                                           const LayoutRect& hitTestRect, const LayoutPoint& hitTestPoint,
688                                           const HitTestingTransformState* transformState, double* zOffset,
689                                           const Vector<RenderLayer*>& columnLayers, size_t columnIndex);
690                                     
691     PassRefPtr<HitTestingTransformState> createLocalTransformState(RenderLayer* rootLayer, RenderLayer* containerLayer,
692                             const LayoutRect& hitTestRect, const LayoutPoint& hitTestPoint,
693                             const HitTestingTransformState* containerTransformState) const;
694     
695     bool hitTestContents(const HitTestRequest&, HitTestResult&, const LayoutRect& layerBounds, const LayoutPoint& hitTestPoint, HitTestFilter) const;
696     
697     void computeScrollDimensions();
698     bool hasHorizontalOverflow() const;
699     bool hasVerticalOverflow() const;
700
701     bool shouldBeNormalFlowOnly() const; 
702
703     int scrollPosition(Scrollbar*) const;
704     
705     // ScrollableArea interface
706     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&);
707     virtual void invalidateScrollCornerRect(const IntRect&);
708     virtual bool isActive() const;
709     virtual bool isScrollCornerVisible() const;
710     virtual IntRect scrollCornerRect() const;
711     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
712     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
713     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
714     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
715     virtual int scrollSize(ScrollbarOrientation) const;
716     virtual void setScrollOffset(const IntPoint&);
717     virtual IntPoint scrollPosition() const;
718     virtual IntPoint minimumScrollPosition() const;
719     virtual IntPoint maximumScrollPosition() const;
720     virtual IntRect visibleContentRect(bool includeScrollbars) const;
721     virtual int visibleHeight() const;
722     virtual int visibleWidth() const;
723     virtual IntSize contentsSize() const;
724     virtual IntSize overhangAmount() const;
725     virtual IntPoint currentMousePosition() const;
726     virtual bool shouldSuspendScrollAnimations() const;
727     virtual bool isOnActivePage() const;
728     virtual IntRect scrollableAreaBoundingBox() const OVERRIDE;
729
730     // Rectangle encompassing the scroll corner and resizer rect.
731     IntRect scrollCornerAndResizerRect() const;
732
733     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
734     void scrollTo(int, int);
735     void updateCompositingLayersAfterScroll();
736
737     IntSize scrollbarOffset(const Scrollbar*) const;
738     
739     void updateScrollableAreaSet(bool hasOverflow);
740
741     void childVisibilityChanged(bool newVisibility);
742     void dirtyVisibleDescendantStatus();
743     void updateVisibilityStatus();
744
745     // This flag is computed by RenderLayerCompositor, which knows more about 3d hierarchies than we do.
746     void setHas3DTransformedDescendant(bool b) { m_has3DTransformedDescendant = b; }
747     bool has3DTransformedDescendant() const { return m_has3DTransformedDescendant; }
748     
749     void dirty3DTransformedDescendantStatus();
750     // Both updates the status, and returns true if descendants of this have 3d.
751     bool update3DTransformedDescendantStatus();
752
753     Node* enclosingElement() const;
754
755     void createReflection();
756     void removeReflection();
757
758     void updateReflectionStyle();
759     bool paintingInsideReflection() const { return m_paintingInsideReflection; }
760     void setPaintingInsideReflection(bool b) { m_paintingInsideReflection = b; }
761
762 #if ENABLE(CSS_FILTERS)
763     void updateOrRemoveFilterEffect();
764 #endif
765
766     void parentClipRects(const RenderLayer* rootLayer, RenderRegion*, ClipRects&, bool temporaryClipRects = false, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
767     ClipRect backgroundClipRect(const RenderLayer* rootLayer, RenderRegion*, bool temporaryClipRects, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize) const;
768     LayoutRect paintingExtent(const RenderLayer* rootLayer, const LayoutRect& paintDirtyRect, PaintBehavior);
769
770     RenderLayer* enclosingTransformedAncestor() const;
771
772     // Convert a point in absolute coords into layer coords, taking transforms into account
773     LayoutPoint absoluteToContents(const LayoutPoint&) const;
774
775     void positionOverflowControls(const IntSize&);
776     void updateScrollCornerStyle();
777     void updateResizerStyle();
778
779     void drawPlatformResizerImage(GraphicsContext*, IntRect resizerCornerRect);
780
781     void updatePagination();
782     bool isPaginated() const { return m_isPaginated; }
783
784 #if USE(ACCELERATED_COMPOSITING)    
785     bool hasCompositingDescendant() const { return m_hasCompositingDescendant; }
786     void setHasCompositingDescendant(bool b)  { m_hasCompositingDescendant = b; }
787     
788     bool mustOverlapCompositedLayers() const { return m_mustOverlapCompositedLayers; }
789     void setMustOverlapCompositedLayers(bool b) { m_mustOverlapCompositedLayers = b; }
790 #endif
791
792     friend class RenderLayerBacking;
793     friend class RenderLayerCompositor;
794     friend class RenderBoxModelObject;
795
796     // Only safe to call from RenderBoxModelObject::destroyLayer(RenderArena*)
797     void destroy(RenderArena*);
798
799     LayoutUnit overflowTop() const;
800     LayoutUnit overflowBottom() const;
801     LayoutUnit overflowLeft() const;
802     LayoutUnit overflowRight() const;
803
804     bool canUseConvertToLayerCoords() const
805     {
806         // These RenderObject have an impact on their layers' without them knowing about it.
807         return !renderer()->hasColumns() && !renderer()->hasTransform() && !isComposited()
808 #if ENABLE(SVG)
809             && !renderer()->isSVGRoot()
810 #endif
811             ;
812     }
813
814     LayoutUnit verticalScrollbarStart(int minX, int maxX) const;
815     LayoutUnit horizontalScrollbarStart(int minX) const;
816
817 protected:
818     // The bitfields are up here so they will fall into the padding from ScrollableArea on 64-bit.
819
820     // Keeps track of whether the layer is currently resizing, so events can cause resizing to start and stop.
821     bool m_inResizeMode : 1;
822
823     bool m_scrollDimensionsDirty : 1;
824     bool m_zOrderListsDirty : 1;
825     bool m_normalFlowListDirty: 1;
826     bool m_isNormalFlowOnly : 1;
827
828     bool m_usedTransparency : 1; // Tracks whether we need to close a transparent layer, i.e., whether
829                                  // we ended up painting this layer or any descendants (and therefore need to
830                                  // blend).
831     bool m_paintingInsideReflection : 1;  // A state bit tracking if we are painting inside a replica.
832     bool m_inOverflowRelayout : 1;
833     unsigned m_repaintStatus : 2; // RepaintStatus
834
835     bool m_visibleContentStatusDirty : 1;
836     bool m_hasVisibleContent : 1;
837     bool m_visibleDescendantStatusDirty : 1;
838     bool m_hasVisibleDescendant : 1;
839
840     bool m_isPaginated : 1; // If we think this layer is split by a multi-column ancestor, then this bit will be set.
841
842     bool m_3DTransformedDescendantStatusDirty : 1;
843     bool m_has3DTransformedDescendant : 1;  // Set on a stacking context layer that has 3D descendants anywhere
844                                             // in a preserves3D hierarchy. Hint to do 3D-aware hit testing.
845 #if USE(ACCELERATED_COMPOSITING)
846     bool m_hasCompositingDescendant : 1; // In the z-order tree.
847     bool m_mustOverlapCompositedLayers : 1;
848 #endif
849
850     bool m_containsDirtyOverlayScrollbars : 1;
851 #if !ASSERT_DISABLED
852     bool m_layerListMutationAllowed : 1;
853 #endif
854     // This is an optimization added for <table>.
855     // Currently cells do not need to update their repaint rectangles when scrolling. This also
856     // saves a lot of time when scrolling on a table.
857     bool m_canSkipRepaintRectsUpdateOnScroll : 1;
858
859 #if ENABLE(CSS_FILTERS)
860     bool m_hasFilterInfo : 1;
861 #endif
862
863     RenderBoxModelObject* m_renderer;
864
865     RenderLayer* m_parent;
866     RenderLayer* m_previous;
867     RenderLayer* m_next;
868     RenderLayer* m_first;
869     RenderLayer* m_last;
870
871     LayoutRect m_repaintRect; // Cached repaint rects. Used by layout.
872     LayoutRect m_outlineBox;
873
874     // Our current relative position offset.
875     LayoutSize m_relativeOffset;
876
877     // Our (x,y) coordinates are in our parent layer's coordinate space.
878     LayoutPoint m_topLeft;
879
880     // The layer's width/height
881     IntSize m_layerSize;
882
883     // Our scroll offsets if the view is scrolled.
884     IntSize m_scrollOffset;
885
886     IntSize m_scrollOverflow;
887     
888     // The width/height of our scrolled area.
889     LayoutSize m_scrollSize;
890
891     // For layers with overflow, we have a pair of scrollbars.
892     RefPtr<Scrollbar> m_hBar;
893     RefPtr<Scrollbar> m_vBar;
894
895     // For layers that establish stacking contexts, m_posZOrderList holds a sorted list of all the
896     // descendant layers within the stacking context that have z-indices of 0 or greater
897     // (auto will count as 0).  m_negZOrderList holds descendants within our stacking context with negative
898     // z-indices.
899     Vector<RenderLayer*>* m_posZOrderList;
900     Vector<RenderLayer*>* m_negZOrderList;
901
902     // This list contains child layers that cannot create stacking contexts.  For now it is just
903     // overflow layers, but that may change in the future.
904     Vector<RenderLayer*>* m_normalFlowList;
905
906     ClipRects* m_clipRects;      // Cached clip rects used when painting and hit testing.
907 #ifndef NDEBUG
908     const RenderLayer* m_clipRectsRoot;   // Root layer used to compute clip rects.
909 #endif
910
911     IntPoint m_cachedOverlayScrollbarOffset;
912
913     RenderMarquee* m_marquee; // Used by layers with overflow:marquee
914     
915     // Cached normal flow values for absolute positioned elements with static left/top values.
916     LayoutUnit m_staticInlinePosition;
917     LayoutUnit m_staticBlockPosition;
918
919     OwnPtr<TransformationMatrix> m_transform;
920     
921     // May ultimately be extended to many replicas (with their own paint order).
922     RenderReplica* m_reflection;
923         
924     // Renderers to hold our custom scroll corner and resizer.
925     RenderScrollbarPart* m_scrollCorner;
926     RenderScrollbarPart* m_resizer;
927
928 private:
929     LayoutRect m_blockSelectionGapsBounds;
930
931 #if USE(ACCELERATED_COMPOSITING)
932     OwnPtr<RenderLayerBacking> m_backing;
933 #endif
934 };
935
936 inline void RenderLayer::clearZOrderLists()
937 {
938     if (m_posZOrderList) {
939         delete m_posZOrderList;
940         m_posZOrderList = 0;
941     }
942
943     if (m_negZOrderList) {
944         delete m_negZOrderList;
945         m_negZOrderList = 0;
946     }
947 }
948
949 inline void RenderLayer::updateZOrderLists()
950 {
951     if (!m_zOrderListsDirty)
952         return;
953
954     if (!isStackingContext()) {
955         clearZOrderLists();
956         m_zOrderListsDirty = false;
957         return;
958     }
959
960     rebuildZOrderLists();
961 }
962
963 #if !ASSERT_DISABLED
964 class LayerListMutationDetector {
965 public:
966     LayerListMutationDetector(RenderLayer* layer)
967         : m_layer(layer)
968         , m_previousMutationAllowedState(layer->layerListMutationAllowed())
969     {
970         m_layer->setLayerListMutationAllowed(false);
971     }
972     
973     ~LayerListMutationDetector()
974     {
975         m_layer->setLayerListMutationAllowed(m_previousMutationAllowedState);
976     }
977
978 private:
979     RenderLayer* m_layer;
980     bool m_previousMutationAllowedState;
981 };
982 #endif
983
984
985 } // namespace WebCore
986
987 #ifndef NDEBUG
988 // Outside the WebCore namespace for ease of invocation from gdb.
989 void showLayerTree(const WebCore::RenderLayer*);
990 void showLayerTree(const WebCore::RenderObject*);
991 #endif
992
993 #endif // RenderLayer_h