[LFC] Merge width and margin computation for block-level, non-replaced and inline...
[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 LayoutUnit BlockFormattingContext::Geometry::inFlowNonReplacedHeight(LayoutContext& layoutContext, const Box& layoutBox)
58 {
59     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
60
61     auto compute = [&]() -> LayoutUnit {
62         // https://www.w3.org/TR/CSS22/visudet.html
63         // If 'height' is 'auto', the height depends on whether the element has any block-level children and whether it has padding or borders:
64         // The element's height is the distance from its top content edge to the first applicable of the following:
65         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
66         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin
67         //    does not collapse with the element's bottom margin
68         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
69         // 4. zero, otherwise
70         // Only children in the normal flow are taken into account (i.e., floating boxes and absolutely positioned boxes are ignored,
71         // and relatively positioned boxes are considered without their offset). Note that the child box may be an anonymous block box.
72         if (!layoutBox.style().logicalHeight().isAuto()) {
73             // FIXME: Only fixed values yet.
74             return layoutBox.style().logicalHeight().value();
75         }
76
77         if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowChild())
78             return 0;
79
80         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
81         if (layoutBox.establishesInlineFormattingContext()) {
82             // height = lastLineBox().bottom();
83             return 0;
84         }
85
86         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin...
87         auto* lastInFlowChild = downcast<Container>(layoutBox).lastInFlowChild();
88         ASSERT(lastInFlowChild);
89         if (!BlockFormattingContext::MarginCollapse::isMarginBottomCollapsedWithParent(*lastInFlowChild)) {
90             auto* lastInFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*lastInFlowChild);
91             ASSERT(lastInFlowDisplayBox);
92             return lastInFlowDisplayBox->bottom() + lastInFlowDisplayBox->marginBottom();
93         }
94
95         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
96         auto* inFlowChild = lastInFlowChild;
97         while (inFlowChild && BlockFormattingContext::MarginCollapse::isMarginTopCollapsedWithParentMarginBottom(*inFlowChild))
98             inFlowChild = inFlowChild->previousInFlowSibling();
99         if (inFlowChild) {
100             auto* inFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*inFlowChild);
101             ASSERT(inFlowDisplayBox);
102             return inFlowDisplayBox->top() + inFlowDisplayBox->borderBox().height();
103         }
104
105         // 4. zero, otherwise
106         return 0;
107     };
108
109     auto computedHeight = compute();
110     if (!isStretchedToViewport(layoutContext, layoutBox))
111         return computedHeight;
112     auto initialContainingBlockHeight = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().height();
113     return std::max(computedHeight, initialContainingBlockHeight);
114 }
115
116 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowNonReplacedWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
117 {
118     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
119
120     auto compute = [&]() {
121         // 10.3.3 Block-level, non-replaced elements in normal flow
122         // The following constraints must hold among the used values of the other properties:
123         // 'margin-left' + 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' + 'margin-right' = width of containing block
124         //
125         // 1. If 'width' is not 'auto' and 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' 
126         //    (plus any of 'margin-left' or 'margin-right' that are not 'auto') is larger than the width of the containing block, then
127         //    any 'auto' values for 'margin-left' or 'margin-right' are, for the following rules, treated as zero.
128         //
129         // 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
130         //    have to be different from its computed value. If the 'direction' property of the containing block has the value 'ltr', the specified value
131         //    of 'margin-right' is ignored and the value is calculated so as to make the equality true. If the value of 'direction' is 'rtl',
132         //    this happens to 'margin-left' instead.
133         //
134         // 3. If there is exactly one value specified as 'auto', its used value follows from the equality.
135         //
136         // 4. If 'width' is set to 'auto', any other 'auto' values become '0' and 'width' follows from the resulting equality.
137         //
138         // 5. If both 'margin-left' and 'margin-right' are 'auto', their used values are equal. This horizontally centers the element with respect to the
139         //    edges of the containing block.
140
141         auto& style = layoutBox.style();
142         auto width = style.logicalWidth();
143         auto* containingBlock = layoutBox.containingBlock();
144         auto containingBlockWidth = layoutContext.displayBoxForLayoutBox(*containingBlock)->width();
145         auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
146
147         LayoutUnit computedWidthValue;
148         std::optional<LayoutUnit> computedMarginLeftValue;
149         std::optional<LayoutUnit> computedMarginRightValue;
150
151         auto marginLeft = style.marginLeft();
152         if (!marginLeft.isAuto())
153             computedMarginLeftValue = valueForLength(marginLeft, containingBlockWidth);
154
155         auto marginRight = style.marginRight();
156         if (!marginRight.isAuto())
157             computedMarginRightValue = valueForLength(marginRight, containingBlockWidth);
158
159         auto borderLeft = displayBox.borderLeft();
160         auto borderRight = displayBox.borderRight();
161         auto paddingLeft = displayBox.paddingLeft();
162         auto paddingRight = displayBox.paddingRight();
163
164         // #1
165         if (!width.isAuto()) {
166             computedWidthValue = valueForLength(width, containingBlockWidth);
167             auto horizontalSpaceForMargin = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft 
168                 + computedWidthValue + paddingRight + borderRight + computedMarginRightValue.value_or(0));
169
170             if (horizontalSpaceForMargin < 0) {
171                 if (!computedMarginLeftValue)
172                     computedMarginLeftValue = LayoutUnit(0);
173                 if (!computedMarginRightValue)
174                     computedMarginRightValue = LayoutUnit(0);
175             }
176         }
177
178         // #2
179         if (!width.isAuto() && !marginLeft.isAuto() && !marginRight.isAuto()) {
180             ASSERT(computedMarginLeftValue);
181             ASSERT(computedMarginRightValue);
182
183             if (containingBlock->style().isLeftToRightDirection())
184                 computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
185             else
186                 computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
187         }
188
189         // #3
190         if (!computedMarginLeftValue && !marginRight.isAuto() && !width.isAuto()) {
191             ASSERT(computedMarginRightValue);
192             computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
193         } else if (!computedMarginRightValue && !marginLeft.isAuto() && !width.isAuto()) {
194             ASSERT(computedMarginLeftValue);
195             computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
196         }
197
198         // #4
199         if (width.isAuto())
200             computedWidthValue = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft + paddingRight + borderRight + computedMarginRightValue.value_or(0));
201
202         // #5
203         if (!computedMarginLeftValue && !computedMarginRightValue) {
204             auto horizontalSpaceForMargin = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
205             computedMarginLeftValue = computedMarginRightValue = horizontalSpaceForMargin / 2;
206         }
207
208         ASSERT(computedMarginLeftValue);
209         ASSERT(computedMarginRightValue);
210
211         return FormattingContext::Geometry::WidthAndMargin { computedWidthValue, { *computedMarginLeftValue, *computedMarginRightValue } };
212     };
213
214     auto computedWidthAndMarginValue = compute();
215     if (!isStretchedToViewport(layoutContext, layoutBox))
216         return computedWidthAndMarginValue;
217     auto initialContainingBlockWidth = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().width();
218     return FormattingContext::Geometry::WidthAndMargin { std::max(computedWidthAndMarginValue.width, initialContainingBlockWidth), { } };
219 }
220
221 LayoutPoint BlockFormattingContext::Geometry::staticPosition(LayoutContext& layoutContext, const Box& layoutBox)
222 {
223     // https://www.w3.org/TR/CSS22/visuren.html#block-formatting
224     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
225     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
226     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
227     // 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).
228     auto containingBlockContentBox = layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock())->contentBox();
229     // Start from the top of the container's content box.
230     auto top = containingBlockContentBox.top();
231     auto left = containingBlockContentBox.left();
232     if (auto* previousInFlowSibling = layoutBox.previousInFlowSibling()) {
233         auto& previousInFlowDisplayBox = *layoutContext.displayBoxForLayoutBox(*previousInFlowSibling);
234         top = previousInFlowDisplayBox.bottom() + previousInFlowDisplayBox.marginBottom();
235     }
236     auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
237     LayoutPoint topLeft = { top, left };
238     topLeft.moveBy({ displayBox.marginLeft(), displayBox.marginTop() });
239     return topLeft;
240 }
241
242 LayoutPoint BlockFormattingContext::Geometry::inFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox)
243 {
244     ASSERT(layoutBox.isInFlowPositioned());
245     // 9.4.3 Relative positioning
246     //
247     // The 'top' and 'bottom' properties move relatively positioned element(s) up or down without changing their size.
248     // 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.
249     //
250     // 1. If both are 'auto', their used values are both '0'.
251     // 2. If one of them is 'auto', it becomes the negative of the other.
252     // 3. If neither is 'auto', 'bottom' is ignored (i.e., the used value of 'bottom' will be minus the value of 'top').
253     auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
254     auto& style = layoutBox.style();
255
256     auto top = style.logicalTop();
257     auto bottom = style.logicalBottom();
258     LayoutUnit topDelta;
259
260     if (top.isAuto() && bottom.isAuto()) {
261         // #1
262         topDelta = 0;
263     } else if (top.isAuto()) {
264         // #2
265         topDelta = -bottom.value();
266     } else if (bottom.isAuto()) {
267         // #3 #4
268         topDelta = top.value();
269     }
270
271     // For relatively positioned elements, 'left' and 'right' move the box(es) horizontally, without changing their size.
272     // 'Left' moves the boxes to the right, and 'right' moves them to the left.
273     // Since boxes are not split or stretched as a result of 'left' or 'right', the used values are always: left = -right.
274     //
275     // 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).
276     // 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').
277     // 3. If 'right' is specified as 'auto', its used value is minus the value of 'left'.
278     // 4. If neither 'left' nor 'right' is 'auto', the position is over-constrained, and one of them has to be ignored.
279     //    If the 'direction' property of the containing block is 'ltr', the value of 'left' wins and 'right' becomes -'left'.
280     //    If 'direction' of the containing block is 'rtl', 'right' wins and 'left' is ignored.
281     //
282     auto left = style.logicalLeft();
283     auto right = style.logicalRight();
284     LayoutUnit leftDelta;
285
286     if (left.isAuto() && right.isAuto()) {
287         // #1
288         leftDelta = 0;
289     } else if (left.isAuto()) {
290         // #2
291         leftDelta = -right.value();
292     } else if (right.isAuto()) {
293         // #3
294         leftDelta = left.value();
295     } else {
296         // #4
297         // FIXME: take direction into account
298         leftDelta = left.value();
299     }
300
301     return { displayBox.left() + leftDelta, displayBox.top() + topDelta };
302 }
303
304 LayoutUnit BlockFormattingContext::Geometry::inFlowHeight(LayoutContext& layoutContext, const Box& layoutBox)
305 {
306     ASSERT(layoutBox.isInFlow());
307
308     if (!layoutBox.replaced())
309         return inFlowNonReplacedHeight(layoutContext, layoutBox);
310     // 10.6.2 Inline replaced elements, block-level replaced elements in normal flow, 'inline-block'
311     // replaced elements in normal flow and floating replaced elements
312     return FormattingContext::Geometry::inlineReplacedHeight(layoutContext, layoutBox);
313 }
314
315 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
316 {
317     ASSERT(layoutBox.isInFlow());
318
319     if (!layoutBox.replaced())
320         return inFlowNonReplacedWidthAndMargin(layoutContext, layoutBox);
321     // 10.3.4 Block-level, replaced elements in normal flow
322     // The used value of 'width' is determined as for inline replaced elements
323     return FormattingContext::Geometry::inlineReplacedWidthAndMargin(layoutContext, layoutBox);
324 }
325
326 }
327 }
328
329 #endif