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