blob: 429c0a9811a48dbf4551a4be92130f250143a38b [file] [log] [blame]
/*
* Copyright (C) 2018 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "BlockFormattingContext.h"
#if ENABLE(LAYOUT_FORMATTING_CONTEXT)
#include "BlockFormattingState.h"
#include "DisplayBox.h"
#include "FloatingContext.h"
#include "FloatingState.h"
#include "LayoutBox.h"
#include "LayoutContainer.h"
#include "LayoutState.h"
#include "Logging.h"
#include <wtf/IsoMallocInlines.h>
#include <wtf/text/TextStream.h>
namespace WebCore {
namespace Layout {
WTF_MAKE_ISO_ALLOCATED_IMPL(BlockFormattingContext);
BlockFormattingContext::BlockFormattingContext(const Box& formattingContextRoot, FormattingState& formattingState)
: FormattingContext(formattingContextRoot, formattingState)
{
}
void BlockFormattingContext::layout() const
{
// 9.4.1 Block formatting contexts
// In a block formatting context, boxes are laid out one after the other, vertically, beginning at the top of a containing block.
// The vertical distance between two sibling boxes is determined by the 'margin' properties.
// Vertical margins between adjacent block-level boxes in a block formatting context collapse.
if (!is<Container>(root()))
return;
LOG_WITH_STREAM(FormattingContextLayout, stream << "[Start] -> block formatting context -> formatting root(" << &root() << ")");
auto& formattingRoot = downcast<Container>(root());
LayoutQueue layoutQueue;
FloatingContext floatingContext(formattingState().floatingState());
// This is a post-order tree traversal layout.
// The root container layout is done in the formatting context it lives in, not that one it creates, so let's start with the first child.
if (auto* firstChild = formattingRoot.firstInFlowOrFloatingChild())
layoutQueue.append(firstChild);
// 1. Go all the way down to the leaf node
// 2. Compute static position and width as we traverse down
// 3. As we climb back on the tree, compute height and finialize position
// (Any subtrees with new formatting contexts need to layout synchronously)
while (!layoutQueue.isEmpty()) {
// Traverse down on the descendants and compute width/static position until we find a leaf node.
while (true) {
auto& layoutBox = *layoutQueue.last();
if (layoutBox.establishesFormattingContext()) {
layoutFormattingContextRoot(floatingContext, layoutBox);
layoutQueue.removeLast();
// Since this box is a formatting context root, it takes care of its entire subtree.
// Continue with next sibling if exists.
if (!layoutBox.nextInFlowOrFloatingSibling())
break;
layoutQueue.append(layoutBox.nextInFlowOrFloatingSibling());
continue;
}
LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
computeStaticPosition(layoutBox);
computeBorderAndPadding(layoutBox);
computeWidthAndMargin(layoutBox);
if (!is<Container>(layoutBox) || !downcast<Container>(layoutBox).hasInFlowOrFloatingChild())
break;
layoutQueue.append(downcast<Container>(layoutBox).firstInFlowOrFloatingChild());
}
// Climb back on the ancestors and compute height/final position.
while (!layoutQueue.isEmpty()) {
// All inflow descendants (if there are any) are laid out by now. Let's compute the box's height.
auto& layoutBox = *layoutQueue.takeLast();
LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
// Formatting root boxes are special-cased and they don't come here.
ASSERT(!layoutBox.establishesFormattingContext());
computeHeightAndMargin(layoutBox);
// Finalize position with clearance.
if (layoutBox.hasFloatClear())
computeVerticalPositionForFloatClear(floatingContext, layoutBox);
if (!is<Container>(layoutBox))
continue;
auto& container = downcast<Container>(layoutBox);
// Move in-flow positioned children to their final position.
placeInFlowPositionedChildren(container);
if (auto* nextSibling = container.nextInFlowOrFloatingSibling()) {
layoutQueue.append(nextSibling);
break;
}
}
}
// Place the inflow positioned children.
placeInFlowPositionedChildren(formattingRoot);
LOG_WITH_STREAM(FormattingContextLayout, stream << "[End] -> block formatting context -> formatting root(" << &root() << ")");
}
void BlockFormattingContext::layoutFormattingContextRoot(FloatingContext& floatingContext, const Box& layoutBox) const
{
// Start laying out this formatting root in the formatting contenxt it lives in.
LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Position][Border][Padding][Width][Margin] -> for layoutBox(" << &layoutBox << ")");
computeStaticPosition(layoutBox);
computeBorderAndPadding(layoutBox);
computeWidthAndMargin(layoutBox);
precomputeVerticalPositionForFormattingRootIfNeeded(layoutBox);
// Swich over to the new formatting context (the one that the root creates).
auto formattingContext = layoutState().createFormattingStateForFormattingRootIfNeeded(layoutBox).createFormattingContext(layoutBox);
formattingContext->layout();
// Come back and finalize the root's geometry.
LOG_WITH_STREAM(FormattingContextLayout, stream << "[Compute] -> [Height][Margin] -> for layoutBox(" << &layoutBox << ")");
computeHeightAndMargin(layoutBox);
// Float related final positioning.
if (layoutBox.isFloatingPositioned()) {
computeFloatingPosition(floatingContext, layoutBox);
floatingContext.floatingState().append(layoutBox);
} else if (layoutBox.hasFloatClear())
computeVerticalPositionForFloatClear(floatingContext, layoutBox);
else if (layoutBox.establishesBlockFormattingContext())
computePositionToAvoidFloats(floatingContext, layoutBox);
// Now that we computed the root's height, we can go back and layout the out-of-flow descedants (if any).
formattingContext->layoutOutOfFlowDescendants(layoutBox);
}
void BlockFormattingContext::placeInFlowPositionedChildren(const Container& container) const
{
LOG_WITH_STREAM(FormattingContextLayout, stream << "Start: move in-flow positioned children -> parent: " << &container);
for (auto& layoutBox : childrenOfType<Box>(container)) {
if (!layoutBox.isInFlowPositioned())
continue;
auto computeInFlowPositionedPosition = [&](auto& layoutBox) {
auto& layoutState = this->layoutState();
auto positionOffset = Geometry::inFlowPositionedPositionOffset(layoutState, layoutBox);
auto& displayBox = layoutState.displayBoxForLayoutBox(layoutBox);
auto topLeft = displayBox.topLeft();
topLeft.move(positionOffset);
displayBox.setTopLeft(topLeft);
};
computeInFlowPositionedPosition(layoutBox);
}
LOG_WITH_STREAM(FormattingContextLayout, stream << "End: move in-flow positioned children -> parent: " << &container);
}
void BlockFormattingContext::computeStaticPosition(const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
layoutState.displayBoxForLayoutBox(layoutBox).setTopLeft(Geometry::staticPosition(layoutState, layoutBox));
}
void BlockFormattingContext::computeEstimatedMarginBefore(const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
auto estimatedMarginBefore = Geometry::estimatedMarginBefore(layoutState, layoutBox);
auto& displayBox = layoutState.displayBoxForLayoutBox(layoutBox);
displayBox.setEstimatedMarginBefore(estimatedMarginBefore);
displayBox.moveVertically(estimatedMarginBefore);
}
void BlockFormattingContext::computeEstimatedMarginBeforeForAncestors(const Box& layoutBox) const
{
// We only need to estimate margin top for float related layout (formatting context roots avoid floats).
ASSERT(layoutBox.isFloatingPositioned() || layoutBox.hasFloatClear() || layoutBox.establishesBlockFormattingContext() || layoutBox.establishesInlineFormattingContext());
// In order to figure out whether a box should avoid a float, we need to know the final positions of both (ignore relative positioning for now).
// In block formatting context the final position for a normal flow box includes
// 1. the static position and
// 2. the corresponding (non)collapsed margins.
// Now the vertical margins are computed when all the descendants are finalized, because the margin values might be depending on the height of the box
// (and the height might be based on the content).
// So when we get to the point where we intersect the box with the float to decide if the box needs to move, we don't yet have the final vertical position.
//
// The idea here is that as long as we don't cross the block formatting context boundary, we should be able to pre-compute the final top margin.
auto& layoutState = this->layoutState();
for (auto* ancestor = layoutBox.containingBlock(); ancestor && !ancestor->establishesBlockFormattingContext(); ancestor = ancestor->containingBlock()) {
auto& displayBox = layoutState.displayBoxForLayoutBox(*ancestor);
// FIXME: with incremental layout, we might actually have a valid (non-estimated) margin top as well.
if (displayBox.estimatedMarginBefore())
return;
computeEstimatedMarginBefore(*ancestor);
}
}
void BlockFormattingContext::precomputeVerticalPositionForFormattingRootIfNeeded(const Box& layoutBox) const
{
ASSERT(layoutBox.establishesFormattingContext());
auto avoidsFloats = layoutBox.isFloatingPositioned() || layoutBox.establishesBlockFormattingContext() || layoutBox.hasFloatClear();
if (avoidsFloats)
computeEstimatedMarginBeforeForAncestors(layoutBox);
// If the inline formatting root is also the root for the floats (happens when the root box also establishes a block formatting context)
// the floats are in the coordinate system of this root. No need to find the final vertical position.
auto inlineContextInheritsFloats = layoutBox.establishesInlineFormattingContext() && !layoutBox.establishesBlockFormattingContext();
if (inlineContextInheritsFloats) {
computeEstimatedMarginBefore(layoutBox);
computeEstimatedMarginBeforeForAncestors(layoutBox);
}
}
#ifndef NDEBUG
static bool hasPrecomputedMarginBefore(const LayoutState& layoutState, const Box& layoutBox)
{
for (auto* ancestor = layoutBox.containingBlock(); ancestor && !ancestor->establishesBlockFormattingContext(); ancestor = ancestor->containingBlock()) {
if (layoutState.displayBoxForLayoutBox(*ancestor).estimatedMarginBefore())
continue;
return false;
}
return true;
}
#endif
void BlockFormattingContext::computeFloatingPosition(const FloatingContext& floatingContext, const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
ASSERT(layoutBox.isFloatingPositioned());
ASSERT(hasPrecomputedMarginBefore(layoutState, layoutBox));
auto& displayBox = layoutState.displayBoxForLayoutBox(layoutBox);
// 8.3.1 Collapsing margins
// In block formatting context margins between a floated box and any other box do not collapse.
// Adjust the static position by using the previous inflow box's non-collapsed margin.
if (auto* previousInFlowBox = layoutBox.previousInFlowSibling()) {
auto& previousDisplayBox = layoutState.displayBoxForLayoutBox(*previousInFlowBox);
displayBox.moveVertically(previousDisplayBox.nonCollapsedMarginAfter() - previousDisplayBox.marginAfter());
}
displayBox.setTopLeft(floatingContext.positionForFloat(layoutBox));
}
void BlockFormattingContext::computePositionToAvoidFloats(const FloatingContext& floatingContext, const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
// Formatting context roots avoid floats.
ASSERT(layoutBox.establishesBlockFormattingContext());
ASSERT(!layoutBox.isFloatingPositioned());
ASSERT(!layoutBox.hasFloatClear());
ASSERT(hasPrecomputedMarginBefore(layoutState, layoutBox));
if (floatingContext.floatingState().isEmpty())
return;
if (auto adjustedPosition = floatingContext.positionForFloatAvoiding(layoutBox))
layoutState.displayBoxForLayoutBox(layoutBox).setTopLeft(*adjustedPosition);
}
void BlockFormattingContext::computeVerticalPositionForFloatClear(const FloatingContext& floatingContext, const Box& layoutBox) const
{
ASSERT(layoutBox.hasFloatClear());
if (floatingContext.floatingState().isEmpty())
return;
auto& layoutState = this->layoutState();
// For formatting roots, we already precomputed final position.
if (!layoutBox.establishesFormattingContext())
computeEstimatedMarginBeforeForAncestors(layoutBox);
ASSERT(hasPrecomputedMarginBefore(layoutState, layoutBox));
if (auto verticalPositionWithClearance = floatingContext.verticalPositionWithClearance(layoutBox))
layoutState.displayBoxForLayoutBox(layoutBox).setTop(*verticalPositionWithClearance);
}
void BlockFormattingContext::computeWidthAndMargin(const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
auto compute = [&](Optional<LayoutUnit> usedWidth) -> WidthAndMargin {
if (layoutBox.isInFlow())
return Geometry::inFlowWidthAndMargin(layoutState, layoutBox, usedWidth);
if (layoutBox.isFloatingPositioned())
return Geometry::floatingWidthAndMargin(layoutState, layoutBox, usedWidth);
ASSERT_NOT_REACHED();
return { };
};
auto widthAndMargin = compute({ });
auto containingBlockWidth = layoutState.displayBoxForLayoutBox(*layoutBox.containingBlock()).contentBoxWidth();
if (auto maxWidth = Geometry::computedValueIfNotAuto(layoutBox.style().logicalMaxWidth(), containingBlockWidth)) {
auto maxWidthAndMargin = compute(maxWidth);
if (widthAndMargin.width > maxWidthAndMargin.width)
widthAndMargin = maxWidthAndMargin;
}
if (auto minWidth = Geometry::computedValueIfNotAuto(layoutBox.style().logicalMinWidth(), containingBlockWidth)) {
auto minWidthAndMargin = compute(minWidth);
if (widthAndMargin.width < minWidthAndMargin.width)
widthAndMargin = minWidthAndMargin;
}
auto& displayBox = layoutState.displayBoxForLayoutBox(layoutBox);
displayBox.setContentBoxWidth(widthAndMargin.width);
displayBox.moveHorizontally(widthAndMargin.margin.start);
displayBox.setHorizontalMargin(widthAndMargin.margin);
displayBox.setHorizontalNonComputedMargin(widthAndMargin.nonComputedMargin);
}
void BlockFormattingContext::computeHeightAndMargin(const Box& layoutBox) const
{
auto& layoutState = this->layoutState();
auto compute = [&](Optional<LayoutUnit> usedHeight) -> HeightAndMargin {
if (layoutBox.isInFlow())
return Geometry::inFlowHeightAndMargin(layoutState, layoutBox, usedHeight);
if (layoutBox.isFloatingPositioned())
return Geometry::floatingHeightAndMargin(layoutState, layoutBox, usedHeight);
ASSERT_NOT_REACHED();
return { };
};
auto heightAndMargin = compute({ });
if (auto maxHeight = Geometry::computedMaxHeight(layoutState, layoutBox)) {
if (heightAndMargin.height > *maxHeight) {
auto maxHeightAndMargin = compute(maxHeight);
// Used height should remain the same.
ASSERT((layoutState.inQuirksMode() && (layoutBox.isBodyBox() || layoutBox.isDocumentBox())) || maxHeightAndMargin.height == *maxHeight);
heightAndMargin = { *maxHeight, maxHeightAndMargin.margin };
}
}
if (auto minHeight = Geometry::computedMinHeight(layoutState, layoutBox)) {
if (heightAndMargin.height < *minHeight) {
auto minHeightAndMargin = compute(minHeight);
// Used height should remain the same.
ASSERT((layoutState.inQuirksMode() && (layoutBox.isBodyBox() || layoutBox.isDocumentBox())) || minHeightAndMargin.height == *minHeight);
heightAndMargin = { *minHeight, minHeightAndMargin.margin };
}
}
auto& displayBox = layoutState.displayBoxForLayoutBox(layoutBox);
displayBox.setContentBoxHeight(heightAndMargin.height);
displayBox.setVerticalMargin(heightAndMargin.margin);
// If this box has already been moved by the estimated vertical margin, no need to move it again.
if (layoutBox.isFloatingPositioned() || !displayBox.estimatedMarginBefore())
displayBox.moveVertically(heightAndMargin.margin.usedValues().before);
}
FormattingContext::InstrinsicWidthConstraints BlockFormattingContext::instrinsicWidthConstraints() const
{
auto& layoutState = this->layoutState();
auto& formattingRoot = root();
auto& formattingStateForRoot = layoutState.formattingStateForBox(formattingRoot);
if (auto instrinsicWidthConstraints = formattingStateForRoot.instrinsicWidthConstraints(formattingRoot))
return *instrinsicWidthConstraints;
// Can we just compute them without checking the children?
if (!Geometry::instrinsicWidthConstraintsNeedChildrenWidth(formattingRoot)) {
auto instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutState, formattingRoot);
formattingStateForRoot.setInstrinsicWidthConstraints(formattingRoot, instrinsicWidthConstraints);
return instrinsicWidthConstraints;
}
// Visit the in-flow descendants and compute their min/max intrinsic width if needed.
// 1. Go all the way down to the leaf node
// 2. Check if actually need to visit all the boxes as we traverse down (already computed, container's min/max does not depend on descendants etc)
// 3. As we climb back on the tree, compute min/max intrinsic width
// (Any subtrees with new formatting contexts need to layout synchronously)
Vector<const Box*> queue;
ASSERT(is<Container>(formattingRoot));
if (auto* firstChild = downcast<Container>(formattingRoot).firstInFlowOrFloatingChild())
queue.append(firstChild);
auto& formattingState = this->formattingState();
while (!queue.isEmpty()) {
while (true) {
auto& childBox = *queue.last();
auto skipDescendants = formattingState.instrinsicWidthConstraints(childBox) || !Geometry::instrinsicWidthConstraintsNeedChildrenWidth(childBox) || childBox.establishesFormattingContext();
if (skipDescendants) {
InstrinsicWidthConstraints instrinsicWidthConstraints;
if (!Geometry::instrinsicWidthConstraintsNeedChildrenWidth(childBox))
instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutState, childBox);
else if (childBox.establishesFormattingContext())
instrinsicWidthConstraints = layoutState.createFormattingStateForFormattingRootIfNeeded(childBox).createFormattingContext(childBox)->instrinsicWidthConstraints();
formattingState.setInstrinsicWidthConstraints(childBox, instrinsicWidthConstraints);
queue.removeLast();
if (!childBox.nextInFlowOrFloatingSibling())
break;
queue.append(childBox.nextInFlowOrFloatingSibling());
// Skip descendants
continue;
}
}
// Compute min/max intrinsic width bottom up.
while (!queue.isEmpty()) {
auto& childBox = *queue.takeLast();
formattingState.setInstrinsicWidthConstraints(childBox, Geometry::instrinsicWidthConstraints(layoutState, childBox));
// Move over to the next sibling or take the next box in the queue.
if (!is<Container>(childBox) || !downcast<Container>(childBox).nextInFlowOrFloatingSibling())
continue;
queue.append(downcast<Container>(childBox).nextInFlowOrFloatingSibling());
}
}
auto instrinsicWidthConstraints = Geometry::instrinsicWidthConstraints(layoutState, formattingRoot);
formattingStateForRoot.setInstrinsicWidthConstraints(formattingRoot, instrinsicWidthConstraints);
return instrinsicWidthConstraints;
}
}
}
#endif