93666ff6ab01cf9e576a0293976fea84b6403cfe
[WebKit-https.git] / Source / WebCore / rendering / RenderGrid.h
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2013-2017 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "Grid.h"
30 #include "GridTrackSizingAlgorithm.h"
31 #include "RenderBlock.h"
32
33 namespace WebCore {
34
35 class GridArea;
36 class GridSpan;
37
38 struct ContentAlignmentData;
39
40 enum GridAxisPosition {GridAxisStart, GridAxisEnd, GridAxisCenter};
41 enum GridAxis { GridRowAxis, GridColumnAxis };
42
43 class RenderGrid final : public RenderBlock {
44     WTF_MAKE_ISO_ALLOCATED(RenderGrid);
45 public:
46     RenderGrid(Element&, RenderStyle&&);
47     virtual ~RenderGrid();
48
49     Element& element() const { return downcast<Element>(nodeForNonAnonymous()); }
50
51     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
52     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) override;
53
54     bool avoidsFloats() const override { return true; }
55     bool canDropAnonymousBlockChild() const override { return false; }
56
57     void dirtyGrid();
58     Vector<LayoutUnit> trackSizesForComputedStyle(GridTrackSizingDirection) const;
59
60     const Vector<LayoutUnit>& columnPositions() const { return m_columnPositions; }
61     const Vector<LayoutUnit>& rowPositions() const { return m_rowPositions; }
62
63     unsigned autoRepeatCountForDirection(GridTrackSizingDirection direction) const { return m_grid.autoRepeatTracks(direction); }
64
65     // Required by GridTrackSizingAlgorithm. Keep them under control.
66     LayoutUnit guttersSize(const Grid&, GridTrackSizingDirection, unsigned startLine, unsigned span, std::optional<LayoutUnit> availableSize) const;
67
68     StyleContentAlignmentData contentAlignment(GridTrackSizingDirection) const;
69
70 protected:
71     ItemPosition selfAlignmentNormalBehavior(const RenderBox* child = nullptr) const override
72     {
73         ASSERT(child);
74         return child->isRenderReplaced() ? ItemPositionStart : ItemPositionStretch;
75     }
76
77 private:
78     const char* renderName() const override;
79     bool isRenderGrid() const override { return true; }
80     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
81
82     void addChild(RenderPtr<RenderObject> newChild, RenderObject* beforeChild) final;
83     RenderPtr<RenderObject> takeChild(RenderObject&) final;
84
85     StyleSelfAlignmentData selfAlignmentForChild(GridAxis, const RenderBox&, const RenderStyle* = nullptr) const;
86     bool selfAlignmentChangedToStretch(GridAxis, const RenderStyle& oldStyle, const RenderStyle& newStyle, const RenderBox&) const;
87     bool selfAlignmentChangedFromStretch(GridAxis, const RenderStyle& oldStyle, const RenderStyle& newStyle, const RenderBox&) const;
88
89     std::optional<LayoutUnit> availableSpaceForGutters(GridTrackSizingDirection) const;
90
91     bool explicitGridDidResize(const RenderStyle&) const;
92     bool namedGridLinesDefinitionDidChange(const RenderStyle&) const;
93
94     std::optional<LayoutUnit> computeIntrinsicLogicalContentHeightUsing(Length logicalHeightLength, std::optional<LayoutUnit> intrinsicContentHeight, LayoutUnit borderAndPadding) const override;
95
96     unsigned computeAutoRepeatTracksCount(GridTrackSizingDirection, std::optional<LayoutUnit> availableSize) const;
97
98     unsigned clampAutoRepeatTracks(GridTrackSizingDirection, unsigned autoRepeatTracks) const;
99
100     std::unique_ptr<OrderedTrackIndexSet> computeEmptyTracksForAutoRepeat(Grid&, GridTrackSizingDirection) const;
101
102     void placeItemsOnGrid(Grid&, std::optional<LayoutUnit> availableSpaceForColumns) const;
103     void populateExplicitGridAndOrderIterator(Grid&) const;
104     std::unique_ptr<GridArea> createEmptyGridAreaAtSpecifiedPositionsOutsideGrid(Grid&, const RenderBox&, GridTrackSizingDirection, const GridSpan&) const;
105     void placeSpecifiedMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
106     void placeAutoMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
107     typedef std::pair<unsigned, unsigned> AutoPlacementCursor;
108     void placeAutoMajorAxisItemOnGrid(Grid&, RenderBox&, AutoPlacementCursor&) const;
109     GridTrackSizingDirection autoPlacementMajorAxisDirection() const;
110     GridTrackSizingDirection autoPlacementMinorAxisDirection() const;
111
112     bool canPerformSimplifiedLayout() const final;
113     void prepareChildForPositionedLayout(RenderBox&);
114     void layoutPositionedObject(RenderBox&, bool relayoutChildren, bool fixedPositionObjectsOnly) override;
115     void offsetAndBreadthForPositionedChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit& offset, LayoutUnit& breadth);
116
117     void computeTrackSizesForDefiniteSize(GridTrackSizingDirection, LayoutUnit availableSpace);
118     void computeTrackSizesForIndefiniteSize(GridTrackSizingAlgorithm&, GridTrackSizingDirection, Grid&, LayoutUnit& minIntrinsicSize, LayoutUnit& maxIntrinsicSize) const;
119     LayoutUnit computeTrackBasedLogicalHeight() const;
120
121     void repeatTracksSizingIfNeeded(LayoutUnit availableSpaceForColumns, LayoutUnit availableSpaceForRows);
122
123     void layoutGridItems();
124     void populateGridPositionsForDirection(GridTrackSizingDirection);
125
126     GridAxisPosition columnAxisPositionForChild(const RenderBox&) const;
127     GridAxisPosition rowAxisPositionForChild(const RenderBox&) const;
128     LayoutUnit columnAxisOffsetForChild(const RenderBox&) const;
129     LayoutUnit rowAxisOffsetForChild(const RenderBox&) const;
130     ContentAlignmentData computeContentPositionAndDistributionOffset(GridTrackSizingDirection, const LayoutUnit& availableFreeSpace, unsigned numberOfGridTracks) const;
131     LayoutPoint findChildLogicalPosition(const RenderBox&) const;
132     GridArea cachedGridArea(const RenderBox&) const;
133     GridSpan cachedGridSpan(const RenderBox&, GridTrackSizingDirection) const;
134
135     LayoutUnit gridAreaBreadthForChildIncludingAlignmentOffsets(const RenderBox&, GridTrackSizingDirection) const;
136
137     void paintChildren(PaintInfo& forSelf, const LayoutPoint& paintOffset, PaintInfo& forChild, bool usePrintRect) override;
138     LayoutUnit availableAlignmentSpaceForChildBeforeStretching(LayoutUnit gridAreaBreadthForChild, const RenderBox&) const;
139     StyleSelfAlignmentData justifySelfForChild(const RenderBox&, const RenderStyle* = nullptr) const;
140     StyleSelfAlignmentData alignSelfForChild(const RenderBox&, const RenderStyle* = nullptr) const;
141     void applyStretchAlignmentToChildIfNeeded(RenderBox&);
142     bool hasAutoSizeInColumnAxis(const RenderBox& child) const { return isHorizontalWritingMode() ? child.style().height().isAuto() : child.style().width().isAuto(); }
143     bool hasAutoSizeInRowAxis(const RenderBox& child) const { return isHorizontalWritingMode() ? child.style().width().isAuto() : child.style().height().isAuto(); }
144     bool allowedToStretchChildAlongColumnAxis(const RenderBox& child) const { return alignSelfForChild(child).position() == ItemPositionStretch && hasAutoSizeInColumnAxis(child) && !hasAutoMarginsInColumnAxis(child); }
145     bool allowedToStretchChildAlongRowAxis(const RenderBox& child) const { return justifySelfForChild(child).position() == ItemPositionStretch && hasAutoSizeInRowAxis(child) && !hasAutoMarginsInRowAxis(child); }
146     bool hasAutoMarginsInColumnAxis(const RenderBox&) const;
147     bool hasAutoMarginsInRowAxis(const RenderBox&) const;
148     void resetAutoMarginsAndLogicalTopInColumnAxis(RenderBox& child);
149     void updateAutoMarginsInColumnAxisIfNeeded(RenderBox&);
150     void updateAutoMarginsInRowAxisIfNeeded(RenderBox&);
151
152     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
153     std::optional<int> firstLineBaseline() const final;
154     std::optional<int> inlineBlockBaseline(LineDirectionMode) const final;
155     bool isInlineBaselineAlignedChild(const RenderBox&) const;
156
157     LayoutUnit gridGap(GridTrackSizingDirection) const;
158     LayoutUnit gridGap(GridTrackSizingDirection, std::optional<LayoutUnit> availableSize) const;
159
160     unsigned numTracks(GridTrackSizingDirection, const Grid&) const;
161
162     LayoutUnit translateRTLCoordinate(LayoutUnit) const;
163
164     Grid m_grid;
165
166     GridTrackSizingAlgorithm m_trackSizingAlgorithm;
167
168     Vector<LayoutUnit> m_columnPositions;
169     Vector<LayoutUnit> m_rowPositions;
170     LayoutUnit m_offsetBetweenColumns;
171     LayoutUnit m_offsetBetweenRows;
172
173     std::optional<LayoutUnit> m_minContentHeight;
174     std::optional<LayoutUnit> m_maxContentHeight;
175 };
176
177 } // namespace WebCore
178
179 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderGrid, isRenderGrid())