[LFC] Align compute functions styles.
[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             LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
82             computeStaticPosition(layoutContext, layoutBox, displayBox);
83             computeBorderAndPadding(layoutContext, layoutBox, displayBox);
84             computeWidthAndMargin(layoutContext, layoutBox, displayBox);
85             if (layoutBox.establishesFormattingContext()) {
86                 auto formattingContext = layoutContext.formattingContext(layoutBox);
87                 formattingContext->layout(layoutContext, layoutContext.establishedFormattingState(layoutBox, *formattingContext));
88                 break;
89             }
90             if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowOrFloatingChild())
91                 break;
92             auto& firstChild = *downcast<Container>(layoutBox).firstInFlowOrFloatingChild();
93             layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {firstChild, layoutContext.createDisplayBox(firstChild)}));
94         }
95
96         // Climb back on the ancestors and compute height/final position.
97         while (!layoutQueue.isEmpty()) {
98             // All inflow descendants (if there are any) are laid out by now. Let's compute the box's height.
99             auto layoutPair = layoutQueue.takeLast();
100             auto& layoutBox = layoutPair->layoutBox;
101             auto& displayBox = layoutPair->displayBox;
102             LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
103
104             computeHeightAndMargin(layoutContext, layoutBox, displayBox);
105             // Adjust position now that we have all the previous floats placed in this context -if needed.
106             floatingContext.computePosition(layoutBox, displayBox);
107             if (!is<Container>(layoutBox))
108                 continue;
109             auto& container = downcast<Container>(layoutBox);
110             // Move in-flow positioned children to their final position.
111             placeInFlowPositionedChildren(layoutContext, container);
112             if (auto* nextSibling = container.nextInFlowOrFloatingSibling()) {
113                 layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*nextSibling, layoutContext.createDisplayBox(*nextSibling)}));
114                 break;
115             }
116         }
117     }
118     // Place the inflow positioned children.
119     placeInFlowPositionedChildren(layoutContext, formattingRoot);
120     // And take care of out-of-flow boxes as the final step.
121     layoutOutOfFlowDescendants(layoutContext);
122 #ifndef NDEBUG
123     validateGeometryConstraintsAfterLayout(layoutContext);
124 #endif
125     LOG_WITH_STREAM(FormattingContextLayout, stream << "[End] -> block formatting context -> layout context(" << &layoutContext << ") formatting root(" << &root() << ")");
126 }
127
128 std::unique_ptr<FormattingState> BlockFormattingContext::createFormattingState(Ref<FloatingState>&& floatingState) const
129 {
130     return std::make_unique<BlockFormattingState>(WTFMove(floatingState));
131 }
132
133 Ref<FloatingState> BlockFormattingContext::createOrFindFloatingState(LayoutContext&) const
134 {
135     // Block formatting context always establishes a new floating state.
136     return FloatingState::create();
137 }
138
139 void BlockFormattingContext::computeStaticPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
140 {
141     displayBox.setTopLeft(Geometry::staticPosition(layoutContext, layoutBox));
142 }
143
144 void BlockFormattingContext::computeInFlowPositionedPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
145 {
146     displayBox.setTopLeft(Geometry::inFlowPositionedPosition(layoutContext, layoutBox));
147 }
148
149 void BlockFormattingContext::computeWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
150 {
151     if (layoutBox.isInFlow())
152         return computeInFlowWidthAndMargin(layoutContext, layoutBox, displayBox);
153
154     if (layoutBox.isFloatingPositioned())
155         return computeFloatingWidthAndMargin(layoutContext, layoutBox, displayBox);
156
157     ASSERT_NOT_REACHED();
158 }
159
160 void BlockFormattingContext::computeHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
161 {
162     if (layoutBox.isInFlow())
163         return computeInFlowHeightAndMargin(layoutContext, layoutBox, displayBox);
164
165     if (layoutBox.isFloatingPositioned())
166         return computeFloatingHeightAndMargin(layoutContext, layoutBox, displayBox);
167
168     ASSERT_NOT_REACHED();
169 }
170
171 void BlockFormattingContext::computeInFlowHeightAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
172 {
173     auto heightAndMargin = Geometry::inFlowHeightAndMargin(layoutContext, layoutBox);
174     displayBox.setHeight(heightAndMargin.height);
175     displayBox.moveVertically(heightAndMargin.margin.top);
176     displayBox.setVerticalMargin(heightAndMargin.margin);
177 }
178
179 void BlockFormattingContext::computeInFlowWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
180 {
181     auto widthAndMargin = Geometry::inFlowWidthAndMargin(layoutContext, layoutBox);
182     displayBox.setWidth(widthAndMargin.width);
183     displayBox.moveHorizontally(widthAndMargin.margin.left);
184     displayBox.setHorizontalMargin(widthAndMargin.margin);
185 }
186
187 }
188 }
189
190 #endif