Fix the ACCELERATED_COMPOSITING code to not expose RenderLayer outside rendering
[WebKit.git] / Source / WebCore / rendering / RenderBoxModelObject.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2003, 2006, 2007, 2009 Apple Inc. All rights reserved.
5  * Copyright (C) 2010 Google Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef RenderBoxModelObject_h
25 #define RenderBoxModelObject_h
26
27 #include "RenderObject.h"
28 #include "ShadowData.h"
29
30 namespace WebCore {
31
32 // Modes for some of the line-related functions.
33 enum LinePositionMode { PositionOnContainingLine, PositionOfInteriorLineBoxes };
34 enum LineDirectionMode { HorizontalLine, VerticalLine };
35 typedef unsigned BorderEdgeFlags;
36
37 enum BackgroundBleedAvoidance {
38     BackgroundBleedNone,
39     BackgroundBleedShrinkBackground,
40     BackgroundBleedUseTransparencyLayer
41 };
42
43 enum ContentChangeType {
44     ImageChanged,
45     MaskImageChanged,
46     CanvasChanged,
47     VideoChanged,
48     FullScreenChanged
49 };
50
51 class KeyframeList;
52
53 // This class is the base for all objects that adhere to the CSS box model as described
54 // at http://www.w3.org/TR/CSS21/box.html
55
56 class RenderBoxModelObject : public RenderObject {
57 public:
58     RenderBoxModelObject(Node*);
59     virtual ~RenderBoxModelObject();
60     
61     LayoutUnit relativePositionOffsetX() const;
62     LayoutUnit relativePositionOffsetY() const;
63     LayoutSize relativePositionOffset() const { return LayoutSize(relativePositionOffsetX(), relativePositionOffsetY()); }
64     LayoutSize relativePositionLogicalOffset() const { return style()->isHorizontalWritingMode() ? relativePositionOffset() : relativePositionOffset().transposedSize(); }
65
66     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow)
67     // to return the remaining width on a given line (and the height of a single line).
68     virtual LayoutUnit offsetLeft() const;
69     virtual LayoutUnit offsetTop() const;
70     virtual LayoutUnit offsetWidth() const = 0;
71     virtual LayoutUnit offsetHeight() const = 0;
72
73     int pixelSnappedOffsetLeft() const { return roundToInt(offsetLeft()); }
74     int pixelSnappedOffsetTop() const { return roundToInt(offsetTop()); }
75     // FIXME: The implementation for these functions will change once we move to subpixel layout. See bug 60318.
76     int pixelSnappedOffsetWidth() const;
77     int pixelSnappedOffsetHeight() const;
78
79     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
80     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
81     virtual void updateBoxModelInfoFromStyle();
82
83     bool hasSelfPaintingLayer() const;
84     RenderLayer* layer() const { return m_layer; }
85     virtual bool requiresLayer() const { return isRoot() || isPositioned() || isRelPositioned() || isTransparent() || hasTransform() || hasHiddenBackface() || hasMask() || hasReflection() || hasFilter() || style()->specifiesColumns(); }
86
87     // This will work on inlines to return the bounding box of all of the lines' border boxes.
88     virtual IntRect borderBoundingBox() const = 0;
89
90     // These return the CSS computed padding values.
91     LayoutUnit computedCSSPaddingTop() const;
92     LayoutUnit computedCSSPaddingBottom() const;
93     LayoutUnit computedCSSPaddingLeft() const;
94     LayoutUnit computedCSSPaddingRight() const;
95     LayoutUnit computedCSSPaddingBefore() const;
96     LayoutUnit computedCSSPaddingAfter() const;
97     LayoutUnit computedCSSPaddingStart() const;
98     LayoutUnit computedCSSPaddingEnd() const;
99
100     // These functions are used during layout. Table cells and the MathML
101     // code override them to include some extra intrinsic padding.
102     virtual LayoutUnit paddingTop() const { return computedCSSPaddingTop(); }
103     virtual LayoutUnit paddingBottom() const { return computedCSSPaddingBottom(); }
104     virtual LayoutUnit paddingLeft() const { return computedCSSPaddingLeft(); }
105     virtual LayoutUnit paddingRight() const { return computedCSSPaddingRight(); }
106     virtual LayoutUnit paddingBefore() const { return computedCSSPaddingBefore(); }
107     virtual LayoutUnit paddingAfter() const { return computedCSSPaddingAfter(); }
108     virtual LayoutUnit paddingStart() const { return computedCSSPaddingStart(); }
109     virtual LayoutUnit paddingEnd() const { return computedCSSPaddingEnd(); }
110
111     virtual int borderTop() const { return style()->borderTopWidth(); }
112     virtual int borderBottom() const { return style()->borderBottomWidth(); }
113     virtual int borderLeft() const { return style()->borderLeftWidth(); }
114     virtual int borderRight() const { return style()->borderRightWidth(); }
115     virtual int borderBefore() const { return style()->borderBeforeWidth(); }
116     virtual int borderAfter() const { return style()->borderAfterWidth(); }
117     virtual int borderStart() const { return style()->borderStartWidth(); }
118     virtual int borderEnd() const { return style()->borderEndWidth(); }
119
120     LayoutUnit borderAndPaddingHeight() const { return borderTop() + borderBottom() + paddingTop() + paddingBottom(); }
121     LayoutUnit borderAndPaddingWidth() const { return borderLeft() + borderRight() + paddingLeft() + paddingRight(); }
122     LayoutUnit borderAndPaddingLogicalHeight() const { return borderBefore() + borderAfter() + paddingBefore() + paddingAfter(); }
123     LayoutUnit borderAndPaddingLogicalWidth() const { return borderStart() + borderEnd() + paddingStart() + paddingEnd(); }
124     LayoutUnit borderAndPaddingLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
125
126     LayoutUnit borderAndPaddingStart() const { return borderStart() + paddingStart(); }
127     LayoutUnit borderLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() : borderTop(); }
128     LayoutUnit borderLogicalRight() const { return style()->isHorizontalWritingMode() ? borderRight() : borderBottom(); }
129
130     virtual LayoutUnit marginTop() const = 0;
131     virtual LayoutUnit marginBottom() const = 0;
132     virtual LayoutUnit marginLeft() const = 0;
133     virtual LayoutUnit marginRight() const = 0;
134     virtual LayoutUnit marginBefore() const = 0;
135     virtual LayoutUnit marginAfter() const = 0;
136     virtual LayoutUnit marginStart() const = 0;
137     virtual LayoutUnit marginEnd() const = 0;
138     LayoutUnit marginHeight() const { return marginTop() + marginBottom(); }
139     LayoutUnit marginWidth() const { return marginLeft() + marginRight(); }
140
141     bool hasInlineDirectionBordersPaddingOrMargin() const { return hasInlineDirectionBordersOrPadding() || marginStart()|| marginEnd(); }
142     bool hasInlineDirectionBordersOrPadding() const { return borderStart() || borderEnd() || paddingStart()|| paddingEnd(); }
143
144     virtual LayoutUnit containingBlockLogicalWidthForContent() const;
145
146     virtual void childBecameNonInline(RenderObject* /*child*/) { }
147
148     void paintBorder(const PaintInfo&, const LayoutRect&, const RenderStyle*, BackgroundBleedAvoidance = BackgroundBleedNone, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
149     bool paintNinePieceImage(GraphicsContext*, const LayoutRect&, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
150     void paintBoxShadow(const PaintInfo&, const LayoutRect&, const RenderStyle*, ShadowStyle, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
151     void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance, InlineFlowBox* = 0, const LayoutSize& = LayoutSize(), CompositeOperator = CompositeSourceOver, RenderObject* backgroundObject = 0);
152     
153     virtual bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, InlineFlowBox* = 0) const;
154
155     // Overridden by subclasses to determine line height and baseline position.
156     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
157     virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
158
159     virtual void mapAbsoluteToLocalPoint(bool fixed, bool useTransforms, TransformState&) const OVERRIDE;
160
161     // Called by RenderObject::willBeDestroyed() and is the only way layers should ever be destroyed
162     void destroyLayer();
163
164     void highQualityRepaintTimerFired(Timer<RenderBoxModelObject>*);
165
166     virtual void setSelectionState(SelectionState s);
167
168 #if USE(ACCELERATED_COMPOSITING)
169     void contentChanged(ContentChangeType);
170     bool hasAcceleratedCompositing() const;
171
172     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
173     void transitionPaused(double timeOffset, CSSPropertyID);
174     void transitionFinished(CSSPropertyID);
175
176     bool startAnimation(double timeOffset, const Animation*, const KeyframeList& keyframes);
177     void animationPaused(double timeOffset, const String& name);
178     void animationFinished(const String& name);
179
180     void suspendAnimations(double time = 0);
181 #endif
182
183 protected:
184     virtual void willBeDestroyed();
185
186     class BackgroundImageGeometry {
187     public:
188         IntPoint destOrigin() const { return m_destOrigin; }
189         void setDestOrigin(const IntPoint& destOrigin)
190         {
191             m_destOrigin = destOrigin;
192         }
193         
194         IntRect destRect() const { return m_destRect; }
195         void setDestRect(const IntRect& destRect)
196         {
197             m_destRect = destRect;
198         }
199
200         // Returns the phase relative to the destination rectangle.
201         IntPoint relativePhase() const;
202         
203         IntPoint phase() const { return m_phase; }   
204         void setPhase(const IntPoint& phase)
205         {
206             m_phase = phase;
207         }
208
209         IntSize tileSize() const { return m_tileSize; }    
210         void setTileSize(const IntSize& tileSize)
211         {
212             m_tileSize = tileSize;
213         }
214         
215         void setPhaseX(int x) { m_phase.setX(x); }
216         void setPhaseY(int y) { m_phase.setY(y); }
217         
218         void setNoRepeatX(int xOffset);
219         void setNoRepeatY(int yOffset);
220         
221         void useFixedAttachment(const IntPoint& attachmentPoint);
222         
223         void clip(const IntRect&);
224     private:
225         IntRect m_destRect;
226         IntPoint m_destOrigin;
227         IntPoint m_phase;
228         IntSize m_tileSize;
229     };
230
231     void calculateBackgroundImageGeometry(const FillLayer*, const LayoutRect& paintRect, BackgroundImageGeometry&);
232     void getBorderEdgeInfo(class BorderEdge[], const RenderStyle*, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true) const;
233     bool borderObscuresBackgroundEdge(const FloatSize& contextScale) const;
234     bool borderObscuresBackground() const;
235
236     bool shouldPaintAtLowQuality(GraphicsContext*, Image*, const void*, const LayoutSize&);
237
238     RenderBoxModelObject* continuation() const;
239     void setContinuation(RenderBoxModelObject*);
240
241     static bool shouldAntialiasLines(GraphicsContext*);
242
243 public:
244     // For RenderBlocks and RenderInlines with m_style->styleType() == FIRST_LETTER, this tracks their remaining text fragments
245     RenderObject* firstLetterRemainingText() const;
246     void setFirstLetterRemainingText(RenderObject*);
247
248     void ensureLayer();
249
250 private:
251     virtual bool isBoxModelObject() const { return true; }
252
253     IntSize calculateFillTileSize(const FillLayer*, const IntSize& scaledPositioningAreaSize) const;
254     IntSize calculateImageIntrinsicDimensions(StyleImage*, const IntSize& scaledPositioningAreaSize) const;
255
256     RoundedRect getBackgroundRoundedRect(const LayoutRect&, InlineFlowBox*, LayoutUnit inlineBoxWidth, LayoutUnit inlineBoxHeight,
257         bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
258
259     void clipBorderSidePolygon(GraphicsContext*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
260                                BoxSide, bool firstEdgeMatches, bool secondEdgeMatches);
261     void clipBorderSideForComplexInnerPath(GraphicsContext*, const RoundedRect&, const RoundedRect&, BoxSide, const class BorderEdge[]);
262     void paintOneBorderSide(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
263                                 const IntRect& sideRect, BoxSide, BoxSide adjacentSide1, BoxSide adjacentSide2, const class BorderEdge[],
264                                 const Path*, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias, const Color* overrideColor = 0);
265     void paintTranslucentBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
266                           const class BorderEdge[], BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false);
267     void paintBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
268                           const class BorderEdge[], BorderEdgeFlags, BackgroundBleedAvoidance,
269                           bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false, const Color* overrideColor = 0);
270     void drawBoxSideFromPath(GraphicsContext*, const LayoutRect&, const Path&, const class BorderEdge[],
271                             float thickness, float drawThickness, BoxSide, const RenderStyle*, 
272                             Color, EBorderStyle, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
273
274     friend class RenderView;
275
276     RenderLayer* m_layer;
277     
278     // Used to store state between styleWillChange and styleDidChange
279     static bool s_wasFloating;
280     static bool s_hadLayer;
281     static bool s_hadTransform;
282     static bool s_layerWasSelfPainting;
283 };
284
285 inline RenderBoxModelObject* toRenderBoxModelObject(RenderObject* object)
286
287     ASSERT(!object || object->isBoxModelObject());
288     return static_cast<RenderBoxModelObject*>(object);
289 }
290
291 inline const RenderBoxModelObject* toRenderBoxModelObject(const RenderObject* object)
292
293     ASSERT(!object || object->isBoxModelObject());
294     return static_cast<const RenderBoxModelObject*>(object);
295 }
296
297 // This will catch anyone doing an unnecessary cast.
298 void toRenderBoxModelObject(const RenderBoxModelObject*);
299
300 } // namespace WebCore
301
302 #endif // RenderBoxModelObject_h