[css-grid] Remove compilation flag ENABLE_CSS_GRID_LAYOUT
[WebKit-https.git] / Source / WebCore / rendering / Grid.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
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 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 #pragma once
27
28 #include "GridPositionsResolver.h"
29 #include "OrderIterator.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/ListHashSet.h>
32
33 namespace WebCore {
34
35 typedef Vector<RenderBox*, 1> GridCell;
36 typedef Vector<Vector<GridCell>> GridAsMatrix;
37 typedef ListHashSet<size_t> OrderedTrackIndexSet;
38
39 class GridArea;
40 class GridPositionsResolver;
41 class RenderGrid;
42
43 class Grid final {
44 public:
45     explicit Grid(RenderGrid&);
46
47     unsigned numTracks(GridTrackSizingDirection) const;
48
49     void ensureGridSize(unsigned maximumRowSize, unsigned maximumColumnSize);
50     void insert(RenderBox&, const GridArea&);
51
52     // Note that each in flow child of a grid container becomes a grid item. This means that
53     // this method will return false for a grid container with only out of flow children.
54     bool hasGridItems() const { return !m_gridItemArea.isEmpty(); }
55
56     // FIXME: move this to SizingData once placeItemsOnGrid() takes it as argument.
57     bool hasAnyOrthogonalGridItem() const { return m_hasAnyOrthogonalGridItem; }
58     void setHasAnyOrthogonalGridItem(bool hasAnyOrthogonalGridItem) { m_hasAnyOrthogonalGridItem = hasAnyOrthogonalGridItem; }
59
60     GridArea gridItemArea(const RenderBox& item) const;
61     void setGridItemArea(const RenderBox& item, GridArea);
62
63     GridSpan gridItemSpan(const RenderBox&, GridTrackSizingDirection) const;
64
65     const GridCell& cell(unsigned row, unsigned column) const { return m_grid[row][column]; }
66
67     int smallestTrackStart(GridTrackSizingDirection) const;
68     void setSmallestTracksStart(int rowStart, int columnStart);
69
70     unsigned autoRepeatTracks(GridTrackSizingDirection) const;
71     void setAutoRepeatTracks(unsigned autoRepeatRows, unsigned autoRepeatColumns);
72
73     void setAutoRepeatEmptyColumns(std::unique_ptr<OrderedTrackIndexSet>);
74     void setAutoRepeatEmptyRows(std::unique_ptr<OrderedTrackIndexSet>);
75
76     unsigned autoRepeatEmptyTracksCount(GridTrackSizingDirection) const;
77     bool hasAutoRepeatEmptyTracks(GridTrackSizingDirection) const;
78     bool isEmptyAutoRepeatTrack(GridTrackSizingDirection, unsigned) const;
79
80     OrderedTrackIndexSet* autoRepeatEmptyTracks(GridTrackSizingDirection) const;
81
82     OrderIterator& orderIterator() { return m_orderIterator; }
83
84     void setNeedsItemsPlacement(bool);
85     bool needsItemsPlacement() const { return m_needsItemsPlacement; };
86
87 private:
88     friend class GridIterator;
89
90     OrderIterator m_orderIterator;
91
92     int m_smallestColumnStart { 0 };
93     int m_smallestRowStart { 0 };
94
95     unsigned m_autoRepeatColumns { 0 };
96     unsigned m_autoRepeatRows { 0 };
97
98     bool m_hasAnyOrthogonalGridItem { false };
99     bool m_needsItemsPlacement { true };
100
101     GridAsMatrix m_grid;
102
103     HashMap<const RenderBox*, GridArea> m_gridItemArea;
104     HashMap<const RenderBox*, size_t> m_gridItemsIndexesMap;
105
106     std::unique_ptr<OrderedTrackIndexSet> m_autoRepeatEmptyColumns;
107     std::unique_ptr<OrderedTrackIndexSet> m_autoRepeatEmptyRows;
108 };
109
110 class GridIterator {
111     WTF_MAKE_NONCOPYABLE(GridIterator);
112 public:
113     // |direction| is the direction that is fixed to |fixedTrackIndex| so e.g
114     // GridIterator(m_grid, ForColumns, 1) will walk over the rows of the 2nd column.
115     GridIterator(const Grid&, GridTrackSizingDirection, unsigned fixedTrackIndex, unsigned varyingTrackIndex = 0);
116
117     RenderBox* nextGridItem();
118     bool isEmptyAreaEnough(unsigned rowSpan, unsigned columnSpan) const;
119     std::unique_ptr<GridArea> nextEmptyGridArea(unsigned fixedTrackSpan, unsigned varyingTrackSpan);
120
121 private:
122     const GridAsMatrix& m_grid;
123     GridTrackSizingDirection m_direction;
124     unsigned m_rowIndex;
125     unsigned m_columnIndex;
126     unsigned m_childIndex;
127 };
128
129 } // namespace WebCore