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