Allow implicit conversion from Ref<T> to T&
[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
107     bool isCSSOMSafe() const { return m_isCSSOMSafe; }
108     bool isSubtypeExposedToCSSOM() const
109     { 
110         return isPrimitiveValue() 
111             || isSVGColor()
112             || isValueList();
113     }
114
115     PassRefPtr<CSSValue> cloneForCSSOM() const;
116
117     void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
118
119     bool hasFailedOrCanceledSubresources() const;
120
121     bool equals(const CSSValue&) const;
122
123 protected:
124
125     static const size_t ClassTypeBits = 6;
126     enum ClassType {
127         PrimitiveClass,
128
129         // Image classes.
130         ImageClass,
131         CursorImageClass,
132
133         // Image generator classes.
134         CanvasClass,
135         CrossfadeClass,
136         FilterImageClass,
137         LinearGradientClass,
138         RadialGradientClass,
139
140         // Timing function classes.
141         CubicBezierTimingFunctionClass,
142         StepsTimingFunctionClass,
143
144         // Other class types.
145         AspectRatioClass,
146         BorderImageSliceClass,
147         FontFeatureClass,
148         FontClass,
149         FontFaceSrcClass,
150         FunctionClass,
151
152         InheritedClass,
153         InitialClass,
154
155         ReflectClass,
156         ShadowClass,
157         UnicodeRangeClass,
158         LineBoxContainClass,
159         CalculationClass,
160 #if ENABLE(CSS_GRID_LAYOUT)
161         GridTemplateAreasClass,
162 #endif
163         SVGColorClass,
164         SVGPaintClass,
165
166         // List class types must appear after ValueListClass.
167         ValueListClass,
168 #if ENABLE(CSS_IMAGE_SET)
169         ImageSetClass,
170 #endif
171         WebKitCSSFilterClass,
172         WebKitCSSTransformClass,
173 #if ENABLE(CSS_GRID_LAYOUT)
174         GridLineNamesClass,
175 #endif
176         // Do not append non-list class types here.
177     };
178
179     static const size_t ValueListSeparatorBits = 2;
180     enum ValueListSeparator {
181         SpaceSeparator,
182         CommaSeparator,
183         SlashSeparator
184     };
185
186     ClassType classType() const { return static_cast<ClassType>(m_classType); }
187
188     explicit CSSValue(ClassType classType, bool isCSSOMSafe = false)
189         : m_isCSSOMSafe(isCSSOMSafe)
190         , m_isTextClone(false)
191         , m_primitiveUnitType(0)
192         , m_hasCachedCSSText(false)
193         , m_isQuirkValue(false)
194         , m_valueListSeparator(SpaceSeparator)
195         , m_classType(classType)
196     {
197     }
198
199     // NOTE: This class is non-virtual for memory and performance reasons.
200     // Don't go making it virtual again unless you know exactly what you're doing!
201
202     ~CSSValue() { }
203
204 private:
205     WEBCORE_EXPORT void destroy();
206
207 protected:
208     unsigned m_isCSSOMSafe : 1;
209     unsigned m_isTextClone : 1;
210     // The bits in this section are only used by specific subclasses but kept here
211     // to maximize struct packing.
212
213     // CSSPrimitiveValue bits:
214     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitTypes
215     mutable unsigned m_hasCachedCSSText : 1;
216     unsigned m_isQuirkValue : 1;
217
218     unsigned m_valueListSeparator : ValueListSeparatorBits;
219
220 private:
221     unsigned m_classType : ClassTypeBits; // ClassType
222 };
223
224 template<typename CSSValueType>
225 inline bool compareCSSValueVector(const Vector<RefPtr<CSSValueType>>& firstVector, const Vector<RefPtr<CSSValueType>>& secondVector)
226 {
227     size_t size = firstVector.size();
228     if (size != secondVector.size())
229         return false;
230
231     for (size_t i = 0; i < size; i++) {
232         const RefPtr<CSSValueType>& firstPtr = firstVector[i];
233         const RefPtr<CSSValueType>& secondPtr = secondVector[i];
234         if (firstPtr == secondPtr || (firstPtr && secondPtr && firstPtr->equals(*secondPtr)))
235             continue;
236         return false;
237     }
238     return true;
239 }
240
241 template<typename CSSValueType>
242 inline bool compareCSSValuePtr(const RefPtr<CSSValueType>& first, const RefPtr<CSSValueType>& second)
243 {
244     return first ? second && first->equals(*second) : !second;
245 }
246
247 template<typename CSSValueType>
248 inline bool compareCSSValue(const Ref<CSSValueType>& first, const Ref<CSSValueType>& second)
249 {
250     return first.get().equals(second);
251 }
252
253 } // namespace WebCore
254
255 #define SPECIALIZE_TYPE_TRAITS_CSS_VALUE(ToValueTypeName, predicate) \
256 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
257     static bool isType(const WebCore::CSSValue& value) { return value.predicate; } \
258 SPECIALIZE_TYPE_TRAITS_END()
259
260 #endif // CSSValue_h