[LFC] When the formatting root is also a containing block for out-of-flow elements.
[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, 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
114             computeHeightAndMargin(layoutContext, layoutBox, displayBox);
115             // Adjust position now that we have all the previous floats placed in this context -if needed.
116             floatingContext.computePosition(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             layoutOutOfFlowDescendants(layoutContext, container);
123             if (auto* nextSibling = container.nextInFlowOrFloatingSibling()) {
124                 layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*nextSibling, layoutContext.createDisplayBox(*nextSibling)}));
125                 break;
126             }
127         }
128     }
129     // Place the inflow positioned children.
130     placeInFlowPositionedChildren(layoutContext, formattingRoot);
131     LOG_WITH_STREAM(FormattingContextLayout, stream << "[End] -> block formatting context -> layout context(" << &layoutContext << ") formatting root(" << &root() << ")");
132 }
133
134 void BlockFormattingContext::layoutFormattingContextRoot(LayoutContext& layoutContext, FormattingState& formattingState, const Box& layoutBox, Display::Box& displayBox) const
135 {
136     // Start laying out this formatting root in the formatting contenxt it lives in.
137     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
138     computeStaticPosition(layoutContext, layoutBox, displayBox);
139     computeBorderAndPadding(layoutContext, layoutBox, displayBox);
140     computeWidthAndMargin(layoutContext, layoutBox, displayBox);
141
142     // Swich over to the new formatting context (the one that the root creates).
143     auto formattingContext = layoutContext.formattingContext(layoutBox);
144     auto& establishedFormattingState = layoutContext.establishedFormattingState(layoutBox, *formattingContext);
145     formattingContext->layout(layoutContext, establishedFormattingState);
146
147     // Come back and finalize the root's geometry.
148     FloatingContext(formattingState.floatingState()).computePosition(layoutBox, displayBox);
149     LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
150     computeHeightAndMargin(layoutContext, layoutBox, displayBox);
151     // Now that we computed the root's height, we can go back and layout the out-of-flow descedants (if any).
152     formattingContext->layoutOutOfFlowDescendants(layoutContext, layoutBox);
153 }
154
155 std::unique_ptr<FormattingState> BlockFormattingContext::createFormattingState(Ref<FloatingState>&& floatingState) const
156 {
157     return std::make_unique<BlockFormattingState>(WTFMove(floatingState));
158 }
159
160 Ref<FloatingState> BlockFormattingContext::createOrFindFloatingState(LayoutContext&) const
161 {
162     // Block formatting context always establishes a new floating state.
163     return FloatingState::create();
164 }
165
166 void BlockFormattingContext::computeStaticPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
167 {
168     displayBox.setTopLeft(Geometry::staticPosition(layoutContext, layoutBox));
169 }
170
171 void BlockFormattingContext::computeInFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
172 {
173     displayBox.setTopLeft(Geometry::inFlowPositionedPosition(layoutContext, layoutBox));
174 }
175
176 void BlockFormattingContext::computeWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
177 {
178     if (layoutBox.isInFlow())
179         return computeInFlowWidthAndMargin(layoutContext, layoutBox, displayBox);
180
181     if (layoutBox.isFloatingPositioned())
182         return computeFloatingWidthAndMargin(layoutContext, layoutBox, displayBox);
183
184     ASSERT_NOT_REACHED();
185 }
186
187 void BlockFormattingContext::computeHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
188 {
189     if (layoutBox.isInFlow())
190         return computeInFlowHeightAndMargin(layoutContext, layoutBox, displayBox);
191
192     if (layoutBox.isFloatingPositioned())
193         return computeFloatingHeightAndMargin(layoutContext, layoutBox, displayBox);
194
195     ASSERT_NOT_REACHED();
196 }
197
198 void BlockFormattingContext::computeInFlowHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
199 {
200     auto heightAndMargin = Geometry::inFlowHeightAndMargin(layoutContext, layoutBox);
201     displayBox.setContentBoxHeight(heightAndMargin.height);
202     displayBox.moveVertically(heightAndMargin.collapsedMargin.value_or(heightAndMargin.margin).top);
203     displayBox.setVerticalMargin(heightAndMargin.collapsedMargin.value_or(heightAndMargin.margin));
204     displayBox.setVerticalNonCollapsedMargin(heightAndMargin.margin);
205 }
206
207 void BlockFormattingContext::computeInFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
208 {
209     auto widthAndMargin = Geometry::inFlowWidthAndMargin(layoutContext, layoutBox);
210     displayBox.setContentBoxWidth(widthAndMargin.width);
211     displayBox.moveHorizontally(widthAndMargin.margin.left);
212     displayBox.setHorizontalMargin(widthAndMargin.margin);
213 }
214
215 }
216 }
217
218 #endif