[LFC][Floating] Remove redundant FloatAvoider functions.
[WebKit-https.git] / Source / WebCore / layout / floats / FloatingContext.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 "FloatingContext.h"
28
29 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
30
31 #include "DisplayBox.h"
32 #include "FloatAvoider.h"
33 #include "LayoutBox.h"
34 #include "LayoutContainer.h"
35 #include "LayoutContext.h"
36 #include <wtf/IsoMallocInlines.h>
37
38 namespace WebCore {
39 namespace Layout {
40
41 WTF_MAKE_ISO_ALLOCATED_IMPL(FloatingContext);
42
43 // Finding the top/left position for a new floating(F)
44 //  ____  ____  _____               _______
45 // |    || L2 ||     | <-----1---->|       |
46 // |    ||____||  L3 |             |   R1  |
47 // | L1 |      |_____|             |       |
48 // |____| <-------------2--------->|       |
49 //                                 |       |
50 //                                 |_______|
51 //
52 // 1. Compute the initial vertical position for (F) -> (1)
53 // 2. Find the corresponding floating pair (L3-R1)
54 // 3. Align (F) horizontally with (L3-R1) depending whether (F) is left/right positioned
55 // 4. Intersect (F) with (L3-R1)
56 // 5. If (F) does not fit, find the next floating pair (L1-R1)
57 // 6. Repeat until either (F) fits/no more floats.
58 // Note that all coordinates are in the coordinate system of the formatting root.
59 // The formatting root here is always the one that establishes the floating context (see inherited floating context).
60 // (It simply means that the float box's formatting root is not necessarily the same as the FormattingContext's root.)
61
62 class Iterator;
63
64 class FloatingPair {
65 public:
66     bool isEmpty() const { return !m_leftIndex && !m_rightIndex; }
67     const FloatingState::FloatItem* left() const;
68     const FloatingState::FloatItem* right() const;
69     bool intersects(const Display::Box::Rect&) const;
70     PositionInContextRoot verticalConstraint() const { return m_verticalPosition; }
71     FloatAvoider::HorizontalConstraints horizontalConstraints() const;
72     PositionInContextRoot bottom() const;
73     bool operator==(const FloatingPair&) const;
74
75 private:
76     friend class Iterator;
77     FloatingPair(const FloatingState::FloatList&);
78
79     const FloatingState::FloatList& m_floats;
80
81     std::optional<unsigned> m_leftIndex;
82     std::optional<unsigned> m_rightIndex;
83     PositionInContextRoot m_verticalPosition;
84 };
85
86 class Iterator {
87 public:
88     Iterator(const FloatingState::FloatList&, std::optional<PositionInContextRoot> verticalPosition);
89
90     const FloatingPair& operator*() const { return m_current; }
91     Iterator& operator++();
92     bool operator==(const Iterator&) const;
93     bool operator!=(const Iterator&) const;
94
95 private:
96     void set(PositionInContextRoot verticalPosition);
97
98     const FloatingState::FloatList& m_floats;
99     FloatingPair m_current;
100 };
101
102 static Iterator begin(const FloatingState& floatingState, PositionInContextRoot initialVerticalPosition)
103 {
104     // Start with the inner-most floating pair for the initial vertical position.
105     return Iterator(floatingState.floats(), initialVerticalPosition);
106 }
107
108 static Iterator end(const FloatingState& floatingState)
109 {
110     return Iterator(floatingState.floats(), std::nullopt);
111 }
112
113 FloatingContext::FloatingContext(FloatingState& floatingState)
114     : m_floatingState(floatingState)
115 {
116 }
117
118 PointInContainingBlock FloatingContext::positionForFloat(const Box& layoutBox) const
119 {
120     ASSERT(layoutBox.isFloatingPositioned());
121
122     if (m_floatingState.isEmpty()) {
123         auto& displayBox = *layoutContext().displayBoxForLayoutBox(layoutBox);
124
125         auto alignWithContainingBlock = [&]() -> PositionInContainingBlock {
126             // If there is no floating to align with, push the box to the left/right edge of its containing block's content box.
127             auto& containingBlockDisplayBox = *layoutContext().displayBoxForLayoutBox(*layoutBox.containingBlock());
128
129             if (layoutBox.isLeftFloatingPositioned())
130                 return containingBlockDisplayBox.contentBoxLeft() + displayBox.marginLeft();
131
132             return containingBlockDisplayBox.contentBoxRight() - displayBox.marginRight() - displayBox.width();
133         };
134
135         // No float box on the context yet -> align it with the containing block's left/right edge.
136         return { alignWithContainingBlock(), displayBox.top() };
137     }
138
139     // Find the top most position where the float box fits.
140     FloatAvoider alignedBox = { layoutBox, m_floatingState, layoutContext() };
141     floatingPosition(alignedBox);
142     return alignedBox.rectInContainingBlock().topLeft();
143 }
144
145 std::optional<PositionInContainingBlock> FloatingContext::verticalPositionWithClearance(const Box& layoutBox) const
146 {
147     ASSERT(layoutBox.hasFloatClear());
148     ASSERT(layoutBox.isBlockLevelBox());
149
150     if (m_floatingState.isEmpty())
151         return { };
152
153     auto bottom = [&](std::optional<PositionInContextRoot> floatBottom) -> std::optional<PositionInContainingBlock> {
154         // 'bottom' is in the formatting root's coordinate system.
155         if (!floatBottom)
156             return { };
157
158         // 9.5.2 Controlling flow next to floats: the 'clear' property
159         // Then the amount of clearance is set to the greater of:
160         //
161         // 1. The amount necessary to place the border edge of the block even with the bottom outer edge of the lowest float that is to be cleared.
162         // 2. The amount necessary to place the top border edge of the block at its hypothetical position.
163
164         auto& layoutContext = this->layoutContext();
165         auto& displayBox = *layoutContext.displayBoxForLayoutBox(layoutBox);
166         auto rootRelativeTop = FormattingContext::mapTopLeftToAncestor(layoutContext, layoutBox, downcast<Container>(m_floatingState.root())).y;
167         auto clearance = *floatBottom - rootRelativeTop;
168         if (clearance <= 0)
169             return { };
170
171         // Clearance inhibits margin collapsing. Let's reset the relevant adjoining margins.
172         if (auto* previousInFlowSibling = layoutBox.previousInFlowSibling()) {
173             auto& previousInFlowDisplayBox = *layoutContext.displayBoxForLayoutBox(*previousInFlowSibling);
174
175             // Since the previous inflow sibling has already been laid out, its margin is collapsed by now.
176             ASSERT(!previousInFlowDisplayBox.marginBottom());
177             auto collapsedMargin = displayBox.marginTop();
178
179             // Reset previous bottom and current top margins to non-collapsing.
180             previousInFlowDisplayBox.setVerticalMargin({ previousInFlowDisplayBox.marginTop(), previousInFlowDisplayBox.nonCollapsedMarginBottom() });
181             displayBox.setVerticalMargin({ displayBox.nonCollapsedMarginTop(), displayBox.marginBottom() });
182
183             auto nonCollapsedMargin = previousInFlowDisplayBox.marginBottom() + displayBox.marginTop();
184             auto marginOffset = nonCollapsedMargin - collapsedMargin;
185             // Move the box to the position where it would be with non-collapsed margins.
186             rootRelativeTop += marginOffset;
187
188             // Having negative clearance is also normal. It just means that the box with the non-collapsed margins is now lower than it needs to be.
189             clearance -= marginOffset;
190         }
191         // Now adjust the box's position with the clearance.
192         rootRelativeTop += clearance;
193         ASSERT(*floatBottom == rootRelativeTop);
194
195         // The return vertical position is in the containing block's coordinate system.
196         auto containingBlockRootRelativeTop = FormattingContext::mapTopLeftToAncestor(layoutContext, *layoutBox.containingBlock(), downcast<Container>(m_floatingState.root())).y;
197         return rootRelativeTop - containingBlockRootRelativeTop;
198     };
199
200     auto clear = layoutBox.style().clear();
201     auto& formattingContextRoot = layoutBox.formattingContextRoot();
202
203     if (clear == Clear::Left)
204         return bottom(m_floatingState.leftBottom(formattingContextRoot));
205
206     if (clear == Clear::Right)
207         return bottom(m_floatingState.rightBottom(formattingContextRoot));
208
209     if (clear == Clear::Both)
210         return bottom(m_floatingState.bottom(formattingContextRoot));
211
212     ASSERT_NOT_REACHED();
213     return { };
214 }
215
216 void FloatingContext::floatingPosition(FloatAvoider& floatAvoider) const
217 {
218     std::optional<PositionInContextRoot> bottomMost;
219     auto end = Layout::end(m_floatingState);
220     for (auto iterator = begin(m_floatingState, floatAvoider.rect().top()); iterator != end; ++iterator) {
221         ASSERT(!(*iterator).isEmpty());
222         auto floats = *iterator;
223
224         // Move the box horizontally so that it either
225         // 1. aligns with the current floating pair
226         // 2. or with the containing block's content box if there's no float to align with at this vertical position.
227         floatAvoider.setHorizontalConstraints(floats.horizontalConstraints());
228         floatAvoider.setVerticalConstraint(floats.verticalConstraint());
229         // Check if the box fits at this position.
230         if (!floats.intersects(floatAvoider.rect()))
231             return;
232
233         bottomMost = floats.bottom();
234         // Move to the next floating pair.
235     }
236
237     // The candidate box is already below of all the floats.
238     if (!bottomMost)
239         return;
240
241     // Passed all the floats and still does not fit? Push it below the last float.
242     floatAvoider.setVerticalConstraint(*bottomMost);
243     floatAvoider.setHorizontalConstraints({ });
244 }
245
246 FloatingPair::FloatingPair(const FloatingState::FloatList& floats)
247     : m_floats(floats)
248 {
249 }
250
251 const FloatingState::FloatItem* FloatingPair::left() const
252 {
253     if (!m_leftIndex)
254         return nullptr;
255
256     ASSERT(m_floats[*m_leftIndex].isLeftPositioned());
257     return &m_floats[*m_leftIndex];
258 }
259
260 const FloatingState::FloatItem* FloatingPair::right() const
261 {
262     if (!m_rightIndex)
263         return nullptr;
264
265     ASSERT(!m_floats[*m_rightIndex].isLeftPositioned());
266     return &m_floats[*m_rightIndex];
267 }
268
269 bool FloatingPair::intersects(const Display::Box::Rect& candidateRect) const
270 {
271     auto intersects = [&](const FloatingState::FloatItem* floating, Float floatingType) {
272         if (!floating)
273             return false;
274
275         auto marginRect = floating->rectWithMargin();
276         // Before intersecting, check if the candidate position is too far to the left/right.
277         // The new float's containing block could push the candidate position beyond the current float horizontally.
278         if ((floatingType == Float::Left && candidateRect.left() < marginRect.right())
279             || (floatingType == Float::Right && candidateRect.right() > marginRect.left()))
280             return true;
281         return marginRect.intersects(candidateRect);
282     };
283
284     if (!m_leftIndex && !m_rightIndex) {
285         ASSERT_NOT_REACHED();
286         return false;
287     }
288
289     if (intersects(left(), Float::Left))
290         return true;
291
292     if (intersects(right(), Float::Right))
293         return true;
294
295     return false;
296 }
297
298 bool FloatingPair::operator ==(const FloatingPair& other) const
299 {
300     return m_leftIndex == other.m_leftIndex && m_rightIndex == other.m_rightIndex;
301 }
302
303 FloatAvoider::HorizontalConstraints FloatingPair::horizontalConstraints() const
304 {
305     std::optional<PositionInContextRoot> leftEdge;
306     std::optional<PositionInContextRoot> rightEdge;
307
308     if (left())
309         leftEdge = left()->rectWithMargin().right();
310
311     if (right())
312         rightEdge = right()->rectWithMargin().left();
313
314     return { leftEdge, rightEdge };
315 }
316
317 PositionInContextRoot FloatingPair::bottom() const
318 {
319     auto* left = this->left();
320     auto* right = this->right();
321     ASSERT(left || right);
322
323     auto leftBottom = left ? std::optional<PositionInContextRoot>(left->rectWithMargin().bottom()) : std::nullopt;
324     auto rightBottom = right ? std::optional<PositionInContextRoot>(right->rectWithMargin().bottom()) : std::nullopt;
325
326     if (leftBottom && rightBottom)
327         return std::max(*leftBottom, *rightBottom);
328
329     if (leftBottom)
330         return *leftBottom;
331
332     return *rightBottom;
333 }
334
335 Iterator::Iterator(const FloatingState::FloatList& floats, std::optional<PositionInContextRoot> verticalPosition)
336     : m_floats(floats)
337     , m_current(floats)
338 {
339     if (verticalPosition)
340         set(*verticalPosition);
341 }
342
343 inline static std::optional<unsigned> previousFloatingIndex(Float floatingType, const FloatingState::FloatList& floats, unsigned currentIndex)
344 {
345     RELEASE_ASSERT(currentIndex <= floats.size());
346
347     while (currentIndex) {
348         auto& floating = floats[--currentIndex];
349         if ((floatingType == Float::Left && floating.isLeftPositioned()) || (floatingType == Float::Right && !floating.isLeftPositioned()))
350             return currentIndex;
351     }
352
353     return { };
354 }
355
356 Iterator& Iterator::operator++()
357 {
358     if (m_current.isEmpty()) {
359         ASSERT_NOT_REACHED();
360         return *this;
361     }
362
363     auto findPreviousFloatingWithLowerBottom = [&](Float floatingType, unsigned currentIndex) -> std::optional<unsigned> {
364
365         RELEASE_ASSERT(currentIndex < m_floats.size());
366
367         // Last floating? There's certainly no previous floating at this point.
368         if (!currentIndex)
369             return { };
370
371         auto currentBottom = m_floats[currentIndex].rectWithMargin().bottom();
372
373         std::optional<unsigned> index = currentIndex;
374         while (true) {
375             index = previousFloatingIndex(floatingType, m_floats, *index);
376             if (!index)
377                 return { };
378
379             if (m_floats[*index].rectWithMargin().bottom() > currentBottom)
380                 return index;
381         }
382
383         ASSERT_NOT_REACHED();
384         return { };
385     };
386
387     // 1. Take the current floating from left and right and check which one's bottom edge is positioned higher (they could be on the same vertical position too).
388     // The current floats from left and right are considered the inner-most pair for the current vertical position.
389     // 2. Move away from inner-most pair by picking one of the previous floats in the list(#1)
390     // Ensure that the new floating's bottom edge is positioned lower than the current one -which essentially means skipping in-between floats that are positioned higher).
391     // 3. Reset the vertical position and align it with the new left-right pair. These floats are now the inner-most boxes for the current vertical position.
392     // As the result we have more horizontal space on the current vertical position.
393     auto leftBottom = m_current.left() ? std::optional<PositionInContextRoot>(m_current.left()->bottom()) : std::nullopt;
394     auto rightBottom = m_current.right() ? std::optional<PositionInContextRoot>(m_current.right()->bottom()) : std::nullopt;
395
396     auto updateLeft = (leftBottom == rightBottom) || (!rightBottom || (leftBottom && leftBottom < rightBottom)); 
397     auto updateRight = (leftBottom == rightBottom) || (!leftBottom || (rightBottom && leftBottom > rightBottom)); 
398
399     if (updateLeft) {
400         ASSERT(m_current.m_leftIndex);
401         m_current.m_verticalPosition = *leftBottom;
402         m_current.m_leftIndex = findPreviousFloatingWithLowerBottom(Float::Left, *m_current.m_leftIndex);
403     }
404     
405     if (updateRight) {
406         ASSERT(m_current.m_rightIndex);
407         m_current.m_verticalPosition = *rightBottom;
408         m_current.m_rightIndex = findPreviousFloatingWithLowerBottom(Float::Right, *m_current.m_rightIndex);
409     }
410
411     return *this;
412 }
413
414 void Iterator::set(PositionInContextRoot verticalPosition)
415 {
416     // Move the iterator to the initial vertical position by starting at the inner-most floating pair (last floats on left/right).
417     // 1. Check if the inner-most pair covers the vertical position.
418     // 2. Move outwards from the inner-most pair until the vertical postion intersects.
419     // (Note that verticalPosition has already been adjusted with the top of the last float.)
420
421     m_current.m_verticalPosition = verticalPosition;
422     // No floats at all?
423     if (m_floats.isEmpty()) {
424         ASSERT_NOT_REACHED();
425
426         m_current.m_leftIndex = { };
427         m_current.m_rightIndex = { };
428         return;
429     }
430
431     auto findFloatingBelow = [&](Float floatingType) -> std::optional<unsigned> {
432
433         ASSERT(!m_floats.isEmpty());
434
435         auto index = floatingType == Float::Left ? m_current.m_leftIndex : m_current.m_rightIndex;
436         // Start from the end if we don't have current yet.
437         index = index.value_or(m_floats.size());
438         while (true) {
439             index = previousFloatingIndex(floatingType, m_floats, *index);
440             if (!index)
441                 return { };
442
443             auto bottom = m_floats[*index].rectWithMargin().bottom();
444             // Is this floating intrusive on this position?
445             if (bottom > verticalPosition)
446                 return index;
447         }
448
449         return { };
450     };
451
452     m_current.m_leftIndex = findFloatingBelow(Float::Left);
453     m_current.m_rightIndex = findFloatingBelow(Float::Right);
454
455     ASSERT(!m_current.m_leftIndex || (*m_current.m_leftIndex < m_floats.size() && m_floats[*m_current.m_leftIndex].isLeftPositioned()));
456     ASSERT(!m_current.m_rightIndex || (*m_current.m_rightIndex < m_floats.size() && !m_floats[*m_current.m_rightIndex].isLeftPositioned()));
457 }
458
459 bool Iterator::operator==(const Iterator& other) const
460 {
461     return m_current == other.m_current;
462 }
463
464 bool Iterator::operator!=(const Iterator& other) const
465 {
466     return !(*this == other);
467 }
468
469 }
470 }
471 #endif