Move CSS classes from ExceptionCode to Exception
[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 CachedResource;
34 class StyleSheetContents;
35
36 enum CSSPropertyID : uint16_t;
37
38 // FIXME: The current CSSValue and subclasses should be turned into internal types (StyleValue).
39 // The few subtypes that are actually exposed in CSSOM can be seen in the cloneForCSSOM() function.
40 // They should be handled by separate wrapper classes.
41
42 // Please don't expose more CSSValue types to the web.
43 class CSSValue : public RefCounted<CSSValue> {
44 public:
45     enum Type {
46         CSS_INHERIT = 0,
47         CSS_PRIMITIVE_VALUE = 1,
48         CSS_VALUE_LIST = 2,
49         CSS_CUSTOM = 3,
50         CSS_INITIAL = 4,
51         CSS_UNSET = 5,
52         CSS_REVERT = 6
53     };
54
55     // Override RefCounted's deref() to ensure operator delete is called on
56     // the appropriate subclass type.
57     void deref()
58     {
59         if (derefBase())
60             destroy();
61     }
62
63     WEBCORE_EXPORT Type cssValueType() const;
64
65     WEBCORE_EXPORT String cssText() const;
66
67     ExceptionOr<void> setCssText(const String&) { return { }; } // FIXME: Not implemented.
68
69     bool isPrimitiveValue() const { return m_classType == PrimitiveClass; }
70     bool isValueList() const { return m_classType >= ValueListClass; }
71     
72     bool isBaseValueList() const { return m_classType == ValueListClass; }
73         
74
75     bool isAspectRatioValue() const { return m_classType == AspectRatioClass; }
76     bool isBorderImageSliceValue() const { return m_classType == BorderImageSliceClass; }
77     bool isCanvasValue() const { return m_classType == CanvasClass; }
78     bool isCrossfadeValue() const { return m_classType == CrossfadeClass; }
79     bool isCursorImageValue() const { return m_classType == CursorImageClass; }
80     bool isCustomPropertyValue() const { return m_classType == CustomPropertyClass; }
81     bool isInvalidCustomPropertyValue() const;
82     bool isVariableDependentValue() const { return m_classType == VariableDependentClass; }
83     bool isVariableValue() const { return m_classType == VariableClass; }
84     bool isFunctionValue() const { return m_classType == FunctionClass; }
85     bool isFontFeatureValue() const { return m_classType == FontFeatureClass; }
86 #if ENABLE(VARIATION_FONTS)
87     bool isFontVariationValue() const { return m_classType == FontVariationClass; }
88 #endif
89     bool isFontFaceSrcValue() const { return m_classType == FontFaceSrcClass; }
90     bool isFontValue() const { return m_classType == FontClass; }
91     bool isImageGeneratorValue() const { return m_classType >= CanvasClass && m_classType <= RadialGradientClass; }
92     bool isGradientValue() const { return m_classType >= LinearGradientClass && m_classType <= RadialGradientClass; }
93     bool isNamedImageValue() const { return m_classType == NamedImageClass; }
94     bool isImageSetValue() const { return m_classType == ImageSetClass; }
95     bool isImageValue() const { return m_classType == ImageClass; }
96     bool isImplicitInitialValue() const;
97     bool isInheritedValue() const { return m_classType == InheritedClass; }
98     bool isInitialValue() const { return m_classType == InitialClass; }
99     bool isUnsetValue() const { return m_classType == UnsetClass; }
100     bool isRevertValue() const { return m_classType == RevertClass; }
101     bool treatAsInitialValue(CSSPropertyID) const;
102     bool treatAsInheritedValue(CSSPropertyID) const;
103     bool isLinearGradientValue() const { return m_classType == LinearGradientClass; }
104     bool isRadialGradientValue() const { return m_classType == RadialGradientClass; }
105     bool isReflectValue() const { return m_classType == ReflectClass; }
106     bool isShadowValue() const { return m_classType == ShadowClass; }
107     bool isCubicBezierTimingFunctionValue() const { return m_classType == CubicBezierTimingFunctionClass; }
108     bool isStepsTimingFunctionValue() const { return m_classType == StepsTimingFunctionClass; }
109     bool isSpringTimingFunctionValue() const { return m_classType == SpringTimingFunctionClass; }
110     bool isWebKitCSSTransformValue() const { return m_classType == WebKitCSSTransformClass; }
111     bool isLineBoxContainValue() const { return m_classType == LineBoxContainClass; }
112     bool isCalcValue() const {return m_classType == CalculationClass; }
113     bool isFilterImageValue() const { return m_classType == FilterImageClass; }
114     bool isWebKitCSSFilterValue() const { return m_classType == WebKitCSSFilterClass; }
115     bool isContentDistributionValue() const { return m_classType == CSSContentDistributionClass; }
116 #if ENABLE(CSS_GRID_LAYOUT)
117     bool isGridAutoRepeatValue() const { return m_classType == GridAutoRepeatClass; }
118     bool isGridTemplateAreasValue() const { return m_classType == GridTemplateAreasClass; }
119     bool isGridLineNamesValue() const { return m_classType == GridLineNamesClass; }
120 #endif
121     bool isSVGColor() const { return m_classType == SVGColorClass || m_classType == SVGPaintClass; }
122     bool isSVGPaint() const { return m_classType == SVGPaintClass; }
123     bool isUnicodeRangeValue() const { return m_classType == UnicodeRangeClass; }
124
125 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
126     bool isAnimationTriggerScrollValue() const { return m_classType == AnimationTriggerScrollClass; }
127 #endif
128
129     bool isCustomPropertyDeclaration() const { return m_classType == CustomPropertyDeclarationClass; }
130     bool isCustomIdentValue() const { return m_classType == CustomIdentClass; }
131     bool isVariableReferenceValue() const { return m_classType == VariableReferenceClass; }
132
133     bool isCSSOMSafe() const { return m_isCSSOMSafe; }
134     bool isSubtypeExposedToCSSOM() const
135     { 
136         return isPrimitiveValue() 
137             || isSVGColor()
138             || isValueList();
139     }
140
141     RefPtr<CSSValue> cloneForCSSOM() const;
142
143     bool traverseSubresources(const std::function<bool (const CachedResource&)>& handler) const;
144
145     bool equals(const CSSValue&) const;
146     bool operator==(const CSSValue& other) const { return equals(other); }
147
148 protected:
149
150     static const size_t ClassTypeBits = 6;
151     enum ClassType {
152         PrimitiveClass,
153
154         // Image classes.
155         ImageClass,
156         CursorImageClass,
157
158         // Image generator classes.
159         CanvasClass,
160         NamedImageClass,
161         CrossfadeClass,
162         FilterImageClass,
163         LinearGradientClass,
164         RadialGradientClass,
165
166         // Timing function classes.
167         CubicBezierTimingFunctionClass,
168         StepsTimingFunctionClass,
169         SpringTimingFunctionClass,
170
171         // Other class types.
172         AspectRatioClass,
173         BorderImageSliceClass,
174         FontFeatureClass,
175 #if ENABLE(VARIATION_FONTS)
176         FontVariationClass,
177 #endif
178         FontClass,
179         FontFaceSrcClass,
180         FunctionClass,
181
182         InheritedClass,
183         InitialClass,
184         UnsetClass,
185         RevertClass,
186
187         ReflectClass,
188         ShadowClass,
189         UnicodeRangeClass,
190         LineBoxContainClass,
191         CalculationClass,
192 #if ENABLE(CSS_GRID_LAYOUT)
193         GridTemplateAreasClass,
194 #endif
195         SVGColorClass,
196         SVGPaintClass,
197
198 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
199         AnimationTriggerScrollClass,
200 #endif
201
202         CSSContentDistributionClass,
203         
204         // FIXME-NEWPARSER: Remove in favor of new variables implementation.
205         CustomPropertyClass,
206         VariableDependentClass,
207         VariableClass,
208
209         // New variables implementation.
210         CustomPropertyDeclarationClass,
211         CustomIdentClass,
212         VariableReferenceClass,
213
214         // List class types must appear after ValueListClass.
215         ValueListClass,
216         ImageSetClass,
217         WebKitCSSFilterClass,
218         WebKitCSSTransformClass,
219 #if ENABLE(CSS_GRID_LAYOUT)
220         GridLineNamesClass,
221         GridAutoRepeatClass,
222 #endif
223         // Do not append non-list class types here.
224     };
225
226     static const size_t ValueListSeparatorBits = 2;
227     enum ValueListSeparator {
228         SpaceSeparator,
229         CommaSeparator,
230         SlashSeparator
231     };
232
233     ClassType classType() const { return static_cast<ClassType>(m_classType); }
234
235     explicit CSSValue(ClassType classType, bool isCSSOMSafe = false)
236         : m_isCSSOMSafe(isCSSOMSafe)
237         , m_isTextClone(false)
238         , m_primitiveUnitType(0)
239         , m_hasCachedCSSText(false)
240         , m_isQuirkValue(false)
241         , m_valueListSeparator(SpaceSeparator)
242         , m_classType(classType)
243     {
244     }
245
246     // NOTE: This class is non-virtual for memory and performance reasons.
247     // Don't go making it virtual again unless you know exactly what you're doing!
248
249     ~CSSValue() { }
250
251 private:
252     WEBCORE_EXPORT void destroy();
253
254 protected:
255     unsigned m_isCSSOMSafe : 1;
256     unsigned m_isTextClone : 1;
257     // The bits in this section are only used by specific subclasses but kept here
258     // to maximize struct packing.
259
260     // CSSPrimitiveValue bits:
261     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitTypes
262     mutable unsigned m_hasCachedCSSText : 1;
263     unsigned m_isQuirkValue : 1;
264
265     unsigned m_valueListSeparator : ValueListSeparatorBits;
266
267 private:
268     unsigned m_classType : ClassTypeBits; // ClassType
269     
270 friend class CSSValueList;
271 };
272
273 template<typename CSSValueType>
274 inline bool compareCSSValueVector(const Vector<Ref<CSSValueType>>& firstVector, const Vector<Ref<CSSValueType>>& secondVector)
275 {
276     size_t size = firstVector.size();
277     if (size != secondVector.size())
278         return false;
279
280     for (size_t i = 0; i < size; ++i) {
281         auto& firstPtr = firstVector[i];
282         auto& secondPtr = secondVector[i];
283         if (firstPtr.ptr() == secondPtr.ptr() || firstPtr->equals(secondPtr))
284             continue;
285         return false;
286     }
287     return true;
288 }
289
290 template<typename CSSValueType>
291 inline bool compareCSSValuePtr(const RefPtr<CSSValueType>& first, const RefPtr<CSSValueType>& second)
292 {
293     return first ? second && first->equals(*second) : !second;
294 }
295
296 template<typename CSSValueType>
297 inline bool compareCSSValue(const Ref<CSSValueType>& first, const Ref<CSSValueType>& second)
298 {
299     return first.get().equals(second);
300 }
301
302 typedef HashMap<AtomicString, RefPtr<CSSValue>> CustomPropertyValueMap;
303
304 } // namespace WebCore
305
306 #define SPECIALIZE_TYPE_TRAITS_CSS_VALUE(ToValueTypeName, predicate) \
307 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
308     static bool isType(const WebCore::CSSValue& value) { return value.predicate; } \
309 SPECIALIZE_TYPE_TRAITS_END()