[LFC] Layout::Box::containingBlock should return a const ContainerBox&
[WebKit-https.git] / Source / WebCore / layout / layouttree / LayoutBox.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 "LayoutBox.h"
28
29 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
30
31 #include "DisplayBox.h"
32 #include "LayoutContainerBox.h"
33 #include "LayoutPhase.h"
34 #include "LayoutState.h"
35 #include "RenderStyle.h"
36 #include <wtf/IsoMallocInlines.h>
37
38 namespace WebCore {
39 namespace Layout {
40
41 WTF_MAKE_ISO_ALLOCATED_IMPL(Box);
42
43 Box::Box(Optional<ElementAttributes> attributes, RenderStyle&& style, BaseTypeFlags baseTypeFlags)
44     : m_style(WTFMove(style))
45     , m_elementAttributes(attributes)
46     , m_baseTypeFlags(baseTypeFlags)
47     , m_hasRareData(false)
48     , m_isAnonymous(false)
49 {
50 }
51
52 Box::~Box()
53 {
54     if (UNLIKELY(m_hasRareData))
55         removeRareData();
56 }
57
58 void Box::updateStyle(const RenderStyle& newStyle)
59 {
60     m_style = RenderStyle::clone(newStyle);
61 }
62
63 bool Box::establishesFormattingContext() const
64 {
65     // We need the final tree structure to tell whether a box establishes a certain formatting context. 
66     ASSERT(!Phase::isInTreeBuilding());
67     return establishesBlockFormattingContext() || establishesInlineFormattingContext() || establishesTableFormattingContext() || establishesIndependentFormattingContext();
68 }
69
70 bool Box::establishesBlockFormattingContext() const
71 {
72     // Initial Containing Block always creates a new (inital) block formatting context.
73     if (!parent())
74         return true;
75
76     if (isTableWrapperBox())
77         return true;
78
79     // 9.4.1 Block formatting contexts
80     // Floats, absolutely positioned elements, block containers (such as inline-blocks, table-cells, and table-captions)
81     // that are not block boxes, and block boxes with 'overflow' other than 'visible' (except when that value has been propagated to the viewport)
82     // establish new block formatting contexts for their contents.
83     if (isFloatingPositioned() || isAbsolutelyPositioned()) {
84         // Not all floating or out-of-positioned block level boxes establish BFC.
85         // See [9.7 Relationships between 'display', 'position', and 'float'] for details.
86         return style().display() == DisplayType::Block;
87     }
88
89     if (isBlockContainerBox() && !isBlockLevelBox())
90         return true;
91
92     if (isBlockLevelBox() && !isOverflowVisible())
93         return true;
94
95     return false;
96 }
97
98 bool Box::establishesInlineFormattingContext() const
99 {
100     // 9.4.2 Inline formatting contexts
101     // An inline formatting context is established by a block container box that contains no block-level boxes.
102     if (!isBlockContainerBox())
103         return false;
104
105     if (!isContainerBox())
106         return false;
107
108     // FIXME ???
109     if (!downcast<ContainerBox>(*this).firstInFlowChild())
110         return false;
111
112     // It's enough to check the first in-flow child since we can't have both block and inline level sibling boxes.
113     return downcast<ContainerBox>(*this).firstInFlowChild()->isInlineLevelBox();
114 }
115
116 bool Box::establishesTableFormattingContext() const
117 {
118     return isTableBox();
119 }
120
121 bool Box::establishesIndependentFormattingContext() const
122 {
123     // FIXME: This is where we would check for 'contain' property.
124     return isAbsolutelyPositioned();
125 }
126
127 bool Box::isRelativelyPositioned() const
128 {
129     return m_style.position() == PositionType::Relative;
130 }
131
132 bool Box::isStickyPositioned() const
133 {
134     return m_style.position() == PositionType::Sticky;
135 }
136
137 bool Box::isAbsolutelyPositioned() const
138 {
139     return m_style.position() == PositionType::Absolute || isFixedPositioned(); 
140 }
141
142 bool Box::isFixedPositioned() const
143 {
144     return m_style.position() == PositionType::Fixed;
145 }
146
147 bool Box::isFloatingPositioned() const
148 {
149     // FIXME: Rendering code caches values like this. (style="position: absolute; float: left")
150     if (isOutOfFlowPositioned())
151         return false;
152     return m_style.floating() != Float::No;
153 }
154
155 bool Box::isLeftFloatingPositioned() const
156 {
157     if (!isFloatingPositioned())
158         return false;
159     return m_style.floating() == Float::Left;
160 }
161
162 bool Box::isRightFloatingPositioned() const
163 {
164     if (!isFloatingPositioned())
165         return false;
166     return m_style.floating() == Float::Right;
167 }
168
169 bool Box::hasFloatClear() const
170 {
171     return m_style.clear() != Clear::None;
172 }
173
174 bool Box::isFloatAvoider() const
175 {
176     if (establishesIndependentFormattingContext())
177         return false;
178     return (establishesBlockFormattingContext() && !establishesInlineFormattingContext()) || establishesTableFormattingContext() || hasFloatClear();
179 }
180
181 const ContainerBox& Box::containingBlock() const
182 {
183     // Finding the containing block by traversing the tree during tree construction could provide incorrect result.
184     ASSERT(!Phase::isInTreeBuilding());
185     // If we ever end up here with the ICB, we must be doing something not-so-great.
186     RELEASE_ASSERT(!isInitialContainingBlock());
187     // The containing block in which the root element lives is a rectangle called the initial containing block.
188     // For other elements, if the element's position is 'relative' or 'static', the containing block is formed by the
189     // content edge of the nearest block container ancestor box or which establishes a formatting context.
190     // If the element has 'position: fixed', the containing block is established by the viewport
191     // If the element has 'position: absolute', the containing block is established by the nearest ancestor with a
192     // 'position' of 'absolute', 'relative' or 'fixed'.
193     if (!isPositioned() || isInFlowPositioned()) {
194         auto* ancestor = parent();
195         for (; !ancestor->isInitialContainingBlock(); ancestor = ancestor->parent()) {
196             if (ancestor->isBlockContainerBox() || ancestor->establishesFormattingContext())
197                 return *ancestor;
198         }
199         return *ancestor;
200     }
201
202     if (isFixedPositioned()) {
203         auto* ancestor = parent();
204         for (; !ancestor->isInitialContainingBlock(); ancestor = ancestor->parent()) {
205             if (ancestor->style().hasTransform())
206                 return *ancestor;
207         }
208         return *ancestor;
209     }
210
211     if (isOutOfFlowPositioned()) {
212         auto* ancestor = parent();
213         for (; !ancestor->isInitialContainingBlock(); ancestor = ancestor->parent()) {
214             if (ancestor->isPositioned() || ancestor->style().hasTransform())
215                 return *ancestor;
216         }
217         return *ancestor;
218     }
219
220     ASSERT_NOT_REACHED();
221     return initialContainingBlock();
222 }
223
224 const ContainerBox& Box::formattingContextRoot() const
225 {
226     // Finding the context root by traversing the tree during tree construction could provide incorrect result.
227     ASSERT(!Phase::isInTreeBuilding());
228     // We should never need to ask this question on the ICB.
229     ASSERT(!isInitialContainingBlock());
230     // A box lives in the same formatting context as its containing block unless the containing block establishes a formatting context.
231     // However relatively positioned (inflow) inline container lives in the formatting context where its parent lives unless
232     // the parent establishes a formatting context.
233     //
234     // <div id=outer style="position: absolute"><div id=inner><span style="position: relative">content</span></div></div>
235     // While the relatively positioned inline container (span) is placed relative to its containing block "outer", it lives in the inline
236     // formatting context established by "inner".
237     auto& ancestor = isInlineLevelBox() && isInFlowPositioned() ? *parent() : containingBlock();
238     if (ancestor.establishesFormattingContext())
239         return ancestor;
240     return ancestor.formattingContextRoot();
241 }
242
243 const ContainerBox& Box::initialContainingBlock() const
244 {
245     if (isInitialContainingBlock())
246         return downcast<ContainerBox>(*this);
247
248     auto* parent = this->parent();
249     for (; parent->parent(); parent = parent->parent()) { }
250
251     return *parent;
252 }
253
254 bool Box::isInFormattingContextOf(const ContainerBox& formattingContextRoot) const
255
256     ASSERT(formattingContextRoot.establishesFormattingContext());
257     ASSERT(!isInitialContainingBlock());
258     auto* ancestor = &containingBlock();
259     while (ancestor) {
260         if (ancestor == &formattingContextRoot)
261             return true;
262         if (ancestor->isInitialContainingBlock())
263             return false;
264         ancestor = &ancestor->containingBlock();
265     }
266     ASSERT_NOT_REACHED();
267     return false;
268 }
269
270 bool Box::isInlineBlockBox() const
271 {
272     return m_style.display() == DisplayType::InlineBlock;
273 }
274
275 bool Box::isInlineTableBox() const
276 {
277     return m_style.display() == DisplayType::InlineTable;
278 }
279
280 bool Box::isBlockLevelBox() const
281 {
282     // Block level elements generate block level boxes.
283     auto display = m_style.display();
284     return display == DisplayType::Block || display == DisplayType::ListItem || display == DisplayType::Table;
285 }
286
287 bool Box::isInlineLevelBox() const
288 {
289     // Inline level elements generate inline level boxes.
290     auto display = m_style.display();
291     return display == DisplayType::Inline || isInlineBlockBox() || isInlineTableBox();
292 }
293
294 bool Box::isInlineBox() const
295 {
296     // An inline box is one that is both inline-level and whose contents participate in its containing inline formatting context.
297     // A non-replaced element with a 'display' value of 'inline' generates an inline box.
298     return m_style.display() == DisplayType::Inline && !isReplacedBox();
299 }
300
301 bool Box::isAtomicInlineLevelBox() const
302 {
303     // Inline-level boxes that are not inline boxes (such as replaced inline-level elements, inline-block elements, and inline-table elements)
304     // are called atomic inline-level boxes because they participate in their inline formatting context as a single opaque box.
305     return isInlineLevelBox() && !isInlineBox();
306 }
307
308 bool Box::isBlockContainerBox() const
309 {
310     auto display = m_style.display();
311     return display == DisplayType::Block || display == DisplayType::ListItem || isInlineBlockBox() || isTableWrapperBox() || isTableCell() || isTableCaption(); // TODO && !replaced element
312 }
313
314 bool Box::isInitialContainingBlock() const
315 {
316     return !parent();
317 }
318
319 const Box* Box::nextInFlowSibling() const
320 {
321     auto* nextSibling = this->nextSibling();
322     while (nextSibling && !nextSibling->isInFlow())
323         nextSibling = nextSibling->nextSibling();
324     return nextSibling;
325 }
326
327 const Box* Box::nextInFlowOrFloatingSibling() const
328 {
329     auto* nextSibling = this->nextSibling();
330     while (nextSibling && !(nextSibling->isInFlow() || nextSibling->isFloatingPositioned()))
331         nextSibling = nextSibling->nextSibling();
332     return nextSibling;
333 }
334
335 const Box* Box::previousInFlowSibling() const
336 {
337     auto* previousSibling = this->previousSibling();
338     while (previousSibling && !previousSibling->isInFlow())
339         previousSibling = previousSibling->previousSibling();
340     return previousSibling;
341 }
342
343 const Box* Box::previousInFlowOrFloatingSibling() const
344 {
345     auto* previousSibling = this->previousSibling();
346     while (previousSibling && !(previousSibling->isInFlow() || previousSibling->isFloatingPositioned()))
347         previousSibling = previousSibling->previousSibling();
348     return previousSibling;
349 }
350
351 bool Box::isOverflowVisible() const
352 {
353     auto isOverflowVisible = m_style.overflowX() == Overflow::Visible || m_style.overflowY() == Overflow::Visible;
354     // UAs must apply the 'overflow' property set on the root element to the viewport. When the root element is an HTML "HTML" element
355     // or an XHTML "html" element, and that element has an HTML "BODY" element or an XHTML "body" element as a child,
356     // user agents must instead apply the 'overflow' property from the first such child element to the viewport,
357     // if the value on the root element is 'visible'. The 'visible' value when used for the viewport must be interpreted as 'auto'.
358     // The element from which the value is propagated must have a used value for 'overflow' of 'visible'.
359     if (isBodyBox()) {
360         auto* documentBox = parent();
361         ASSERT(documentBox);
362         if (!documentBox->isDocumentBox())
363             return isOverflowVisible;
364         if (!documentBox->isOverflowVisible())
365             return isOverflowVisible;
366         return true;
367     }
368     if (isInitialContainingBlock()) {
369         auto* documentBox = downcast<ContainerBox>(*this).firstChild();
370         if (!documentBox || !documentBox->isDocumentBox() || !is<ContainerBox>(documentBox))
371             return isOverflowVisible;
372         auto* bodyBox = downcast<ContainerBox>(documentBox)->firstChild();
373         if (!bodyBox || !bodyBox->isBodyBox())
374             return isOverflowVisible;
375         auto& bodyBoxStyle = bodyBox->style();
376         return bodyBoxStyle.overflowX() == Overflow::Visible || bodyBoxStyle.overflowY() == Overflow::Visible;
377     }
378     return isOverflowVisible;
379 }
380
381 bool Box::isPaddingApplicable() const
382 {
383     // 8.4 Padding properties:
384     // Applies to: all elements except table-row-group, table-header-group, table-footer-group, table-row, table-column-group and table-column
385     if (isAnonymous())
386         return false;
387
388     return !isTableHeader()
389         && !isTableBody()
390         && !isTableFooter()
391         && !isTableRow()
392         && !isTableColumnGroup()
393         && !isTableColumn();
394 }
395
396 void Box::setRowSpan(unsigned rowSpan)
397 {
398     ensureRareData().rowSpan = rowSpan;
399 }
400
401 void Box::setColumnSpan(unsigned columnSpan)
402 {
403     ensureRareData().columnSpan = columnSpan;
404 }
405
406 unsigned Box::rowSpan() const
407 {
408     if (!hasRareData())
409         return 1;
410     return rareData().rowSpan;
411 }
412
413 unsigned Box::columnSpan() const
414 {
415     if (!hasRareData())
416         return 1;
417     return rareData().columnSpan;
418 }
419
420 void Box::setColumnWidth(LayoutUnit columnWidth)
421 {
422     ensureRareData().columnWidth = columnWidth;
423 }
424
425 Optional<LayoutUnit> Box::columnWidth() const
426 {
427     if (!hasRareData())
428         return { };
429     return rareData().columnWidth;
430 }
431
432 void Box::setCachedDisplayBoxForLayoutState(LayoutState& layoutState, std::unique_ptr<Display::Box> box) const
433 {
434     ASSERT(!m_cachedLayoutState);
435     m_cachedLayoutState = makeWeakPtr(layoutState);
436     m_cachedDisplayBoxForLayoutState = WTFMove(box);
437 }
438
439 Box::RareDataMap& Box::rareDataMap()
440 {
441     static NeverDestroyed<RareDataMap> map;
442     return map;
443 }
444
445 const Box::BoxRareData& Box::rareData() const
446 {
447     ASSERT(hasRareData());
448     return *rareDataMap().get(this);
449 }
450
451 Box::BoxRareData& Box::ensureRareData()
452 {
453     setHasRareData(true);
454     return *rareDataMap().ensure(this, [] { return makeUnique<BoxRareData>(); }).iterator->value;
455 }
456
457 void Box::removeRareData()
458 {
459     rareDataMap().remove(this);
460     setHasRareData(false);
461 }
462
463 }
464 }
465
466 #endif