Add changes missing from r234925.
[WebKit-https.git] / Source / WebCore / layout / blockformatting / BlockFormattingContext.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 "BlockFormattingState.h"
32 #include "DisplayBox.h"
33 #include "FloatingContext.h"
34 #include "FloatingState.h"
35 #include "LayoutBox.h"
36 #include "LayoutContainer.h"
37 #include "LayoutContext.h"
38 #include "Logging.h"
39 #include <wtf/IsoMallocInlines.h>
40 #include <wtf/text/TextStream.h>
41
42 namespace WebCore {
43 namespace Layout {
44
45 WTF_MAKE_ISO_ALLOCATED_IMPL(BlockFormattingContext);
46
47 BlockFormattingContext::BlockFormattingContext(const Box& formattingContextRoot)
48     : FormattingContext(formattingContextRoot)
49 {
50 }
51
52 void BlockFormattingContext::layout(LayoutContext& layoutContext, FormattingState& formattingState) const
53 {
54     // 9.4.1 Block formatting contexts
55     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
56     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
57     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
58     if (!is<Container>(root()))
59         return;
60
61     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Start] -> block formatting context -> layout context(" << &layoutContext << ") formatting root(" << &root() << ")");
62
63     auto& formattingRoot = downcast<Container>(root());
64     LayoutQueue layoutQueue;
65     FloatingContext floatingContext(formattingState.floatingState());
66     // This is a post-order tree traversal layout.
67     // The root container layout is done in the formatting context it lives in, not that one it creates, so let's start with the first child.
68     if (auto* firstChild = formattingRoot.firstInFlowOrFloatingChild())
69         layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*firstChild, layoutContext.createDisplayBox(*firstChild)}));
70     // 1. Go all the way down to the leaf node
71     // 2. Compute static position and width as we traverse down
72     // 3. As we climb back on the tree, compute height and finialize position
73     // (Any subtrees with new formatting contexts need to layout synchronously)
74     while (!layoutQueue.isEmpty()) {
75         // Traverse down on the descendants and compute width/static position until we find a leaf node.
76         while (true) {
77             auto& layoutPair = *layoutQueue.last();
78             auto& layoutBox = layoutPair.layoutBox;
79             auto& displayBox = layoutPair.displayBox;
80
81             if (layoutBox.establishesFormattingContext()) {
82                 layoutFormattingContextRoot(layoutContext, floatingContext, formattingState, layoutBox, displayBox);
83                 layoutQueue.removeLast();
84                 // Since this box is a formatting context root, it takes care of its entire subtree.
85                 // Continue with next sibling if exists.
86                 if (!layoutBox.nextInFlowOrFloatingSibling())
87                     break;
88                 auto* nextSibling = layoutBox.nextInFlowOrFloatingSibling();
89                 layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*nextSibling, layoutContext.createDisplayBox(*nextSibling)}));
90                 continue;
91             }
92
93             LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
94             computeStaticPosition(layoutContext, layoutBox, displayBox);
95             computeBorderAndPadding(layoutContext, layoutBox, displayBox);
96             computeWidthAndMargin(layoutContext, layoutBox, displayBox);
97             if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowOrFloatingChild())
98                 break;
99             auto& firstChild = *downcast<Container>(layoutBox).firstInFlowOrFloatingChild();
100             layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {firstChild, layoutContext.createDisplayBox(firstChild)}));
101         }
102
103         // Climb back on the ancestors and compute height/final position.
104         while (!layoutQueue.isEmpty()) {
105             // All inflow descendants (if there are any) are laid out by now. Let's compute the box's height.
106             auto layoutPair = layoutQueue.takeLast();
107             auto& layoutBox = layoutPair->layoutBox;
108             auto& displayBox = layoutPair->displayBox;
109
110             LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
111             // Formatting root boxes are special-cased and they don't come here.
112             ASSERT(!layoutBox.establishesFormattingContext());
113             computeHeightAndMargin(layoutContext, layoutBox, displayBox);
114             // Finalize position with clearance.
115             if (layoutBox.hasFloatClear())
116                 computeVerticalPositionForFloatClear(layoutContext, floatingContext, layoutBox, displayBox);
117             if (!is<Container>(layoutBox))
118                 continue;
119             auto& container = downcast<Container>(layoutBox);
120             // Move in-flow positioned children to their final position.
121             placeInFlowPositionedChildren(layoutContext, container);
122             if (auto* nextSibling = container.nextInFlowOrFloatingSibling()) {
123                 layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*nextSibling, layoutContext.createDisplayBox(*nextSibling)}));
124                 break;
125             }
126         }
127     }
128     // Place the inflow positioned children.
129     placeInFlowPositionedChildren(layoutContext, formattingRoot);
130     LOG_WITH_STREAM(FormattingContextLayout, stream << "[End] -> block formatting context -> layout context(" << &layoutContext << ") formatting root(" << &root() << ")");
131 }
132
133 void BlockFormattingContext::layoutFormattingContextRoot(LayoutContext& layoutContext, FloatingContext& floatingContext, FormattingState&, const Box& layoutBox, Display::Box& displayBox) const
134 {
135     // Start laying out this formatting root in the formatting contenxt it lives in.
136     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
137     computeStaticPosition(layoutContext, layoutBox, displayBox);
138     computeBorderAndPadding(layoutContext, layoutBox, displayBox);
139     computeWidthAndMargin(layoutContext, layoutBox, displayBox);
140
141     // Swich over to the new formatting context (the one that the root creates).
142     auto formattingContext = layoutContext.formattingContext(layoutBox);
143     formattingContext->layout(layoutContext, layoutContext.establishedFormattingState(layoutBox));
144
145     // Come back and finalize the root's geometry.
146     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
147     computeHeightAndMargin(layoutContext, layoutBox, displayBox);
148     if (layoutBox.isFloatingPositioned())
149         computeFloatingPosition(layoutContext, floatingContext, layoutBox, displayBox);
150     // Now that we computed the root's height, we can go back and layout the out-of-flow descedants (if any).
151     formattingContext->layoutOutOfFlowDescendants(layoutContext, layoutBox);
152 }
153
154 void BlockFormattingContext::computeStaticPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
155 {
156     displayBox.setTopLeft(Geometry::staticPosition(layoutContext, layoutBox));
157 }
158
159 void BlockFormattingContext::computeEstimatedMarginTop(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
160 {
161     auto estimatedMarginTop = MarginCollapse::estimatedMarginTop(layoutContext, layoutBox);
162     displayBox.setEstimatedMarginTop(estimatedMarginTop);
163     displayBox.moveVertically(estimatedMarginTop);
164 }
165
166 void BlockFormattingContext::computeEstimatedMarginTopForAncestors(LayoutContext& layoutContext, const Box& layoutBox) const
167 {
168     // We only need to estimate margin top for float related layout.
169     ASSERT(layoutBox.isFloatingPositioned() || layoutBox.hasFloatClear());
170
171     // In order to figure out whether a box should avoid a float, we need to know the final positions of both (ignore relative positioning for now).
172     // In block formatting context the final position for a normal flow box includes
173     // 1. the static position and
174     // 2. the corresponding (non)collapsed margins.
175     // Now the vertical margins are computed when all the descendants are finalized, because the margin values might be depending on the height of the box
176     // (and the height might be based on the content).
177     // So when we get to the point where we intersect the box with the float to decide if the box needs to move, we don't yet have the final vertical position.
178     //
179     // The idea here is that as long as we don't cross the block formatting context boundary, we should be able to pre-compute the final top margin.
180
181     for (auto* ancestor = layoutBox.containingBlock(); ancestor && !ancestor->establishesBlockFormattingContext(); ancestor = ancestor->containingBlock()) {
182         auto* displayBox = layoutContext.displayBoxForLayoutBox(*ancestor);
183         ASSERT(displayBox);
184         // FIXME: with incremental layout, we might actually have a valid (non-estimated) margin top as well.
185         if (displayBox->estimatedMarginTop())
186             return;
187
188         computeEstimatedMarginTop(layoutContext, *ancestor, *displayBox);
189     }
190 }
191
192 void BlockFormattingContext::computeFloatingPosition(LayoutContext& layoutContext, FloatingContext& floatingContext, const Box& layoutBox, Display::Box& displayBox) const
193 {
194     ASSERT(layoutBox.isFloatingPositioned());
195     // 8.3.1 Collapsing margins
196     // In block formatting context margins between a floated box and any other box do not collapse.
197     // Adjust the static position by using the previous inflow box's non-collapsed margin.
198     if (auto* previousInFlowBox = layoutBox.previousInFlowSibling()) {
199         auto& previousDisplayBox = *layoutContext.displayBoxForLayoutBox(*previousInFlowBox);
200         displayBox.moveVertically(previousDisplayBox.nonCollapsedMarginBottom() - previousDisplayBox.marginBottom());
201     }
202     computeEstimatedMarginTopForAncestors(layoutContext, layoutBox);
203     displayBox.setTopLeft(floatingContext.positionForFloat(layoutBox));
204     floatingContext.floatingState().append(layoutBox);
205 }
206
207 void BlockFormattingContext::computeVerticalPositionForFloatClear(LayoutContext& layoutContext, const FloatingContext& floatingContext, const Box& layoutBox, Display::Box& displayBox) const
208 {
209     ASSERT(layoutBox.hasFloatClear());
210     if (floatingContext.floatingState().isEmpty())
211         return;
212
213     computeEstimatedMarginTopForAncestors(layoutContext, layoutBox);
214     if (auto verticalPositionWithClearance = floatingContext.verticalPositionWithClearance(layoutBox))
215         displayBox.setTop(*verticalPositionWithClearance);
216 }
217
218 void BlockFormattingContext::computeInFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
219 {
220     displayBox.setTopLeft(Geometry::inFlowPositionedPosition(layoutContext, layoutBox));
221 }
222
223 void BlockFormattingContext::computeWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
224 {
225     if (layoutBox.isInFlow())
226         return computeInFlowWidthAndMargin(layoutContext, layoutBox, displayBox);
227
228     if (layoutBox.isFloatingPositioned())
229         return computeFloatingWidthAndMargin(layoutContext, layoutBox, displayBox);
230
231     ASSERT_NOT_REACHED();
232 }
233
234 void BlockFormattingContext::computeHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
235 {
236     if (layoutBox.isInFlow())
237         return computeInFlowHeightAndMargin(layoutContext, layoutBox, displayBox);
238
239     if (layoutBox.isFloatingPositioned())
240         return computeFloatingHeightAndMargin(layoutContext, layoutBox, displayBox);
241
242     ASSERT_NOT_REACHED();
243 }
244
245 void BlockFormattingContext::computeInFlowHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
246 {
247     auto heightAndMargin = Geometry::inFlowHeightAndMargin(layoutContext, layoutBox);
248     displayBox.setContentBoxHeight(heightAndMargin.height);
249     auto marginValue = heightAndMargin.collapsedMargin.value_or(heightAndMargin.margin);
250     displayBox.setVerticalMargin(marginValue);
251     displayBox.setVerticalNonCollapsedMargin(heightAndMargin.margin);
252
253     // This box has already been moved by the estimated vertical margin. No need to move it again.
254     if (!displayBox.estimatedMarginTop())
255         displayBox.moveVertically(marginValue.top);
256 }
257
258 void BlockFormattingContext::computeInFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
259 {
260     auto widthAndMargin = Geometry::inFlowWidthAndMargin(layoutContext, layoutBox);
261     displayBox.setContentBoxWidth(widthAndMargin.width);
262     displayBox.moveHorizontally(widthAndMargin.margin.left);
263     displayBox.setHorizontalMargin(widthAndMargin.margin);
264 }
265
266 FormattingContext::InstrinsicWidthConstraints BlockFormattingContext::instrinsicWidthConstraints(LayoutContext& layoutContext, const Box& layoutBox) const
267 {
268     auto& formattingState = layoutContext.formattingStateForBox(layoutBox);
269     ASSERT(formattingState.isBlockFormattingState());
270     if (auto instrinsicWidthConstraints = formattingState.instrinsicWidthConstraints(layoutBox))
271         return *instrinsicWidthConstraints;
272
273     // Can we just compute them without checking the children?
274     if (!Geometry::instrinsicWidthConstraintsNeedChildrenWidth(layoutBox)) {
275         auto instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutContext, layoutBox);
276         formattingState.setInstrinsicWidthConstraints(layoutBox, instrinsicWidthConstraints);
277         return instrinsicWidthConstraints;
278     }
279
280     // Visit the in-flow descendants and compute their min/max intrinsic width if needed.
281     // 1. Go all the way down to the leaf node
282     // 2. Check if actually need to visit all the boxes as we traverse down (already computed, container's min/max does not depend on descendants etc)
283     // 3. As we climb back on the tree, compute min/max intrinsic width
284     // (Any subtrees with new formatting contexts need to layout synchronously)
285     Vector<const Box*> queue;
286     // Non-containers early return.
287     ASSERT(is<Container>(layoutBox));
288     if (auto* firstChild = downcast<Container>(layoutBox).firstInFlowOrFloatingChild())
289         queue.append(firstChild);
290
291     auto& formattingStateForChildren = layoutBox.establishesFormattingContext() ? layoutContext.establishedFormattingState(layoutBox) : formattingState;
292     while (!queue.isEmpty()) {
293         while (true) {
294             auto& childBox = *queue.last(); 
295             // Already computed?
296             auto instrinsicWidthConstraints = formattingStateForChildren.instrinsicWidthConstraints(childBox);
297             // Can we just compute them without checking the children?
298             if (!instrinsicWidthConstraints && !Geometry::instrinsicWidthConstraintsNeedChildrenWidth(childBox))
299                 instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutContext, childBox);
300             // Is it a formatting context root?
301             if (!instrinsicWidthConstraints && childBox.establishesFormattingContext())
302                 instrinsicWidthConstraints = layoutContext.formattingContext(childBox)->instrinsicWidthConstraints(layoutContext, childBox);
303             // Go to the next sibling (and skip the descendants) if this box's min/max width is computed.
304             if (instrinsicWidthConstraints) {
305                 formattingStateForChildren.setInstrinsicWidthConstraints(childBox, *instrinsicWidthConstraints); 
306                 queue.removeLast();
307                 if (!childBox.nextInFlowOrFloatingSibling())
308                     break;
309                 queue.append(childBox.nextInFlowOrFloatingSibling());
310                 continue;
311             }
312
313             if (!is<Container>(childBox) || !downcast<Container>(childBox).hasInFlowOrFloatingChild())
314                 break;
315
316             queue.append(downcast<Container>(childBox).firstInFlowOrFloatingChild());
317         }
318
319         // Compute min/max intrinsic width bottom up.
320         while (!queue.isEmpty()) {
321             auto& childBox = *queue.takeLast();
322             formattingStateForChildren.setInstrinsicWidthConstraints(childBox, Geometry::instrinsicWidthConstraints(layoutContext, childBox)); 
323             // Move over to the next sibling or take the next box in the queue.
324             if (!is<Container>(childBox) || !downcast<Container>(childBox).nextInFlowOrFloatingSibling())
325                 continue;
326             queue.append(downcast<Container>(childBox).nextInFlowOrFloatingSibling());
327         }
328     }
329
330     auto instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutContext, layoutBox);
331     formattingState.setInstrinsicWidthConstraints(layoutBox, instrinsicWidthConstraints); 
332     return instrinsicWidthConstraints;
333 }
334
335 }
336 }
337
338 #endif