[LFC] LayoutContext::displayBoxForLayoutBox() should return a Display::Box&
[WebKit-https.git] / Source / WebCore / layout / FormattingContext.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 "FormattingContext.h"
28
29 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
30
31 #include "DisplayBox.h"
32 #include "LayoutBox.h"
33 #include "LayoutContainer.h"
34 #include "LayoutContext.h"
35 #include "LayoutDescendantIterator.h"
36 #include "Logging.h"
37 #include <wtf/IsoMallocInlines.h>
38 #include <wtf/text/TextStream.h>
39
40 namespace WebCore {
41 namespace Layout {
42
43 WTF_MAKE_ISO_ALLOCATED_IMPL(FormattingContext);
44
45 FormattingContext::FormattingContext(const Box& formattingContextRoot)
46     : m_root(makeWeakPtr(const_cast<Box&>(formattingContextRoot)))
47 {
48 }
49
50 FormattingContext::~FormattingContext()
51 {
52 }
53
54 void FormattingContext::computeOutOfFlowHorizontalGeometry(LayoutContext& layoutContext, const Box& layoutBox) const
55 {
56     auto horizontalGeometry = Geometry::outOfFlowHorizontalGeometry(layoutContext, *this, layoutBox);
57
58     auto& displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
59     displayBox.setLeft(horizontalGeometry.left + horizontalGeometry.widthAndMargin.margin.left);
60     displayBox.setContentBoxWidth(horizontalGeometry.widthAndMargin.width);
61     displayBox.setHorizontalMargin(horizontalGeometry.widthAndMargin.margin);
62     displayBox.setHorizontalNonComputedMargin(horizontalGeometry.widthAndMargin.nonComputedMargin);
63 }
64
65 void FormattingContext::computeOutOfFlowVerticalGeometry(LayoutContext& layoutContext, const Box& layoutBox) const
66 {
67     auto verticalGeometry = Geometry::outOfFlowVerticalGeometry(layoutContext, layoutBox);
68
69     auto& displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
70     displayBox.setTop(verticalGeometry.top + verticalGeometry.heightAndMargin.margin.top);
71     displayBox.setContentBoxHeight(verticalGeometry.heightAndMargin.height);
72     ASSERT(!verticalGeometry.heightAndMargin.collapsedMargin);
73     displayBox.setVerticalMargin(verticalGeometry.heightAndMargin.margin);
74     displayBox.setVerticalNonCollapsedMargin(verticalGeometry.heightAndMargin.margin);
75 }
76
77 void FormattingContext::computeBorderAndPadding(LayoutContext& layoutContext, const Box& layoutBox) const
78 {
79     auto& displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
80     displayBox.setBorder(Geometry::computedBorder(layoutContext, layoutBox));
81     displayBox.setPadding(Geometry::computedPadding(layoutContext, layoutBox));
82 }
83
84 void FormattingContext::placeInFlowPositionedChildren(LayoutContext& layoutContext, const Container& container) const
85 {
86     // If this container also establishes a formatting context, then positioning already has happend in that the formatting context.
87     if (container.establishesFormattingContext() && &container != &root())
88         return;
89
90     LOG_WITH_STREAM(FormattingContextLayout, stream << "Start: move in-flow positioned children -> context: " << &layoutContext << " parent: " << &container);
91     for (auto& layoutBox : childrenOfType<Box>(container)) {
92         if (!layoutBox.isInFlowPositioned())
93             continue;
94         computeInFlowPositionedPosition(layoutContext, layoutBox);
95     }
96     LOG_WITH_STREAM(FormattingContextLayout, stream << "End: move in-flow positioned children -> context: " << &layoutContext << " parent: " << &container);
97 }
98
99 void FormattingContext::layoutOutOfFlowDescendants(LayoutContext& layoutContext, const Box& layoutBox) const
100 {
101     // Initial containing block by definition is a containing block.
102     if (!layoutBox.isPositioned() && !layoutBox.isInitialContainingBlock())
103         return;
104
105     if (!is<Container>(layoutBox))
106         return;
107
108     auto& container = downcast<Container>(layoutBox);
109     if (!container.hasChild())
110         return;
111
112     LOG_WITH_STREAM(FormattingContextLayout, stream << "Start: layout out-of-flow descendants -> context: " << &layoutContext << " root: " << &root());
113
114     for (auto& outOfFlowBox : container.outOfFlowDescendants()) {
115         auto& layoutBox = *outOfFlowBox;
116         layoutContext.createDisplayBox(layoutBox);
117
118         ASSERT(layoutBox.establishesFormattingContext());
119         auto formattingContext = layoutContext.formattingContext(layoutBox);
120
121         computeBorderAndPadding(layoutContext, layoutBox);
122         computeOutOfFlowHorizontalGeometry(layoutContext, layoutBox);
123
124         formattingContext->layout(layoutContext, layoutContext.establishedFormattingState(layoutBox));
125
126         computeOutOfFlowVerticalGeometry(layoutContext, layoutBox);
127         layoutOutOfFlowDescendants(layoutContext, layoutBox);
128     }
129     LOG_WITH_STREAM(FormattingContextLayout, stream << "End: layout out-of-flow descendants -> context: " << &layoutContext << " root: " << &root());
130 }
131
132 Display::Box FormattingContext::mapBoxToAncestor(const LayoutContext& layoutContext, const Box& layoutBox, const Container& ancestor)
133 {
134     ASSERT(layoutBox.isDescendantOf(ancestor));
135
136     auto& displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
137     auto topLeft = displayBox.topLeft();
138
139     auto* containingBlock = layoutBox.containingBlock();
140     for (; containingBlock && containingBlock != &ancestor; containingBlock = containingBlock->containingBlock())
141         topLeft.moveBy(layoutContext.displayBoxForLayoutBox(*containingBlock).topLeft());
142
143     if (!containingBlock) {
144         ASSERT_NOT_REACHED();
145         return Display::Box(displayBox);
146     }
147
148     auto mappedDisplayBox = Display::Box(displayBox);
149     mappedDisplayBox.setTopLeft(topLeft);
150     return mappedDisplayBox;
151 }
152
153 Position FormattingContext::mapTopLeftToAncestor(const LayoutContext& layoutContext, const Box& layoutBox, const Container& ancestor)
154 {
155     ASSERT(layoutBox.isDescendantOf(ancestor));
156     return mapCoordinateToAncestor(layoutContext, layoutContext.displayBoxForLayoutBox(layoutBox).topLeft(), *layoutBox.containingBlock(), ancestor);
157 }
158
159 Position FormattingContext::mapCoordinateToAncestor(const LayoutContext& layoutContext, Position position, const Container& containingBlock, const Container& ancestor)
160 {
161     auto mappedPosition = position;
162     auto* container = &containingBlock;
163     for (; container && container != &ancestor; container = container->containingBlock())
164         mappedPosition.moveBy(layoutContext.displayBoxForLayoutBox(*container).topLeft());
165
166     if (!container) {
167         ASSERT_NOT_REACHED();
168         return position;
169     }
170
171     return mappedPosition;
172 }
173
174 #ifndef NDEBUG
175 void FormattingContext::validateGeometryConstraintsAfterLayout(const LayoutContext& layoutContext) const
176 {
177     if (!is<Container>(root()))
178         return;
179     auto& formattingContextRoot = downcast<Container>(root());
180     // FIXME: add a descendantsOfType<> flavor that stops at nested formatting contexts
181     for (auto& layoutBox : descendantsOfType<Box>(formattingContextRoot)) {
182         if (&layoutBox.formattingContextRoot() != &formattingContextRoot)
183             continue;
184         auto& containingBlockDisplayBox = layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock());
185         auto& displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
186
187         // 10.3.3 Block-level, non-replaced elements in normal flow
188         // 10.3.7 Absolutely positioned, non-replaced elements
189         if ((layoutBox.isBlockLevelBox() || layoutBox.isOutOfFlowPositioned()) && !layoutBox.replaced()) {
190             // margin-left + border-left-width + padding-left + width + padding-right + border-right-width + margin-right = width of containing block
191             auto containingBlockWidth = containingBlockDisplayBox.contentBoxWidth();
192             ASSERT(displayBox.marginLeft() + displayBox.borderLeft() + displayBox.paddingLeft().value_or(0) + displayBox.contentBoxWidth()
193                 + displayBox.paddingRight().value_or(0) + displayBox.borderRight() + displayBox.marginRight() == containingBlockWidth);
194         }
195
196         // 10.6.4 Absolutely positioned, non-replaced elements
197         if (layoutBox.isOutOfFlowPositioned() && !layoutBox.replaced()) {
198             // top + margin-top + border-top-width + padding-top + height + padding-bottom + border-bottom-width + margin-bottom + bottom = height of containing block
199             auto containingBlockHeight = containingBlockDisplayBox.contentBoxHeight();
200             ASSERT(displayBox.top() + displayBox.marginTop() + displayBox.borderTop() + displayBox.paddingTop().value_or(0) + displayBox.contentBoxHeight()
201                 + displayBox.paddingBottom().value_or(0) + displayBox.borderBottom() + displayBox.marginBottom() == containingBlockHeight);
202         }
203     }
204 }
205 #endif
206
207 }
208 }
209 #endif