47bf590996e8997204e3b3e0d0de1b5397c30ce7
[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 "BlockMarginCollapse.h"
33 #include "DisplayBox.h"
34 #include "FloatingContext.h"
35 #include "FloatingState.h"
36 #include "LayoutBox.h"
37 #include "LayoutContainer.h"
38 #include "LayoutContext.h"
39 #include <wtf/IsoMallocInlines.h>
40
41 namespace WebCore {
42 namespace Layout {
43
44 WTF_MAKE_ISO_ALLOCATED_IMPL(BlockFormattingContext);
45
46 BlockFormattingContext::BlockFormattingContext(const Box& formattingContextRoot)
47     : FormattingContext(formattingContextRoot)
48 {
49 }
50
51 void BlockFormattingContext::layout(LayoutContext& layoutContext, FormattingState& formattingState) const
52 {
53     // 9.4.1 Block formatting contexts
54     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
55     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
56     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
57     if (!is<Container>(root()))
58         return;
59     auto& formattingRoot = downcast<Container>(root());
60     LayoutQueue layoutQueue;
61     FloatingContext floatingContext(formattingState.floatingState());
62     // This is a post-order tree traversal layout.
63     // 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.
64     if (auto* firstChild = formattingRoot.firstInFlowOrFloatingChild())
65         layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*firstChild, layoutContext.createDisplayBox(*firstChild)}));
66     // 1. Go all the way down to the leaf node
67     // 2. Compute static position and width as we traverse down
68     // 3. As we climb back on the tree, compute height and finialize position
69     // (Any subtrees with new formatting contexts need to layout synchronously)
70     while (!layoutQueue.isEmpty()) {
71         // Traverse down on the descendants and compute width/static position until we find a leaf node.
72         while (true) {
73             auto& layoutPair = *layoutQueue.last();
74             auto& layoutBox = layoutPair.layoutBox;
75             auto& displayBox = layoutPair.displayBox;
76             
77             computeWidth(layoutBox, displayBox);
78             computeStaticPosition(layoutContext, layoutBox, layoutPair.displayBox);
79             if (layoutBox.establishesFormattingContext()) {
80                 auto formattingContext = layoutContext.formattingContext(layoutBox);
81                 formattingContext->layout(layoutContext, layoutContext.establishedFormattingState(layoutBox, *formattingContext));
82                 break;
83             }
84             if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowOrFloatingChild())
85                 break;
86             auto& firstChild = *downcast<Container>(layoutBox).firstInFlowOrFloatingChild();
87             layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {firstChild, layoutContext.createDisplayBox(firstChild)}));
88         }
89
90         // Climb back on the ancestors and compute height/final position.
91         while (!layoutQueue.isEmpty()) {
92             // All inflow descendants (if there are any) are laid out by now. Let's compute the box's height.
93             auto layoutPair = layoutQueue.takeLast();
94             auto& layoutBox = layoutPair->layoutBox;
95             auto& displayBox = layoutPair->displayBox;
96
97             computeHeight(layoutBox, displayBox);
98             // Adjust position now that we have all the previous floats placed in this context -if needed.
99             floatingContext.computePosition(layoutBox, displayBox);
100             if (!is<Container>(layoutBox))
101                 continue;
102             auto& container = downcast<Container>(layoutBox);
103             // Move in-flow positioned children to their final position.
104             placeInFlowPositionedChildren(container);
105             if (auto* nextSibling = container.nextInFlowOrFloatingSibling()) {
106                 layoutQueue.append(std::make_unique<LayoutPair>(LayoutPair {*nextSibling, layoutContext.createDisplayBox(*nextSibling)}));
107                 break;
108             }
109         }
110     }
111     // Place the inflow positioned children.
112     placeInFlowPositionedChildren(formattingRoot);
113     // And take care of out-of-flow boxes as the final step.
114     layoutOutOfFlowDescendants(layoutContext);
115 }
116
117 std::unique_ptr<FormattingState> BlockFormattingContext::createFormattingState(Ref<FloatingState>&& floatingState) const
118 {
119     return std::make_unique<BlockFormattingState>(WTFMove(floatingState));
120 }
121
122 Ref<FloatingState> BlockFormattingContext::createOrFindFloatingState(LayoutContext&) const
123 {
124     // Block formatting context always establishes a new floating state.
125     return FloatingState::create();
126 }
127
128 void BlockFormattingContext::computeStaticPosition(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
129 {
130     // https://www.w3.org/TR/CSS22/visuren.html#block-formatting
131     // In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
132     // The vertical distance between two sibling boxes is determined by the 'margin' properties.
133     // Vertical margins between adjacent block-level boxes in a block formatting context collapse.
134     // 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).
135     auto containingBlockContentBox = layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock())->contentBox();
136     // Start from the top of the container's content box.
137     auto top = containingBlockContentBox.y();
138     auto left = containingBlockContentBox.x();
139     if (auto* previousInFlowSibling = layoutBox.previousInFlowSibling())
140         top = layoutContext.displayBoxForLayoutBox(*previousInFlowSibling)->bottom() + marginBottom(*previousInFlowSibling);
141     LayoutPoint topLeft = { top, left };
142     topLeft.moveBy({ marginLeft(layoutBox), marginTop(layoutBox) });
143     displayBox.setTopLeft(topLeft);
144 }
145
146 void BlockFormattingContext::computeInFlowWidth(const Box&, Display::Box&) const
147 {
148 }
149
150 void BlockFormattingContext::computeInFlowHeight(const Box&, Display::Box&) const
151 {
152 }
153
154 LayoutUnit BlockFormattingContext::marginTop(const Box& layoutBox) const
155 {
156     return BlockMarginCollapse::marginTop(layoutBox);
157 }
158
159 LayoutUnit BlockFormattingContext::marginBottom(const Box& layoutBox) const
160 {
161     return BlockMarginCollapse::marginBottom(layoutBox);
162 }
163
164 }
165 }
166
167 #endif