[CSS Grid Layout] Fix positioning grid items using named grid lines/areas
[WebKit-https.git] / Source / WebCore / rendering / style / GridPosition.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013, 2014 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef GridPosition_h
33 #define GridPosition_h
34
35 #if ENABLE(CSS_GRID_LAYOUT)
36
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 enum GridPositionType {
42     AutoPosition,
43     ExplicitPosition, // [ <integer> || <string> ]
44     SpanPosition, // span && [ <integer> || <string> ]
45     NamedGridAreaPosition // <ident>
46 };
47
48 enum GridPositionSide {
49     ColumnStartSide,
50     ColumnEndSide,
51     RowStartSide,
52     RowEndSide
53 };
54
55 class GridPosition {
56 public:
57     GridPosition()
58         : m_type(AutoPosition)
59         , m_integerPosition(0)
60     {
61     }
62
63     static inline size_t adjustGridPositionForRowEndColumnEndSide(size_t resolvedPosition)
64     {
65         return resolvedPosition ? resolvedPosition - 1 : 0;
66     }
67
68     static size_t adjustGridPositionForSide(size_t resolvedPosition, GridPositionSide side)
69     {
70         // An item finishing on the N-th line belongs to the N-1-th cell.
71         if (side == ColumnEndSide || side == RowEndSide)
72             return adjustGridPositionForRowEndColumnEndSide(resolvedPosition);
73
74         return resolvedPosition;
75     }
76
77     bool isPositive() const { return integerPosition() > 0; }
78
79     GridPositionType type() const { return m_type; }
80     bool isAuto() const { return m_type == AutoPosition; }
81     bool isSpan() const { return m_type == SpanPosition; }
82     bool isNamedGridArea() const { return m_type == NamedGridAreaPosition; }
83
84     void setExplicitPosition(int position, const String& namedGridLine)
85     {
86         m_type = ExplicitPosition;
87         m_integerPosition = position;
88         m_namedGridLine = namedGridLine;
89     }
90
91     // 'span' values cannot be negative, yet we reuse the <integer> position which can
92     // be. This means that we have to convert the span position to an integer, losing
93     // some precision here. It shouldn't be an issue in practice though.
94     void setSpanPosition(int position, const String& namedGridLine)
95     {
96         m_type = SpanPosition;
97         m_integerPosition = position;
98         m_namedGridLine = namedGridLine;
99     }
100
101     void setNamedGridArea(const String& namedGridArea)
102     {
103         m_type = NamedGridAreaPosition;
104         m_namedGridLine = namedGridArea;
105     }
106
107     int integerPosition() const
108     {
109         ASSERT(type() == ExplicitPosition);
110         return m_integerPosition;
111     }
112
113     String namedGridLine() const
114     {
115         ASSERT(type() == ExplicitPosition || type() == SpanPosition || type() == NamedGridAreaPosition);
116         return m_namedGridLine;
117     }
118
119     int spanPosition() const
120     {
121         ASSERT(type() == SpanPosition);
122         return m_integerPosition;
123     }
124
125     bool operator==(const GridPosition& other) const
126     {
127         return m_type == other.m_type && m_integerPosition == other.m_integerPosition && m_namedGridLine == other.m_namedGridLine;
128     }
129
130     bool shouldBeResolvedAgainstOppositePosition() const
131     {
132         return isAuto() || isSpan();
133     }
134 private:
135     GridPositionType m_type;
136     int m_integerPosition;
137     String m_namedGridLine;
138 };
139
140 } // namespace WebCore
141
142 #endif /* ENABLE(CSS_GRID_LAYOUT) */
143
144 #endif // GridPosition_h