Revert borders to integers for subpixel layout
[WebKit-https.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() || hasOverflowClip() || hasTransform() || 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 LayoutRect borderBoundingBox() const = 0;
79
80     // Virtual since table cells override
81     virtual LayoutUnit paddingTop(bool includeIntrinsicPadding = true) const;
82     virtual LayoutUnit paddingBottom(bool includeIntrinsicPadding = true) const;
83     virtual LayoutUnit paddingLeft(bool includeIntrinsicPadding = true) const;
84     virtual LayoutUnit paddingRight(bool includeIntrinsicPadding = true) const;
85     virtual LayoutUnit paddingBefore(bool includeIntrinsicPadding = true) const;
86     virtual LayoutUnit paddingAfter(bool includeIntrinsicPadding = true) const;
87     virtual LayoutUnit paddingStart(bool includeIntrinsicPadding = true) const;
88     virtual LayoutUnit paddingEnd(bool includeIntrinsicPadding = true) const;
89
90     virtual int borderTop() const { return style()->borderTopWidth(); }
91     virtual int borderBottom() const { return style()->borderBottomWidth(); }
92     virtual int borderLeft() const { return style()->borderLeftWidth(); }
93     virtual int borderRight() const { return style()->borderRightWidth(); }
94     virtual int borderBefore() const { return style()->borderBeforeWidth(); }
95     virtual int borderAfter() const { return style()->borderAfterWidth(); }
96     virtual int borderStart() const { return style()->borderStartWidth(); }
97     virtual int borderEnd() const { return style()->borderEndWidth(); }
98
99     LayoutUnit borderAndPaddingHeight() const { return borderTop() + borderBottom() + paddingTop() + paddingBottom(); }
100     LayoutUnit borderAndPaddingWidth() const { return borderLeft() + borderRight() + paddingLeft() + paddingRight(); }
101     LayoutUnit borderAndPaddingLogicalHeight() const { return borderBefore() + borderAfter() + paddingBefore() + paddingAfter(); }
102     LayoutUnit borderAndPaddingLogicalWidth() const { return borderStart() + borderEnd() + paddingStart() + paddingEnd(); }
103     LayoutUnit borderAndPaddingLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
104
105     LayoutUnit borderAndPaddingStart() const { return borderStart() + paddingStart(); }
106     LayoutUnit borderLogicalLeft() const { return style()->isHorizontalWritingMode() ? borderLeft() : borderTop(); }
107     LayoutUnit borderLogicalRight() const { return style()->isHorizontalWritingMode() ? borderRight() : borderBottom(); }
108
109     virtual LayoutUnit marginTop() const = 0;
110     virtual LayoutUnit marginBottom() const = 0;
111     virtual LayoutUnit marginLeft() const = 0;
112     virtual LayoutUnit marginRight() const = 0;
113     virtual LayoutUnit marginBefore() const = 0;
114     virtual LayoutUnit marginAfter() const = 0;
115     virtual LayoutUnit marginStart() const = 0;
116     virtual LayoutUnit marginEnd() const = 0;
117
118     bool hasInlineDirectionBordersPaddingOrMargin() const { return hasInlineDirectionBordersOrPadding() || marginStart()|| marginEnd(); }
119     bool hasInlineDirectionBordersOrPadding() const { return borderStart() || borderEnd() || paddingStart()|| paddingEnd(); }
120
121     virtual LayoutUnit containingBlockLogicalWidthForContent() const;
122
123     virtual void childBecameNonInline(RenderObject* /*child*/) { }
124
125     void paintBorder(const PaintInfo&, const LayoutRect&, const RenderStyle*, BackgroundBleedAvoidance = BackgroundBleedNone, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
126     bool paintNinePieceImage(GraphicsContext*, const LayoutRect&, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
127     void paintBoxShadow(const PaintInfo&, const LayoutRect&, const RenderStyle*, ShadowStyle, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
128     void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance, InlineFlowBox* = 0, const LayoutSize& = LayoutSize(), CompositeOperator = CompositeSourceOver, RenderObject* backgroundObject = 0);
129     
130     virtual bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, InlineFlowBox* = 0) const;
131
132     // Overridden by subclasses to determine line height and baseline position.
133     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
134     virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
135
136     virtual void mapAbsoluteToLocalPoint(bool fixed, bool useTransforms, TransformState&) const OVERRIDE;
137
138     // Called by RenderObject::willBeDestroyed() and is the only way layers should ever be destroyed
139     void destroyLayer();
140
141     void highQualityRepaintTimerFired(Timer<RenderBoxModelObject>*);
142
143     virtual void setSelectionState(SelectionState s);
144
145 protected:
146     virtual void willBeDestroyed();
147
148     class BackgroundImageGeometry {
149     public:
150         IntPoint destOrigin() const { return m_destOrigin; }
151         void setDestOrigin(const IntPoint& destOrigin)
152         {
153             m_destOrigin = destOrigin;
154         }
155         
156         IntRect destRect() const { return m_destRect; }
157         void setDestRect(const IntRect& destRect)
158         {
159             m_destRect = destRect;
160         }
161
162         // Returns the phase relative to the destination rectangle.
163         IntPoint relativePhase() const;
164         
165         IntPoint phase() const { return m_phase; }   
166         void setPhase(const IntPoint& phase)
167         {
168             m_phase = phase;
169         }
170
171         IntSize tileSize() const { return m_tileSize; }    
172         void setTileSize(const IntSize& tileSize)
173         {
174             m_tileSize = tileSize;
175         }
176         
177         void setPhaseX(int x) { m_phase.setX(x); }
178         void setPhaseY(int y) { m_phase.setY(y); }
179         
180         void setNoRepeatX(int xOffset);
181         void setNoRepeatY(int yOffset);
182         
183         void useFixedAttachment(const IntPoint& attachmentPoint);
184         
185         void clip(const IntRect&);
186     private:
187         IntRect m_destRect;
188         IntPoint m_destOrigin;
189         IntPoint m_phase;
190         IntSize m_tileSize;
191     };
192
193     void calculateBackgroundImageGeometry(const FillLayer*, const LayoutRect& paintRect, BackgroundImageGeometry&);
194     void getBorderEdgeInfo(class BorderEdge[], bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true) const;
195     bool borderObscuresBackgroundEdge(const FloatSize& contextScale) const;
196     bool borderObscuresBackground() const;
197
198     bool shouldPaintAtLowQuality(GraphicsContext*, Image*, const void*, const LayoutSize&);
199
200     RenderBoxModelObject* continuation() const;
201     void setContinuation(RenderBoxModelObject*);
202
203     static bool shouldAntialiasLines(GraphicsContext*);
204
205 public:
206     // For RenderBlocks and RenderInlines with m_style->styleType() == FIRST_LETTER, this tracks their remaining text fragments
207     RenderObject* firstLetterRemainingText() const;
208     void setFirstLetterRemainingText(RenderObject*);
209
210 private:
211     virtual bool isBoxModelObject() const { return true; }
212
213     IntSize calculateFillTileSize(const FillLayer*, const IntSize& scaledPositioningAreaSize) const;
214     IntSize calculateImageIntrinsicDimensions(StyleImage*, const IntSize& scaledPositioningAreaSize) const;
215
216     RoundedRect getBackgroundRoundedRect(const LayoutRect&, InlineFlowBox*, LayoutUnit inlineBoxWidth, LayoutUnit inlineBoxHeight,
217         bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
218
219     void clipBorderSidePolygon(GraphicsContext*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
220                                BoxSide, bool firstEdgeMatches, bool secondEdgeMatches);
221     void clipBorderSideForComplexInnerPath(GraphicsContext*, const RoundedRect&, const RoundedRect&, BoxSide, const class BorderEdge[]);
222     void paintOneBorderSide(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
223                                 const IntRect& sideRect, BoxSide, BoxSide adjacentSide1, BoxSide adjacentSide2, const class BorderEdge[],
224                                 const Path*, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias, const Color* overrideColor = 0);
225     void paintTranslucentBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
226                           const class BorderEdge[], BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false);
227     void paintBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
228                           const class BorderEdge[], BorderEdgeFlags, BackgroundBleedAvoidance,
229                           bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false, const Color* overrideColor = 0);
230     void drawBoxSideFromPath(GraphicsContext*, const LayoutRect&, const Path&, const class BorderEdge[],
231                             float thickness, float drawThickness, BoxSide, const RenderStyle*, 
232                             Color, EBorderStyle, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
233
234     friend class RenderView;
235
236     RenderLayer* m_layer;
237     
238     // Used to store state between styleWillChange and styleDidChange
239     static bool s_wasFloating;
240     static bool s_hadLayer;
241     static bool s_layerWasSelfPainting;
242 };
243
244 inline RenderBoxModelObject* toRenderBoxModelObject(RenderObject* object)
245
246     ASSERT(!object || object->isBoxModelObject());
247     return static_cast<RenderBoxModelObject*>(object);
248 }
249
250 inline const RenderBoxModelObject* toRenderBoxModelObject(const RenderObject* object)
251
252     ASSERT(!object || object->isBoxModelObject());
253     return static_cast<const RenderBoxModelObject*>(object);
254 }
255
256 // This will catch anyone doing an unnecessary cast.
257 void toRenderBoxModelObject(const RenderBoxModelObject*);
258
259 } // namespace WebCore
260
261 #endif // RenderBoxModelObject_h