[css-grid] Margin wrong applied when stretching an orthogonal item in fixed size...
[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
42 class RenderGrid final : public RenderBlock {
43 public:
44     RenderGrid(Element&, RenderStyle&&);
45     virtual ~RenderGrid();
46
47     Element& element() const { return downcast<Element>(nodeForNonAnonymous()); }
48
49     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
50     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) override;
51
52     bool avoidsFloats() const override { return true; }
53     bool canDropAnonymousBlockChild() const override { return false; }
54
55     void dirtyGrid();
56     Vector<LayoutUnit> trackSizesForComputedStyle(GridTrackSizingDirection) const;
57
58     const Vector<LayoutUnit>& columnPositions() const { return m_columnPositions; }
59     const Vector<LayoutUnit>& rowPositions() const { return m_rowPositions; }
60
61     unsigned autoRepeatCountForDirection(GridTrackSizingDirection direction) const { return m_grid.autoRepeatTracks(direction); }
62
63     // Required by GridTrackSizingAlgorithm. Keep them under control.
64     bool isOrthogonalChild(const RenderBox&) const;
65     LayoutUnit guttersSize(const Grid&, GridTrackSizingDirection, unsigned startLine, unsigned span, std::optional<LayoutUnit> availableSize) const;
66
67 protected:
68     ItemPosition selfAlignmentNormalBehavior(const RenderBox* child = nullptr) const override
69     {
70         ASSERT(child);
71         return child->isRenderReplaced() ? ItemPositionStart : ItemPositionStretch;
72     }
73
74 private:
75     const char* renderName() const override;
76     bool isRenderGrid() const override { return true; }
77     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
78
79     void addChild(RenderObject* newChild, RenderObject* beforeChild) final;
80     void removeChild(RenderObject&) final;
81
82     std::optional<LayoutUnit> availableSpaceForGutters(GridTrackSizingDirection) const;
83
84     bool explicitGridDidResize(const RenderStyle&) const;
85     bool namedGridLinesDefinitionDidChange(const RenderStyle&) const;
86
87     std::optional<LayoutUnit> computeIntrinsicLogicalContentHeightUsing(Length logicalHeightLength, std::optional<LayoutUnit> intrinsicContentHeight, LayoutUnit borderAndPadding) const override;
88
89     unsigned computeAutoRepeatTracksCount(GridTrackSizingDirection, std::optional<LayoutUnit> availableSize) const;
90
91     unsigned clampAutoRepeatTracks(GridTrackSizingDirection, unsigned autoRepeatTracks) const;
92
93     std::unique_ptr<OrderedTrackIndexSet> computeEmptyTracksForAutoRepeat(Grid&, GridTrackSizingDirection) const;
94
95     void placeItemsOnGrid(Grid&, std::optional<LayoutUnit> availableSpaceForColumns) const;
96     void populateExplicitGridAndOrderIterator(Grid&) const;
97     std::unique_ptr<GridArea> createEmptyGridAreaAtSpecifiedPositionsOutsideGrid(Grid&, const RenderBox&, GridTrackSizingDirection, const GridSpan&) const;
98     void placeSpecifiedMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
99     void placeAutoMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
100     typedef std::pair<unsigned, unsigned> AutoPlacementCursor;
101     void placeAutoMajorAxisItemOnGrid(Grid&, RenderBox&, AutoPlacementCursor&) const;
102     GridTrackSizingDirection autoPlacementMajorAxisDirection() const;
103     GridTrackSizingDirection autoPlacementMinorAxisDirection() const;
104
105     bool canPerformSimplifiedLayout() const final;
106     void prepareChildForPositionedLayout(RenderBox&);
107     void layoutPositionedObject(RenderBox&, bool relayoutChildren, bool fixedPositionObjectsOnly) override;
108     void offsetAndBreadthForPositionedChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit& offset, LayoutUnit& breadth);
109
110     void computeTrackSizesForDefiniteSize(GridTrackSizingDirection, LayoutUnit availableSpace);
111     void computeTrackSizesForIndefiniteSize(GridTrackSizingAlgorithm&, GridTrackSizingDirection, Grid&, LayoutUnit& minIntrinsicSize, LayoutUnit& maxIntrinsicSize) const;
112     LayoutUnit computeTrackBasedLogicalHeight() const;
113
114     void repeatTracksSizingIfNeeded(LayoutUnit availableSpaceForColumns, LayoutUnit availableSpaceForRows);
115
116     void layoutGridItems();
117     void populateGridPositionsForDirection(GridTrackSizingDirection);
118
119     GridAxisPosition columnAxisPositionForChild(const RenderBox&) const;
120     GridAxisPosition rowAxisPositionForChild(const RenderBox&) const;
121     LayoutUnit columnAxisOffsetForChild(const RenderBox&) const;
122     LayoutUnit rowAxisOffsetForChild(const RenderBox&) const;
123     ContentAlignmentData computeContentPositionAndDistributionOffset(GridTrackSizingDirection, const LayoutUnit& availableFreeSpace, unsigned numberOfGridTracks) const;
124     LayoutPoint findChildLogicalPosition(const RenderBox&) const;
125     GridArea cachedGridArea(const RenderBox&) const;
126     GridSpan cachedGridSpan(const RenderBox&, GridTrackSizingDirection) const;
127
128     LayoutUnit gridAreaBreadthForChildIncludingAlignmentOffsets(const RenderBox&, GridTrackSizingDirection) const;
129
130     void applyStretchAlignmentToTracksIfNeeded(GridTrackSizingDirection);
131
132     void paintChildren(PaintInfo& forSelf, const LayoutPoint& paintOffset, PaintInfo& forChild, bool usePrintRect) override;
133     LayoutUnit marginLogicalSizeForChild(GridTrackSizingDirection, const RenderBox&) const;
134     LayoutUnit computeMarginLogicalSizeForChild(GridTrackSizingDirection, const RenderBox&) const;
135     LayoutUnit availableAlignmentSpaceForChildBeforeStretching(LayoutUnit gridAreaBreadthForChild, const RenderBox&) const;
136     StyleSelfAlignmentData justifySelfForChild(const RenderBox&) const;
137     StyleSelfAlignmentData alignSelfForChild(const RenderBox&) const;
138     void applyStretchAlignmentToChildIfNeeded(RenderBox&);
139     bool hasAutoSizeInColumnAxis(const RenderBox& child) const { return isHorizontalWritingMode() ? child.style().height().isAuto() : child.style().width().isAuto(); }
140     bool hasAutoSizeInRowAxis(const RenderBox& child) const { return isHorizontalWritingMode() ? child.style().width().isAuto() : child.style().height().isAuto(); }
141     bool allowedToStretchChildAlongColumnAxis(const RenderBox& child) const { return alignSelfForChild(child).position() == ItemPositionStretch && hasAutoSizeInColumnAxis(child) && !hasAutoMarginsInColumnAxis(child); }
142     bool allowedToStretchChildAlongRowAxis(const RenderBox& child) const { return justifySelfForChild(child).position() == ItemPositionStretch && hasAutoSizeInRowAxis(child) && !hasAutoMarginsInRowAxis(child); }
143     bool hasAutoMarginsInColumnAxis(const RenderBox&) const;
144     bool hasAutoMarginsInRowAxis(const RenderBox&) const;
145     void resetAutoMarginsAndLogicalTopInColumnAxis(RenderBox& child);
146     void updateAutoMarginsInColumnAxisIfNeeded(RenderBox&);
147     void updateAutoMarginsInRowAxisIfNeeded(RenderBox&);
148
149     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
150     std::optional<int> firstLineBaseline() const final;
151     std::optional<int> inlineBlockBaseline(LineDirectionMode) const final;
152     bool isInlineBaselineAlignedChild(const RenderBox&) const;
153
154     LayoutUnit gridGap(GridTrackSizingDirection) const;
155     LayoutUnit gridGap(GridTrackSizingDirection, std::optional<LayoutUnit> availableSize) const;
156
157     unsigned numTracks(GridTrackSizingDirection, const Grid&) const;
158
159     LayoutUnit translateRTLCoordinate(LayoutUnit) const;
160
161     GridTrackSizingDirection flowAwareDirectionForChild(const RenderBox&, GridTrackSizingDirection) const;
162
163     Grid m_grid;
164
165     GridTrackSizingAlgorithm m_trackSizingAlgorithm;
166
167     Vector<LayoutUnit> m_columnPositions;
168     Vector<LayoutUnit> m_rowPositions;
169     LayoutUnit m_offsetBetweenColumns;
170     LayoutUnit m_offsetBetweenRows;
171
172     std::optional<LayoutUnit> m_minContentHeight;
173     std::optional<LayoutUnit> m_maxContentHeight;
174 };
175
176 } // namespace WebCore
177
178 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderGrid, isRenderGrid())