6703e962c7e26753c4589bd788a420be801d63eb
[WebKit-https.git] / Source / WebCore / rendering / RenderBox.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 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef RenderBox_h
24 #define RenderBox_h
25
26 #include "RenderBoxModelObject.h"
27 #include "RenderOverflow.h"
28 #include "ScrollTypes.h"
29 #if ENABLE(CSS_SHAPES)
30 #include "ShapeOutsideInfo.h"
31 #endif
32
33 namespace WebCore {
34
35 class InlineElementBox;
36 class RenderBlockFlow;
37 class RenderBoxRegionInfo;
38 class RenderRegion;
39 struct PaintInfo;
40
41 enum SizeType { MainOrPreferredSize, MinSize, MaxSize };
42 enum AvailableLogicalHeightType { ExcludeMarginBorderPadding, IncludeMarginBorderPadding };
43 enum OverlayScrollbarSizeRelevancy { IgnoreOverlayScrollbarSize, IncludeOverlayScrollbarSize };
44
45 enum ShouldComputePreferred { ComputeActual, ComputePreferred };
46
47 class RenderBox : public RenderBoxModelObject {
48 public:
49     virtual ~RenderBox();
50
51     // hasAutoZIndex only returns true if the element is positioned or a flex-item since
52     // position:static elements that are not flex-items get their z-index coerced to auto.
53     virtual bool requiresLayer() const override
54     {
55         return isRoot() || isPositioned() || createsGroup() || hasClipPath() || hasOverflowClip()
56             || hasTransform() || hasHiddenBackface() || hasReflection() || style().specifiesColumns()
57             || !style().hasAutoZIndex();
58     }
59
60     virtual bool backgroundIsKnownToBeOpaqueInRect(const LayoutRect& localRect) const override final;
61
62     // Use this with caution! No type checking is done!
63     RenderBox* firstChildBox() const;
64     RenderBox* lastChildBox() const;
65
66     LayoutUnit x() const { return m_frameRect.x(); }
67     LayoutUnit y() const { return m_frameRect.y(); }
68     LayoutUnit width() const { return m_frameRect.width(); }
69     LayoutUnit height() const { return m_frameRect.height(); }
70
71     int pixelSnappedWidth() const { return m_frameRect.pixelSnappedWidth(); }
72     int pixelSnappedHeight() const { return m_frameRect.pixelSnappedHeight(); }
73
74     // These represent your location relative to your container as a physical offset.
75     // In layout related methods you almost always want the logical location (e.g. x() and y()).
76     LayoutUnit top() const { return topLeftLocation().y(); }
77     LayoutUnit left() const { return topLeftLocation().x(); }
78
79     void setX(LayoutUnit x) { m_frameRect.setX(x); }
80     void setY(LayoutUnit y) { m_frameRect.setY(y); }
81     void setWidth(LayoutUnit width) { m_frameRect.setWidth(width); }
82     void setHeight(LayoutUnit height) { m_frameRect.setHeight(height); }
83
84     LayoutUnit logicalLeft() const { return style().isHorizontalWritingMode() ? x() : y(); }
85     LayoutUnit logicalRight() const { return logicalLeft() + logicalWidth(); }
86     LayoutUnit logicalTop() const { return style().isHorizontalWritingMode() ? y() : x(); }
87     LayoutUnit logicalBottom() const { return logicalTop() + logicalHeight(); }
88     LayoutUnit logicalWidth() const { return style().isHorizontalWritingMode() ? width() : height(); }
89     LayoutUnit logicalHeight() const { return style().isHorizontalWritingMode() ? height() : width(); }
90
91     LayoutUnit constrainLogicalWidthInRegionByMinMax(LayoutUnit, LayoutUnit, RenderBlock*, RenderRegion* = 0) const;
92     LayoutUnit constrainLogicalHeightByMinMax(LayoutUnit) const;
93     LayoutUnit constrainContentBoxLogicalHeightByMinMax(LayoutUnit) const;
94
95     int pixelSnappedLogicalHeight() const { return style().isHorizontalWritingMode() ? pixelSnappedHeight() : pixelSnappedWidth(); }
96     int pixelSnappedLogicalWidth() const { return style().isHorizontalWritingMode() ? pixelSnappedWidth() : pixelSnappedHeight(); }
97
98     void setLogicalLeft(LayoutUnit left)
99     {
100         if (style().isHorizontalWritingMode())
101             setX(left);
102         else
103             setY(left);
104     }
105     void setLogicalTop(LayoutUnit top)
106     {
107         if (style().isHorizontalWritingMode())
108             setY(top);
109         else
110             setX(top);
111     }
112     void setLogicalLocation(const LayoutPoint& location)
113     {
114         if (style().isHorizontalWritingMode())
115             setLocation(location);
116         else
117             setLocation(location.transposedPoint());
118     }
119     void setLogicalWidth(LayoutUnit size)
120     {
121         if (style().isHorizontalWritingMode())
122             setWidth(size);
123         else
124             setHeight(size);
125     }
126     void setLogicalHeight(LayoutUnit size)
127     {
128         if (style().isHorizontalWritingMode())
129             setHeight(size);
130         else
131             setWidth(size);
132     }
133     void setLogicalSize(const LayoutSize& size)
134     {
135         if (style().isHorizontalWritingMode())
136             setSize(size);
137         else
138             setSize(size.transposedSize());
139     }
140
141     LayoutPoint location() const { return m_frameRect.location(); }
142     LayoutSize locationOffset() const { return LayoutSize(x(), y()); }
143     LayoutSize size() const { return m_frameRect.size(); }
144     IntSize pixelSnappedSize() const { return m_frameRect.pixelSnappedSize(); }
145
146     void setLocation(const LayoutPoint& location) { m_frameRect.setLocation(location); }
147     
148     void setSize(const LayoutSize& size) { m_frameRect.setSize(size); }
149     void move(LayoutUnit dx, LayoutUnit dy) { m_frameRect.move(dx, dy); }
150
151     LayoutRect frameRect() const { return m_frameRect; }
152     IntRect pixelSnappedFrameRect() const { return pixelSnappedIntRect(m_frameRect); }
153     void setFrameRect(const LayoutRect& rect) { m_frameRect = rect; }
154
155     LayoutRect borderBoxRect() const { return LayoutRect(LayoutPoint(), size()); }
156     LayoutRect paddingBoxRect() const { return LayoutRect(borderLeft(), borderTop(), contentWidth() + paddingLeft() + paddingRight(), contentHeight() + paddingTop() + paddingBottom()); }
157     IntRect pixelSnappedBorderBoxRect() const { return IntRect(IntPoint(), m_frameRect.pixelSnappedSize()); }
158     virtual IntRect borderBoundingBox() const override final { return pixelSnappedBorderBoxRect(); }
159
160     RoundedRect::Radii borderRadii() const;
161
162     // The content area of the box (excludes padding - and intrinsic padding for table cells, etc... - and border).
163     LayoutRect contentBoxRect() const { return LayoutRect(borderLeft() + paddingLeft(), borderTop() + paddingTop(), contentWidth(), contentHeight()); }
164     // The content box in absolute coords. Ignores transforms.
165     IntRect absoluteContentBox() const;
166     // The content box converted to absolute coords (taking transforms into account).
167     FloatQuad absoluteContentQuad() const;
168
169     // This returns the content area of the box (excluding padding and border). The only difference with contentBoxRect is that computedCSSContentBoxRect
170     // does include the intrinsic padding in the content box as this is what some callers expect (like getComputedStyle).
171     LayoutRect computedCSSContentBoxRect() const { return LayoutRect(borderLeft() + computedCSSPaddingLeft(), borderTop() + computedCSSPaddingTop(), clientWidth() - computedCSSPaddingLeft() - computedCSSPaddingRight(), clientHeight() - computedCSSPaddingTop() - computedCSSPaddingBottom()); }
172
173     // Bounds of the outline box in absolute coords. Respects transforms
174     virtual LayoutRect outlineBoundsForRepaint(const RenderLayerModelObject* /*repaintContainer*/, const RenderGeometryMap*) const override final;
175     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = 0) override;
176
177     // Use this with caution! No type checking is done!
178     RenderBox* previousSiblingBox() const;
179     RenderBox* nextSiblingBox() const;
180     RenderBox* parentBox() const;
181
182     // Visual and layout overflow are in the coordinate space of the box.  This means that they aren't purely physical directions.
183     // For horizontal-tb and vertical-lr they will match physical directions, but for horizontal-bt and vertical-rl, the top/bottom and left/right
184     // respectively are flipped when compared to their physical counterparts.  For example minX is on the left in vertical-lr,
185     // but it is on the right in vertical-rl.
186     LayoutRect layoutOverflowRect() const { return m_overflow ? m_overflow->layoutOverflowRect() : clientBoxRect(); }
187     LayoutUnit logicalLeftLayoutOverflow() const { return style().isHorizontalWritingMode() ? layoutOverflowRect().x() : layoutOverflowRect().y(); }
188     LayoutUnit logicalRightLayoutOverflow() const { return style().isHorizontalWritingMode() ? layoutOverflowRect().maxX() : layoutOverflowRect().maxY(); }
189     
190     virtual LayoutRect visualOverflowRect() const { return m_overflow ? m_overflow->visualOverflowRect() : borderBoxRect(); }
191     LayoutUnit logicalLeftVisualOverflow() const { return style().isHorizontalWritingMode() ? visualOverflowRect().x() : visualOverflowRect().y(); }
192     LayoutUnit logicalRightVisualOverflow() const { return style().isHorizontalWritingMode() ? visualOverflowRect().maxX() : visualOverflowRect().maxY(); }
193
194     LayoutRect overflowRectForPaintRejection(RenderRegion*) const;
195     
196     void addLayoutOverflow(const LayoutRect&);
197     void addVisualOverflow(const LayoutRect&);
198     void clearOverflow();
199     
200     virtual bool isTopLayoutOverflowAllowed() const { return !style().isLeftToRightDirection() && !isHorizontalWritingMode(); }
201     virtual bool isLeftLayoutOverflowAllowed() const { return !style().isLeftToRightDirection() && isHorizontalWritingMode(); }
202     
203     void addVisualEffectOverflow();
204     LayoutRect applyVisualEffectOverflow(const LayoutRect&) const;
205     void addOverflowFromChild(RenderBox* child) { addOverflowFromChild(child, child->locationOffset()); }
206     void addOverflowFromChild(RenderBox* child, const LayoutSize& delta);
207     
208     void updateLayerTransform();
209
210     LayoutUnit contentWidth() const { return clientWidth() - paddingLeft() - paddingRight(); }
211     LayoutUnit contentHeight() const { return clientHeight() - paddingTop() - paddingBottom(); }
212     LayoutUnit contentLogicalWidth() const { return style().isHorizontalWritingMode() ? contentWidth() : contentHeight(); }
213     LayoutUnit contentLogicalHeight() const { return style().isHorizontalWritingMode() ? contentHeight() : contentWidth(); }
214
215     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow)
216     // to return the remaining width on a given line (and the height of a single line).
217     virtual LayoutUnit offsetWidth() const override { return width(); }
218     virtual LayoutUnit offsetHeight() const override { return height(); }
219
220     virtual int pixelSnappedOffsetWidth() const override final;
221     virtual int pixelSnappedOffsetHeight() const override final;
222
223     // More IE extensions.  clientWidth and clientHeight represent the interior of an object
224     // excluding border and scrollbar.  clientLeft/Top are just the borderLeftWidth and borderTopWidth.
225     LayoutUnit clientLeft() const { return borderLeft(); }
226     LayoutUnit clientTop() const { return borderTop(); }
227     LayoutUnit clientWidth() const;
228     LayoutUnit clientHeight() const;
229     LayoutUnit clientLogicalWidth() const { return style().isHorizontalWritingMode() ? clientWidth() : clientHeight(); }
230     LayoutUnit clientLogicalHeight() const { return style().isHorizontalWritingMode() ? clientHeight() : clientWidth(); }
231     LayoutUnit clientLogicalBottom() const { return borderBefore() + clientLogicalHeight(); }
232     LayoutRect clientBoxRect() const { return LayoutRect(clientLeft(), clientTop(), clientWidth(), clientHeight()); }
233
234     int pixelSnappedClientWidth() const;
235     int pixelSnappedClientHeight() const;
236
237     // scrollWidth/scrollHeight will be the same as clientWidth/clientHeight unless the
238     // object has overflow:hidden/scroll/auto specified and also has overflow.
239     // scrollLeft/Top return the current scroll position.  These methods are virtual so that objects like
240     // textareas can scroll shadow content (but pretend that they are the objects that are
241     // scrolling).
242     virtual int scrollLeft() const;
243     virtual int scrollTop() const;
244     virtual int scrollWidth() const;
245     virtual int scrollHeight() const;
246     virtual void setScrollLeft(int);
247     virtual void setScrollTop(int);
248
249     virtual LayoutUnit marginTop() const override { return m_marginBox.top(); }
250     virtual LayoutUnit marginBottom() const override { return m_marginBox.bottom(); }
251     virtual LayoutUnit marginLeft() const override { return m_marginBox.left(); }
252     virtual LayoutUnit marginRight() const override { return m_marginBox.right(); }
253     void setMarginTop(LayoutUnit margin) { m_marginBox.setTop(margin); }
254     void setMarginBottom(LayoutUnit margin) { m_marginBox.setBottom(margin); }
255     void setMarginLeft(LayoutUnit margin) { m_marginBox.setLeft(margin); }
256     void setMarginRight(LayoutUnit margin) { m_marginBox.setRight(margin); }
257
258     LayoutUnit marginLogicalLeft() const { return m_marginBox.logicalLeft(style().writingMode()); }
259     LayoutUnit marginLogicalRight() const { return m_marginBox.logicalRight(style().writingMode()); }
260     
261     virtual LayoutUnit marginBefore(const RenderStyle* overrideStyle = 0) const override final { return m_marginBox.before((overrideStyle ? overrideStyle : &style())->writingMode()); }
262     virtual LayoutUnit marginAfter(const RenderStyle* overrideStyle = 0) const override final { return m_marginBox.after((overrideStyle ? overrideStyle : &style())->writingMode()); }
263     virtual LayoutUnit marginStart(const RenderStyle* overrideStyle = 0) const override final
264     {
265         const RenderStyle* styleToUse = overrideStyle ? overrideStyle : &style();
266         return m_marginBox.start(styleToUse->writingMode(), styleToUse->direction());
267     }
268     virtual LayoutUnit marginEnd(const RenderStyle* overrideStyle = 0) const override final
269     {
270         const RenderStyle* styleToUse = overrideStyle ? overrideStyle : &style();
271         return m_marginBox.end(styleToUse->writingMode(), styleToUse->direction());
272     }
273     void setMarginBefore(LayoutUnit value, const RenderStyle* overrideStyle = 0) { m_marginBox.setBefore((overrideStyle ? overrideStyle : &style())->writingMode(), value); }
274     void setMarginAfter(LayoutUnit value, const RenderStyle* overrideStyle = 0) { m_marginBox.setAfter((overrideStyle ? overrideStyle : &style())->writingMode(), value); }
275     void setMarginStart(LayoutUnit value, const RenderStyle* overrideStyle = 0)
276     {
277         const RenderStyle* styleToUse = overrideStyle ? overrideStyle : &style();
278         m_marginBox.setStart(styleToUse->writingMode(), styleToUse->direction(), value);
279     }
280     void setMarginEnd(LayoutUnit value, const RenderStyle* overrideStyle = 0)
281     {
282         const RenderStyle* styleToUse = overrideStyle ? overrideStyle : &style();
283         m_marginBox.setEnd(styleToUse->writingMode(), styleToUse->direction(), value);
284     }
285
286     // The following five functions are used to implement collapsing margins.
287     // All objects know their maximal positive and negative margins.  The
288     // formula for computing a collapsed margin is |maxPosMargin| - |maxNegmargin|.
289     // For a non-collapsing box, such as a leaf element, this formula will simply return
290     // the margin of the element.  Blocks override the maxMarginBefore and maxMarginAfter
291     // methods.
292     enum MarginSign { PositiveMargin, NegativeMargin };
293     virtual bool isSelfCollapsingBlock() const { return false; }
294     virtual LayoutUnit collapsedMarginBefore() const { return marginBefore(); }
295     virtual LayoutUnit collapsedMarginAfter() const { return marginAfter(); }
296
297     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
298     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
299     
300     LayoutRect reflectionBox() const;
301     int reflectionOffset() const;
302     // Given a rect in the object's coordinate space, returns the corresponding rect in the reflection.
303     LayoutRect reflectedRect(const LayoutRect&) const;
304
305     virtual void layout() override;
306     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
307
308     virtual LayoutUnit minPreferredLogicalWidth() const override;
309     virtual LayoutUnit maxPreferredLogicalWidth() const override;
310
311     // FIXME: We should rename these back to overrideLogicalHeight/Width and have them store
312     // the border-box height/width like the regular height/width accessors on RenderBox.
313     // Right now, these are different than contentHeight/contentWidth because they still
314     // include the scrollbar height/width.
315     LayoutUnit overrideLogicalContentWidth() const;
316     LayoutUnit overrideLogicalContentHeight() const;
317     bool hasOverrideHeight() const;
318     bool hasOverrideWidth() const;
319     void setOverrideLogicalContentHeight(LayoutUnit);
320     void setOverrideLogicalContentWidth(LayoutUnit);
321     void clearOverrideSize();
322     void clearOverrideLogicalContentHeight();
323     void clearOverrideLogicalContentWidth();
324
325     LayoutUnit overrideContainingBlockContentLogicalWidth() const;
326     LayoutUnit overrideContainingBlockContentLogicalHeight() const;
327     bool hasOverrideContainingBlockLogicalWidth() const;
328     bool hasOverrideContainingBlockLogicalHeight() const;
329     void setOverrideContainingBlockContentLogicalWidth(LayoutUnit);
330     void setOverrideContainingBlockContentLogicalHeight(LayoutUnit);
331     void clearContainingBlockOverrideSize();
332     void clearOverrideContainingBlockContentLogicalHeight();
333
334     virtual LayoutSize offsetFromContainer(RenderObject*, const LayoutPoint&, bool* offsetDependsOnPoint = 0) const override;
335     
336     LayoutUnit adjustBorderBoxLogicalWidthForBoxSizing(LayoutUnit width) const;
337     LayoutUnit adjustBorderBoxLogicalHeightForBoxSizing(LayoutUnit height) const;
338     LayoutUnit adjustContentBoxLogicalWidthForBoxSizing(LayoutUnit width) const;
339     LayoutUnit adjustContentBoxLogicalHeightForBoxSizing(LayoutUnit height) const;
340
341     struct ComputedMarginValues {
342         ComputedMarginValues()
343             : m_before(0)
344             , m_after(0)
345             , m_start(0)
346             , m_end(0)
347         {
348         }
349         LayoutUnit m_before;
350         LayoutUnit m_after;
351         LayoutUnit m_start;
352         LayoutUnit m_end;
353     };
354     struct LogicalExtentComputedValues {
355         LogicalExtentComputedValues()
356             : m_extent(0)
357             , m_position(0)
358         {
359         }
360
361         LayoutUnit m_extent;
362         LayoutUnit m_position;
363         ComputedMarginValues m_margins;
364     };
365     // Resolve auto margins in the inline direction of the containing block so that objects can be pushed to the start, middle or end
366     // of the containing block.
367     void computeInlineDirectionMargins(RenderBlock* containingBlock, LayoutUnit containerWidth, LayoutUnit childWidth, LayoutUnit& marginStart, LayoutUnit& marginEnd) const;
368
369     // Used to resolve margins in the containing block's block-flow direction.
370     void computeBlockDirectionMargins(const RenderBlock* containingBlock, LayoutUnit& marginBefore, LayoutUnit& marginAfter) const;
371     void computeAndSetBlockDirectionMargins(const RenderBlock* containingBlock);
372
373     enum RenderBoxRegionInfoFlags { CacheRenderBoxRegionInfo, DoNotCacheRenderBoxRegionInfo };
374     LayoutRect borderBoxRectInRegion(RenderRegion*, RenderBoxRegionInfoFlags = CacheRenderBoxRegionInfo) const;
375     LayoutRect clientBoxRectInRegion(RenderRegion*) const;
376     RenderRegion* clampToStartAndEndRegions(RenderRegion*) const;
377     void clearRenderBoxRegionInfo();
378     virtual LayoutUnit offsetFromLogicalTopOfFirstPage() const;
379     
380     void positionLineBox(InlineElementBox&);
381
382     virtual std::unique_ptr<InlineElementBox> createInlineBox();
383     void dirtyLineBoxes(bool fullLayout);
384
385     // For inline replaced elements, this function returns the inline box that owns us.  Enables
386     // the replaced RenderObject to quickly determine what line it is contained on and to easily
387     // iterate over structures on the line.
388     InlineElementBox* inlineBoxWrapper() const { return m_inlineBoxWrapper; }
389     void setInlineBoxWrapper(InlineElementBox* boxWrapper) { m_inlineBoxWrapper = boxWrapper; }
390     void deleteLineBoxWrapper();
391
392     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override;
393     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const override;
394     void repaintDuringLayoutIfMoved(const LayoutRect&);
395     virtual void repaintOverhangingFloats(bool paintAllDescendants);
396
397     virtual LayoutUnit containingBlockLogicalWidthForContent() const override;
398     LayoutUnit containingBlockLogicalHeightForContent(AvailableLogicalHeightType) const;
399
400     LayoutUnit containingBlockLogicalWidthForContentInRegion(RenderRegion*) const;
401     LayoutUnit containingBlockAvailableLineWidthInRegion(RenderRegion*) const;
402     LayoutUnit perpendicularContainingBlockLogicalHeight() const;
403
404     virtual void updateLogicalWidth();
405     virtual void updateLogicalHeight();
406     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const;
407
408     RenderBoxRegionInfo* renderBoxRegionInfo(RenderRegion*, RenderBoxRegionInfoFlags = CacheRenderBoxRegionInfo) const;
409     void computeLogicalWidthInRegion(LogicalExtentComputedValues&, RenderRegion* = 0) const;
410
411     bool stretchesToViewport() const
412     {
413         return document().inQuirksMode() && style().logicalHeight().isAuto() && !isFloatingOrOutOfFlowPositioned() && (isRoot() || isBody()) && !isInline();
414     }
415
416     virtual LayoutSize intrinsicSize() const { return LayoutSize(); }
417     LayoutUnit intrinsicLogicalWidth() const { return style().isHorizontalWritingMode() ? intrinsicSize().width() : intrinsicSize().height(); }
418     LayoutUnit intrinsicLogicalHeight() const { return style().isHorizontalWritingMode() ? intrinsicSize().height() : intrinsicSize().width(); }
419
420     // Whether or not the element shrinks to its intrinsic width (rather than filling the width
421     // of a containing block).  HTML4 buttons, <select>s, <input>s, legends, and floating/compact elements do this.
422     bool sizesLogicalWidthToFitContent(SizeType) const;
423
424     LayoutUnit shrinkLogicalWidthToAvoidFloats(LayoutUnit childMarginStart, LayoutUnit childMarginEnd, const RenderBlock* cb, RenderRegion*) const;
425
426     LayoutUnit computeLogicalWidthInRegionUsing(SizeType, Length logicalWidth, LayoutUnit availableLogicalWidth, const RenderBlock* containingBlock, RenderRegion*) const;
427     LayoutUnit computeLogicalHeightUsing(const Length& height) const;
428     LayoutUnit computeContentLogicalHeight(const Length& height) const;
429     LayoutUnit computeContentAndScrollbarLogicalHeightUsing(const Length& height) const;
430     LayoutUnit computeReplacedLogicalWidthUsing(Length width) const;
431     LayoutUnit computeReplacedLogicalWidthRespectingMinMaxWidth(LayoutUnit logicalWidth, ShouldComputePreferred  = ComputeActual) const;
432     LayoutUnit computeReplacedLogicalHeightUsing(Length height) const;
433     LayoutUnit computeReplacedLogicalHeightRespectingMinMaxHeight(LayoutUnit logicalHeight) const;
434
435     virtual LayoutUnit computeReplacedLogicalWidth(ShouldComputePreferred  = ComputeActual) const;
436     virtual LayoutUnit computeReplacedLogicalHeight() const;
437
438     static bool percentageLogicalHeightIsResolvableFromBlock(const RenderBlock* containingBlock, bool outOfFlowPositioned);
439     LayoutUnit computePercentageLogicalHeight(const Length& height) const;
440
441     // Block flows subclass availableWidth/Height to handle multi column layout (shrinking the width/height available to children when laying out.)
442     virtual LayoutUnit availableLogicalWidth() const { return contentLogicalWidth(); }
443     virtual LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const;
444     LayoutUnit availableLogicalHeightUsing(const Length&, AvailableLogicalHeightType) const;
445     
446     // There are a few cases where we need to refer specifically to the available physical width and available physical height.
447     // Relative positioning is one of those cases, since left/top offsets are physical.
448     LayoutUnit availableWidth() const { return style().isHorizontalWritingMode() ? availableLogicalWidth() : availableLogicalHeight(IncludeMarginBorderPadding); }
449     LayoutUnit availableHeight() const { return style().isHorizontalWritingMode() ? availableLogicalHeight(IncludeMarginBorderPadding) : availableLogicalWidth(); }
450
451     virtual int verticalScrollbarWidth() const;
452     int horizontalScrollbarHeight() const;
453     int instrinsicScrollbarLogicalWidth() const;
454     int scrollbarLogicalHeight() const { return style().isHorizontalWritingMode() ? horizontalScrollbarHeight() : verticalScrollbarWidth(); }
455     virtual bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = nullptr, RenderBox* startBox = nullptr, const IntPoint& wheelEventAbsolutePoint = IntPoint());
456     virtual bool logicalScroll(ScrollLogicalDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = 0);
457     bool canBeScrolledAndHasScrollableArea() const;
458     virtual bool canBeProgramaticallyScrolled() const;
459     virtual void autoscroll(const IntPoint&);
460     bool canAutoscroll() const;
461     IntSize calculateAutoscrollDirection(const IntPoint& windowPoint) const;
462     static RenderBox* findAutoscrollable(RenderObject*);
463     virtual void stopAutoscroll() { }
464     virtual void panScroll(const IntPoint&);
465
466     bool hasAutoVerticalScrollbar() const { return hasOverflowClip() && (style().overflowY() == OAUTO || style().overflowY() == OOVERLAY); }
467     bool hasAutoHorizontalScrollbar() const { return hasOverflowClip() && (style().overflowX() == OAUTO || style().overflowX() == OOVERLAY); }
468     bool scrollsOverflow() const { return scrollsOverflowX() || scrollsOverflowY(); }
469     bool scrollsOverflowX() const { return hasOverflowClip() && (style().overflowX() == OSCROLL || hasAutoHorizontalScrollbar()); }
470     bool scrollsOverflowY() const { return hasOverflowClip() && (style().overflowY() == OSCROLL || hasAutoVerticalScrollbar()); }
471     bool hasScrollableOverflowX() const { return scrollsOverflowX() && scrollWidth() != clientWidth(); }
472     bool hasScrollableOverflowY() const { return scrollsOverflowY() && scrollHeight() != clientHeight(); }
473
474     bool usesCompositedScrolling() const;
475     
476     bool hasUnsplittableScrollingOverflow() const;
477     bool isUnsplittableForPagination() const;
478
479     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0) override;
480
481     virtual LayoutRect overflowClipRect(const LayoutPoint& location, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize, PaintPhase = PaintPhaseBlockBackground);
482     virtual LayoutRect overflowClipRectForChildLayers(const LayoutPoint& location, RenderRegion* region, OverlayScrollbarSizeRelevancy relevancy) { return overflowClipRect(location, region, relevancy); }
483     LayoutRect clipRect(const LayoutPoint& location, RenderRegion*);
484     virtual bool hasControlClip() const { return false; }
485     virtual LayoutRect controlClipRect(const LayoutPoint&) const { return LayoutRect(); }
486     bool pushContentsClip(PaintInfo&, const LayoutPoint& accumulatedOffset);
487     void popContentsClip(PaintInfo&, PaintPhase originalPhase, const LayoutPoint& accumulatedOffset);
488
489     virtual void paintObject(PaintInfo&, const LayoutPoint&) { ASSERT_NOT_REACHED(); }
490     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
491     virtual void paintMask(PaintInfo&, const LayoutPoint&);
492     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) override;
493
494     // Called when a positioned object moves but doesn't necessarily change size.  A simplified layout is attempted
495     // that just updates the object's position. If the size does change, the object remains dirty.
496     bool tryLayoutDoingPositionedMovementOnly()
497     {
498         LayoutUnit oldWidth = width();
499         updateLogicalWidth();
500         // If we shrink to fit our width may have changed, so we still need full layout.
501         if (oldWidth != width())
502             return false;
503         updateLogicalHeight();
504         return true;
505     }
506
507     LayoutRect maskClipRect();
508
509     virtual VisiblePosition positionForPoint(const LayoutPoint&) override;
510
511     RenderBlockFlow* outermostBlockContainingFloatingObject();
512
513     void removeFloatingOrPositionedChildFromBlockLists();
514     
515     RenderLayer* enclosingFloatPaintingLayer() const;
516     
517     virtual int firstLineBaseline() const { return -1; }
518     virtual int inlineBlockBaseline(LineDirectionMode) const { return -1; } // Returns -1 if we should skip this box when computing the baseline of an inline-block.
519
520     bool shrinkToAvoidFloats() const;
521     virtual bool avoidsFloats() const;
522
523     virtual void markForPaginationRelayoutIfNeeded() { }
524
525     bool isWritingModeRoot() const { return !parent() || parent()->style().writingMode() != style().writingMode(); }
526
527     bool isDeprecatedFlexItem() const { return !isInline() && !isFloatingOrOutOfFlowPositioned() && parent() && parent()->isDeprecatedFlexibleBox(); }
528     bool isFlexItemIncludingDeprecated() const { return !isInline() && !isFloatingOrOutOfFlowPositioned() && parent() && parent()->isFlexibleBoxIncludingDeprecated(); }
529     
530     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override;
531     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override;
532
533     virtual LayoutUnit offsetLeft() const override;
534     virtual LayoutUnit offsetTop() const override;
535
536     LayoutPoint flipForWritingModeForChild(const RenderBox* child, const LayoutPoint&) const;
537     LayoutUnit flipForWritingMode(LayoutUnit position) const; // The offset is in the block direction (y for horizontal writing modes, x for vertical writing modes).
538     LayoutPoint flipForWritingMode(const LayoutPoint&) const;
539     LayoutPoint flipForWritingModeIncludingColumns(const LayoutPoint&) const;
540     LayoutSize flipForWritingMode(const LayoutSize&) const;
541     void flipForWritingMode(LayoutRect&) const;
542     FloatPoint flipForWritingMode(const FloatPoint&) const;
543     void flipForWritingMode(FloatRect&) const;
544     // These represent your location relative to your container as a physical offset.
545     // In layout related methods you almost always want the logical location (e.g. x() and y()).
546     LayoutPoint topLeftLocation() const;
547     LayoutSize topLeftLocationOffset() const;
548
549     LayoutRect logicalVisualOverflowRectForPropagation(RenderStyle*) const;
550     LayoutRect visualOverflowRectForPropagation(RenderStyle*) const;
551     LayoutRect logicalLayoutOverflowRectForPropagation(RenderStyle*) const;
552     LayoutRect layoutOverflowRectForPropagation(RenderStyle*) const;
553
554     bool hasRenderOverflow() const { return m_overflow; }    
555     bool hasVisualOverflow() const { return m_overflow && !borderBoxRect().contains(m_overflow->visualOverflowRect()); }
556
557     virtual bool needsPreferredWidthsRecalculation() const;
558     virtual void computeIntrinsicRatioInformation(FloatSize& /* intrinsicSize */, double& /* intrinsicRatio */, bool& /* isPercentageIntrinsicSize */) const { }
559
560     IntSize scrolledContentOffset() const;
561     LayoutSize cachedSizeForOverflowClip() const;
562     void applyCachedClipAndScrollOffsetForRepaint(LayoutRect& paintRect) const;
563
564     virtual bool hasRelativeDimensions() const;
565     virtual bool hasRelativeLogicalHeight() const;
566     bool hasViewportPercentageLogicalHeight() const;
567
568     bool hasHorizontalLayoutOverflow() const
569     {
570         if (!m_overflow)
571             return false;
572
573         LayoutRect layoutOverflowRect = m_overflow->layoutOverflowRect();
574         flipForWritingMode(layoutOverflowRect);
575         return layoutOverflowRect.x() < x() || layoutOverflowRect.maxX() > x() + logicalWidth();
576     }
577
578     bool hasVerticalLayoutOverflow() const
579     {
580         if (!m_overflow)
581             return false;
582
583         LayoutRect layoutOverflowRect = m_overflow->layoutOverflowRect();
584         flipForWritingMode(layoutOverflowRect);
585         return layoutOverflowRect.y() < y() || layoutOverflowRect.maxY() > y() + logicalHeight();
586     }
587
588     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject*) const
589     {
590         ASSERT_NOT_REACHED();
591         return 0;
592     }
593
594     bool hasSameDirectionAs(const RenderBox* object) const { return style().direction() == object->style().direction(); }
595
596 #if ENABLE(CSS_SHAPES)
597     ShapeOutsideInfo* shapeOutsideInfo() const
598     {
599         return ShapeOutsideInfo::isEnabledFor(*this) ? ShapeOutsideInfo::info(*this) : nullptr;
600     }
601
602     void markShapeOutsideDependentsForLayout()
603     {
604         if (isFloating())
605             removeFloatingOrPositionedChildFromBlockLists();
606     }
607 #endif
608
609     // True if this box can have a range in an outside fragmentation context.
610     bool canHaveOutsideRegionRange() const { return !isInFlowRenderFlowThread(); }
611
612 protected:
613     RenderBox(Element&, PassRef<RenderStyle>, unsigned baseTypeFlags);
614     RenderBox(Document&, PassRef<RenderStyle>, unsigned baseTypeFlags);
615
616     virtual void willBeDestroyed() override;
617
618     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle) override;
619     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
620     virtual void updateFromStyle() override;
621
622     // Returns false if it could not cheaply compute the extent (e.g. fixed background), in which case the returned rect may be incorrect.
623     bool getBackgroundPaintedExtent(LayoutRect&) const;
624     virtual bool foregroundIsKnownToBeOpaqueInRect(const LayoutRect& localRect, unsigned maxDepthToTest) const;
625     virtual bool computeBackgroundIsKnownToBeObscured() override;
626
627     void paintBackground(const PaintInfo&, const LayoutRect&, BackgroundBleedAvoidance = BackgroundBleedNone);
628     
629     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance, CompositeOperator, RenderElement* backgroundObject);
630     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, BackgroundBleedAvoidance = BackgroundBleedNone, CompositeOperator = CompositeSourceOver, RenderElement* backgroundObject = nullptr);
631
632     void paintMaskImages(const PaintInfo&, const LayoutRect&);
633
634     BackgroundBleedAvoidance determineBackgroundBleedAvoidance(GraphicsContext*) const;
635     bool backgroundHasOpaqueTopLayer() const;
636
637     void computePositionedLogicalWidth(LogicalExtentComputedValues&, RenderRegion* = 0) const;
638
639     LayoutUnit computeIntrinsicLogicalWidthUsing(Length logicalWidthLength, LayoutUnit availableLogicalWidth, LayoutUnit borderAndPadding) const;
640     
641     virtual bool shouldComputeSizeAsReplaced() const { return isReplaced() && !isInlineBlockOrInlineTable(); }
642
643     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const override;
644     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject*, RenderGeometryMap&) const override;
645     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
646
647     void paintRootBoxFillLayers(const PaintInfo&);
648
649     RenderObject* splitAnonymousBoxesAroundChild(RenderObject* beforeChild);
650  
651 private:
652 #if ENABLE(CSS_SHAPES)
653     void updateShapeOutsideInfoAfterStyleChange(const RenderStyle&, const RenderStyle* oldStyle);
654 #endif
655
656     bool scrollLayer(ScrollDirection, ScrollGranularity, float multiplier, Element** stopElement);
657
658     bool fixedElementLaysOutRelativeToFrame(const FrameView&) const;
659
660     bool includeVerticalScrollbarSize() const;
661     bool includeHorizontalScrollbarSize() const;
662
663     // Returns true if we did a full repaint
664     bool repaintLayerRectsForImage(WrappedImagePtr image, const FillLayer* layers, bool drawingBackground);
665
666     bool skipContainingBlockForPercentHeightCalculation(const RenderBox* containingBlock) const;
667    
668     LayoutUnit containingBlockLogicalWidthForPositioned(const RenderBoxModelObject* containingBlock, RenderRegion* = 0, bool checkForPerpendicularWritingMode = true) const;
669     LayoutUnit containingBlockLogicalHeightForPositioned(const RenderBoxModelObject* containingBlock, bool checkForPerpendicularWritingMode = true) const;
670
671     LayoutUnit viewLogicalHeightForPercentages() const;
672
673     void computePositionedLogicalHeight(LogicalExtentComputedValues&) const;
674     void computePositionedLogicalWidthUsing(Length logicalWidth, const RenderBoxModelObject* containerBlock, TextDirection containerDirection,
675                                             LayoutUnit containerLogicalWidth, LayoutUnit bordersPlusPadding,
676                                             Length logicalLeft, Length logicalRight, Length marginLogicalLeft, Length marginLogicalRight,
677                                             LogicalExtentComputedValues&) const;
678     void computePositionedLogicalHeightUsing(Length logicalHeightLength, const RenderBoxModelObject* containerBlock,
679                                              LayoutUnit containerLogicalHeight, LayoutUnit bordersPlusPadding, LayoutUnit logicalHeight,
680                                              Length logicalTop, Length logicalBottom, Length marginLogicalTop, Length marginLogicalBottom,
681                                              LogicalExtentComputedValues&) const;
682
683     void computePositionedLogicalHeightReplaced(LogicalExtentComputedValues&) const;
684     void computePositionedLogicalWidthReplaced(LogicalExtentComputedValues&) const;
685
686     LayoutUnit fillAvailableMeasure(LayoutUnit availableLogicalWidth) const;
687     LayoutUnit fillAvailableMeasure(LayoutUnit availableLogicalWidth, LayoutUnit& marginStart, LayoutUnit& marginEnd) const;
688
689     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const;
690
691     // This function calculates the minimum and maximum preferred widths for an object.
692     // These values are used in shrink-to-fit layout systems.
693     // These include tables, positioned objects, floats and flexible boxes.
694     virtual void computePreferredLogicalWidths() { setPreferredLogicalWidthsDirty(false); }
695
696     virtual LayoutRect frameRectForStickyPositioning() const override final { return frameRect(); }
697
698 private:
699     // The width/height of the contents + borders + padding.  The x/y location is relative to our container (which is not always our parent).
700     LayoutRect m_frameRect;
701
702 protected:
703     LayoutBoxExtent m_marginBox;
704
705     // The preferred logical width of the element if it were to break its lines at every possible opportunity.
706     LayoutUnit m_minPreferredLogicalWidth;
707     
708     // The preferred logical width of the element if it never breaks any lines at all.
709     LayoutUnit m_maxPreferredLogicalWidth;
710
711     // For inline replaced elements, the inline box that owns us.
712     InlineElementBox* m_inlineBoxWrapper;
713
714     // Our overflow information.
715     RefPtr<RenderOverflow> m_overflow;
716
717 private:
718     // Used to store state between styleWillChange and styleDidChange
719     static bool s_hadOverflowClip;
720 };
721
722 template<> inline bool isRendererOfType<const RenderBox>(const RenderObject& renderer) { return renderer.isBox(); }
723 RENDER_OBJECT_TYPE_CASTS(RenderBox, isBox())
724
725 inline RenderBox* RenderBox::previousSiblingBox() const
726 {
727     return toRenderBox(previousSibling());
728 }
729
730 inline RenderBox* RenderBox::nextSiblingBox() const
731
732     return toRenderBox(nextSibling());
733 }
734
735 inline RenderBox* RenderBox::parentBox() const
736 {
737     return toRenderBox(parent());
738 }
739
740 inline RenderBox* RenderBox::firstChildBox() const
741 {
742     return toRenderBox(firstChild());
743 }
744
745 inline RenderBox* RenderBox::lastChildBox() const
746 {
747     return toRenderBox(lastChild());
748 }
749
750 } // namespace WebCore
751
752 #endif // RenderBox_h