Implement CSS `display: flow-root` (modern clearfix)
[WebKit-https.git] / Source / WebCore / rendering / style / GridPosition.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2017 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 #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 enum GridPositionSide {
46     ColumnStartSide,
47     ColumnEndSide,
48     RowStartSide,
49     RowEndSide
50 };
51
52 class GridPosition {
53 public:
54     GridPosition()
55         : m_type(AutoPosition)
56         , m_integerPosition(0)
57     {
58     }
59
60     bool isPositive() const { return integerPosition() > 0; }
61
62     GridPositionType type() const { return m_type; }
63     bool isAuto() const { return m_type == AutoPosition; }
64     bool isSpan() const { return m_type == SpanPosition; }
65     bool isNamedGridArea() const { return m_type == NamedGridAreaPosition; }
66
67     WEBCORE_EXPORT void setExplicitPosition(int position, const String& namedGridLine);
68     void setAutoPosition();
69     WEBCORE_EXPORT void setSpanPosition(int position, const String& namedGridLine);
70     void setNamedGridArea(const String&);
71
72     WEBCORE_EXPORT int integerPosition() const;
73     String namedGridLine() const;
74     WEBCORE_EXPORT int spanPosition() const;
75
76     bool operator==(const GridPosition& other) const;
77
78     bool shouldBeResolvedAgainstOppositePosition() const { return isAuto() || isSpan(); }
79
80     // Note that grid line 1 is internally represented by the index 0, that's why the max value for
81     // a position is kGridMaxTracks instead of kGridMaxTracks + 1.
82     static int max();
83     static int min();
84
85     WEBCORE_EXPORT static void setMaxPositionForTesting(unsigned);
86
87 private:
88     static Optional<int> gMaxPositionForTesting;
89
90     void setIntegerPosition(int integerPosition) { m_integerPosition = clampTo(integerPosition, min(), max()); }
91
92     GridPositionType m_type;
93     int m_integerPosition;
94     String m_namedGridLine;
95 };
96
97 } // namespace WebCore