8d31f399d909a812c8fb2446d1f3f1af1f7fc3c7
[WebKit-https.git] / Source / WebCore / css / StyleProperties.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2005, 2006, 2008, 2012, 2013 Apple Inc. All rights reserved.
4  * Copyright (C) 2013 Intel Corporation. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef StyleProperties_h
23 #define StyleProperties_h
24
25 #include "CSSParserMode.h"
26 #include "CSSPrimitiveValue.h"
27 #include "CSSProperty.h"
28 #include "CSSPropertyNames.h"
29 #include "CSSValueKeywords.h"
30 #include <memory>
31 #include <wtf/ListHashSet.h>
32 #include <wtf/TypeCasts.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class CSSRule;
39 class CSSStyleDeclaration;
40 class ComputedStyleExtractor;
41 class ImmutableStyleProperties;
42 class URL;
43 class MutableStyleProperties;
44 class PropertySetCSSStyleDeclaration;
45 class StyledElement;
46 class StylePropertyShorthand;
47 class StyleSheetContents;
48
49 class StyleProperties : public RefCounted<StyleProperties> {
50     friend class PropertyReference;
51 public:
52     // Override RefCounted's deref() to ensure operator delete is called on
53     // the appropriate subclass type.
54     void deref();
55
56     class PropertyReference {
57     public:
58         PropertyReference(const StylePropertyMetadata& metadata, const CSSValue* value)
59             : m_metadata(metadata)
60             , m_value(value)
61         { }
62
63         CSSPropertyID id() const { return static_cast<CSSPropertyID>(m_metadata.m_propertyID); }
64         CSSPropertyID shorthandID() const { return m_metadata.shorthandID(); }
65
66         bool isImportant() const { return m_metadata.m_important; }
67         bool isInherited() const { return m_metadata.m_inherited; }
68         bool isImplicit() const { return m_metadata.m_implicit; }
69
70         String cssName() const;
71         String cssText() const;
72
73         const CSSValue* value() const { return m_value; }
74         // FIXME: We should try to remove this mutable overload.
75         CSSValue* value() { return const_cast<CSSValue*>(m_value); }
76
77         // FIXME: Remove this.
78         CSSProperty toCSSProperty() const { return CSSProperty(id(), const_cast<CSSValue*>(m_value), isImportant(), m_metadata.m_isSetFromShorthand, m_metadata.m_indexInShorthandsVector, isImplicit()); }
79
80     private:
81         const StylePropertyMetadata& m_metadata;
82         const CSSValue* m_value;
83     };
84
85     unsigned propertyCount() const;
86     bool isEmpty() const { return !propertyCount(); }
87     PropertyReference propertyAt(unsigned) const;
88
89     PassRefPtr<CSSValue> getPropertyCSSValue(CSSPropertyID) const;
90     String getPropertyValue(CSSPropertyID) const;
91     bool propertyIsImportant(CSSPropertyID) const;
92     String getPropertyShorthand(CSSPropertyID) const;
93     bool isPropertyImplicit(CSSPropertyID) const;
94
95     Ref<MutableStyleProperties> copyBlockProperties() const;
96
97     CSSParserMode cssParserMode() const { return static_cast<CSSParserMode>(m_cssParserMode); }
98
99     void addSubresourceStyleURLs(ListHashSet<URL>&, StyleSheetContents* contextStyleSheet) const;
100
101     WEBCORE_EXPORT Ref<MutableStyleProperties> mutableCopy() const;
102     Ref<ImmutableStyleProperties> immutableCopyIfNeeded() const;
103
104     Ref<MutableStyleProperties> copyPropertiesInSet(const CSSPropertyID* set, unsigned length) const;
105     
106     String asText() const;
107
108     bool isMutable() const { return m_isMutable; }
109     bool hasCSSOMWrapper() const;
110
111     bool hasFailedOrCanceledSubresources() const;
112
113     static unsigned averageSizeInBytes();
114
115 #ifndef NDEBUG
116     void showStyle();
117 #endif
118
119     bool propertyMatches(CSSPropertyID, const CSSValue*) const;
120
121 protected:
122     StyleProperties(CSSParserMode cssParserMode)
123         : m_cssParserMode(cssParserMode)
124         , m_isMutable(true)
125         , m_arraySize(0)
126     { }
127
128     StyleProperties(CSSParserMode cssParserMode, unsigned immutableArraySize)
129         : m_cssParserMode(cssParserMode)
130         , m_isMutable(false)
131         , m_arraySize(immutableArraySize)
132     { }
133
134     int findPropertyIndex(CSSPropertyID) const;
135
136     unsigned m_cssParserMode : 2;
137     mutable unsigned m_isMutable : 1;
138     unsigned m_arraySize : 29;
139     
140 private:
141     String getShorthandValue(const StylePropertyShorthand&) const;
142     String getCommonValue(const StylePropertyShorthand&) const;
143     enum CommonValueMode { OmitUncommonValues, ReturnNullOnUncommonValues };
144     String borderPropertyValue(CommonValueMode) const;
145     String getLayeredShorthandValue(const StylePropertyShorthand&) const;
146     String get4Values(const StylePropertyShorthand&) const;
147     String borderSpacingValue(const StylePropertyShorthand&) const;
148     String fontValue() const;
149     void appendFontLonghandValueIfExplicit(CSSPropertyID, StringBuilder& result, String& value) const;
150
151     friend class PropertySetCSSStyleDeclaration;
152 };
153
154 class ImmutableStyleProperties : public StyleProperties {
155 public:
156     WEBCORE_EXPORT ~ImmutableStyleProperties();
157     static Ref<ImmutableStyleProperties> create(const CSSProperty* properties, unsigned count, CSSParserMode);
158
159     unsigned propertyCount() const { return m_arraySize; }
160     bool isEmpty() const { return !propertyCount(); }
161     PropertyReference propertyAt(unsigned index) const;
162
163     const CSSValue** valueArray() const;
164     const StylePropertyMetadata* metadataArray() const;
165     int findPropertyIndex(CSSPropertyID) const;
166
167     void* m_storage;
168
169 private:
170     ImmutableStyleProperties(const CSSProperty*, unsigned count, CSSParserMode);
171 };
172
173 inline const CSSValue** ImmutableStyleProperties::valueArray() const
174 {
175     return reinterpret_cast<const CSSValue**>(const_cast<const void**>((&(this->m_storage))));
176 }
177
178 inline const StylePropertyMetadata* ImmutableStyleProperties::metadataArray() const
179 {
180     return reinterpret_cast_ptr<const StylePropertyMetadata*>(&reinterpret_cast_ptr<const char*>(&(this->m_storage))[m_arraySize * sizeof(CSSValue*)]);
181 }
182
183 class MutableStyleProperties : public StyleProperties {
184 public:
185     static Ref<MutableStyleProperties> create(CSSParserMode = CSSQuirksMode);
186     static Ref<MutableStyleProperties> create(const CSSProperty* properties, unsigned count);
187
188     WEBCORE_EXPORT ~MutableStyleProperties();
189
190     unsigned propertyCount() const { return m_propertyVector.size(); }
191     bool isEmpty() const { return !propertyCount(); }
192     PropertyReference propertyAt(unsigned index) const;
193
194     PropertySetCSSStyleDeclaration* cssStyleDeclaration();
195
196     void addParsedProperties(const Vector<CSSProperty>&);
197     void addParsedProperty(const CSSProperty&);
198
199     // These expand shorthand properties into multiple properties.
200     bool setProperty(CSSPropertyID, const String& value, bool important = false, StyleSheetContents* contextStyleSheet = 0);
201     void setProperty(CSSPropertyID, PassRefPtr<CSSValue>, bool important = false);
202
203     // These do not. FIXME: This is too messy, we can do better.
204     bool setProperty(CSSPropertyID, CSSValueID identifier, bool important = false);
205     bool setProperty(CSSPropertyID, CSSPropertyID identifier, bool important = false);
206     void appendPrefixingVariantProperty(const CSSProperty&);
207     void setPrefixingVariantProperty(const CSSProperty&);
208     void setProperty(const CSSProperty&, CSSProperty* slot = 0);
209
210     bool removeProperty(CSSPropertyID, String* returnText = 0);
211     void removePrefixedOrUnprefixedProperty(CSSPropertyID);
212     void removeBlockProperties();
213     bool removePropertiesInSet(const CSSPropertyID* set, unsigned length);
214
215     void mergeAndOverrideOnConflict(const StyleProperties&);
216
217     void clear();
218     void parseDeclaration(const String& styleDeclaration, StyleSheetContents* contextStyleSheet);
219
220     WEBCORE_EXPORT CSSStyleDeclaration* ensureCSSStyleDeclaration();
221     CSSStyleDeclaration* ensureInlineCSSStyleDeclaration(StyledElement* parentElement);
222
223     int findPropertyIndex(CSSPropertyID) const;
224
225     Vector<CSSProperty, 4> m_propertyVector;
226
227 private:
228     explicit MutableStyleProperties(CSSParserMode);
229     explicit MutableStyleProperties(const StyleProperties&);
230     MutableStyleProperties(const CSSProperty* properties, unsigned count);
231
232     bool removeShorthandProperty(CSSPropertyID);
233     CSSProperty* findCSSPropertyWithID(CSSPropertyID);
234     std::unique_ptr<PropertySetCSSStyleDeclaration> m_cssomWrapper;
235
236     friend class StyleProperties;
237 };
238
239 inline ImmutableStyleProperties::PropertyReference ImmutableStyleProperties::propertyAt(unsigned index) const
240 {
241     return PropertyReference(metadataArray()[index], valueArray()[index]);
242 }
243
244 inline MutableStyleProperties::PropertyReference MutableStyleProperties::propertyAt(unsigned index) const
245 {
246     const CSSProperty& property = m_propertyVector[index];
247     return PropertyReference(property.metadata(), property.value());
248 }
249
250 inline StyleProperties::PropertyReference StyleProperties::propertyAt(unsigned index) const
251 {
252     if (is<MutableStyleProperties>(*this))
253         return downcast<MutableStyleProperties>(*this).propertyAt(index);
254     return downcast<ImmutableStyleProperties>(*this).propertyAt(index);
255 }
256
257 inline unsigned StyleProperties::propertyCount() const
258 {
259     if (is<MutableStyleProperties>(*this))
260         return downcast<MutableStyleProperties>(*this).propertyCount();
261     return downcast<ImmutableStyleProperties>(*this).propertyCount();
262 }
263
264 inline void StyleProperties::deref()
265 {
266     if (!derefBase())
267         return;
268
269     if (is<MutableStyleProperties>(*this))
270         delete downcast<MutableStyleProperties>(this);
271     else
272         delete downcast<ImmutableStyleProperties>(this);
273 }
274
275 inline int StyleProperties::findPropertyIndex(CSSPropertyID propertyID) const
276 {
277     if (is<MutableStyleProperties>(*this))
278         return downcast<MutableStyleProperties>(*this).findPropertyIndex(propertyID);
279     return downcast<ImmutableStyleProperties>(*this).findPropertyIndex(propertyID);
280 }
281
282 } // namespace WebCore
283
284 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::MutableStyleProperties)
285     static bool isType(const WebCore::StyleProperties& set) { return set.isMutable(); }
286 SPECIALIZE_TYPE_TRAITS_END()
287
288 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ImmutableStyleProperties)
289     static bool isType(const WebCore::StyleProperties& set) { return !set.isMutable(); }
290 SPECIALIZE_TYPE_TRAITS_END()
291
292 #endif // StyleProperties_h