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     WTF_MAKE_NONCOPYABLE(ContentAlignmentData); WTF_MAKE_FAST_ALLOCATED;
  40 public:
  41     ContentAlignmentData() = default;
  42     bool isValid() const { return positionOffset >= 0 && distributionOffset >= 0; }
  43
  44     LayoutUnit positionOffset;
  45     LayoutUnit distributionOffset;
  46 };
  47
  48 enum GridAxisPosition {GridAxisStart, GridAxisEnd, GridAxisCenter};
  49
  50 class RenderGrid final : public RenderBlock {
  51     WTF_MAKE_ISO_ALLOCATED(RenderGrid);
  52 public:
  53     RenderGrid(Element&, RenderStyle&&);
  54     virtual ~RenderGrid();
  55
  56     Element& element() const { return downcast<Element>(nodeForNonAnonymous()); }
  57
  58     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
  59     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0_lu) override;
  60
  61     bool avoidsFloats() const override { return true; }
  62     bool canDropAnonymousBlockChild() const override { return false; }
  63
  64     void dirtyGrid();
  65     Vector<LayoutUnit> trackSizesForComputedStyle(GridTrackSizingDirection) const;
  66
  67     const Vector<LayoutUnit>& columnPositions() const { return m_columnPositions; }
  68     const Vector<LayoutUnit>& rowPositions() const { return m_rowPositions; }
  69
  70     unsigned autoRepeatCountForDirection(GridTrackSizingDirection direction) const { return m_grid.autoRepeatTracks(direction); }
  71     unsigned explicitGridStartForDirection(GridTrackSizingDirection direction) const { return m_grid.explicitGridStart(direction); }
  72
  73     // Required by GridTrackSizingAlgorithm. Keep them under control.
  74     LayoutUnit guttersSize(const Grid&, GridTrackSizingDirection, unsigned startLine, unsigned span, Optional<LayoutUnit> availableSize) const;
  75     LayoutUnit gridItemOffset(GridTrackSizingDirection) const;
  76
  77     void updateGridAreaLogicalSize(RenderBox&, Optional<LayoutUnit> width, Optional<LayoutUnit> height) const;
  78     bool isBaselineAlignmentForChild(const RenderBox&) const;
  79     bool isBaselineAlignmentForChild(const RenderBox&, GridAxis) const;
  80
  81     StyleSelfAlignmentData selfAlignmentForChild(GridAxis, const RenderBox&, const RenderStyle* = nullptr) const;
  82
  83     StyleContentAlignmentData contentAlignment(GridTrackSizingDirection) const;
  84
  85 private:
  86     ItemPosition selfAlignmentNormalBehavior(const RenderBox* child = nullptr) const override
  87     {
  88         ASSERT(child);
  89         return child->isRenderReplaced() ? ItemPosition::Start : ItemPosition::Stretch;
  90     }
  91
  92     const char* renderName() const override;
  93     bool isRenderGrid() const override { return true; }
  94     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
  95
  96     bool selfAlignmentChangedToStretch(GridAxis, const RenderStyle& oldStyle, const RenderStyle& newStyle, const RenderBox&) const;
  97     bool selfAlignmentChangedFromStretch(GridAxis, const RenderStyle& oldStyle, const RenderStyle& newStyle, const RenderBox&) const;
  98
  99     Optional<LayoutUnit> availableSpaceForGutters(GridTrackSizingDirection) const;
 100
 101     bool explicitGridDidResize(const RenderStyle&) const;
 102     bool namedGridLinesDefinitionDidChange(const RenderStyle&) const;
 103
 104     unsigned computeAutoRepeatTracksCount(GridTrackSizingDirection, Optional<LayoutUnit> availableSize) const;
 105
 106     unsigned clampAutoRepeatTracks(GridTrackSizingDirection, unsigned autoRepeatTracks) const;
 107
 108     std::unique_ptr<OrderedTrackIndexSet> computeEmptyTracksForAutoRepeat(Grid&, GridTrackSizingDirection) const;
 109
 110     void performGridItemsPreLayout(const GridTrackSizingAlgorithm&) const;
 111
 112     void placeItemsOnGrid(GridTrackSizingAlgorithm&, Optional<LayoutUnit> availableLogicalWidth) const;
 113     void populateExplicitGridAndOrderIterator(Grid&) const;
 114     std::unique_ptr<GridArea> createEmptyGridAreaAtSpecifiedPositionsOutsideGrid(Grid&, const RenderBox&, GridTrackSizingDirection, const GridSpan&) const;
 115     void placeSpecifiedMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
 116     void placeAutoMajorAxisItemsOnGrid(Grid&, const Vector<RenderBox*>&) const;
 117     typedef std::pair<unsigned, unsigned> AutoPlacementCursor;
 118     void placeAutoMajorAxisItemOnGrid(Grid&, RenderBox&, AutoPlacementCursor&) const;
 119     GridTrackSizingDirection autoPlacementMajorAxisDirection() const;
 120     GridTrackSizingDirection autoPlacementMinorAxisDirection() const;
 121
 122     bool canPerformSimplifiedLayout() const final;
 123     void prepareChildForPositionedLayout(RenderBox&);
 124     bool hasStaticPositionForChild(const RenderBox&, GridTrackSizingDirection) const;
 125     void layoutPositionedObject(RenderBox&, bool relayoutChildren, bool fixedPositionObjectsOnly) override;
 126
 127     void computeTrackSizesForDefiniteSize(GridTrackSizingDirection, LayoutUnit availableSpace);
 128     void computeTrackSizesForIndefiniteSize(GridTrackSizingAlgorithm&, GridTrackSizingDirection, LayoutUnit* minIntrinsicSize = nullptr, LayoutUnit* maxIntrinsicSize = nullptr) const;
 129     LayoutUnit computeTrackBasedLogicalHeight() const;
 130
 131     void repeatTracksSizingIfNeeded(LayoutUnit availableSpaceForColumns, LayoutUnit availableSpaceForRows);
 132
 133     void layoutGridItems();
 134     void populateGridPositionsForDirection(GridTrackSizingDirection);
 135
 136     LayoutUnit resolveAutoStartGridPosition(GridTrackSizingDirection) const;
 137     LayoutUnit resolveAutoEndGridPosition(GridTrackSizingDirection) const;
 138     LayoutUnit gridAreaBreadthForOutOfFlowChild(const RenderBox&, GridTrackSizingDirection);
 139     LayoutUnit logicalOffsetForOutOfFlowChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit) const;
 140     void gridAreaPositionForOutOfFlowChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit& start, LayoutUnit& end) const;
 141     void gridAreaPositionForInFlowChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit& start, LayoutUnit& end) const;
 142     void gridAreaPositionForChild(const RenderBox&, GridTrackSizingDirection, LayoutUnit& start, LayoutUnit& end) const;
 143
 144     GridAxisPosition columnAxisPositionForChild(const RenderBox&) const;
 145     GridAxisPosition rowAxisPositionForChild(const RenderBox&) const;
 146     LayoutUnit columnAxisOffsetForChild(const RenderBox&) const;
 147     LayoutUnit rowAxisOffsetForChild(const RenderBox&) const;
 148     void computeContentPositionAndDistributionOffset(GridTrackSizingDirection, const LayoutUnit& availableFreeSpace, unsigned numberOfGridTracks);
 149     void setLogicalPositionForChild(RenderBox&) const;
 150     void setLogicalOffsetForChild(RenderBox&, GridTrackSizingDirection) const;
 151     LayoutUnit logicalOffsetForChild(const RenderBox&, GridTrackSizingDirection) const;
 152     GridArea cachedGridArea(const RenderBox&) const;
 153     GridSpan cachedGridSpan(const RenderBox&, GridTrackSizingDirection) const;
 154
 155     LayoutUnit gridAreaBreadthForChildIncludingAlignmentOffsets(const RenderBox&, GridTrackSizingDirection) const;
 156
 157     void paintChildren(PaintInfo& forSelf, const LayoutPoint& paintOffset, PaintInfo& forChild, bool usePrintRect) override;
 158     LayoutUnit availableAlignmentSpaceForChildBeforeStretching(LayoutUnit gridAreaBreadthForChild, const RenderBox&) const;
 159     StyleSelfAlignmentData justifySelfForChild(const RenderBox&, const RenderStyle* = nullptr) const;
 160     StyleSelfAlignmentData alignSelfForChild(const RenderBox&, const RenderStyle* = nullptr) const;
 161     void applyStretchAlignmentToChildIfNeeded(RenderBox&);
 162     bool hasAutoSizeInColumnAxis(const RenderBox& child) const;
 163     bool hasAutoSizeInRowAxis(const RenderBox& child) const;
 164     bool allowedToStretchChildAlongColumnAxis(const RenderBox& child) const { return alignSelfForChild(child).position() == ItemPosition::Stretch && hasAutoSizeInColumnAxis(child) && !hasAutoMarginsInColumnAxis(child); }
 165     bool allowedToStretchChildAlongRowAxis(const RenderBox& child) const { return justifySelfForChild(child).position() == ItemPosition::Stretch && hasAutoSizeInRowAxis(child) && !hasAutoMarginsInRowAxis(child); }
 166     bool hasAutoMarginsInColumnAxis(const RenderBox&) const;
 167     bool hasAutoMarginsInRowAxis(const RenderBox&) const;
 168     void resetAutoMarginsAndLogicalTopInColumnAxis(RenderBox& child);
 169     void updateAutoMarginsInColumnAxisIfNeeded(RenderBox&);
 170     void updateAutoMarginsInRowAxisIfNeeded(RenderBox&);
 171
 172     LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
 173     Optional<LayoutUnit> firstLineBaseline() const final;
 174     Optional<LayoutUnit> inlineBlockBaseline(LineDirectionMode) const final;
 175     bool isInlineBaselineAlignedChild(const RenderBox&) const;
 176
 177     LayoutUnit columnAxisBaselineOffsetForChild(const RenderBox&) const;
 178     LayoutUnit rowAxisBaselineOffsetForChild(const RenderBox&) const;
 179
 180     LayoutUnit gridGap(GridTrackSizingDirection) const;
 181     LayoutUnit gridGap(GridTrackSizingDirection, Optional<LayoutUnit> availableSize) const;
 182
 183     unsigned nonCollapsedTracks(GridTrackSizingDirection) const;
 184     unsigned numTracks(GridTrackSizingDirection, const Grid&) const;
 185
 186     LayoutUnit translateOutOfFlowRTLCoordinate(const RenderBox&, LayoutUnit) const;
 187     LayoutUnit translateRTLCoordinate(LayoutUnit) const;
 188
 189     bool shouldResetLogicalHeightBeforeLayout() const override { return true; }
 190
 191     Grid m_grid;
 192
 193     GridTrackSizingAlgorithm m_trackSizingAlgorithm;
 194
 195     Vector<LayoutUnit> m_columnPositions;
 196     Vector<LayoutUnit> m_rowPositions;
 197     ContentAlignmentData m_offsetBetweenColumns;
 198     ContentAlignmentData m_offsetBetweenRows;
 199
 200     typedef HashMap<const RenderBox*, Optional<size_t>> OutOfFlowPositionsMap;
 201     OutOfFlowPositionsMap m_outOfFlowItemColumn;
 202     OutOfFlowPositionsMap m_outOfFlowItemRow;
 203
 204     bool m_hasAnyOrthogonalItem {false};
 205     bool m_baselineItemsCached {false};
 206 };
 207
 208 } // namespace WebCore
 209
 210 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderGrid, isRenderGrid())