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