[CSS Grid Layout] Implement support for grid-template
[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 #if ENABLE(CSS_VARIABLES)
63     String serializeResolvingVariables(const HashMap<AtomicString, String>&) const;
64 #endif
65
66     bool isPrimitiveValue() const { return m_classType == PrimitiveClass; }
67     bool isValueList() const { return m_classType >= ValueListClass; }
68     
69     bool isBaseValueList() const { return m_classType == ValueListClass; }
70         
71
72     bool isAspectRatioValue() const { return m_classType == AspectRatioClass; }
73     bool isBorderImageSliceValue() const { return m_classType == BorderImageSliceClass; }
74     bool isCanvasValue() const { return m_classType == CanvasClass; }
75     bool isCrossfadeValue() const { return m_classType == CrossfadeClass; }
76     bool isCursorImageValue() const { return m_classType == CursorImageClass; }
77     bool isFunctionValue() const { return m_classType == FunctionClass; }
78     bool isFontFeatureValue() const { return m_classType == FontFeatureClass; }
79     bool isFontFaceSrcValue() const { return m_classType == FontFaceSrcClass; }
80     bool isFontValue() const { return m_classType == FontClass; }
81     bool isImageGeneratorValue() const { return m_classType >= CanvasClass && m_classType <= RadialGradientClass; }
82     bool isGradientValue() const { return m_classType >= LinearGradientClass && m_classType <= RadialGradientClass; }
83 #if ENABLE(CSS_IMAGE_SET)
84     bool isImageSetValue() const { return m_classType == ImageSetClass; }
85 #endif
86     bool isImageValue() const { return m_classType == ImageClass; }
87     bool isImplicitInitialValue() const;
88     bool isInheritedValue() const { return m_classType == InheritedClass; }
89     bool isInitialValue() const { return m_classType == InitialClass; }
90     bool isLinearGradientValue() const { return m_classType == LinearGradientClass; }
91     bool isRadialGradientValue() const { return m_classType == RadialGradientClass; }
92     bool isReflectValue() const { return m_classType == ReflectClass; }
93     bool isShadowValue() const { return m_classType == ShadowClass; }
94     bool isCubicBezierTimingFunctionValue() const { return m_classType == CubicBezierTimingFunctionClass; }
95     bool isStepsTimingFunctionValue() const { return m_classType == StepsTimingFunctionClass; }
96     bool isWebKitCSSTransformValue() const { return m_classType == WebKitCSSTransformClass; }
97     bool isLineBoxContainValue() const { return m_classType == LineBoxContainClass; }
98     bool isCalcValue() const {return m_classType == CalculationClass; }
99 #if ENABLE(CSS_FILTERS)
100     bool isFilterImageValue() const { return m_classType == FilterImageClass; }
101     bool isWebKitCSSFilterValue() const { return m_classType == WebKitCSSFilterClass; }
102 #if ENABLE(CSS_SHADERS)
103     bool isWebKitCSSArrayFunctionValue() const { return m_classType == WebKitCSSArrayFunctionValueClass; }
104     bool isWebKitCSSMatFunctionValue() const { return m_classType == WebKitCSSMatFunctionValueClass; }
105     bool isWebKitCSSMixFunctionValue() const { return m_classType == WebKitCSSMixFunctionValueClass; }
106     bool isWebKitCSSShaderValue() const { return m_classType == WebKitCSSShaderClass; }
107 #endif
108 #endif // ENABLE(CSS_FILTERS)
109 #if ENABLE(CSS_VARIABLES)
110     bool isVariableValue() const { return m_classType == VariableClass; }
111 #endif
112     bool isGridTemplateValue() const { return m_classType == GridTemplateClass; }
113 #if ENABLE(SVG)
114     bool isSVGColor() const { return m_classType == SVGColorClass || m_classType == SVGPaintClass; }
115     bool isSVGPaint() const { return m_classType == SVGPaintClass; }
116     bool isWebKitCSSSVGDocumentValue() const { return m_classType == WebKitCSSSVGDocumentClass; }
117 #endif
118     bool isUnicodeRangeValue() const { return m_classType == UnicodeRangeClass; }
119
120     bool isCSSOMSafe() const { return m_isCSSOMSafe; }
121     bool isSubtypeExposedToCSSOM() const
122     { 
123         return isPrimitiveValue() 
124 #if ENABLE(SVG)
125             || isSVGColor()
126 #endif
127             || isValueList();
128     }
129
130     PassRefPtr<CSSValue> cloneForCSSOM() const;
131
132     void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
133
134     bool hasFailedOrCanceledSubresources() const;
135
136     bool equals(const CSSValue&) const;
137
138 protected:
139
140     static const size_t ClassTypeBits = 6;
141     enum ClassType {
142         PrimitiveClass,
143
144         // Image classes.
145         ImageClass,
146         CursorImageClass,
147
148         // Image generator classes.
149         CanvasClass,
150         CrossfadeClass,
151 #if ENABLE(CSS_FILTERS)
152         FilterImageClass,
153 #endif
154         LinearGradientClass,
155         RadialGradientClass,
156
157         // Timing function classes.
158         CubicBezierTimingFunctionClass,
159         StepsTimingFunctionClass,
160
161         // Other class types.
162         AspectRatioClass,
163         BorderImageSliceClass,
164         FontFeatureClass,
165         FontClass,
166         FontFaceSrcClass,
167         FunctionClass,
168
169         InheritedClass,
170         InitialClass,
171
172         ReflectClass,
173         ShadowClass,
174         UnicodeRangeClass,
175         LineBoxContainClass,
176         CalculationClass,
177 #if ENABLE(CSS_FILTERS) && ENABLE(CSS_SHADERS)
178         WebKitCSSShaderClass,
179 #endif
180 #if ENABLE(CSS_VARIABLES)
181         VariableClass,
182 #endif
183         GridTemplateClass,
184 #if ENABLE(SVG)
185         SVGColorClass,
186         SVGPaintClass,
187         WebKitCSSSVGDocumentClass,
188 #endif
189
190         // List class types must appear after ValueListClass.
191         ValueListClass,
192 #if ENABLE(CSS_IMAGE_SET)
193         ImageSetClass,
194 #endif
195 #if ENABLE(CSS_FILTERS)
196         WebKitCSSFilterClass,
197 #if ENABLE(CSS_SHADERS)
198         WebKitCSSArrayFunctionValueClass,
199         WebKitCSSMatFunctionValueClass,
200         WebKitCSSMixFunctionValueClass,
201 #endif
202 #endif
203         WebKitCSSTransformClass,
204         // Do not append non-list class types here.
205     };
206
207     static const size_t ValueListSeparatorBits = 2;
208     enum ValueListSeparator {
209         SpaceSeparator,
210         CommaSeparator,
211         SlashSeparator
212     };
213
214     ClassType classType() const { return static_cast<ClassType>(m_classType); }
215
216     explicit CSSValue(ClassType classType, bool isCSSOMSafe = false)
217         : m_isCSSOMSafe(isCSSOMSafe)
218         , m_isTextClone(false)
219         , m_primitiveUnitType(0)
220         , m_hasCachedCSSText(false)
221         , m_isQuirkValue(false)
222         , m_valueListSeparator(SpaceSeparator)
223         , m_classType(classType)
224     {
225     }
226
227     // NOTE: This class is non-virtual for memory and performance reasons.
228     // Don't go making it virtual again unless you know exactly what you're doing!
229
230     ~CSSValue() { }
231
232 private:
233     void destroy();
234
235 protected:
236     unsigned m_isCSSOMSafe : 1;
237     unsigned m_isTextClone : 1;
238     // The bits in this section are only used by specific subclasses but kept here
239     // to maximize struct packing.
240
241     // CSSPrimitiveValue bits:
242     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitTypes
243     mutable unsigned m_hasCachedCSSText : 1;
244     unsigned m_isQuirkValue : 1;
245
246     unsigned m_valueListSeparator : ValueListSeparatorBits;
247
248 private:
249     unsigned m_classType : ClassTypeBits; // ClassType
250 };
251
252 template<typename CSSValueType>
253 inline bool compareCSSValueVector(const Vector<RefPtr<CSSValueType> >& firstVector, const Vector<RefPtr<CSSValueType> >& secondVector)
254 {
255     size_t size = firstVector.size();
256     if (size != secondVector.size())
257         return false;
258
259     for (size_t i = 0; i < size; i++) {
260         const RefPtr<CSSValueType>& firstPtr = firstVector[i];
261         const RefPtr<CSSValueType>& secondPtr = secondVector[i];
262         if (firstPtr == secondPtr || (firstPtr && secondPtr && firstPtr->equals(*secondPtr)))
263             continue;
264         return false;
265     }
266     return true;
267 }
268
269 template<typename CSSValueType>
270 inline bool compareCSSValuePtr(const RefPtr<CSSValueType>& first, const RefPtr<CSSValueType>& second)
271 {
272     return first ? second && first->equals(*second) : !second;
273 }
274
275 #define CSS_VALUE_TYPE_CASTS(ValueTypeName) \
276 inline const CSS##ValueTypeName* toCSS##ValueTypeName(const CSSValue* value) \
277 { \
278     ASSERT_WITH_SECURITY_IMPLICATION(!value || value->is##ValueTypeName()); \
279     return static_cast<const CSS##ValueTypeName*>(value); \
280 } \
281 inline CSS##ValueTypeName* toCSS##ValueTypeName(CSSValue* value) \
282 { \
283     ASSERT_WITH_SECURITY_IMPLICATION(!value || value->is##ValueTypeName()); \
284     return static_cast<CSS##ValueTypeName*>(value); \
285 } \
286 void toCSS##ValueTypeName(const CSS##ValueTypeName*); \
287 void toCSS##ValueTypeName(const CSS##ValueTypeName&);
288
289 } // namespace WebCore
290
291 #endif // CSSValue_h