[LFC] Add Display::Box::nonCollapsedMarginBox for verification purposes.
[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 }
62
63 void FormattingContext::computeFloatingWidthAndMargin(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
64 {
65     auto widthAndMargin = Geometry::floatingWidthAndMargin(layoutContext, layoutBox);
66     displayBox.setContentBoxWidth(widthAndMargin.width);
67     displayBox.moveHorizontally(widthAndMargin.margin.left);
68     displayBox.setHorizontalMargin(widthAndMargin.margin);
69 }
70
71 void FormattingContext::computeOutOfFlowHorizontalGeometry(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
72 {
73     auto horizontalGeometry = Geometry::outOfFlowHorizontalGeometry(layoutContext, layoutBox);
74     displayBox.setLeft(horizontalGeometry.left);
75     displayBox.setContentBoxWidth(horizontalGeometry.widthAndMargin.width);
76     displayBox.setHorizontalMargin(horizontalGeometry.widthAndMargin.margin);
77 }
78
79 void FormattingContext::computeOutOfFlowVerticalGeometry(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
80 {
81     auto verticalGeometry = Geometry::outOfFlowVerticalGeometry(layoutContext, layoutBox);
82     displayBox.setTop(verticalGeometry.top);
83     displayBox.setContentBoxHeight(verticalGeometry.bottom - verticalGeometry.top);
84     ASSERT(!verticalGeometry.heightAndMargin.collapsedMargin);
85     displayBox.setVerticalMargin(verticalGeometry.heightAndMargin.margin);
86 }
87
88 void FormattingContext::computeBorderAndPadding(LayoutContext& layoutContext, const Box& layoutBox, Display::Box& displayBox) const
89 {
90     displayBox.setBorder(Geometry::computedBorder(layoutContext, layoutBox));
91     if (auto padding = Geometry::computedPadding(layoutContext, layoutBox))
92         displayBox.setPadding(*padding);
93 }
94
95 void FormattingContext::placeInFlowPositionedChildren(LayoutContext& layoutContext, const Container& container) const
96 {
97     // If this container also establishes a formatting context, then positioning already has happend in that the formatting context.
98     if (container.establishesFormattingContext() && &container != &root())
99         return;
100
101     LOG_WITH_STREAM(FormattingContextLayout, stream << "Start: move in-flow positioned children -> context: " << &layoutContext << " parent: " << &container);
102     for (auto& layoutBox : childrenOfType<Box>(container)) {
103         if (!layoutBox.isInFlowPositioned())
104             continue;
105         computeInFlowPositionedPosition(layoutContext, layoutBox, *layoutContext.displayBoxForLayoutBox(layoutBox));
106     }
107     LOG_WITH_STREAM(FormattingContextLayout, stream << "End: move in-flow positioned children -> context: " << &layoutContext << " parent: " << &container);
108 }
109
110 void FormattingContext::layoutOutOfFlowDescendants(LayoutContext& layoutContext, const Box& layoutBox) const
111 {
112     // Initial containing block by definition is a containing block.
113     if (!layoutBox.isPositioned() && !layoutBox.isInitialContainingBlock())
114         return;
115
116     if (!is<Container>(layoutBox))
117         return;
118
119     auto& container = downcast<Container>(layoutBox);
120     if (!container.hasChild())
121         return;
122
123     LOG_WITH_STREAM(FormattingContextLayout, stream << "Start: layout out-of-flow descendants -> context: " << &layoutContext << " root: " << &root());
124
125     for (auto& outOfFlowBox : container.outOfFlowDescendants()) {
126         auto& layoutBox = *outOfFlowBox;
127         auto& displayBox = layoutContext.createDisplayBox(layoutBox);
128
129         // The term "static position" (of an element) refers, roughly, to the position an element would have had in the normal flow.
130         // More precisely, the static position for 'top' is the distance from the top edge of the containing block to the top margin edge
131         // of a hypothetical box that would have been the first box of the element if its specified 'position' value had been 'static' and
132         // its specified 'float' had been 'none' and its specified 'clear' had been 'none'.
133         computeBorderAndPadding(layoutContext, layoutBox, displayBox);
134         computeOutOfFlowHorizontalGeometry(layoutContext, layoutBox, displayBox);
135
136         ASSERT(layoutBox.establishesFormattingContext());
137         auto formattingContext = layoutContext.formattingContext(layoutBox);
138         formattingContext->layout(layoutContext, layoutContext.establishedFormattingState(layoutBox, *formattingContext));
139
140         computeOutOfFlowVerticalGeometry(layoutContext, layoutBox, displayBox);
141         layoutOutOfFlowDescendants(layoutContext, layoutBox);
142     }
143     LOG_WITH_STREAM(FormattingContextLayout, stream << "End: layout out-of-flow descendants -> context: " << &layoutContext << " root: " << &root());
144 }
145
146 #ifndef NDEBUG
147 void FormattingContext::validateGeometryConstraintsAfterLayout(const LayoutContext& layoutContext) const
148 {
149     if (!is<Container>(root()))
150         return;
151     auto& formattingContextRoot = downcast<Container>(root());
152     // FIXME: add a descendantsOfType<> flavor that stops at nested formatting contexts
153     for (auto& layoutBox : descendantsOfType<Box>(formattingContextRoot)) {
154         if (&layoutBox.formattingContextRoot() != &formattingContextRoot)
155             continue;
156         auto& containingBlockDisplayBox = *layoutContext.displayBoxForLayoutBox(*layoutBox.containingBlock());
157         auto* displayBox = layoutContext.displayBoxForLayoutBox(layoutBox);
158         ASSERT(displayBox);
159
160         // 10.3.3 Block-level, non-replaced elements in normal flow
161         // 10.3.7 Absolutely positioned, non-replaced elements
162         if ((layoutBox.isBlockLevelBox() || layoutBox.isOutOfFlowPositioned()) && !layoutBox.replaced()) {
163             // margin-left + border-left-width + padding-left + width + padding-right + border-right-width + margin-right = width of containing block
164             auto containingBlockWidth = containingBlockDisplayBox.contentBoxWidth();
165             ASSERT(displayBox->marginLeft() + displayBox->borderLeft() + displayBox->paddingLeft() + displayBox->contentBoxWidth()
166                 + displayBox->paddingRight() + displayBox->borderRight() + displayBox->marginRight() == containingBlockWidth);
167         }
168
169         // 10.6.4 Absolutely positioned, non-replaced elements
170         if (layoutBox.isOutOfFlowPositioned() && !layoutBox.replaced()) {
171             // top + margin-top + border-top-width + padding-top + height + padding-bottom + border-bottom-width + margin-bottom + bottom = height of containing block
172             auto containingBlockHeight = containingBlockDisplayBox.contentBoxHeight();
173             ASSERT(displayBox->top() + displayBox->marginTop() + displayBox->borderTop() + displayBox->paddingTop() + displayBox->contentBoxHeight()
174                 + displayBox->paddingBottom() + displayBox->borderBottom() + displayBox->marginBottom() == containingBlockHeight);
175         }
176     }
177 }
178 #endif
179
180 }
181 }
182 #endif