6581bb9bd5f0c0a2d497e21651e85b6997be12da
[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 // This class is the base for all objects that adhere to the CSS box model as described
44 // at http://www.w3.org/TR/CSS21/box.html
45
46 class RenderBoxModelObject : public RenderObject {
47 public:
48     RenderBoxModelObject(Node*);
49     virtual ~RenderBoxModelObject();
50     
51     LayoutUnit relativePositionOffsetX() const;
52     LayoutUnit relativePositionOffsetY() const;
53     LayoutSize relativePositionOffset() const { return LayoutSize(relativePositionOffsetX(), relativePositionOffsetY()); }
54     LayoutSize relativePositionLogicalOffset() const { return style()->isHorizontalWritingMode() ? relativePositionOffset() : relativePositionOffset().transposedSize(); }
55
56     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow)
57     // to return the remaining width on a given line (and the height of a single line).
58     virtual LayoutUnit offsetLeft() const;
59     virtual LayoutUnit offsetTop() const;
60     virtual LayoutUnit offsetWidth() const = 0;
61     virtual LayoutUnit offsetHeight() const = 0;
62
63     int pixelSnappedOffsetLeft() const { return roundToInt(offsetLeft()); }
64     int pixelSnappedOffsetTop() const { return roundToInt(offsetTop()); }
65     // FIXME: The implementation for these functions will change once we move to subpixel layout. See bug 60318.
66     int pixelSnappedOffsetWidth() const;
67     int pixelSnappedOffsetHeight() const;
68
69     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
70     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
71     virtual void updateBoxModelInfoFromStyle();
72
73     bool hasSelfPaintingLayer() const;
74     RenderLayer* layer() const { return m_layer; }
75     virtual bool requiresLayer() const { return isRoot() || isPositioned() || isRelPositioned() || isTransparent() || hasTransform() || hasHiddenBackface() || hasMask() || hasReflection() || hasFilter() || style()->specifiesColumns(); }
76
77     // This will work on inlines to return the bounding box of all of the lines' border boxes.
78     virtual IntRect borderBoundingBox() const = 0;
79
80     // These return the CSS computed padding values.
81     LayoutUnit computedCSSPaddingTop() const;
82     LayoutUnit computedCSSPaddingBottom() const;
83     LayoutUnit computedCSSPaddingLeft() const;
84     LayoutUnit computedCSSPaddingRight() const;
85     LayoutUnit computedCSSPaddingBefore() const;
86     LayoutUnit computedCSSPaddingAfter() const;
87     LayoutUnit computedCSSPaddingStart() const;
88     LayoutUnit computedCSSPaddingEnd() const;
89
90     // These functions are used during layout. Table cells and the MathML
91     // code override them to include some extra intrinsic padding.
92     virtual LayoutUnit paddingTop() const { return computedCSSPaddingTop(); }
93     virtual LayoutUnit paddingBottom() const { return computedCSSPaddingBottom(); }
94     virtual LayoutUnit paddingLeft() const { return computedCSSPaddingLeft(); }
95     virtual LayoutUnit paddingRight() const { return computedCSSPaddingRight(); }
96     virtual LayoutUnit paddingBefore() const { return computedCSSPaddingBefore(); }
97     virtual LayoutUnit paddingAfter() const { return computedCSSPaddingAfter(); }
98     virtual LayoutUnit paddingStart() const { return computedCSSPaddingStart(); }
99     virtual LayoutUnit paddingEnd() const { return computedCSSPaddingEnd(); }
100
101     virtual int borderTop() const { return style()->borderTopWidth(); }
102     virtual int borderBottom() const { return style()->borderBottomWidth(); }
103     virtual int borderLeft() const { return style()->borderLeftWidth(); }
104     virtual int borderRight() const { return style()->borderRightWidth(); }
105     virtual int borderBefore() const { return style()->borderBeforeWidth(); }
106     virtual int borderAfter() const { return style()->borderAfterWidth(); }
107     virtual int borderStart() const { return style()->borderStartWidth(); }
108     virtual int borderEnd() const { return style()->borderEndWidth(); }
109
110     LayoutUnit borderAndPaddingHeight() const { return borderTop() + borderBottom() + paddingTop() + paddingBottom(); }
111     LayoutUnit borderAndPaddingWidth() const { return borderLeft() + borderRight() + paddingLeft() + paddingRight(); }
112     LayoutUnit borderAndPaddingLogicalHeight() const { return borderBefore() + borderAfter() + paddingBefore() + paddingAfter(); }
113     LayoutUnit borderAndPaddingLogicalWidth() const { return borderStart() + borderEnd() + paddingStart() + paddingEnd(); }
114     LayoutUnit borderAndPaddingLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
115
116     LayoutUnit borderAndPaddingStart() const { return borderStart() + paddingStart(); }
117     LayoutUnit borderLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() : borderTop(); }
118     LayoutUnit borderLogicalRight() const { return style()->isHorizontalWritingMode() ? borderRight() : borderBottom(); }
119
120     virtual LayoutUnit marginTop() const = 0;
121     virtual LayoutUnit marginBottom() const = 0;
122     virtual LayoutUnit marginLeft() const = 0;
123     virtual LayoutUnit marginRight() const = 0;
124     virtual LayoutUnit marginBefore() const = 0;
125     virtual LayoutUnit marginAfter() const = 0;
126     virtual LayoutUnit marginStart() const = 0;
127     virtual LayoutUnit marginEnd() const = 0;
128     LayoutUnit marginHeight() const { return marginTop() + marginBottom(); }
129     LayoutUnit marginWidth() const { return marginLeft() + marginRight(); }
130
131     bool hasInlineDirectionBordersPaddingOrMargin() const { return hasInlineDirectionBordersOrPadding() || marginStart()|| marginEnd(); }
132     bool hasInlineDirectionBordersOrPadding() const { return borderStart() || borderEnd() || paddingStart()|| paddingEnd(); }
133
134     virtual LayoutUnit containingBlockLogicalWidthForContent() const;
135
136     virtual void childBecameNonInline(RenderObject* /*child*/) { }
137
138     void paintBorder(const PaintInfo&, const LayoutRect&, const RenderStyle*, BackgroundBleedAvoidance = BackgroundBleedNone, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
139     bool paintNinePieceImage(GraphicsContext*, const LayoutRect&, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
140     void paintBoxShadow(const PaintInfo&, const LayoutRect&, const RenderStyle*, ShadowStyle, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
141     void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance, InlineFlowBox* = 0, const LayoutSize& = LayoutSize(), CompositeOperator = CompositeSourceOver, RenderObject* backgroundObject = 0);
142     
143     virtual bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, InlineFlowBox* = 0) const;
144
145     // Overridden by subclasses to determine line height and baseline position.
146     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
147     virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
148
149     virtual void mapAbsoluteToLocalPoint(bool fixed, bool useTransforms, TransformState&) const OVERRIDE;
150
151     // Called by RenderObject::willBeDestroyed() and is the only way layers should ever be destroyed
152     void destroyLayer();
153
154     void highQualityRepaintTimerFired(Timer<RenderBoxModelObject>*);
155
156     virtual void setSelectionState(SelectionState s);
157
158 protected:
159     virtual void willBeDestroyed();
160
161     class BackgroundImageGeometry {
162     public:
163         IntPoint destOrigin() const { return m_destOrigin; }
164         void setDestOrigin(const IntPoint& destOrigin)
165         {
166             m_destOrigin = destOrigin;
167         }
168         
169         IntRect destRect() const { return m_destRect; }
170         void setDestRect(const IntRect& destRect)
171         {
172             m_destRect = destRect;
173         }
174
175         // Returns the phase relative to the destination rectangle.
176         IntPoint relativePhase() const;
177         
178         IntPoint phase() const { return m_phase; }   
179         void setPhase(const IntPoint& phase)
180         {
181             m_phase = phase;
182         }
183
184         IntSize tileSize() const { return m_tileSize; }    
185         void setTileSize(const IntSize& tileSize)
186         {
187             m_tileSize = tileSize;
188         }
189         
190         void setPhaseX(int x) { m_phase.setX(x); }
191         void setPhaseY(int y) { m_phase.setY(y); }
192         
193         void setNoRepeatX(int xOffset);
194         void setNoRepeatY(int yOffset);
195         
196         void useFixedAttachment(const IntPoint& attachmentPoint);
197         
198         void clip(const IntRect&);
199     private:
200         IntRect m_destRect;
201         IntPoint m_destOrigin;
202         IntPoint m_phase;
203         IntSize m_tileSize;
204     };
205
206     void calculateBackgroundImageGeometry(const FillLayer*, const LayoutRect& paintRect, BackgroundImageGeometry&);
207     void getBorderEdgeInfo(class BorderEdge[], const RenderStyle*, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true) const;
208     bool borderObscuresBackgroundEdge(const FloatSize& contextScale) const;
209     bool borderObscuresBackground() const;
210
211     bool shouldPaintAtLowQuality(GraphicsContext*, Image*, const void*, const LayoutSize&);
212
213     RenderBoxModelObject* continuation() const;
214     void setContinuation(RenderBoxModelObject*);
215
216     static bool shouldAntialiasLines(GraphicsContext*);
217
218 public:
219     // For RenderBlocks and RenderInlines with m_style->styleType() == FIRST_LETTER, this tracks their remaining text fragments
220     RenderObject* firstLetterRemainingText() const;
221     void setFirstLetterRemainingText(RenderObject*);
222
223     void ensureLayer();
224
225 private:
226     virtual bool isBoxModelObject() const { return true; }
227
228     IntSize calculateFillTileSize(const FillLayer*, const IntSize& scaledPositioningAreaSize) const;
229     IntSize calculateImageIntrinsicDimensions(StyleImage*, const IntSize& scaledPositioningAreaSize) const;
230
231     RoundedRect getBackgroundRoundedRect(const LayoutRect&, InlineFlowBox*, LayoutUnit inlineBoxWidth, LayoutUnit inlineBoxHeight,
232         bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
233
234     void clipBorderSidePolygon(GraphicsContext*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
235                                BoxSide, bool firstEdgeMatches, bool secondEdgeMatches);
236     void clipBorderSideForComplexInnerPath(GraphicsContext*, const RoundedRect&, const RoundedRect&, BoxSide, const class BorderEdge[]);
237     void paintOneBorderSide(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
238                                 const IntRect& sideRect, BoxSide, BoxSide adjacentSide1, BoxSide adjacentSide2, const class BorderEdge[],
239                                 const Path*, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias, const Color* overrideColor = 0);
240     void paintTranslucentBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
241                           const class BorderEdge[], BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false);
242     void paintBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
243                           const class BorderEdge[], BorderEdgeFlags, BackgroundBleedAvoidance,
244                           bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false, const Color* overrideColor = 0);
245     void drawBoxSideFromPath(GraphicsContext*, const LayoutRect&, const Path&, const class BorderEdge[],
246                             float thickness, float drawThickness, BoxSide, const RenderStyle*, 
247                             Color, EBorderStyle, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
248
249     friend class RenderView;
250
251     RenderLayer* m_layer;
252     
253     // Used to store state between styleWillChange and styleDidChange
254     static bool s_wasFloating;
255     static bool s_hadLayer;
256     static bool s_hadTransform;
257     static bool s_layerWasSelfPainting;
258 };
259
260 inline RenderBoxModelObject* toRenderBoxModelObject(RenderObject* object)
261
262     ASSERT(!object || object->isBoxModelObject());
263     return static_cast<RenderBoxModelObject*>(object);
264 }
265
266 inline const RenderBoxModelObject* toRenderBoxModelObject(const RenderObject* object)
267
268     ASSERT(!object || object->isBoxModelObject());
269     return static_cast<const RenderBoxModelObject*>(object);
270 }
271
272 // This will catch anyone doing an unnecessary cast.
273 void toRenderBoxModelObject(const RenderBoxModelObject*);
274
275 } // namespace WebCore
276
277 #endif // RenderBoxModelObject_h