[LFC] Add vertical margin computation for inflow non-replaced box and for the (10...
[WebKit-https.git] / Source / WebCore / layout / blockformatting / BlockFormattingContextGeometry.cpp
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "BlockFormattingContext.h"
28
29 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
30
31 #include "FormattingContext.h"
32
33 namespace WebCore {
34 namespace Layout {
35
36 static bool isStretchedToViewport(const LayoutContext& layoutContext, const Box& layoutBox)
37 {
38     ASSERT(layoutBox.isInFlow());
39     // In quirks mode, body and html stretch to the viewport.
40     if (!layoutContext.inQuirksMode())
41         return false;
42
43     if (!layoutBox.isDocumentBox() || !layoutBox.isBodyBox())
44         return false;
45
46     return layoutBox.style().logicalHeight().isAuto();
47 }
48
49 static const Container& initialContainingBlock(const Box& layoutBox)
50 {
51     auto* containingBlock = layoutBox.containingBlock();
52     while (containingBlock->containingBlock())
53         containingBlock = containingBlock->containingBlock();
54     return *containingBlock;
55 }
56
57 FormattingContext::Geometry::HeightAndMargin BlockFormattingContext::Geometry::inFlowNonReplacedHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
58 {
59     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
60
61     auto compute = [&]() -> LayoutUnit {
62         // 10.6.3 Block-level non-replaced elements in normal flow when 'overflow' computes to 'visible'
63         //
64         // If 'margin-top', or 'margin-bottom' are 'auto', their used value is 0.
65         // If 'height' is 'auto', the height depends on whether the element has any block-level children and whether it has padding or borders:
66         // The element's height is the distance from its top content edge to the first applicable of the following:
67         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
68         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin
69         //    does not collapse with the element's bottom margin
70         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
71         // 4. zero, otherwise
72         // Only children in the normal flow are taken into account (i.e., floating boxes and absolutely positioned boxes are ignored,
73         // and relatively positioned boxes are considered without their offset). Note that the child box may be an anonymous block box.
74         if (!layoutBox.style().logicalHeight().isAuto()) {
75             // FIXME: Only fixed values yet.
76             return layoutBox.style().logicalHeight().value();
77         }
78
79         if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowChild())
80             return 0;
81
82         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
83         if (layoutBox.establishesInlineFormattingContext()) {
84             // height = lastLineBox().bottom();
85             return 0;
86         }
87
88         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin...
89         auto* lastInFlowChild = downcast<Container>(layoutBox).lastInFlowChild();
90         ASSERT(lastInFlowChild);
91         if (!MarginCollapse::isMarginBottomCollapsedWithParent(*lastInFlowChild)) {
92             auto* lastInFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*lastInFlowChild);
93             ASSERT(lastInFlowDisplayBox);
94             return lastInFlowDisplayBox->bottom() + lastInFlowDisplayBox->marginBottom();
95         }
96
97         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
98         auto* inFlowChild = lastInFlowChild;
99         while (inFlowChild && MarginCollapse::isMarginTopCollapsedWithParentMarginBottom(*inFlowChild))
100             inFlowChild = inFlowChild->previousInFlowSibling();
101         if (inFlowChild) {
102             auto* inFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*inFlowChild);
103             ASSERT(inFlowDisplayBox);
104             return inFlowDisplayBox->top() + inFlowDisplayBox->borderBox().height();
105         }
106
107         // 4. zero, otherwise
108         return 0;
109     };
110
111     auto height = compute();
112     auto marginTop = MarginCollapse::marginTop(layoutContext, layoutBox);
113     auto marginBottom =  MarginCollapse::marginBottom(layoutContext, layoutBox);
114
115     if (!isStretchedToViewport(layoutContext, layoutBox))
116         return { height, { marginTop, marginBottom } };
117     auto initialContainingBlockHeight = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().height();
118     return { std::max(height, initialContainingBlockHeight), { marginTop, marginBottom } };
119 }
120
121 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowNonReplacedWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox,
122     std::optional<LayoutUnit> precomputedWidth)
123 {
124     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
125
126     auto compute = [&]() {
127         // 10.3.3 Block-level, non-replaced elements in normal flow
128         // The following constraints must hold among the used values of the other properties:
129         // 'margin-left' + 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' + 'margin-right' = width of containing block
130         //
131         // 1. If 'width' is not 'auto' and 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' 
132         //    (plus any of 'margin-left' or 'margin-right' that are not 'auto') is larger than the width of the containing block, then
133         //    any 'auto' values for 'margin-left' or 'margin-right' are, for the following rules, treated as zero.
134         //
135         // 2. If all of the above have a computed value other than 'auto', the values are said to be "over-constrained" and one of the used values will
136         //    have to be different from its computed value. If the 'direction' property of the containing block has the value 'ltr', the specified value
137         //    of 'margin-right' is ignored and the value is calculated so as to make the equality true. If the value of 'direction' is 'rtl',
138         //    this happens to 'margin-left' instead.
139         //
140         // 3. If there is exactly one value specified as 'auto', its used value follows from the equality.
141         //
142         // 4. If 'width' is set to 'auto', any other 'auto' values become '0' and 'width' follows from the resulting equality.
143         //
144         // 5. If both 'margin-left' and 'margin-right' are 'auto', their used values are equal. This horizontally centers the element with respect to the
145         //    edges of the containing block.
146
147         auto& style = layoutBox.style();
148         auto width = precomputedWidth ? Length { precomputedWidth.value(), Fixed } : style.logicalWidth();
149         auto* containingBlock = layoutBox.containingBlock();
150         auto containingBlockWidth = layoutContext.displayBoxForLayoutBox(*containingBlock)->width();
151         auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
152
153         LayoutUnit computedWidthValue;
154         std::optional<LayoutUnit> computedMarginLeftValue;
155         std::optional<LayoutUnit> computedMarginRightValue;
156
157         auto marginLeft = style.marginLeft();
158         if (!marginLeft.isAuto())
159             computedMarginLeftValue = valueForLength(marginLeft, containingBlockWidth);
160
161         auto marginRight = style.marginRight();
162         if (!marginRight.isAuto())
163             computedMarginRightValue = valueForLength(marginRight, containingBlockWidth);
164
165         auto borderLeft = displayBox.borderLeft();
166         auto borderRight = displayBox.borderRight();
167         auto paddingLeft = displayBox.paddingLeft();
168         auto paddingRight = displayBox.paddingRight();
169
170         // #1
171         if (!width.isAuto()) {
172             computedWidthValue = valueForLength(width, containingBlockWidth);
173             auto horizontalSpaceForMargin = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft 
174                 + computedWidthValue + paddingRight + borderRight + computedMarginRightValue.value_or(0));
175
176             if (horizontalSpaceForMargin < 0) {
177                 if (!computedMarginLeftValue)
178                     computedMarginLeftValue = LayoutUnit(0);
179                 if (!computedMarginRightValue)
180                     computedMarginRightValue = LayoutUnit(0);
181             }
182         }
183
184         // #2
185         if (!width.isAuto() && !marginLeft.isAuto() && !marginRight.isAuto()) {
186             ASSERT(computedMarginLeftValue);
187             ASSERT(computedMarginRightValue);
188
189             if (containingBlock->style().isLeftToRightDirection())
190                 computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
191             else
192                 computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
193         }
194
195         // #3
196         if (!computedMarginLeftValue && !marginRight.isAuto() && !width.isAuto()) {
197             ASSERT(computedMarginRightValue);
198             computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
199         } else if (!computedMarginRightValue && !marginLeft.isAuto() && !width.isAuto()) {
200             ASSERT(computedMarginLeftValue);
201             computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
202         }
203
204         // #4
205         if (width.isAuto())
206             computedWidthValue = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft + paddingRight + borderRight + computedMarginRightValue.value_or(0));
207
208         // #5
209         if (!computedMarginLeftValue && !computedMarginRightValue) {
210             auto horizontalSpaceForMargin = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
211             computedMarginLeftValue = computedMarginRightValue = horizontalSpaceForMargin / 2;
212         }
213
214         ASSERT(computedMarginLeftValue);
215         ASSERT(computedMarginRightValue);
216
217         return FormattingContext::Geometry::WidthAndMargin { computedWidthValue, { *computedMarginLeftValue, *computedMarginRightValue } };
218     };
219
220     auto computedWidthAndMarginValue = compute();
221     if (!isStretchedToViewport(layoutContext, layoutBox))
222         return computedWidthAndMarginValue;
223     auto initialContainingBlockWidth = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().width();
224     return FormattingContext::Geometry::WidthAndMargin { std::max(computedWidthAndMarginValue.width, initialContainingBlockWidth), { computedWidthAndMarginValue.margin } };
225 }
226
227 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowReplacedWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
228 {
229     ASSERT(layoutBox.isInFlow() && layoutBox.replaced());
230
231     // 10.3.4 Block-level, replaced elements in normal flow
232     //
233     // 1. The used value of 'width' is determined as for inline replaced elements.
234     // 2. Then the rules for non-replaced block-level elements are applied to determine the margins.
235
236     // #1
237     auto inlineReplacedWidthAndMargin = FormattingContext::Geometry::inlineReplacedWidthAndMargin(layoutContext, layoutBox);
238     // #2
239     auto inlineReplacedWidthAndBlockNonReplacedMargin = inFlowNonReplacedWidthAndMargin(layoutContext, layoutBox, inlineReplacedWidthAndMargin.width);
240     ASSERT(inlineReplacedWidthAndMargin.width == inlineReplacedWidthAndBlockNonReplacedMargin.width);
241     return inlineReplacedWidthAndBlockNonReplacedMargin;
242 }
243
244 LayoutPoint BlockFormattingContext::Geometry::staticPosition(LayoutContext& layoutContext, const Box& layoutBox)
245 {
246     // https://www.w3.org/TR/CSS22/visuren.html#block-formatting
247     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
248     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
249     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
250     // In a block formatting context, each box's left outer edge touches the left edge of the containing block (for right-to-left formatting, right edges touch).
251     auto containingBlockContentBox = layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock())->contentBox();
252     // Start from the top of the container's content box.
253     auto top = containingBlockContentBox.top();
254     auto left = containingBlockContentBox.left();
255     if (auto* previousInFlowSibling = layoutBox.previousInFlowSibling()) {
256         auto& previousInFlowDisplayBox = *layoutContext.displayBoxForLayoutBox(*previousInFlowSibling);
257         top = previousInFlowDisplayBox.bottom() + previousInFlowDisplayBox.marginBottom();
258     }
259     auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
260     LayoutPoint topLeft = { top, left };
261     topLeft.moveBy({ displayBox.marginLeft(), displayBox.marginTop() });
262     return topLeft;
263 }
264
265 LayoutPoint BlockFormattingContext::Geometry::inFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox)
266 {
267     ASSERT(layoutBox.isInFlowPositioned());
268     // 9.4.3 Relative positioning
269     //
270     // The 'top' and 'bottom' properties move relatively positioned element(s) up or down without changing their size.
271     // Top' moves the boxes down, and 'bottom' moves them up. Since boxes are not split or stretched as a result of 'top' or 'bottom', the used values are always: top = -bottom.
272     //
273     // 1. If both are 'auto', their used values are both '0'.
274     // 2. If one of them is 'auto', it becomes the negative of the other.
275     // 3. If neither is 'auto', 'bottom' is ignored (i.e., the used value of 'bottom' will be minus the value of 'top').
276     auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
277     auto& style = layoutBox.style();
278
279     auto top = style.logicalTop();
280     auto bottom = style.logicalBottom();
281     LayoutUnit topDelta;
282
283     if (top.isAuto() && bottom.isAuto()) {
284         // #1
285         topDelta = 0;
286     } else if (top.isAuto()) {
287         // #2
288         topDelta = -bottom.value();
289     } else if (bottom.isAuto()) {
290         // #3 #4
291         topDelta = top.value();
292     }
293
294     // For relatively positioned elements, 'left' and 'right' move the box(es) horizontally, without changing their size.
295     // 'Left' moves the boxes to the right, and 'right' moves them to the left.
296     // Since boxes are not split or stretched as a result of 'left' or 'right', the used values are always: left = -right.
297     //
298     // 1. If both 'left' and 'right' are 'auto' (their initial values), the used values are '0' (i.e., the boxes stay in their original position).
299     // 2. If 'left' is 'auto', its used value is minus the value of 'right' (i.e., the boxes move to the left by the value of 'right').
300     // 3. If 'right' is specified as 'auto', its used value is minus the value of 'left'.
301     // 4. If neither 'left' nor 'right' is 'auto', the position is over-constrained, and one of them has to be ignored.
302     //    If the 'direction' property of the containing block is 'ltr', the value of 'left' wins and 'right' becomes -'left'.
303     //    If 'direction' of the containing block is 'rtl', 'right' wins and 'left' is ignored.
304     //
305     auto left = style.logicalLeft();
306     auto right = style.logicalRight();
307     LayoutUnit leftDelta;
308
309     if (left.isAuto() && right.isAuto()) {
310         // #1
311         leftDelta = 0;
312     } else if (left.isAuto()) {
313         // #2
314         leftDelta = -right.value();
315     } else if (right.isAuto()) {
316         // #3
317         leftDelta = left.value();
318     } else {
319         // #4
320         // FIXME: take direction into account
321         leftDelta = left.value();
322     }
323
324     return { displayBox.left() + leftDelta, displayBox.top() + topDelta };
325 }
326
327 FormattingContext::Geometry::HeightAndMargin BlockFormattingContext::Geometry::inFlowHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
328 {
329     ASSERT(layoutBox.isInFlow());
330
331     if (!layoutBox.replaced())
332         return inFlowNonReplacedHeightAndMargin(layoutContext, layoutBox);
333     // 10.6.2 Inline replaced elements, block-level replaced elements in normal flow, 'inline-block'
334     // replaced elements in normal flow and floating replaced elements
335     return FormattingContext::Geometry::inlineReplacedHeightAndMargin(layoutContext, layoutBox);
336 }
337
338 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
339 {
340     ASSERT(layoutBox.isInFlow());
341
342     if (!layoutBox.replaced())
343         return inFlowNonReplacedWidthAndMargin(layoutContext, layoutBox);
344     return inFlowReplacedWidthAndMargin(layoutContext, layoutBox);
345 }
346
347 }
348 }
349
350 #endif