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