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