Give StylePropertySet a proper mutability flag.
[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 "KURLHash.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 isAspectRatioValue() const { return m_classType == AspectRatioClass; }
67     bool isBorderImageSliceValue() const { return m_classType == BorderImageSliceClass; }
68     bool isCursorImageValue() const { return m_classType == CursorImageClass; }
69     bool isFontFeatureValue() const { return m_classType == FontFeatureClass; }
70     bool isFontValue() const { return m_classType == FontClass; }
71     bool isImageGeneratorValue() const { return m_classType >= CanvasClass && m_classType <= RadialGradientClass; }
72 #if ENABLE(CSS_IMAGE_SET)
73     bool isImageSetValue() const { return m_classType == ImageSetClass; }
74 #endif
75     bool isImageValue() const { return m_classType == ImageClass || m_classType == CursorImageClass; }
76     bool isImplicitInitialValue() const;
77     bool isInheritedValue() const { return m_classType == InheritedClass; }
78     bool isInitialValue() const { return m_classType == InitialClass; }
79     bool isReflectValue() const { return m_classType == ReflectClass; }
80     bool isShadowValue() const { return m_classType == ShadowClass; }
81     bool isCubicBezierTimingFunctionValue() const { return m_classType == CubicBezierTimingFunctionClass; }
82     bool isLinearTimingFunctionValue() const { return m_classType == LinearTimingFunctionClass; }
83     bool isStepsTimingFunctionValue() const { return m_classType == StepsTimingFunctionClass; }
84     bool isWebKitCSSTransformValue() const { return m_classType == WebKitCSSTransformClass; }
85     bool isCSSLineBoxContainValue() const { return m_classType == LineBoxContainClass; }
86     bool isCalculationValue() const {return m_classType == CalculationClass; }
87 #if ENABLE(CSS_FILTERS)
88     bool isWebKitCSSFilterValue() const { return m_classType == WebKitCSSFilterClass; }
89 #if ENABLE(CSS_SHADERS)
90     bool isWebKitCSSShaderValue() const { return m_classType == WebKitCSSShaderClass; }
91 #endif
92 #endif // ENABLE(CSS_FILTERS)
93 #if ENABLE(SVG)
94     bool isSVGColor() const { return m_classType == SVGColorClass || m_classType == SVGPaintClass; }
95     bool isSVGPaint() const { return m_classType == SVGPaintClass; }
96 #endif
97     
98     bool isCSSOMSafe() const { return m_isCSSOMSafe; }
99     bool isSubtypeExposedToCSSOM() const
100     { 
101         return isPrimitiveValue() 
102 #if ENABLE(SVG)
103             || isSVGColor()
104 #endif
105             || isValueList();
106     }
107
108     PassRefPtr<CSSValue> cloneForCSSOM() const;
109
110     void addSubresourceStyleURLs(ListHashSet<KURL>&, const StyleSheetContents*) const;
111
112 protected:
113
114     static const size_t ClassTypeBits = 5;
115     enum ClassType {
116         PrimitiveClass,
117
118         // Image classes.
119         ImageClass,
120         CursorImageClass,
121
122         // Image generator classes.
123         CanvasClass,
124         CrossfadeClass,
125         LinearGradientClass,
126         RadialGradientClass,
127
128         // Timing function classes.
129         CubicBezierTimingFunctionClass,
130         LinearTimingFunctionClass,
131         StepsTimingFunctionClass,
132
133         // Other class types.
134         AspectRatioClass,
135         BorderImageSliceClass,
136         FontFeatureClass,
137         FontClass,
138         FontFaceSrcClass,
139         FunctionClass,
140
141         InheritedClass,
142         InitialClass,
143
144         ReflectClass,
145         ShadowClass,
146         UnicodeRangeClass,
147         LineBoxContainClass,
148         CalculationClass,
149 #if ENABLE(CSS_FILTERS) && ENABLE(CSS_SHADERS)
150         WebKitCSSShaderClass,
151 #endif
152 #if ENABLE(SVG)
153         SVGColorClass,
154         SVGPaintClass,
155 #endif
156
157         // List class types must appear after ValueListClass.
158         ValueListClass,
159 #if ENABLE(CSS_IMAGE_SET)
160         ImageSetClass,
161 #endif
162 #if ENABLE(CSS_FILTERS)
163         WebKitCSSFilterClass,
164 #endif
165         WebKitCSSTransformClass,
166         // Do not append non-list class types here.
167     };
168
169     static const size_t ValueListSeparatorBits = 2;
170     enum ValueListSeparator {
171         SpaceSeparator,
172         CommaSeparator,
173         SlashSeparator
174     };
175
176     ClassType classType() const { return static_cast<ClassType>(m_classType); }
177
178     explicit CSSValue(ClassType classType, bool isCSSOMSafe = false)
179         : m_isCSSOMSafe(isCSSOMSafe)
180         , m_isTextClone(false)
181         , m_primitiveUnitType(0)
182         , m_hasCachedCSSText(false)
183         , m_isQuirkValue(false)
184         , m_valueListSeparator(SpaceSeparator)
185         , m_classType(classType)
186     {
187     }
188
189     // NOTE: This class is non-virtual for memory and performance reasons.
190     // Don't go making it virtual again unless you know exactly what you're doing!
191
192     ~CSSValue() { }
193
194 private:
195     void destroy();
196
197 protected:
198     unsigned m_isCSSOMSafe : 1;
199     unsigned m_isTextClone : 1;
200     // The bits in this section are only used by specific subclasses but kept here
201     // to maximize struct packing.
202
203     // CSSPrimitiveValue bits:
204     unsigned m_primitiveUnitType : 7; // CSSPrimitiveValue::UnitTypes
205     mutable unsigned m_hasCachedCSSText : 1;
206     unsigned m_isQuirkValue : 1;
207
208     unsigned m_valueListSeparator : ValueListSeparatorBits;
209
210 private:
211     unsigned m_classType : ClassTypeBits; // ClassType
212 };
213
214 } // namespace WebCore
215
216 #endif // CSSValue_h