[css-grid] Remove compilation flag ENABLE_CSS_GRID_LAYOUT
[WebKit-https.git] / Source / WebCore / css / CSSValue.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #pragma once
22
23 #include "ExceptionOr.h"
24 #include "URLHash.h"
25 #include <wtf/HashMap.h>
26 #include <wtf/ListHashSet.h>
27 #include <wtf/RefCounted.h>
28 #include <wtf/RefPtr.h>
29 #include <wtf/TypeCasts.h>
30
31 namespace WebCore {
32
33 class CSSCustomPropertyValue;
34 class CachedResource;
35 class DeprecatedCSSOMValue;
36 class StyleSheetContents;
37
38 enum CSSPropertyID : uint16_t;
39
40 class CSSValue : public RefCounted<CSSValue> {
41 public:
42     enum Type {
43         CSS_INHERIT = 0,
44         CSS_PRIMITIVE_VALUE = 1,
45         CSS_VALUE_LIST = 2,
46         CSS_CUSTOM = 3,
47         CSS_INITIAL = 4,
48         CSS_UNSET = 5,
49         CSS_REVERT = 6
50     };
51
52     // Override RefCounted's deref() to ensure operator delete is called on
53     // the appropriate subclass type.
54     void deref()
55     {
56         if (derefBase())
57             destroy();
58     }
59
60     Type cssValueType() const;
61     String cssText() const;
62
63     bool isPrimitiveValue() const { return m_classType == PrimitiveClass; }
64     bool isValueList() const { return m_classType >= ValueListClass; }
65     
66     bool isBaseValueList() const { return m_classType == ValueListClass; }
67         
68
69     bool isAspectRatioValue() const { return m_classType == AspectRatioClass; }
70     bool isBorderImageSliceValue() const { return m_classType == BorderImageSliceClass; }
71     bool isCanvasValue() const { return m_classType == CanvasClass; }
72     bool isCrossfadeValue() const { return m_classType == CrossfadeClass; }
73     bool isCursorImageValue() const { return m_classType == CursorImageClass; }
74     bool isCustomPropertyValue() const { return m_classType == CustomPropertyClass; }
75     bool isFunctionValue() const { return m_classType == FunctionClass; }
76     bool isFontFeatureValue() const { return m_classType == FontFeatureClass; }
77 #if ENABLE(VARIATION_FONTS)
78     bool isFontVariationValue() const { return m_classType == FontVariationClass; }
79 #endif
80     bool isFontFaceSrcValue() const { return m_classType == FontFaceSrcClass; }
81     bool isFontValue() const { return m_classType == FontClass; }
82     bool isImageGeneratorValue() const { return m_classType >= CanvasClass && m_classType <= RadialGradientClass; }
83     bool isGradientValue() const { return m_classType >= LinearGradientClass && m_classType <= RadialGradientClass; }
84     bool isNamedImageValue() const { return m_classType == NamedImageClass; }
85     bool isImageSetValue() const { return m_classType == ImageSetClass; }
86     bool isImageValue() const { return m_classType == ImageClass; }
87     bool isImplicitInitialValue() const;
88     bool isInheritedValue() const { return m_classType == InheritedClass; }
89     bool isInitialValue() const { return m_classType == InitialClass; }
90     bool isUnsetValue() const { return m_classType == UnsetClass; }
91     bool isRevertValue() const { return m_classType == RevertClass; }
92     bool treatAsInitialValue(CSSPropertyID) const;
93     bool treatAsInheritedValue(CSSPropertyID) const;
94     bool isLinearGradientValue() const { return m_classType == LinearGradientClass; }
95     bool isRadialGradientValue() const { return m_classType == RadialGradientClass; }
96     bool isReflectValue() const { return m_classType == ReflectClass; }
97     bool isShadowValue() const { return m_classType == ShadowClass; }
98     bool isCubicBezierTimingFunctionValue() const { return m_classType == CubicBezierTimingFunctionClass; }
99     bool isStepsTimingFunctionValue() const { return m_classType == StepsTimingFunctionClass; }
100     bool isSpringTimingFunctionValue() const { return m_classType == SpringTimingFunctionClass; }
101     bool isLineBoxContainValue() const { return m_classType == LineBoxContainClass; }
102     bool isCalcValue() const {return m_classType == CalculationClass; }
103     bool isFilterImageValue() const { return m_classType == FilterImageClass; }
104     bool isContentDistributionValue() const { return m_classType == CSSContentDistributionClass; }
105     bool isGridAutoRepeatValue() const { return m_classType == GridAutoRepeatClass; }
106     bool isGridTemplateAreasValue() const { return m_classType == GridTemplateAreasClass; }
107     bool isGridLineNamesValue() const { return m_classType == GridLineNamesClass; }
108     bool isUnicodeRangeValue() const { return m_classType == UnicodeRangeClass; }
109
110 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
111     bool isAnimationTriggerScrollValue() const { return m_classType == AnimationTriggerScrollClass; }
112 #endif
113
114     bool isCustomIdentValue() const { return m_classType == CustomIdentClass; }
115     bool isVariableReferenceValue() const { return m_classType == VariableReferenceClass; }
116     bool isPendingSubstitutionValue() const { return m_classType == PendingSubstitutionValueClass; }
117     
118     bool hasVariableReferences() const { return isVariableReferenceValue() || isPendingSubstitutionValue(); }
119
120     Ref<DeprecatedCSSOMValue> createDeprecatedCSSOMWrapper() const;
121
122     bool traverseSubresources(const std::function<bool (const CachedResource&)>& handler) const;
123
124     bool equals(const CSSValue&) const;
125     bool operator==(const CSSValue& other) const { return equals(other); }
126
127 protected:
128
129     static const size_t ClassTypeBits = 6;
130     enum ClassType {
131         PrimitiveClass,
132
133         // Image classes.
134         ImageClass,
135         CursorImageClass,
136
137         // Image generator classes.
138         CanvasClass,
139         NamedImageClass,
140         CrossfadeClass,
141         FilterImageClass,
142         LinearGradientClass,
143         RadialGradientClass,
144
145         // Timing function classes.
146         CubicBezierTimingFunctionClass,
147         StepsTimingFunctionClass,
148         SpringTimingFunctionClass,
149
150         // Other class types.
151         AspectRatioClass,
152         BorderImageSliceClass,
153         FontFeatureClass,
154 #if ENABLE(VARIATION_FONTS)
155         FontVariationClass,
156 #endif
157         FontClass,
158         FontFaceSrcClass,
159         FunctionClass,
160
161         InheritedClass,
162         InitialClass,
163         UnsetClass,
164         RevertClass,
165
166         ReflectClass,
167         ShadowClass,
168         UnicodeRangeClass,
169         LineBoxContainClass,
170         CalculationClass,
171         GridTemplateAreasClass,
172 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
173         AnimationTriggerScrollClass,
174 #endif
175
176         CSSContentDistributionClass,
177         
178         CustomIdentClass,
179
180         CustomPropertyClass,
181         VariableReferenceClass,
182         PendingSubstitutionValueClass,
183
184         // List class types must appear after ValueListClass. Note CSSFunctionValue
185         // is deliberately excluded, since we don't want it exposed to the CSS OM
186         // as a list.
187         ValueListClass,
188         ImageSetClass,
189         GridLineNamesClass,
190         GridAutoRepeatClass,
191         // Do not append non-list class types here.
192     };
193
194 public:
195     static const size_t ValueListSeparatorBits = 2;
196     enum ValueListSeparator {
197         SpaceSeparator,
198         CommaSeparator,
199         SlashSeparator
200     };
201
202 protected:
203     ClassType classType() const { return static_cast<ClassType>(m_classType); }
204
205     explicit CSSValue(ClassType classType)
206         : m_primitiveUnitType(0)
207         , m_hasCachedCSSText(false)
208         , m_isQuirkValue(false)
209         , m_valueListSeparator(SpaceSeparator)
210         , m_classType(classType)
211     {
212     }
213
214     // NOTE: This class is non-virtual for memory and performance reasons.
215     // Don't go making it virtual again unless you know exactly what you're doing!
216
217     ~CSSValue() { }
218
219 private:
220     WEBCORE_EXPORT void destroy();
221
222 protected:
223     // The bits in this section are only used by specific subclasses but kept here
224     // to maximize struct packing.
225
226     // CSSPrimitiveValue bits:
227     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitType
228     mutable unsigned m_hasCachedCSSText : 1;
229     unsigned m_isQuirkValue : 1;
230
231     unsigned m_valueListSeparator : ValueListSeparatorBits;
232
233 private:
234     unsigned m_classType : ClassTypeBits; // ClassType
235     
236 friend class CSSValueList;
237 };
238
239 template<typename CSSValueType>
240 inline bool compareCSSValueVector(const Vector<Ref<CSSValueType>>& firstVector, const Vector<Ref<CSSValueType>>& secondVector)
241 {
242     size_t size = firstVector.size();
243     if (size != secondVector.size())
244         return false;
245
246     for (size_t i = 0; i < size; ++i) {
247         auto& firstPtr = firstVector[i];
248         auto& secondPtr = secondVector[i];
249         if (firstPtr.ptr() == secondPtr.ptr() || firstPtr->equals(secondPtr))
250             continue;
251         return false;
252     }
253     return true;
254 }
255
256 template<typename CSSValueType>
257 inline bool compareCSSValuePtr(const RefPtr<CSSValueType>& first, const RefPtr<CSSValueType>& second)
258 {
259     return first ? second && first->equals(*second) : !second;
260 }
261
262 template<typename CSSValueType>
263 inline bool compareCSSValue(const Ref<CSSValueType>& first, const Ref<CSSValueType>& second)
264 {
265     return first.get().equals(second);
266 }
267
268 typedef HashMap<AtomicString, RefPtr<CSSCustomPropertyValue>> CustomPropertyValueMap;
269
270 } // namespace WebCore
271
272 #define SPECIALIZE_TYPE_TRAITS_CSS_VALUE(ToValueTypeName, predicate) \
273 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
274     static bool isType(const WebCore::CSSValue& value) { return value.predicate; } \
275 SPECIALIZE_TYPE_TRAITS_END()