[LFC][Floating] Remove redundant LayoutContext member variable.
[WebKit-https.git] / Source / WebCore / layout / 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 "LayoutBox.h"
33 #include "LayoutContainer.h"
34 #include "LayoutContext.h"
35 #include <wtf/IsoMallocInlines.h>
36
37 namespace WebCore {
38 namespace Layout {
39
40 WTF_MAKE_ISO_ALLOCATED_IMPL(FloatingContext);
41
42 // Finding the top/left position for a new floating(F)
43 //  ____  ____  _____               _______
44 // |    || L2 ||     | <-----1---->|       |
45 // |    ||____||  L3 |             |   R1  |
46 // | L1 |      |_____|             |       |
47 // |____| <-------------2--------->|       |
48 //                                 |       |
49 //                                 |_______|
50 //
51 // 1. Compute the initial vertical position for (F) -> (1)
52 // 2. Find the corresponding floating pair (L3-R1)
53 // 3. Align (F) horizontally with (L3-R1) depending whether (F) is left/right positioned
54 // 4. Intersect (F) with (L3-R1)
55 // 5. If (F) does not fit, find the next floating pair (L1-R1)
56 // 6. Repeat until either (F) fits/no more floats.
57 // Note that all coordinates are in the coordinate system of the formatting root.
58 // The formatting root here is always the one that establishes the floating context (see inherited floating context).
59 // (It simply means that the float box's formatting root is not necessarily the same as the FormattingContext's root.)
60
61 class Iterator;
62
63 class FloatingPair {
64 public:
65     bool isEmpty() const { return !m_leftIndex && !m_rightIndex; }
66     const Display::Box* left() const;
67     const Display::Box* right() const;
68     bool intersects(const Display::Box::Rect&) const;
69     LayoutUnit verticalPosition() const { return m_verticalPosition; }
70     LayoutUnit bottom() const;
71     bool operator==(const FloatingPair&) const;
72
73 private:
74     friend class Iterator;
75     FloatingPair(const FloatingState::FloatList&);
76
77     const FloatingState::FloatList& m_floats;
78
79     std::optional<unsigned> m_leftIndex;
80     std::optional<unsigned> m_rightIndex;
81     LayoutUnit m_verticalPosition;
82 };
83
84 class Iterator {
85 public:
86     Iterator(const FloatingState::FloatList&, std::optional<LayoutUnit> verticalPosition);
87
88     const FloatingPair& operator*() const { return m_current; }
89     Iterator& operator++();
90     bool operator==(const Iterator&) const;
91     bool operator!=(const Iterator&) const;
92
93 private:
94     void set(LayoutUnit verticalPosition);
95
96     const FloatingState::FloatList& m_floats;
97     FloatingPair m_current;
98 };
99
100 static Iterator begin(const FloatingState& floatingState, LayoutUnit initialVerticalPosition)
101 {
102     // Start with the inner-most floating pair for the initial vertical position.
103     return Iterator(floatingState.floats(), initialVerticalPosition);
104 }
105
106 static Iterator end(const FloatingState& floatingState)
107 {
108     return Iterator(floatingState.floats(), std::nullopt);
109 }
110
111 FloatingContext::FloatingContext(FloatingState& floatingState)
112     : m_floatingState(floatingState)
113 {
114 }
115
116 Position FloatingContext::computePosition(const Box& layoutBox) const
117 {
118     ASSERT(layoutBox.isFloatingPositioned());
119     FloatingState::FloatItem floatItem = { layoutBox, m_floatingState };
120
121     Position floatPosition;
122     if (m_floatingState.isEmpty()) {
123         // No float box on the context yet -> align it with the containing block's left/right edge.
124         auto& displayBox = floatItem.displayBox();
125         floatPosition = { alignWithContainingBlock(floatItem) + displayBox.marginLeft(), displayBox.top() };
126     } else {
127         // Find the top most position where the float box fits.
128         floatPosition = floatingPosition(floatItem);
129     }
130
131     return toContainingBlock(floatItem, floatPosition);
132 }
133
134 Position FloatingContext::floatingPosition(const FloatingState::FloatItem& floatItem) const
135 {
136     auto initialVerticalPosition = this->initialVerticalPosition(floatItem);
137     auto& displayBox = floatItem.displayBox();
138     auto marginBoxSize = displayBox.marginBox().size();
139
140     auto end = Layout::end(m_floatingState);
141     auto top = initialVerticalPosition;
142     auto bottomMost = top;
143     for (auto iterator = begin(m_floatingState, initialVerticalPosition); iterator != end; ++iterator) {
144         ASSERT(!(*iterator).isEmpty());
145
146         auto floats = *iterator;
147         top = floats.verticalPosition();
148
149         // Move the box horizontally so that it aligns with the current floating pair.
150         auto left = alignWithFloatings(floats, floatItem);
151         // Check if the box fits at this vertical position.
152         if (!floats.intersects({ top, left, marginBoxSize.width(), marginBoxSize.height() }))
153             return { left + displayBox.marginLeft(), top + displayBox.marginTop() };
154
155         bottomMost = floats.bottom();
156         // Move to the next floating pair.
157     }
158
159     // Passed all the floats and still does not fit?
160     return { alignWithContainingBlock(floatItem) + displayBox.marginLeft(), bottomMost + displayBox.marginTop() };
161 }
162
163 LayoutUnit FloatingContext::initialVerticalPosition(const FloatingState::FloatItem& floatItem) const
164 {
165     // Incoming floating cannot be placed higher than existing floats.
166     // Take the static position (where the box would go if it wasn't floating) and adjust it with the last floating.
167     auto marginBoxTop = floatItem.displayBox().rectWithMargin().top();
168
169     if (auto lastFloat = m_floatingState.last())
170         return std::max(marginBoxTop, lastFloat->displayBox().rectWithMargin().top());
171
172     return marginBoxTop;
173 }
174
175 LayoutUnit FloatingContext::alignWithContainingBlock(const FloatingState::FloatItem& floatItem) const
176 {
177     // If there is no floating to align with, push the box to the left/right edge of its containing block's content box.
178     // (Either there's no floats at all or this box does not fit at any vertical positions where the floats are.)
179     auto& containgBlockDisplayBox = floatItem.containingBlockDisplayBox();
180     auto containingBlockContentBoxLeft = containgBlockDisplayBox.left() + containgBlockDisplayBox.contentBoxLeft();
181
182     if (floatItem.layoutBox().isLeftFloatingPositioned())
183         return containingBlockContentBoxLeft;
184
185     return containingBlockContentBoxLeft + containgBlockDisplayBox.contentBoxWidth() - floatItem.displayBox().marginBox().width();
186 }
187
188 LayoutUnit FloatingContext::alignWithFloatings(const FloatingPair& floatingPair, const FloatingState::FloatItem& floatItem) const
189 {
190     // Compute the horizontal position for the new floating by taking both the contining block and the current left/right floats into account.
191     auto& containingBlockDisplayBox = floatItem.containingBlockDisplayBox();
192     auto containingBlockContentBoxLeft = containingBlockDisplayBox.left() + containingBlockDisplayBox.contentBoxLeft();
193     auto containingBlockContentBoxRight = containingBlockDisplayBox.left() + containingBlockDisplayBox.contentBoxRight();
194     auto marginBoxWidth = floatItem.displayBox().marginBox().width();
195
196     auto leftAlignedBoxLeft = containingBlockContentBoxLeft;
197     auto rightAlignedBoxLeft = containingBlockContentBoxRight - marginBoxWidth;
198
199     if (floatingPair.isEmpty()) {
200         ASSERT_NOT_REACHED();
201         return floatItem.layoutBox().isLeftFloatingPositioned() ? leftAlignedBoxLeft : rightAlignedBoxLeft;
202     }
203
204     if (floatItem.layoutBox().isLeftFloatingPositioned()) {
205         if (auto* leftDisplayBox = floatingPair.left()) {
206             auto leftFloatingBoxRight = leftDisplayBox->rectWithMargin().right();
207             return std::min(std::max(leftAlignedBoxLeft, leftFloatingBoxRight), rightAlignedBoxLeft);
208         }
209         
210         return leftAlignedBoxLeft;
211     }
212
213     ASSERT(floatItem.layoutBox().isRightFloatingPositioned());
214
215     if (auto* rightDisplayBox = floatingPair.right()) {
216         auto rightFloatingBoxLeft = rightDisplayBox->rectWithMargin().left();
217         return std::max(std::min(rightAlignedBoxLeft, rightFloatingBoxLeft - marginBoxWidth), leftAlignedBoxLeft);
218     }
219
220     return rightAlignedBoxLeft;
221 }
222
223 // FIXME: find a better place for this.
224 Position FloatingContext::toContainingBlock(const FloatingState::FloatItem& floatItem, Position position) const
225 {
226     // From formatting root coordinate system back to containing block's.
227     if (&floatItem.containingBlock() == &m_floatingState.root())
228         return position;
229
230     auto& containgBlockDisplayBox = floatItem.containingBlockDisplayBox();
231     return { position.x - containgBlockDisplayBox.left(), position.y - containgBlockDisplayBox.top() };
232 }
233
234 FloatingPair::FloatingPair(const FloatingState::FloatList& floats)
235     : m_floats(floats)
236 {
237 }
238
239 const Display::Box* FloatingPair::left() const
240 {
241     if (!m_leftIndex)
242         return nullptr;
243
244     ASSERT(m_floats[*m_leftIndex].layoutBox().isLeftFloatingPositioned());
245     return &m_floats[*m_leftIndex].displayBox();
246 }
247
248 const Display::Box* FloatingPair::right() const
249 {
250     if (!m_rightIndex)
251         return nullptr;
252
253     ASSERT(m_floats[*m_rightIndex].layoutBox().isRightFloatingPositioned());
254     return &m_floats[*m_rightIndex].displayBox();
255 }
256
257 bool FloatingPair::intersects(const Display::Box::Rect& candidateRect) const
258 {
259     auto intersects = [&](const Display::Box* floating, Float floatingType) {
260         if (!floating)
261             return false;
262
263         auto marginRect = floating->rectWithMargin();
264         // Before intersecting, check if the candidate position is too far to the left/right.
265         // The new float's containing block could push the candidate position beyond the current float horizontally.
266         if ((floatingType == Float::Left && candidateRect.left() < marginRect.right())
267             || (floatingType == Float::Right && candidateRect.right() > marginRect.left()))
268             return true;
269         return marginRect.intersects(candidateRect);
270     };
271
272     if (!m_leftIndex && !m_rightIndex) {
273         ASSERT_NOT_REACHED();
274         return false;
275     }
276
277     if (intersects(left(), Float::Left))
278         return true;
279
280     if (intersects(right(), Float::Right))
281         return true;
282
283     return false;
284 }
285
286 bool FloatingPair::operator ==(const FloatingPair& other) const
287 {
288     return m_leftIndex == other.m_leftIndex && m_rightIndex == other.m_rightIndex;
289 }
290
291 LayoutUnit FloatingPair::bottom() const
292 {
293     auto* left = this->left();
294     auto* right = this->right();
295     ASSERT(left || right);
296
297     auto leftBottom = left ? std::optional<LayoutUnit>(left->rectWithMargin().bottom()) : std::nullopt;
298     auto rightBottom = right ? std::optional<LayoutUnit>(right->rectWithMargin().bottom()) : std::nullopt;
299
300     if (leftBottom && rightBottom)
301         return std::max(*leftBottom, *rightBottom);
302
303     if (leftBottom)
304         return *leftBottom;
305
306     return *rightBottom;
307 }
308
309 Iterator::Iterator(const FloatingState::FloatList& floats, std::optional<LayoutUnit> verticalPosition)
310     : m_floats(floats)
311     , m_current(floats)
312 {
313     if (verticalPosition)
314         set(*verticalPosition);
315 }
316
317 inline static std::optional<unsigned> previousFloatingIndex(Float floatingType, const FloatingState::FloatList& floats, unsigned currentIndex)
318 {
319     RELEASE_ASSERT(currentIndex <= floats.size());
320
321     while (currentIndex) {
322         auto& floating = floats[--currentIndex].layoutBox();
323         if ((floatingType == Float::Left && floating.isLeftFloatingPositioned()) || (floatingType == Float::Right && floating.isRightFloatingPositioned()))
324             return currentIndex;
325     }
326
327     return { };
328 }
329
330 Iterator& Iterator::operator++()
331 {
332     if (m_current.isEmpty()) {
333         ASSERT_NOT_REACHED();
334         return *this;
335     }
336
337     auto findPreviousFloatingWithLowerBottom = [&](Float floatingType, unsigned currentIndex) -> std::optional<unsigned> {
338
339         RELEASE_ASSERT(currentIndex < m_floats.size());
340
341         // Last floating? There's certainly no previous floating at this point.
342         if (!currentIndex)
343             return { };
344
345         auto currentBottom = m_floats[currentIndex].displayBox().rectWithMargin().bottom();
346
347         std::optional<unsigned> index = currentIndex;
348         while (true) {
349             index = previousFloatingIndex(floatingType, m_floats, *index);
350             if (!index)
351                 return { };
352
353             if (m_floats[*index].displayBox().rectWithMargin().bottom() > currentBottom)
354                 return index;
355         }
356
357         ASSERT_NOT_REACHED();
358         return { };
359     };
360
361     // 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).
362     // The current floats from left and right are considered the inner-most pair for the current vertical position.
363     // 2. Move away from inner-most pair by picking one of the previous floats in the list(#1)
364     // 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).
365     // 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.
366     // As the result we have more horizontal space on the current vertical position.
367     auto leftBottom = m_current.left() ? std::optional<LayoutUnit>(m_current.left()->bottom()) : std::nullopt;
368     auto rightBottom = m_current.right() ? std::optional<LayoutUnit>(m_current.right()->bottom()) : std::nullopt;
369
370     auto updateLeft = (leftBottom == rightBottom) || (!rightBottom || (leftBottom && leftBottom < rightBottom)); 
371     auto updateRight = (leftBottom == rightBottom) || (!leftBottom || (rightBottom && leftBottom > rightBottom)); 
372
373     if (updateLeft) {
374         ASSERT(m_current.m_leftIndex);
375         m_current.m_verticalPosition = *leftBottom;
376         m_current.m_leftIndex = findPreviousFloatingWithLowerBottom(Float::Left, *m_current.m_leftIndex);
377     }
378     
379     if (updateRight) {
380         ASSERT(m_current.m_rightIndex);
381         m_current.m_verticalPosition = *rightBottom;
382         m_current.m_rightIndex = findPreviousFloatingWithLowerBottom(Float::Right, *m_current.m_rightIndex);
383     }
384
385     return *this;
386 }
387
388 void Iterator::set(LayoutUnit verticalPosition)
389 {
390     // Move the iterator to the initial vertical position by starting at the inner-most floating pair (last floats on left/right).
391     // 1. Check if the inner-most pair covers the vertical position.
392     // 2. Move outwards from the inner-most pair until the vertical postion intersects.
393     // (Note that verticalPosition has already been adjusted with the top of the last float.)
394
395     m_current.m_verticalPosition = verticalPosition;
396     // No floats at all?
397     if (m_floats.isEmpty()) {
398         ASSERT_NOT_REACHED();
399
400         m_current.m_leftIndex = { };
401         m_current.m_rightIndex = { };
402         return;
403     }
404
405     auto findFloatingBelow = [&](Float floatingType) -> std::optional<unsigned> {
406
407         ASSERT(!m_floats.isEmpty());
408
409         auto index = floatingType == Float::Left ? m_current.m_leftIndex : m_current.m_rightIndex;
410         // Start from the end if we don't have current yet.
411         index = index.value_or(m_floats.size());
412         while (true) {
413             index = previousFloatingIndex(floatingType, m_floats, *index);
414             if (!index)
415                 return { };
416
417             auto bottom = m_floats[*index].displayBox().rectWithMargin().bottom();
418             // Is this floating intrusive on this position?
419             if (bottom > verticalPosition)
420                 return index;
421         }
422
423         return { };
424     };
425
426     m_current.m_leftIndex = findFloatingBelow(Float::Left);
427     m_current.m_rightIndex = findFloatingBelow(Float::Right);
428
429     ASSERT(!m_current.m_leftIndex || (*m_current.m_leftIndex < m_floats.size() && m_floats[*m_current.m_leftIndex].layoutBox().isLeftFloatingPositioned()));
430     ASSERT(!m_current.m_rightIndex || (*m_current.m_rightIndex < m_floats.size() && m_floats[*m_current.m_rightIndex].layoutBox().isRightFloatingPositioned()));
431 }
432
433 bool Iterator::operator==(const Iterator& other) const
434 {
435     return m_current == other.m_current;
436 }
437
438 bool Iterator::operator!=(const Iterator& other) const
439 {
440     return !(*this == other);
441 }
442
443 }
444 }
445 #endif