1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
|
/*
* Copyright (C) 2025 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 "GridLayout.h"
#include "GridAreaLines.h"
#include "GridItemRect.h"
#include "GridLayoutUtils.h"
#include "ImplicitGrid.h"
#include "RenderStyleInlines.h"
#include "LayoutBoxGeometry.h"
#include "LayoutElementBox.h"
#include "NotImplemented.h"
#include "PlacedGridItem.h"
#include "TrackSizingAlgorithm.h"
#include "TrackSizingFunctions.h"
#include "UnplacedGridItem.h"
#include "UsedTrackSizes.h"
#include <wtf/Vector.h>
namespace WebCore {
namespace Layout {
struct UsedMargins {
LayoutUnit marginStart;
LayoutUnit marginEnd;
};
struct UsedGridItemSizes {
LayoutUnit inlineAxisSize;
LayoutUnit blockAxisSize;
};
GridLayout::GridLayout(const GridFormattingContext& gridFormattingContext)
: m_gridFormattingContext(gridFormattingContext)
{
}
// 8.5. Grid Item Placement Algorithm.
// https://drafts.csswg.org/css-grid-1/#auto-placement-algo
auto GridLayout::placeGridItems(const UnplacedGridItems& unplacedGridItems, const Vector<Style::GridTrackSize>& gridTemplateColumnsTrackSizes,
const Vector<Style::GridTrackSize>& gridTemplateRowsTrackSizes, GridAutoFlowOptions autoFlowOptions)
{
struct Result {
GridAreas gridAreas;
size_t implicitGridColumnsCount;
size_t implicitGridRowsCount;
};
ImplicitGrid implicitGrid(gridTemplateColumnsTrackSizes.size(), gridTemplateRowsTrackSizes.size());
// 1. Position anything that's not auto-positioned.
auto& nonAutoPositionedGridItems = unplacedGridItems.nonAutoPositionedItems;
for (auto& nonAutoPositionedItem : nonAutoPositionedGridItems)
implicitGrid.insertUnplacedGridItem(nonAutoPositionedItem);
// 2. Process the items locked to a given row.
// Phase 1: Only single-cell items within explicit grid bounds
auto& definiteRowPositionedGridItems = unplacedGridItems.definiteRowPositionedItems;
HashMap<unsigned, unsigned, DefaultHash<unsigned>, WTF::UnsignedWithZeroKeyHashTraits<unsigned>> rowCursors;
for (auto& definiteRowPositionedItem : definiteRowPositionedGridItems)
implicitGrid.insertDefiniteRowItem(definiteRowPositionedItem, autoFlowOptions, &rowCursors);
// 3. FIXME: Process auto-positioned items (not implemented yet)
ASSERT(unplacedGridItems.autoPositionedItems.isEmpty());
ASSERT(implicitGrid.columnsCount() == gridTemplateColumnsTrackSizes.size() && implicitGrid.rowsCount() == gridTemplateRowsTrackSizes.size(),
"Since we currently only support placing items which fit within the explicit grid, the size of the implicit grid should match the passed in sizes.");
return Result { implicitGrid.gridAreas(), implicitGrid.columnsCount(), implicitGrid.rowsCount() };
}
// https://drafts.csswg.org/css-grid-1/#layout-algorithm
std::pair<UsedTrackSizes, GridItemRects> GridLayout::layout(GridFormattingContext::GridLayoutConstraints, const UnplacedGridItems& unplacedGridItems)
{
CheckedRef gridContainerStyle = this->gridContainerStyle();
auto& gridTemplateColumnsTrackSizes = gridContainerStyle->gridTemplateColumns().sizes;
auto& gridTemplateRowsTrackSizes = gridContainerStyle->gridTemplateRows().sizes;
// 1. Run the Grid Item Placement Algorithm to resolve the placement of all grid items in the grid.
GridAutoFlowOptions autoFlowOptions {
.strategy = gridContainerStyle->gridAutoFlow().isDense() ? PackingStrategy::Dense : PackingStrategy::Sparse,
.direction = gridContainerStyle->gridAutoFlow().isRow() ? GridAutoFlowDirection::Row : GridAutoFlowDirection::Column
};
auto [ gridAreas, implicitGridColumnsCount, implicitGridRowsCount ] = placeGridItems(unplacedGridItems, gridTemplateColumnsTrackSizes, gridTemplateRowsTrackSizes, autoFlowOptions);
auto placedGridItems = formattingContext().constructPlacedGridItems(gridAreas);
auto columnTrackSizingFunctionsList = trackSizingFunctions(implicitGridColumnsCount, gridTemplateColumnsTrackSizes);
auto rowTrackSizingFunctionsList = trackSizingFunctions(implicitGridRowsCount, gridTemplateRowsTrackSizes);
// 3. Given the resulting grid container size, run the Grid Sizing Algorithm to size the grid.
UsedTrackSizes usedTrackSizes = performGridSizingAlgorithm(placedGridItems, columnTrackSizingFunctionsList, rowTrackSizingFunctionsList);
// 4. Lay out the grid items into their respective containing blocks. Each grid area’s
// width and height are considered definite for this purpose.
auto [ usedInlineSizes, usedBlockSizes ] = layoutGridItems(placedGridItems, usedTrackSizes);
// https://drafts.csswg.org/css-grid-1/#alignment
const auto& zoomFactor = gridContainerStyle->usedZoomForLength();
auto usedInlineMargins = computeInlineMargins(placedGridItems, zoomFactor);
auto usedBlockMargins = computeBlockMargins(placedGridItems, zoomFactor);
// https://drafts.csswg.org/css-grid-1/#alignment
// After a grid container’s grid tracks have been sized, and the dimensions of all grid items
// are finalized, grid items can be aligned within their grid areas.
auto inlineAxisPositions = performInlineAxisSelfAlignment(placedGridItems, usedInlineMargins);
auto blockAxisPositions = performBlockAxisSelfAlignment(placedGridItems, usedBlockMargins);
GridItemRects gridItemRects;
gridItemRects.reserveInitialCapacity(placedGridItems.size());
for (size_t gridItemIndex = 0; gridItemIndex < placedGridItems.size(); ++gridItemIndex) {
auto borderBoxRect = LayoutRect { inlineAxisPositions[gridItemIndex], blockAxisPositions[gridItemIndex],
usedInlineSizes[gridItemIndex], usedBlockSizes[gridItemIndex]
};
auto& gridItemInlineMargins = usedInlineMargins[gridItemIndex];
auto& gridItemBlockMargins = usedBlockMargins[gridItemIndex];
auto marginEdges = RectEdges<LayoutUnit> {
gridItemBlockMargins.marginStart,
gridItemInlineMargins.marginEnd,
gridItemBlockMargins.marginEnd,
gridItemInlineMargins.marginStart
};
auto& placedGridItem = placedGridItems[gridItemIndex];
gridItemRects.append({ borderBoxRect, marginEdges, placedGridItem.gridAreaLines(), placedGridItem.layoutBox() });
}
return { usedTrackSizes, gridItemRects };
}
GridLayout::BorderBoxPositions GridLayout::performInlineAxisSelfAlignment(const PlacedGridItems& placedGridItems, const Vector<UsedMargins>& inlineMargins)
{
BorderBoxPositions borderBoxPositions;
borderBoxPositions.reserveInitialCapacity(placedGridItems.size());
auto computeMarginBoxPosition = [](const PlacedGridItem& placedGridItem) -> LayoutUnit {
switch (placedGridItem.inlineAxisAlignment().position()) {
case ItemPosition::FlexStart:
case ItemPosition::SelfStart:
case ItemPosition::Start:
return { };
default:
ASSERT_NOT_IMPLEMENTED_YET();
return { };
}
};
for (size_t gridItemIndex = 0; gridItemIndex < placedGridItems.size(); ++gridItemIndex) {
auto& gridItem = placedGridItems[gridItemIndex];
auto marginBoxPosition = computeMarginBoxPosition(gridItem);
borderBoxPositions.append(marginBoxPosition + inlineMargins[gridItemIndex].marginStart);
}
return borderBoxPositions;
}
GridLayout::BorderBoxPositions GridLayout::performBlockAxisSelfAlignment(const PlacedGridItems& placedGridItems, const Vector<UsedMargins>& blockMargins)
{
BorderBoxPositions borderBoxPositions;
borderBoxPositions.reserveInitialCapacity(placedGridItems.size());
auto computeMarginBoxPosition = [](const PlacedGridItem& placedGridItem) -> LayoutUnit {
switch (placedGridItem.blockAxisAlignment().position()) {
case ItemPosition::FlexStart:
case ItemPosition::SelfStart:
case ItemPosition::Start:
return { };
default:
ASSERT_NOT_IMPLEMENTED_YET();
return { };
}
};
for (size_t gridItemIndex = 0; gridItemIndex < placedGridItems.size(); ++gridItemIndex) {
auto& gridItem = placedGridItems[gridItemIndex];
auto marginBoxPosition = computeMarginBoxPosition(gridItem);
borderBoxPositions.append(marginBoxPosition + blockMargins[gridItemIndex].marginStart);
}
return borderBoxPositions;
}
TrackSizingFunctionsList GridLayout::trackSizingFunctions(size_t implicitGridTracksCount, const Vector<Style::GridTrackSize> gridTemplateTrackSizes)
{
ASSERT(implicitGridTracksCount == gridTemplateTrackSizes.size(), "Currently only support mapping track sizes from explicit grid from grid-template-{columns, rows}");
UNUSED_VARIABLE(implicitGridTracksCount);
// https://drafts.csswg.org/css-grid-1/#algo-terms
return gridTemplateTrackSizes.map([](const Style::GridTrackSize& gridTrackSize) {
auto minTrackSizingFunction = [&]() {
// If the track was sized with a minmax() function, this is the first argument to that function.
if (gridTrackSize.isMinMax())
return gridTrackSize.minTrackBreadth();
// If the track was sized with a <flex> value or fit-content() function, auto.
if (gridTrackSize.isFitContent() || gridTrackSize.minTrackBreadth().isFlex())
return Style::GridTrackBreadth { CSS::Keyword::Auto { } };
// Otherwise, the track’s sizing function.
return gridTrackSize.minTrackBreadth();
};
auto maxTrackSizingFunction = [&]() {
// If the track was sized with a minmax() function, this is the second argument to that function.
if (gridTrackSize.isMinMax())
return gridTrackSize.maxTrackBreadth();
// Otherwise, the track’s sizing function. In all cases, treat auto and fit-content() as max-content,
// except where specified otherwise for fit-content().
if (gridTrackSize.maxTrackBreadth().isAuto())
return Style::GridTrackBreadth { CSS::Keyword::MaxContent { } };
if (gridTrackSize.isFitContent()) {
ASSERT_NOT_IMPLEMENTED_YET();
return Style::GridTrackBreadth { CSS::Keyword::MaxContent { } };
}
return gridTrackSize.maxTrackBreadth();
};
return TrackSizingFunctions { minTrackSizingFunction(), maxTrackSizingFunction() };
});
}
// https://www.w3.org/TR/css-grid-1/#algo-grid-sizing
UsedTrackSizes GridLayout::performGridSizingAlgorithm(const PlacedGridItems& placedGridItems,
const TrackSizingFunctionsList& columnTrackSizingFunctionsList, const TrackSizingFunctionsList& rowTrackSizingFunctionsList)
{
// 1. First, the track sizing algorithm is used to resolve the sizes of the grid columns.
auto columnSizes = TrackSizingAlgorithm::sizeTracks(placedGridItems, columnTrackSizingFunctionsList);
// 2. Next, the track sizing algorithm resolves the sizes of the grid rows.
auto rowSizes = TrackSizingAlgorithm::sizeTracks(placedGridItems, rowTrackSizingFunctionsList);
// 3. Then, if the min-content contribution of any grid item has changed based on the
// row sizes and alignment calculated in step 2, re-resolve the sizes of the grid
// columns with the new min-content and max-content contributions (once only).
auto resolveGridColumnSizesIfAnyMinContentContributionChanged = [] {
notImplemented();
};
UNUSED_VARIABLE(resolveGridColumnSizesIfAnyMinContentContributionChanged);
// 4. Next, if the min-content contribution of any grid item has changed based on the
// column sizes and alignment calculated in step 3, re-resolve the sizes of the grid
// rows with the new min-content and max-content contributions (once only).
auto resolveGridRowSizesIfAnyMinContentContributionChanged = [] {
notImplemented();
};
UNUSED_VARIABLE(resolveGridRowSizesIfAnyMinContentContributionChanged);
return { columnSizes, rowSizes };
}
// https://drafts.csswg.org/css-grid-1/#auto-margins
Vector<UsedMargins> GridLayout::computeInlineMargins(const PlacedGridItems& placedGridItems, const Style::ZoomFactor& zoomFactor)
{
return placedGridItems.map([&zoomFactor](const PlacedGridItem& placedGridItem) {
auto& inlineAxisSizes = placedGridItem.inlineAxisSizes();
auto marginStart = [&] -> LayoutUnit {
if (auto fixedMarginStart = inlineAxisSizes.marginStart.tryFixed())
return LayoutUnit { fixedMarginStart->resolveZoom(zoomFactor) };
ASSERT_NOT_IMPLEMENTED_YET();
return { };
};
auto marginEnd = [&] -> LayoutUnit {
if (auto fixedMarginEnd = inlineAxisSizes.marginEnd.tryFixed())
return LayoutUnit { fixedMarginEnd->resolveZoom(zoomFactor) };
ASSERT_NOT_IMPLEMENTED_YET();
return { };
};
return UsedMargins { marginStart(), marginEnd() };
});
}
// https://drafts.csswg.org/css-grid-1/#auto-margins
Vector<UsedMargins> GridLayout::computeBlockMargins(const PlacedGridItems& placedGridItems, const Style::ZoomFactor& zoomFactor)
{
return placedGridItems.map([&zoomFactor](const PlacedGridItem& placedGridItem) {
auto& blockAxisSizes = placedGridItem.blockAxisSizes();
auto marginStart = [&] -> LayoutUnit {
if (auto fixedMarginStart = blockAxisSizes.marginStart.tryFixed())
return LayoutUnit { fixedMarginStart->resolveZoom(zoomFactor) };
ASSERT_NOT_IMPLEMENTED_YET();
return { };
};
auto marginEnd = [&] -> LayoutUnit {
if (auto fixedMarginEnd = blockAxisSizes.marginEnd.tryFixed())
return LayoutUnit { fixedMarginEnd->resolveZoom(zoomFactor) };
ASSERT_NOT_IMPLEMENTED_YET();
return { };
};
return UsedMargins { marginStart(), marginEnd() };
});
}
// https://drafts.csswg.org/css-grid-1/#grid-item-sizing
std::pair<GridLayout::UsedInlineSizes, GridLayout::UsedBlockSizes> GridLayout::layoutGridItems(const PlacedGridItems& placedGridItems, const UsedTrackSizes&) const
{
UsedInlineSizes usedInlineSizes;
UsedBlockSizes usedBlockSizes;
auto gridItemsCount = placedGridItems.size();
usedInlineSizes.reserveInitialCapacity(gridItemsCount);
usedBlockSizes.reserveInitialCapacity(gridItemsCount);
auto& formattingContext = this->formattingContext();
auto& integrationUtils = formattingContext.integrationUtils();
for (auto& gridItem : placedGridItems) {
auto& gridItemBoxGeometry = formattingContext.geometryForGridItem(gridItem.layoutBox());
auto usedInlineSizeForGridItem = GridLayoutUtils::usedInlineSizeForGridItem(gridItem) + gridItemBoxGeometry.horizontalBorderAndPadding();
usedInlineSizes.append(usedInlineSizeForGridItem);
auto usedBlockSizeForGridItem = GridLayoutUtils::usedBlockSizeForGridItem(gridItem) + gridItemBoxGeometry.verticalBorderAndPadding();
usedBlockSizes.append(usedBlockSizeForGridItem);
auto& layoutBox = gridItem.layoutBox();
integrationUtils.layoutWithFormattingContextForBox(layoutBox, usedInlineSizeForGridItem, usedBlockSizeForGridItem);
}
return { usedInlineSizes, usedBlockSizes };
}
const ElementBox& GridLayout::gridContainer() const
{
return m_gridFormattingContext->root();
}
const RenderStyle& GridLayout::gridContainerStyle() const
{
return gridContainer().style();
}
} // namespace Layout
} // namespace WebCore
|