f2ed01e9802bdff836f0d2c4252eb22ad0bde744
[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 #pragma once
33
34 #if ENABLE(CSS_GRID_LAYOUT)
35
36 #include <wtf/text/WTFString.h>
37
38 namespace WebCore {
39
40 // Recommended maximum size for both explicit and implicit grids.
41 const int kGridMaxTracks = 1000000;
42
43 enum GridPositionType {
44     AutoPosition,
45     ExplicitPosition, // [ <integer> || <string> ]
46     SpanPosition, // span && [ <integer> || <string> ]
47     NamedGridAreaPosition // <ident>
48 };
49
50 enum GridPositionSide {
51     ColumnStartSide,
52     ColumnEndSide,
53     RowStartSide,
54     RowEndSide
55 };
56
57 class GridPosition {
58 public:
59     GridPosition()
60         : m_type(AutoPosition)
61         , m_integerPosition(0)
62     {
63     }
64
65     bool isPositive() const { return integerPosition() > 0; }
66
67     GridPositionType type() const { return m_type; }
68     bool isAuto() const { return m_type == AutoPosition; }
69     bool isSpan() const { return m_type == SpanPosition; }
70     bool isNamedGridArea() const { return m_type == NamedGridAreaPosition; }
71
72     void setExplicitPosition(int position, const String& namedGridLine)
73     {
74         m_type = ExplicitPosition;
75         setIntegerPosition(position);
76         m_namedGridLine = namedGridLine;
77     }
78
79     void setAutoPosition()
80     {
81         m_type = AutoPosition;
82         m_integerPosition = 0;
83     }
84
85     // 'span' values cannot be negative, yet we reuse the <integer> position which can
86     // be. This means that we have to convert the span position to an integer, losing
87     // some precision here. It shouldn't be an issue in practice though.
88     void setSpanPosition(int position, const String& namedGridLine)
89     {
90         m_type = SpanPosition;
91         setIntegerPosition(position);
92         m_namedGridLine = namedGridLine;
93     }
94
95     void setNamedGridArea(const String& namedGridArea)
96     {
97         m_type = NamedGridAreaPosition;
98         m_namedGridLine = namedGridArea;
99     }
100
101     int integerPosition() const
102     {
103         ASSERT(type() == ExplicitPosition);
104         return m_integerPosition;
105     }
106
107     String namedGridLine() const
108     {
109         ASSERT(type() == ExplicitPosition || type() == SpanPosition || type() == NamedGridAreaPosition);
110         return m_namedGridLine;
111     }
112
113     int spanPosition() const
114     {
115         ASSERT(type() == SpanPosition);
116         return m_integerPosition;
117     }
118
119     bool operator==(const GridPosition& other) const
120     {
121         return m_type == other.m_type && m_integerPosition == other.m_integerPosition && m_namedGridLine == other.m_namedGridLine;
122     }
123
124     bool shouldBeResolvedAgainstOppositePosition() const
125     {
126         return isAuto() || isSpan();
127     }
128
129 private:
130     void setIntegerPosition(int integerPosition)
131     {
132         m_integerPosition = clampTo(integerPosition, -kGridMaxTracks, kGridMaxTracks);
133     }
134
135     GridPositionType m_type;
136     int m_integerPosition;
137     String m_namedGridLine;
138 };
139
140 } // namespace WebCore
141
142 #endif // ENABLE(CSS_GRID_LAYOUT)