src/third_party/WebKit/Source/core/rendering/RenderGrid.h

   1 /*
   2  * Copyright (C) 2011 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef RenderGrid_h
  27 #define RenderGrid_h
  28
  29 #include "core/rendering/OrderIterator.h"
  30 #include "core/rendering/RenderBlock.h"
  31 #include "core/rendering/style/GridResolvedPosition.h"
  32
  33 namespace blink {
  34
  35 struct GridCoordinate;
  36 struct GridSpan;
  37 class GridTrack;
  38 class GridItemWithSpan;
  39
  40 class RenderGrid final : public RenderBlock {
  41 public:
  42     RenderGrid(Element*);
  43     virtual ~RenderGrid();
  44
  45     virtual const char* renderName() const override;
  46
  47     virtual void layoutBlock(bool relayoutChildren) override;
  48
  49     virtual bool canCollapseAnonymousBlockChild() const override { return false; }
  50
  51     void dirtyGrid();
  52
  53     const Vector<LayoutUnit>& columnPositions() const { return m_columnPositions; }
  54     const Vector<LayoutUnit>& rowPositions() const { return m_rowPositions; }
  55
  56     typedef Vector<RenderBox*, 1> GridCell;
  57     const GridCell& gridCell(int row, int column) { return m_grid[row][column]; }
  58     const Vector<RenderBox*>& itemsOverflowingGridArea() { return m_gridItemsOverflowingGridArea; }
  59     int paintIndexForGridItem(const RenderBox* renderBox) { return m_gridItemsIndexesMap.get(renderBox); }
  60
  61     bool gridIsDirty() const { return m_gridIsDirty; }
  62
  63 private:
  64     virtual bool isOfType(RenderObjectType type) const override { return type == RenderObjectRenderGrid || RenderBlock::isOfType(type); }
  65     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
  66     virtual void computePreferredLogicalWidths() override;
  67
  68     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) override;
  69     void addChildToIndexesMap(RenderBox&);
  70     virtual void removeChild(RenderObject*) override;
  71
  72     virtual void styleDidChange(StyleDifference, const RenderStyle*) override;
  73
  74     bool explicitGridDidResize(const RenderStyle*) const;
  75     bool namedGridLinesDefinitionDidChange(const RenderStyle*) const;
  76
  77     class GridIterator;
  78     struct GridSizingData;
  79     bool gridElementIsShrinkToFit();
  80     void computeUsedBreadthOfGridTracks(GridTrackSizingDirection, GridSizingData&);
  81     void computeUsedBreadthOfGridTracks(GridTrackSizingDirection, GridSizingData&, LayoutUnit& availableLogicalSpace);
  82     LayoutUnit computeUsedBreadthOfMinLength(GridTrackSizingDirection, const GridLength&) const;
  83     LayoutUnit computeUsedBreadthOfMaxLength(GridTrackSizingDirection, const GridLength&, LayoutUnit usedBreadth) const;
  84     LayoutUnit computeUsedBreadthOfSpecifiedLength(GridTrackSizingDirection, const Length&) const;
  85     void resolveContentBasedTrackSizingFunctions(GridTrackSizingDirection, GridSizingData&, LayoutUnit& availableLogicalSpace);
  86
  87     void ensureGridSize(size_t maximumRowIndex, size_t maximumColumnIndex);
  88     void insertItemIntoGrid(RenderBox&, const GridCoordinate&);
  89     void placeItemsOnGrid();
  90     void populateExplicitGridAndOrderIterator();
  91     PassOwnPtr<GridCoordinate> createEmptyGridAreaAtSpecifiedPositionsOutsideGrid(const RenderBox&, GridTrackSizingDirection, const GridSpan& specifiedPositions) const;
  92     void placeSpecifiedMajorAxisItemsOnGrid(const Vector<RenderBox*>&);
  93     void placeAutoMajorAxisItemsOnGrid(const Vector<RenderBox*>&);
  94     void placeAutoMajorAxisItemOnGrid(RenderBox&, std::pair<size_t, size_t>& autoPlacementCursor);
  95     GridTrackSizingDirection autoPlacementMajorAxisDirection() const;
  96     GridTrackSizingDirection autoPlacementMinorAxisDirection() const;
  97
  98     void layoutGridItems();
  99     void populateGridPositions(const GridSizingData&);
 100
 101     typedef LayoutUnit (RenderGrid::* SizingFunction)(RenderBox&, GridTrackSizingDirection, Vector<GridTrack>&);
 102     typedef LayoutUnit (GridTrack::* AccumulatorGetter)() const;
 103     typedef void (GridTrack::* AccumulatorGrowFunction)(LayoutUnit);
 104     typedef bool (GridTrackSize::* FilterFunction)() const;
 105     void resolveContentBasedTrackSizingFunctionsForItems(GridTrackSizingDirection, GridSizingData&, GridItemWithSpan&, FilterFunction, SizingFunction, AccumulatorGetter, AccumulatorGrowFunction, FilterFunction growAboveMaxBreadthFilterFunction = nullptr);
 106     void distributeSpaceToTracks(Vector<GridTrack*>&, Vector<size_t>* tracksForGrowthAboveMaxBreadth, AccumulatorGetter, AccumulatorGrowFunction, GridSizingData&, LayoutUnit& availableLogicalSpace);
 107
 108     double computeNormalizedFractionBreadth(Vector<GridTrack>&, const GridSpan& tracksSpan, GridTrackSizingDirection, LayoutUnit availableLogicalSpace) const;
 109
 110     GridTrackSize gridTrackSize(GridTrackSizingDirection, size_t) const;
 111
 112     LayoutUnit logicalHeightForChild(RenderBox&, Vector<GridTrack>&);
 113     LayoutUnit minContentForChild(RenderBox&, GridTrackSizingDirection, Vector<GridTrack>& columnTracks);
 114     LayoutUnit maxContentForChild(RenderBox&, GridTrackSizingDirection, Vector<GridTrack>& columnTracks);
 115     LayoutUnit startOfColumnForChild(const RenderBox& child) const;
 116     LayoutUnit endOfColumnForChild(const RenderBox& child) const;
 117     LayoutUnit columnPositionAlignedWithGridContainerStart(const RenderBox&) const;
 118     LayoutUnit columnPositionAlignedWithGridContainerEnd(const RenderBox&) const;
 119     LayoutUnit centeredColumnPositionForChild(const RenderBox&) const;
 120     LayoutUnit columnPositionForChild(const RenderBox&) const;
 121     LayoutUnit startOfRowForChild(const RenderBox& child) const;
 122     LayoutUnit endOfRowForChild(const RenderBox& child) const;
 123     LayoutUnit centeredRowPositionForChild(const RenderBox&) const;
 124     LayoutUnit rowPositionForChild(const RenderBox&) const;
 125     LayoutPoint findChildLogicalPosition(const RenderBox&) const;
 126     GridCoordinate cachedGridCoordinate(const RenderBox&) const;
 127
 128     LayoutUnit gridAreaBreadthForChild(const RenderBox& child, GridTrackSizingDirection, const Vector<GridTrack>&) const;
 129
 130     virtual void paintChildren(PaintInfo&, const LayoutPoint&) override;
 131     bool needToStretchChildLogicalHeight(const RenderBox&) const;
 132     LayoutUnit childIntrinsicHeight(const RenderBox&) const;
 133     LayoutUnit childIntrinsicWidth(const RenderBox&) const;
 134     LayoutUnit intrinsicLogicalHeightForChild(const RenderBox&) const;
 135     LayoutUnit marginLogicalHeightForChild(const RenderBox&) const;
 136     LayoutUnit availableAlignmentSpaceForChildBeforeStretching(LayoutUnit gridAreaBreadthForChild, const RenderBox&) const;
 137     void applyStretchAlignmentToChildIfNeeded(RenderBox&, LayoutUnit gridAreaBreadthForChild);
 138
 139 #if ENABLE(ASSERT)
 140     bool tracksAreWiderThanMinTrackBreadth(GridTrackSizingDirection, const Vector<GridTrack>&);
 141 #endif
 142
 143     size_t gridItemSpan(const RenderBox&, GridTrackSizingDirection);
 144     bool spanningItemCrossesFlexibleSizedTracks(const GridCoordinate&, GridTrackSizingDirection) const;
 145
 146     size_t gridColumnCount() const
 147     {
 148         ASSERT(!gridIsDirty());
 149         return m_grid[0].size();
 150     }
 151     size_t gridRowCount() const
 152     {
 153         ASSERT(!gridIsDirty());
 154         return m_grid.size();
 155     }
 156
 157     typedef Vector<Vector<GridCell> > GridRepresentation;
 158     GridRepresentation m_grid;
 159     bool m_gridIsDirty;
 160     Vector<LayoutUnit> m_rowPositions;
 161     Vector<LayoutUnit> m_columnPositions;
 162     HashMap<const RenderBox*, GridCoordinate> m_gridItemCoordinate;
 163     OrderIterator m_orderIterator;
 164     Vector<RenderBox*> m_gridItemsOverflowingGridArea;
 165     HashMap<const RenderBox*, size_t> m_gridItemsIndexesMap;
 166 };
 167
 168 DEFINE_RENDER_OBJECT_TYPE_CASTS(RenderGrid, isRenderGrid());
 169
 170 } // namespace blink
 171
 172 #endif // RenderGrid_h