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