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