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