Micro-optimize RenderBoxModelObject::computedCSSPadding().
[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 "LayoutRect.h"
28 #include "RenderLayerModelObject.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     BackgroundBleedBackgroundOverBorder
42 };
43
44 enum ContentChangeType {
45     ImageChanged,
46     MaskImageChanged,
47     BackgroundImageChanged,
48     CanvasChanged,
49     CanvasPixelsChanged,
50     VideoChanged,
51     FullScreenChanged
52 };
53
54 class ImageBuffer;
55 class InlineFlowBox;
56 class KeyframeList;
57 class RenderTextFragment;
58 class StickyPositionViewportConstraints;
59
60 // This class is the base for all objects that adhere to the CSS box model as described
61 // at http://www.w3.org/TR/CSS21/box.html
62
63 class RenderBoxModelObject : public RenderLayerModelObject {
64 public:
65     virtual ~RenderBoxModelObject();
66     
67     LayoutSize relativePositionOffset() const;
68     LayoutSize relativePositionLogicalOffset() const { return style().isHorizontalWritingMode() ? relativePositionOffset() : relativePositionOffset().transposedSize(); }
69
70     void computeStickyPositionConstraints(StickyPositionViewportConstraints&, const FloatRect& viewportRect) const;
71     LayoutSize stickyPositionOffset() const;
72     LayoutSize stickyPositionLogicalOffset() const { return style().isHorizontalWritingMode() ? stickyPositionOffset() : stickyPositionOffset().transposedSize(); }
73
74     LayoutSize offsetForInFlowPosition() const;
75
76     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow)
77     // to return the remaining width on a given line (and the height of a single line).
78     virtual LayoutUnit offsetLeft() const;
79     virtual LayoutUnit offsetTop() const;
80     virtual LayoutUnit offsetWidth() const = 0;
81     virtual LayoutUnit offsetHeight() const = 0;
82
83     int pixelSnappedOffsetLeft() const { return roundToInt(offsetLeft()); }
84     int pixelSnappedOffsetTop() const { return roundToInt(offsetTop()); }
85     virtual int pixelSnappedOffsetWidth() const;
86     virtual int pixelSnappedOffsetHeight() const;
87
88     virtual void updateFromStyle() override;
89
90     virtual bool requiresLayer() const override { return isRoot() || isPositioned() || createsGroup() || hasClipPath() || hasTransform() || hasHiddenBackface() || hasReflection() || style().specifiesColumns(); }
91
92     // This will work on inlines to return the bounding box of all of the lines' border boxes.
93     virtual IntRect borderBoundingBox() const = 0;
94
95     // These return the CSS computed padding values.
96     LayoutUnit computedCSSPaddingTop() const { return computedCSSPadding(style().paddingTop()); }
97     LayoutUnit computedCSSPaddingBottom() const { return computedCSSPadding(style().paddingBottom()); }
98     LayoutUnit computedCSSPaddingLeft() const { return computedCSSPadding(style().paddingLeft()); }
99     LayoutUnit computedCSSPaddingRight() const { return computedCSSPadding(style().paddingRight()); }
100     LayoutUnit computedCSSPaddingBefore() const { return computedCSSPadding(style().paddingBefore()); }
101     LayoutUnit computedCSSPaddingAfter() const { return computedCSSPadding(style().paddingAfter()); }
102     LayoutUnit computedCSSPaddingStart() const { return computedCSSPadding(style().paddingStart()); }
103     LayoutUnit computedCSSPaddingEnd() const { return computedCSSPadding(style().paddingEnd()); }
104
105     // These functions are used during layout. Table cells and the MathML
106     // code override them to include some extra intrinsic padding.
107     virtual LayoutUnit paddingTop() const { return computedCSSPaddingTop(); }
108     virtual LayoutUnit paddingBottom() const { return computedCSSPaddingBottom(); }
109     virtual LayoutUnit paddingLeft() const { return computedCSSPaddingLeft(); }
110     virtual LayoutUnit paddingRight() const { return computedCSSPaddingRight(); }
111     virtual LayoutUnit paddingBefore() const { return computedCSSPaddingBefore(); }
112     virtual LayoutUnit paddingAfter() const { return computedCSSPaddingAfter(); }
113     virtual LayoutUnit paddingStart() const { return computedCSSPaddingStart(); }
114     virtual LayoutUnit paddingEnd() const { return computedCSSPaddingEnd(); }
115
116     virtual int borderTop() const { return style().borderTopWidth(); }
117     virtual int borderBottom() const { return style().borderBottomWidth(); }
118     virtual int borderLeft() const { return style().borderLeftWidth(); }
119     virtual int borderRight() const { return style().borderRightWidth(); }
120     virtual int borderBefore() const { return style().borderBeforeWidth(); }
121     virtual int borderAfter() const { return style().borderAfterWidth(); }
122     virtual int borderStart() const { return style().borderStartWidth(); }
123     virtual int borderEnd() const { return style().borderEndWidth(); }
124
125     LayoutUnit borderAndPaddingStart() const { return borderStart() + paddingStart(); }
126     LayoutUnit borderAndPaddingBefore() const { return borderBefore() + paddingBefore(); }
127     LayoutUnit borderAndPaddingAfter() const { return borderAfter() + paddingAfter(); }
128
129     LayoutUnit borderAndPaddingHeight() const { return borderTop() + borderBottom() + paddingTop() + paddingBottom(); }
130     LayoutUnit borderAndPaddingWidth() const { return borderLeft() + borderRight() + paddingLeft() + paddingRight(); }
131     LayoutUnit borderAndPaddingLogicalHeight() const { return borderAndPaddingBefore() + borderAndPaddingAfter(); }
132     LayoutUnit borderAndPaddingLogicalWidth() const { return borderStart() + borderEnd() + paddingStart() + paddingEnd(); }
133     LayoutUnit borderAndPaddingLogicalLeft() const { return style().isHorizontalWritingMode() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
134
135     LayoutUnit borderLogicalLeft() const { return style().isHorizontalWritingMode() ? borderLeft() : borderTop(); }
136     LayoutUnit borderLogicalRight() const { return style().isHorizontalWritingMode() ? borderRight() : borderBottom(); }
137     LayoutUnit borderLogicalWidth() const { return borderStart() + borderEnd(); }
138     LayoutUnit borderLogicalHeight() const { return borderBefore() + borderAfter(); }
139
140     LayoutUnit paddingLogicalLeft() const { return style().isHorizontalWritingMode() ? paddingLeft() : paddingTop(); }
141     LayoutUnit paddingLogicalRight() const { return style().isHorizontalWritingMode() ? paddingRight() : paddingBottom(); }
142     LayoutUnit paddingLogicalWidth() const { return paddingStart() + paddingEnd(); }
143     LayoutUnit paddingLogicalHeight() const { return paddingBefore() + paddingAfter(); }
144
145     virtual LayoutUnit marginTop() const = 0;
146     virtual LayoutUnit marginBottom() const = 0;
147     virtual LayoutUnit marginLeft() const = 0;
148     virtual LayoutUnit marginRight() const = 0;
149     virtual LayoutUnit marginBefore(const RenderStyle* otherStyle = 0) const = 0;
150     virtual LayoutUnit marginAfter(const RenderStyle* otherStyle = 0) const = 0;
151     virtual LayoutUnit marginStart(const RenderStyle* otherStyle = 0) const = 0;
152     virtual LayoutUnit marginEnd(const RenderStyle* otherStyle = 0) const = 0;
153     LayoutUnit marginHeight() const { return marginTop() + marginBottom(); }
154     LayoutUnit marginWidth() const { return marginLeft() + marginRight(); }
155     LayoutUnit marginLogicalHeight() const { return marginBefore() + marginAfter(); }
156     LayoutUnit marginLogicalWidth() const { return marginStart() + marginEnd(); }
157
158     bool hasInlineDirectionBordersPaddingOrMargin() const { return hasInlineDirectionBordersOrPadding() || marginStart()|| marginEnd(); }
159     bool hasInlineDirectionBordersOrPadding() const { return borderStart() || borderEnd() || paddingStart()|| paddingEnd(); }
160
161     virtual LayoutUnit containingBlockLogicalWidthForContent() const;
162
163     virtual void childBecameNonInline(RenderObject* /*child*/) { }
164
165     void paintBorder(const PaintInfo&, const LayoutRect&, const RenderStyle*, BackgroundBleedAvoidance = BackgroundBleedNone, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
166     bool paintNinePieceImage(GraphicsContext*, const LayoutRect&, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
167     void paintBoxShadow(const PaintInfo&, const LayoutRect&, const RenderStyle*, ShadowStyle, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true);
168     void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance, InlineFlowBox* = 0, const LayoutSize& = LayoutSize(), CompositeOperator = CompositeSourceOver, RenderElement* backgroundObject = 0);
169
170     virtual bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, InlineFlowBox* = 0) const;
171
172     // Overridden by subclasses to determine line height and baseline position.
173     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
174     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const = 0;
175
176     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
177
178     void highQualityRepaintTimerFired(Timer<RenderBoxModelObject>*);
179
180     virtual void setSelectionState(SelectionState) override;
181
182     bool canHaveBoxInfoInRegion() const { return !isFloating() && !isReplaced() && !isInline() && !hasColumns() && !isTableCell() && isRenderBlock() && !isRenderSVGBlock(); }
183
184     void getGeometryForBackgroundImage(const RenderLayerModelObject* paintContainer, IntRect& destRect, IntPoint& phase, IntSize& tileSize) const;
185 #if USE(ACCELERATED_COMPOSITING)
186     void contentChanged(ContentChangeType);
187     bool hasAcceleratedCompositing() const;
188
189     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
190     void transitionPaused(double timeOffset, CSSPropertyID);
191     void transitionFinished(CSSPropertyID);
192
193     bool startAnimation(double timeOffset, const Animation*, const KeyframeList& keyframes);
194     void animationPaused(double timeOffset, const String& name);
195     void animationFinished(const String& name);
196
197     void suspendAnimations(double time = 0);
198 #endif
199
200 protected:
201     RenderBoxModelObject(Element&, PassRef<RenderStyle>, unsigned baseTypeFlags);
202     RenderBoxModelObject(Document&, PassRef<RenderStyle>, unsigned baseTypeFlags);
203
204     virtual void willBeDestroyed() override;
205
206     class BackgroundImageGeometry {
207     public:
208         BackgroundImageGeometry()
209             : m_hasNonLocalGeometry(false)
210         { }
211         IntPoint destOrigin() const { return m_destOrigin; }
212         void setDestOrigin(const IntPoint& destOrigin)
213         {
214             m_destOrigin = destOrigin;
215         }
216         
217         IntRect destRect() const { return m_destRect; }
218         void setDestRect(const IntRect& destRect)
219         {
220             m_destRect = destRect;
221         }
222
223         // Returns the phase relative to the destination rectangle.
224         IntPoint relativePhase() const;
225         
226         IntPoint phase() const { return m_phase; }   
227         void setPhase(const IntPoint& phase)
228         {
229             m_phase = phase;
230         }
231
232         IntSize tileSize() const { return m_tileSize; }    
233         void setTileSize(const IntSize& tileSize)
234         {
235             m_tileSize = tileSize;
236         }
237         FloatSize spaceSize() const { return m_space; }
238         void setSpaceSize(const FloatSize& space)
239         {
240             m_space = space;
241         }
242
243         void setPhaseX(int x) { m_phase.setX(x); }
244         void setPhaseY(int y) { m_phase.setY(y); }
245         
246         void setNoRepeatX(int xOffset);
247         void setNoRepeatY(int yOffset);
248         
249         void useFixedAttachment(const IntPoint& attachmentPoint);
250         
251         void clip(const IntRect&);
252         
253         void setHasNonLocalGeometry(bool hasNonLocalGeometry = true) { m_hasNonLocalGeometry = hasNonLocalGeometry; }
254         bool hasNonLocalGeometry() const { return m_hasNonLocalGeometry; }
255
256     private:
257         IntRect m_destRect;
258         IntPoint m_destOrigin;
259         IntPoint m_phase;
260         IntSize m_tileSize;
261         FloatSize m_space;
262         bool m_hasNonLocalGeometry; // Has background-attachment: fixed. Implies that we can't always cheaply compute destRect.
263     };
264
265     LayoutPoint adjustedPositionRelativeToOffsetParent(const LayoutPoint&) const;
266
267     void calculateBackgroundImageGeometry(const RenderLayerModelObject* paintContainer, const FillLayer*, const LayoutRect& paintRect, BackgroundImageGeometry&, RenderElement* = 0) const;
268     void getBorderEdgeInfo(class BorderEdge[], const RenderStyle*, bool includeLogicalLeftEdge = true, bool includeLogicalRightEdge = true) const;
269     bool borderObscuresBackgroundEdge(const FloatSize& contextScale) const;
270     bool borderObscuresBackground() const;
271     RoundedRect backgroundRoundedRectAdjustedForBleedAvoidance(GraphicsContext*, const LayoutRect&, BackgroundBleedAvoidance, InlineFlowBox*, const LayoutSize&, bool includeLogicalLeftEdge, bool includeLogicalRightEdge) const;
272     LayoutRect borderInnerRectAdjustedForBleedAvoidance(GraphicsContext*, const LayoutRect&, BackgroundBleedAvoidance) const;
273
274     bool shouldPaintAtLowQuality(GraphicsContext*, Image*, const void*, const LayoutSize&);
275
276     RenderBoxModelObject* continuation() const;
277     void setContinuation(RenderBoxModelObject*);
278
279     LayoutRect localCaretRectForEmptyElement(LayoutUnit width, LayoutUnit textIndentOffset);
280
281     static bool shouldAntialiasLines(GraphicsContext*);
282
283     static void clipRoundedInnerRect(GraphicsContext*, const LayoutRect&, const RoundedRect& clipRect);
284
285     bool hasAutoHeightOrContainingBlockWithAutoHeight() const;
286
287 public:
288     // For RenderBlocks and RenderInlines with m_style->styleType() == FIRST_LETTER, this tracks their remaining text fragments
289     RenderTextFragment* firstLetterRemainingText() const;
290     void setFirstLetterRemainingText(RenderTextFragment*);
291
292     // These functions are only used internally to manipulate the render tree structure via remove/insert/appendChildNode.
293     // Since they are typically called only to move objects around within anonymous blocks (which only have layers in
294     // the case of column spans), the default for fullRemoveInsert is false rather than true.
295     void moveChildTo(RenderBoxModelObject* toBoxModelObject, RenderObject* child, RenderObject* beforeChild, bool fullRemoveInsert = false);
296     void moveChildTo(RenderBoxModelObject* toBoxModelObject, RenderObject* child, bool fullRemoveInsert = false)
297     {
298         moveChildTo(toBoxModelObject, child, 0, fullRemoveInsert);
299     }
300     void moveAllChildrenTo(RenderBoxModelObject* toBoxModelObject, bool fullRemoveInsert = false)
301     {
302         moveAllChildrenTo(toBoxModelObject, 0, fullRemoveInsert);
303     }
304     void moveAllChildrenTo(RenderBoxModelObject* toBoxModelObject, RenderObject* beforeChild, bool fullRemoveInsert = false)
305     {
306         moveChildrenTo(toBoxModelObject, firstChild(), 0, beforeChild, fullRemoveInsert);
307     }
308     // Move all of the kids from |startChild| up to but excluding |endChild|. 0 can be passed as the |endChild| to denote
309     // that all the kids from |startChild| onwards should be moved.
310     void moveChildrenTo(RenderBoxModelObject* toBoxModelObject, RenderObject* startChild, RenderObject* endChild, bool fullRemoveInsert = false)
311     {
312         moveChildrenTo(toBoxModelObject, startChild, endChild, 0, fullRemoveInsert);
313     }
314     void moveChildrenTo(RenderBoxModelObject* toBoxModelObject, RenderObject* startChild, RenderObject* endChild, RenderObject* beforeChild, bool fullRemoveInsert = false);
315
316 private:
317     LayoutUnit computedCSSPadding(const Length&) const;
318     
319     virtual LayoutRect frameRectForStickyPositioning() const = 0;
320
321     IntSize calculateFillTileSize(const FillLayer*, const IntSize& scaledPositioningAreaSize) const;
322
323     enum ScaleByEffectiveZoomOrNot { ScaleByEffectiveZoom, DoNotScaleByEffectiveZoom };
324     IntSize calculateImageIntrinsicDimensions(StyleImage*, const IntSize& scaledPositioningAreaSize, ScaleByEffectiveZoomOrNot) const;
325
326     RoundedRect getBackgroundRoundedRect(const LayoutRect&, InlineFlowBox*, LayoutUnit inlineBoxWidth, LayoutUnit inlineBoxHeight,
327         bool includeLogicalLeftEdge, bool includeLogicalRightEdge) const;
328     
329     bool fixedBackgroundPaintsInLocalCoordinates() const;
330
331     void clipBorderSidePolygon(GraphicsContext*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
332                                BoxSide, bool firstEdgeMatches, bool secondEdgeMatches);
333     void clipBorderSideForComplexInnerPath(GraphicsContext*, const RoundedRect&, const RoundedRect&, BoxSide, const class BorderEdge[]);
334     void paintOneBorderSide(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
335                                 const IntRect& sideRect, BoxSide, BoxSide adjacentSide1, BoxSide adjacentSide2, const class BorderEdge[],
336                                 const Path*, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias, const Color* overrideColor = 0);
337     void paintTranslucentBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder, const IntPoint& innerBorderAdjustment,
338         const class BorderEdge[], BorderEdgeFlags, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false);
339     void paintBorderSides(GraphicsContext*, const RenderStyle*, const RoundedRect& outerBorder, const RoundedRect& innerBorder,
340         const IntPoint& innerBorderAdjustment, const class BorderEdge[], BorderEdgeFlags, BackgroundBleedAvoidance,
341         bool includeLogicalLeftEdge, bool includeLogicalRightEdge, bool antialias = false, const Color* overrideColor = 0);
342     void drawBoxSideFromPath(GraphicsContext*, const LayoutRect&, const Path&, const class BorderEdge[],
343                             float thickness, float drawThickness, BoxSide, const RenderStyle*, 
344                             Color, EBorderStyle, BackgroundBleedAvoidance, bool includeLogicalLeftEdge, bool includeLogicalRightEdge);
345     void paintMaskForTextFillBox(ImageBuffer*, const IntRect&, InlineFlowBox*, const LayoutRect&, RenderRegion*);
346 };
347
348 template <> inline bool isRendererOfType<const RenderBoxModelObject>(const RenderObject& renderer) { return renderer.isBoxModelObject(); }
349
350 RENDER_OBJECT_TYPE_CASTS(RenderBoxModelObject, isBoxModelObject())
351
352 } // namespace WebCore
353
354 #endif // RenderBoxModelObject_h