58fa0aa8e080cf9ba7d1fafae6b9693ff67c3d90
[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 #include "Logging.h"
33 #include <wtf/text/TextStream.h>
34
35 namespace WebCore {
36 namespace Layout {
37
38 static bool isStretchedToViewport(const LayoutContext& layoutContext, const Box& layoutBox)
39 {
40     ASSERT(layoutBox.isInFlow());
41     // In quirks mode, body and html stretch to the viewport.
42     if (!layoutContext.inQuirksMode())
43         return false;
44
45     if (!layoutBox.isDocumentBox() && !layoutBox.isBodyBox())
46         return false;
47
48     return layoutBox.style().logicalHeight().isAuto();
49 }
50
51 static const Container& initialContainingBlock(const Box& layoutBox)
52 {
53     auto* containingBlock = layoutBox.containingBlock();
54     while (containingBlock->containingBlock())
55         containingBlock = containingBlock->containingBlock();
56     return *containingBlock;
57 }
58
59 FormattingContext::Geometry::HeightAndMargin BlockFormattingContext::Geometry::inFlowNonReplacedHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
60 {
61     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
62
63     auto compute = [&]() -> LayoutUnit {
64         // 10.6.3 Block-level non-replaced elements in normal flow when 'overflow' computes to 'visible'
65         //
66         // If 'margin-top', or 'margin-bottom' are 'auto', their used value is 0.
67         // If 'height' is 'auto', the height depends on whether the element has any block-level children and whether it has padding or borders:
68         // The element's height is the distance from its top content edge to the first applicable of the following:
69         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
70         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin
71         //    does not collapse with the element's bottom margin
72         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
73         // 4. zero, otherwise
74         // Only children in the normal flow are taken into account (i.e., floating boxes and absolutely positioned boxes are ignored,
75         // and relatively positioned boxes are considered without their offset). Note that the child box may be an anonymous block box.
76
77         if (!layoutBox.style().logicalHeight().isAuto()) {
78             // FIXME: Only fixed values yet.
79             return layoutBox.style().logicalHeight().value();
80         }
81
82         if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowChild())
83             return 0;
84
85         // 1. the bottom edge of the last line box, if the box establishes a inline formatting context with one or more lines
86         if (layoutBox.establishesInlineFormattingContext()) {
87             // height = lastLineBox().bottom();
88             return 0;
89         }
90
91         // 2. the bottom edge of the bottom (possibly collapsed) margin of its last in-flow child, if the child's bottom margin...
92         auto* lastInFlowChild = downcast<Container>(layoutBox).lastInFlowChild();
93         ASSERT(lastInFlowChild);
94         if (!MarginCollapse::isMarginBottomCollapsedWithParent(*lastInFlowChild)) {
95             auto* lastInFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*lastInFlowChild);
96             ASSERT(lastInFlowDisplayBox);
97             return lastInFlowDisplayBox->bottom() + lastInFlowDisplayBox->marginBottom();
98         }
99
100         // 3. the bottom border edge of the last in-flow child whose top margin doesn't collapse with the element's bottom margin
101         auto* inFlowChild = lastInFlowChild;
102         while (inFlowChild && MarginCollapse::isMarginTopCollapsedWithParentMarginBottom(*inFlowChild))
103             inFlowChild = inFlowChild->previousInFlowSibling();
104         if (inFlowChild) {
105             auto* inFlowDisplayBox = layoutContext.displayBoxForLayoutBox(*inFlowChild);
106             ASSERT(inFlowDisplayBox);
107             return inFlowDisplayBox->top() + inFlowDisplayBox->borderBox().height();
108         }
109
110         // 4. zero, otherwise
111         return 0;
112     };
113
114     auto height = compute();
115     auto marginTop = MarginCollapse::marginTop(layoutContext, layoutBox);
116     auto marginBottom =  MarginCollapse::marginBottom(layoutContext, layoutBox);
117
118     if (!isStretchedToViewport(layoutContext, layoutBox)) {
119         LOG_WITH_STREAM(FormattingContextLayout, stream << "[Height][Margin] -> inflow non-replaced -> height(" << height << "px) margin(" << marginTop << "px, " << marginBottom << "px) -> layoutBox(" << &layoutBox << ")");
120         return { height, { marginTop, marginBottom } };
121     }
122
123     auto initialContainingBlockHeight = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().height();
124     // Stretch but never overstretch with the margins.
125     if (height + marginTop + marginBottom < initialContainingBlockHeight)
126         height = initialContainingBlockHeight - marginTop - marginBottom;
127
128     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Height][Margin] -> inflow non-replaced -> streched to viewport -> height(" << height << "px) margin(" << marginTop << "px, " << marginBottom << "px) -> layoutBox(" << &layoutBox << ")");
129     return { height, { marginTop, marginBottom } };
130 }
131
132 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowNonReplacedWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox,
133     std::optional<LayoutUnit> precomputedWidth)
134 {
135     ASSERT(layoutBox.isInFlow() && !layoutBox.replaced());
136
137     auto compute = [&]() {
138         // 10.3.3 Block-level, non-replaced elements in normal flow
139         // The following constraints must hold among the used values of the other properties:
140         // 'margin-left' + 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' + 'margin-right' = width of containing block
141         //
142         // 1. If 'width' is not 'auto' and 'border-left-width' + 'padding-left' + 'width' + 'padding-right' + 'border-right-width' 
143         //    (plus any of 'margin-left' or 'margin-right' that are not 'auto') is larger than the width of the containing block, then
144         //    any 'auto' values for 'margin-left' or 'margin-right' are, for the following rules, treated as zero.
145         //
146         // 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
147         //    have to be different from its computed value. If the 'direction' property of the containing block has the value 'ltr', the specified value
148         //    of 'margin-right' is ignored and the value is calculated so as to make the equality true. If the value of 'direction' is 'rtl',
149         //    this happens to 'margin-left' instead.
150         //
151         // 3. If there is exactly one value specified as 'auto', its used value follows from the equality.
152         //
153         // 4. If 'width' is set to 'auto', any other 'auto' values become '0' and 'width' follows from the resulting equality.
154         //
155         // 5. If both 'margin-left' and 'margin-right' are 'auto', their used values are equal. This horizontally centers the element with respect to the
156         //    edges of the containing block.
157
158         auto& style = layoutBox.style();
159         auto width = precomputedWidth ? Length { precomputedWidth.value(), Fixed } : style.logicalWidth();
160         auto* containingBlock = layoutBox.containingBlock();
161         auto containingBlockWidth = layoutContext.displayBoxForLayoutBox(*containingBlock)->width();
162         auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
163
164         LayoutUnit computedWidthValue;
165         std::optional<LayoutUnit> computedMarginLeftValue;
166         std::optional<LayoutUnit> computedMarginRightValue;
167
168         auto marginLeft = style.marginLeft();
169         if (!marginLeft.isAuto())
170             computedMarginLeftValue = valueForLength(marginLeft, containingBlockWidth);
171
172         auto marginRight = style.marginRight();
173         if (!marginRight.isAuto())
174             computedMarginRightValue = valueForLength(marginRight, containingBlockWidth);
175
176         auto borderLeft = displayBox.borderLeft();
177         auto borderRight = displayBox.borderRight();
178         auto paddingLeft = displayBox.paddingLeft();
179         auto paddingRight = displayBox.paddingRight();
180
181         // #1
182         if (!width.isAuto()) {
183             computedWidthValue = valueForLength(width, containingBlockWidth);
184             auto horizontalSpaceForMargin = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft 
185                 + computedWidthValue + paddingRight + borderRight + computedMarginRightValue.value_or(0));
186
187             if (horizontalSpaceForMargin < 0) {
188                 if (!computedMarginLeftValue)
189                     computedMarginLeftValue = LayoutUnit(0);
190                 if (!computedMarginRightValue)
191                     computedMarginRightValue = LayoutUnit(0);
192             }
193         }
194
195         // #2
196         if (!width.isAuto() && !marginLeft.isAuto() && !marginRight.isAuto()) {
197             ASSERT(computedMarginLeftValue);
198             ASSERT(computedMarginRightValue);
199
200             if (containingBlock->style().isLeftToRightDirection())
201                 computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
202             else
203                 computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
204         }
205
206         // #3
207         if (!computedMarginLeftValue && !marginRight.isAuto() && !width.isAuto()) {
208             ASSERT(computedMarginRightValue);
209             computedMarginLeftValue = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight + *computedMarginRightValue);
210         } else if (!computedMarginRightValue && !marginLeft.isAuto() && !width.isAuto()) {
211             ASSERT(computedMarginLeftValue);
212             computedMarginRightValue = containingBlockWidth - (*computedMarginLeftValue + borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
213         }
214
215         // #4
216         if (width.isAuto())
217             computedWidthValue = containingBlockWidth - (computedMarginLeftValue.value_or(0) + borderLeft + paddingLeft + paddingRight + borderRight + computedMarginRightValue.value_or(0));
218
219         // #5
220         if (!computedMarginLeftValue && !computedMarginRightValue) {
221             auto horizontalSpaceForMargin = containingBlockWidth - (borderLeft + paddingLeft  + computedWidthValue + paddingRight + borderRight);
222             computedMarginLeftValue = computedMarginRightValue = horizontalSpaceForMargin / 2;
223         }
224
225         ASSERT(computedMarginLeftValue);
226         ASSERT(computedMarginRightValue);
227
228         return FormattingContext::Geometry::WidthAndMargin { computedWidthValue, { *computedMarginLeftValue, *computedMarginRightValue } };
229     };
230
231     auto widthAndMargin = compute();
232     if (!isStretchedToViewport(layoutContext, layoutBox)) {
233         LOG_WITH_STREAM(FormattingContextLayout, stream << "[Width][Margin] -> inflow non-replaced -> width(" << widthAndMargin.width << "px) margin(" << widthAndMargin.margin.left << "px, " << widthAndMargin.margin.right << "px) -> layoutBox(" << &layoutBox << ")");
234         return widthAndMargin;
235     }
236
237     auto initialContainingBlockWidth = layoutContext.displayBoxForLayoutBox(initialContainingBlock(layoutBox))->contentBox().width();
238     auto horizontalMargins = widthAndMargin.margin.left + widthAndMargin.margin.right;
239     // Stretch but never overstretch with the margins.
240     if (widthAndMargin.width + horizontalMargins < initialContainingBlockWidth)
241         widthAndMargin.width = initialContainingBlockWidth - horizontalMargins;
242
243     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Width][Margin] -> inflow non-replaced -> streched to viewport-> width(" << widthAndMargin.width << "px) margin(" << widthAndMargin.margin.left << "px, " << widthAndMargin.margin.right << "px) -> layoutBox(" << &layoutBox << ")");
244     return widthAndMargin;
245 }
246
247 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowReplacedWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
248 {
249     ASSERT(layoutBox.isInFlow() && layoutBox.replaced());
250
251     // 10.3.4 Block-level, replaced elements in normal flow
252     //
253     // 1. The used value of 'width' is determined as for inline replaced elements.
254     // 2. Then the rules for non-replaced block-level elements are applied to determine the margins.
255
256     // #1
257     auto width = FormattingContext::Geometry::inlineReplacedWidthAndMargin(layoutContext, layoutBox).width;
258     // #2
259     auto margin = inFlowNonReplacedWidthAndMargin(layoutContext, layoutBox, width).margin;
260
261     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Width][Margin] -> inflow replaced -> width(" << width << "px) margin(" << margin.left << "px, " << margin.left << "px) -> layoutBox(" << &layoutBox << ")");
262     return { width, margin };
263 }
264
265 LayoutPoint BlockFormattingContext::Geometry::staticPosition(LayoutContext& layoutContext, const Box& layoutBox)
266 {
267     // https://www.w3.org/TR/CSS22/visuren.html#block-formatting
268     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
269     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
270     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
271     // 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).
272
273     auto containingBlockContentBox = layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock())->contentBox();
274     // Start from the top of the container's content box.
275     auto top = containingBlockContentBox.top();
276     auto left = containingBlockContentBox.left();
277     if (auto* previousInFlowSibling = layoutBox.previousInFlowSibling()) {
278         auto& previousInFlowDisplayBox = *layoutContext.displayBoxForLayoutBox(*previousInFlowSibling);
279         top = previousInFlowDisplayBox.bottom() + previousInFlowDisplayBox.marginBottom();
280     }
281     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Position] -> static -> top(" << top << "px) left(" << left << "px) layoutBox(" << &layoutBox << ")");
282     return { top, left };
283 }
284
285 LayoutPoint BlockFormattingContext::Geometry::inFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox)
286 {
287     ASSERT(layoutBox.isInFlowPositioned());
288
289     // 9.4.3 Relative positioning
290     //
291     // The 'top' and 'bottom' properties move relatively positioned element(s) up or down without changing their size.
292     // 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.
293     //
294     // 1. If both are 'auto', their used values are both '0'.
295     // 2. If one of them is 'auto', it becomes the negative of the other.
296     // 3. If neither is 'auto', 'bottom' is ignored (i.e., the used value of 'bottom' will be minus the value of 'top').
297
298     auto& style = layoutBox.style();
299     auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
300     auto& containingBlock = *layoutBox.containingBlock();
301     auto& containingBlockDisplayBox = *layoutContext.displayBoxForLayoutBox(containingBlock);
302     auto containingBlockWidth = containingBlockDisplayBox.width();
303
304     auto top = FormattingContext::Geometry::computedValueIfNotAuto(style.logicalTop(), containingBlockWidth);
305     auto bottom = FormattingContext::Geometry::computedValueIfNotAuto(style.logicalBottom(), containingBlockWidth);
306
307     if (!top && !bottom) {
308         // #1
309         top = bottom = { 0 };
310     } else if (!top) {
311         // #2
312         top = -*bottom;
313     } else if (!bottom) {
314         // #3
315         bottom = -*top;
316     } else {
317         // #4
318         bottom = std::nullopt;
319     }
320
321     // For relatively positioned elements, 'left' and 'right' move the box(es) horizontally, without changing their size.
322     // 'Left' moves the boxes to the right, and 'right' moves them to the left.
323     // Since boxes are not split or stretched as a result of 'left' or 'right', the used values are always: left = -right.
324     //
325     // 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).
326     // 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').
327     // 3. If 'right' is specified as 'auto', its used value is minus the value of 'left'.
328     // 4. If neither 'left' nor 'right' is 'auto', the position is over-constrained, and one of them has to be ignored.
329     //    If the 'direction' property of the containing block is 'ltr', the value of 'left' wins and 'right' becomes -'left'.
330     //    If 'direction' of the containing block is 'rtl', 'right' wins and 'left' is ignored.
331
332     auto left = FormattingContext::Geometry::computedValueIfNotAuto(style.logicalLeft(), containingBlockWidth);
333     auto right = FormattingContext::Geometry::computedValueIfNotAuto(style.logicalRight(), containingBlockWidth);
334
335     if (!left && !right) {
336         // #1
337         left = right = { 0 };
338     } else if (!left) {
339         // #2
340         left = -*right;
341     } else if (!right) {
342         // #3
343         right = -*left;
344     } else {
345         // #4
346         auto isLeftToRightDirection = containingBlock.style().isLeftToRightDirection();
347         if (isLeftToRightDirection)
348             right = -*left;
349         else
350             left = std::nullopt;
351     }
352
353     ASSERT(!bottom || *top == -*bottom);
354     ASSERT(!left || *left == -*right);
355
356     auto newTopPosition = displayBox.top() + *top;
357     auto newLeftPosition = displayBox.left() + left.value_or(-*right);
358
359     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Position] -> positioned inflow -> top(" << newTopPosition << "px) left(" << newLeftPosition << "px) layoutBox(" << &layoutBox << ")");
360     return { newTopPosition, newLeftPosition };
361 }
362
363 FormattingContext::Geometry::HeightAndMargin BlockFormattingContext::Geometry::inFlowHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
364 {
365     ASSERT(layoutBox.isInFlow());
366
367     if (!layoutBox.replaced())
368         return inFlowNonReplacedHeightAndMargin(layoutContext, layoutBox);
369     // 10.6.2 Inline replaced elements, block-level replaced elements in normal flow, 'inline-block'
370     // replaced elements in normal flow and floating replaced elements
371     return FormattingContext::Geometry::inlineReplacedHeightAndMargin(layoutContext, layoutBox);
372 }
373
374 FormattingContext::Geometry::WidthAndMargin BlockFormattingContext::Geometry::inFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox)
375 {
376     ASSERT(layoutBox.isInFlow());
377
378     if (!layoutBox.replaced())
379         return inFlowNonReplacedWidthAndMargin(layoutContext, layoutBox);
380     return inFlowReplacedWidthAndMargin(layoutContext, layoutBox);
381 }
382
383 }
384 }
385
386 #endif