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