Remove feature: CSS variables
[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 #ifndef CSSValue_h
22 #define CSSValue_h
23
24 #include "ExceptionCode.h"
25 #include "URLHash.h"
26 #include <wtf/ListHashSet.h>
27 #include <wtf/RefCounted.h>
28 #include <wtf/RefPtr.h>
29
30 namespace WebCore {
31
32 class StyleSheetContents;
33     
34 // FIXME: The current CSSValue and subclasses should be turned into internal types (StyleValue).
35 // The few subtypes that are actually exposed in CSSOM can be seen in the cloneForCSSOM() function.
36 // They should be handled by separate wrapper classes.
37
38 // Please don't expose more CSSValue types to the web.
39 class CSSValue : public RefCounted<CSSValue> {
40 public:
41     enum Type {
42         CSS_INHERIT = 0,
43         CSS_PRIMITIVE_VALUE = 1,
44         CSS_VALUE_LIST = 2,
45         CSS_CUSTOM = 3,
46         CSS_INITIAL = 4
47
48     };
49
50     // Override RefCounted's deref() to ensure operator delete is called on
51     // the appropriate subclass type.
52     void deref()
53     {
54         if (derefBase())
55             destroy();
56     }
57
58     Type cssValueType() const;
59
60     String cssText() const;
61     void setCssText(const String&, ExceptionCode&) { } // FIXME: Not implemented.
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 isFunctionValue() const { return m_classType == FunctionClass; }
75     bool isFontFeatureValue() const { return m_classType == FontFeatureClass; }
76     bool isFontFaceSrcValue() const { return m_classType == FontFaceSrcClass; }
77     bool isFontValue() const { return m_classType == FontClass; }
78     bool isImageGeneratorValue() const { return m_classType >= CanvasClass && m_classType <= RadialGradientClass; }
79     bool isGradientValue() const { return m_classType >= LinearGradientClass && m_classType <= RadialGradientClass; }
80 #if ENABLE(CSS_IMAGE_SET)
81     bool isImageSetValue() const { return m_classType == ImageSetClass; }
82 #endif
83     bool isImageValue() const { return m_classType == ImageClass; }
84     bool isImplicitInitialValue() const;
85     bool isInheritedValue() const { return m_classType == InheritedClass; }
86     bool isInitialValue() const { return m_classType == InitialClass; }
87     bool isLinearGradientValue() const { return m_classType == LinearGradientClass; }
88     bool isRadialGradientValue() const { return m_classType == RadialGradientClass; }
89     bool isReflectValue() const { return m_classType == ReflectClass; }
90     bool isShadowValue() const { return m_classType == ShadowClass; }
91     bool isCubicBezierTimingFunctionValue() const { return m_classType == CubicBezierTimingFunctionClass; }
92     bool isStepsTimingFunctionValue() const { return m_classType == StepsTimingFunctionClass; }
93     bool isWebKitCSSTransformValue() const { return m_classType == WebKitCSSTransformClass; }
94     bool isLineBoxContainValue() const { return m_classType == LineBoxContainClass; }
95     bool isCalcValue() const {return m_classType == CalculationClass; }
96 #if ENABLE(CSS_FILTERS)
97     bool isFilterImageValue() const { return m_classType == FilterImageClass; }
98     bool isWebKitCSSFilterValue() const { return m_classType == WebKitCSSFilterClass; }
99 #if ENABLE(CSS_SHADERS)
100     bool isWebKitCSSArrayFunctionValue() const { return m_classType == WebKitCSSArrayFunctionValueClass; }
101     bool isWebKitCSSMatFunctionValue() const { return m_classType == WebKitCSSMatFunctionValueClass; }
102     bool isWebKitCSSMixFunctionValue() const { return m_classType == WebKitCSSMixFunctionValueClass; }
103     bool isWebKitCSSShaderValue() const { return m_classType == WebKitCSSShaderClass; }
104 #endif
105 #endif // ENABLE(CSS_FILTERS)
106     bool isGridTemplateValue() const { return m_classType == GridTemplateClass; }
107 #if ENABLE(SVG)
108     bool isSVGColor() const { return m_classType == SVGColorClass || m_classType == SVGPaintClass; }
109     bool isSVGPaint() const { return m_classType == SVGPaintClass; }
110     bool isWebKitCSSSVGDocumentValue() const { return m_classType == WebKitCSSSVGDocumentClass; }
111 #endif
112     bool isUnicodeRangeValue() const { return m_classType == UnicodeRangeClass; }
113
114     bool isCSSOMSafe() const { return m_isCSSOMSafe; }
115     bool isSubtypeExposedToCSSOM() const
116     { 
117         return isPrimitiveValue() 
118 #if ENABLE(SVG)
119             || isSVGColor()
120 #endif
121             || isValueList();
122     }
123
124     PassRefPtr<CSSValue> cloneForCSSOM() const;
125
126     void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
127
128     bool hasFailedOrCanceledSubresources() const;
129
130     bool equals(const CSSValue&) const;
131
132 protected:
133
134     static const size_t ClassTypeBits = 6;
135     enum ClassType {
136         PrimitiveClass,
137
138         // Image classes.
139         ImageClass,
140         CursorImageClass,
141
142         // Image generator classes.
143         CanvasClass,
144         CrossfadeClass,
145 #if ENABLE(CSS_FILTERS)
146         FilterImageClass,
147 #endif
148         LinearGradientClass,
149         RadialGradientClass,
150
151         // Timing function classes.
152         CubicBezierTimingFunctionClass,
153         StepsTimingFunctionClass,
154
155         // Other class types.
156         AspectRatioClass,
157         BorderImageSliceClass,
158         FontFeatureClass,
159         FontClass,
160         FontFaceSrcClass,
161         FunctionClass,
162
163         InheritedClass,
164         InitialClass,
165
166         ReflectClass,
167         ShadowClass,
168         UnicodeRangeClass,
169         LineBoxContainClass,
170         CalculationClass,
171 #if ENABLE(CSS_FILTERS) && ENABLE(CSS_SHADERS)
172         WebKitCSSShaderClass,
173 #endif
174         GridTemplateClass,
175 #if ENABLE(SVG)
176         SVGColorClass,
177         SVGPaintClass,
178         WebKitCSSSVGDocumentClass,
179 #endif
180
181         // List class types must appear after ValueListClass.
182         ValueListClass,
183 #if ENABLE(CSS_IMAGE_SET)
184         ImageSetClass,
185 #endif
186 #if ENABLE(CSS_FILTERS)
187         WebKitCSSFilterClass,
188 #if ENABLE(CSS_SHADERS)
189         WebKitCSSArrayFunctionValueClass,
190         WebKitCSSMatFunctionValueClass,
191         WebKitCSSMixFunctionValueClass,
192 #endif
193 #endif
194         WebKitCSSTransformClass,
195         // Do not append non-list class types here.
196     };
197
198     static const size_t ValueListSeparatorBits = 2;
199     enum ValueListSeparator {
200         SpaceSeparator,
201         CommaSeparator,
202         SlashSeparator
203     };
204
205     ClassType classType() const { return static_cast<ClassType>(m_classType); }
206
207     explicit CSSValue(ClassType classType, bool isCSSOMSafe = false)
208         : m_isCSSOMSafe(isCSSOMSafe)
209         , m_isTextClone(false)
210         , m_primitiveUnitType(0)
211         , m_hasCachedCSSText(false)
212         , m_isQuirkValue(false)
213         , m_valueListSeparator(SpaceSeparator)
214         , m_classType(classType)
215     {
216     }
217
218     // NOTE: This class is non-virtual for memory and performance reasons.
219     // Don't go making it virtual again unless you know exactly what you're doing!
220
221     ~CSSValue() { }
222
223 private:
224     void destroy();
225
226 protected:
227     unsigned m_isCSSOMSafe : 1;
228     unsigned m_isTextClone : 1;
229     // The bits in this section are only used by specific subclasses but kept here
230     // to maximize struct packing.
231
232     // CSSPrimitiveValue bits:
233     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitTypes
234     mutable unsigned m_hasCachedCSSText : 1;
235     unsigned m_isQuirkValue : 1;
236
237     unsigned m_valueListSeparator : ValueListSeparatorBits;
238
239 private:
240     unsigned m_classType : ClassTypeBits; // ClassType
241 };
242
243 template<typename CSSValueType>
244 inline bool compareCSSValueVector(const Vector<RefPtr<CSSValueType>>& firstVector, const Vector<RefPtr<CSSValueType>>& secondVector)
245 {
246     size_t size = firstVector.size();
247     if (size != secondVector.size())
248         return false;
249
250     for (size_t i = 0; i < size; i++) {
251         const RefPtr<CSSValueType>& firstPtr = firstVector[i];
252         const RefPtr<CSSValueType>& secondPtr = secondVector[i];
253         if (firstPtr == secondPtr || (firstPtr && secondPtr && firstPtr->equals(*secondPtr)))
254             continue;
255         return false;
256     }
257     return true;
258 }
259
260 template<typename CSSValueType>
261 inline bool compareCSSValuePtr(const RefPtr<CSSValueType>& first, const RefPtr<CSSValueType>& second)
262 {
263     return first ? second && first->equals(*second) : !second;
264 }
265
266 template<typename CSSValueType>
267 inline bool compareCSSValue(const Ref<CSSValueType>& first, const Ref<CSSValueType>& second)
268 {
269     return first.get().equals(second.get());
270 }
271
272 #define CSS_VALUE_TYPE_CASTS(ToValueTypeName, predicate) \
273     TYPE_CASTS_BASE(ToValueTypeName, CSSValue, value, value->predicate, value.predicate)
274
275 } // namespace WebCore
276
277 #endif // CSSValue_h