[LFC] Layout::Box::containingBlock should return a const ContainerBox&
[WebKit-https.git] / Source / WebCore / layout / floats / FloatingState.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 "FloatingState.h"
28
29 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
30
31 #include "FormattingContext.h"
32 #include "LayoutBox.h"
33 #include "LayoutContainerBox.h"
34 #include "LayoutState.h"
35 #include <wtf/IsoMallocInlines.h>
36
37 namespace WebCore {
38 namespace Layout {
39
40 WTF_MAKE_ISO_ALLOCATED_IMPL(FloatingState);
41
42 FloatingState::FloatItem::FloatItem(const Box& layoutBox, Display::Box absoluteDisplayBox)
43     : m_layoutBox(makeWeakPtr(layoutBox))
44     , m_position(layoutBox.isLeftFloatingPositioned() ? Position::Left : Position::Right)
45     , m_absoluteDisplayBox(absoluteDisplayBox)
46 {
47 }
48
49 FloatingState::FloatItem::FloatItem(Position position, Display::Box absoluteDisplayBox)
50     : m_position(position)
51     , m_absoluteDisplayBox(absoluteDisplayBox)
52 {
53 }
54
55 FloatingState::FloatingState(LayoutState& layoutState, const ContainerBox& formattingContextRoot)
56     : m_layoutState(layoutState)
57     , m_formattingContextRoot(makeWeakPtr(formattingContextRoot))
58 {
59 }
60
61 void FloatingState::append(FloatItem floatItem)
62 {
63     ASSERT(is<ContainerBox>(*m_formattingContextRoot));
64
65     if (m_floats.isEmpty())
66         return m_floats.append(floatItem);
67
68     auto isLeftPositioned = floatItem.isLeftPositioned();
69     // When adding a new float item to the list, we have to ensure that it is definitely the left(right)-most item.
70     // Normally it is, but negative horizontal margins can push the float box beyond another float box.
71     // Float items in m_floats list should stay in horizontal position order (left/right edge) on the same vertical position.
72     auto horizontalMargin = floatItem.horizontalMargin();
73     auto hasNegativeHorizontalMargin = (isLeftPositioned && horizontalMargin.start < 0) || (!isLeftPositioned && horizontalMargin.end < 0);
74     if (!hasNegativeHorizontalMargin)
75         return m_floats.append(floatItem);
76
77     for (int i = m_floats.size() - 1; i >= 0; --i) {
78         auto& floatItem = m_floats[i];
79         if (isLeftPositioned != floatItem.isLeftPositioned())
80             continue;
81         if (floatItem.rectWithMargin().top() < floatItem.rectWithMargin().bottom())
82             continue;
83         if ((isLeftPositioned && floatItem.rectWithMargin().right() >= floatItem.rectWithMargin().right())
84             || (!isLeftPositioned && floatItem.rectWithMargin().left() <= floatItem.rectWithMargin().left()))
85             return m_floats.insert(i + 1, floatItem);
86     }
87     return m_floats.insert(0, floatItem);
88 }
89
90 Optional<PositionInContextRoot> FloatingState::bottom(const ContainerBox& formattingContextRoot, Clear type) const
91 {
92     if (m_floats.isEmpty())
93         return { };
94
95     // TODO: Currently this is only called once for each formatting context root with floats per layout.
96     // Cache the value if we end up calling it more frequently (and update it at append/remove).
97     Optional<PositionInContextRoot> bottom;
98     for (auto& floatItem : m_floats) {
99         // Ignore floats from ancestor formatting contexts when the floating state is inherited.
100         if (!floatItem.isInFormattingContextOf(formattingContextRoot))
101             continue;
102
103         if ((type == Clear::Left && !floatItem.isLeftPositioned())
104             || (type == Clear::Right && floatItem.isLeftPositioned()))
105             continue;
106
107         auto floatsBottom = floatItem.rectWithMargin().bottom();
108         if (bottom) {
109             bottom = std::max<PositionInContextRoot>(*bottom, { floatsBottom });
110             continue;
111         }
112         bottom = PositionInContextRoot { floatsBottom };
113     }
114     return bottom;
115 }
116
117 Optional<PositionInContextRoot> FloatingState::top(const ContainerBox& formattingContextRoot) const
118 {
119     if (m_floats.isEmpty())
120         return { };
121
122     Optional<PositionInContextRoot> top;
123     for (auto& floatItem : m_floats) {
124         // Ignore floats from ancestor formatting contexts when the floating state is inherited.
125         if (!floatItem.isInFormattingContextOf(formattingContextRoot))
126             continue;
127
128         auto floatTop = floatItem.rectWithMargin().top();
129         if (top) {
130             top = std::min<PositionInContextRoot>(*top, { floatTop });
131             continue;
132         }
133         top = PositionInContextRoot { floatTop };
134     }
135     return top;
136 }
137
138 }
139 }
140 #endif