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