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