Fix 'border' serialization with both common and uncommon values
[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 #pragma once
23
24 #include "CSSParserContext.h"
25 #include "CSSParserTokenRange.h"
26 #include "CSSProperty.h"
27 #include "CSSValueKeywords.h"
28 #include <memory>
29 #include <wtf/Function.h>
30 #include <wtf/TypeCasts.h>
31 #include <wtf/Vector.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class CSSDeferredParser;
37 class CSSStyleDeclaration;
38 class CachedResource;
39 class Color;
40 class ImmutableStyleProperties;
41 class URL;
42 class MutableStyleProperties;
43 class PropertySetCSSStyleDeclaration;
44 class StyledElement;
45 class StylePropertyShorthand;
46 class StyleSheetContents;
47
48 enum StylePropertiesType { ImmutablePropertiesType, MutablePropertiesType, DeferredPropertiesType };
49     
50 class StylePropertiesBase : public RefCounted<StylePropertiesBase> {
51 public:
52     // Override RefCounted's deref() to ensure operator delete is called on
53     // the appropriate subclass type.
54     void deref();
55     
56     StylePropertiesType type() const { return static_cast<StylePropertiesType>(m_type); }
57
58     CSSParserMode cssParserMode() const { return static_cast<CSSParserMode>(m_cssParserMode); }
59
60 protected:
61     StylePropertiesBase(CSSParserMode cssParserMode, StylePropertiesType type)
62         : m_cssParserMode(cssParserMode)
63         , m_type(type)
64         , m_arraySize(0)
65     { }
66     
67     StylePropertiesBase(CSSParserMode cssParserMode, unsigned immutableArraySize)
68         : m_cssParserMode(cssParserMode)
69         , m_type(ImmutablePropertiesType)
70         , m_arraySize(immutableArraySize)
71     { }
72     
73     unsigned m_cssParserMode : 3;
74     mutable unsigned m_type : 2;
75     unsigned m_arraySize : 27;
76 };
77
78 class StyleProperties : public StylePropertiesBase {
79     friend class PropertyReference;
80 public:
81     class PropertyReference {
82     public:
83         PropertyReference(const StylePropertyMetadata& metadata, const CSSValue* value)
84             : m_metadata(metadata)
85             , m_value(value)
86         { }
87
88         CSSPropertyID id() const { return static_cast<CSSPropertyID>(m_metadata.m_propertyID); }
89         CSSPropertyID shorthandID() const { return m_metadata.shorthandID(); }
90
91         bool isImportant() const { return m_metadata.m_important; }
92         bool isInherited() const { return m_metadata.m_inherited; }
93         bool isImplicit() const { return m_metadata.m_implicit; }
94
95         String cssName() const;
96         String cssText() const;
97
98         const CSSValue* value() const { return m_value; }
99         // FIXME: We should try to remove this mutable overload.
100         CSSValue* value() { return const_cast<CSSValue*>(m_value); }
101
102         // FIXME: Remove this.
103         CSSProperty toCSSProperty() const { return CSSProperty(id(), const_cast<CSSValue*>(m_value), isImportant(), m_metadata.m_isSetFromShorthand, m_metadata.m_indexInShorthandsVector, isImplicit()); }
104
105     private:
106         const StylePropertyMetadata& m_metadata;
107         const CSSValue* m_value;
108     };
109
110     unsigned propertyCount() const;
111     bool isEmpty() const { return !propertyCount(); }
112     PropertyReference propertyAt(unsigned) const;
113
114     WEBCORE_EXPORT RefPtr<CSSValue> getPropertyCSSValue(CSSPropertyID) const;
115     WEBCORE_EXPORT String getPropertyValue(CSSPropertyID) const;
116
117     WEBCORE_EXPORT std::optional<Color> propertyAsColor(CSSPropertyID) const;
118     WEBCORE_EXPORT CSSValueID propertyAsValueID(CSSPropertyID) const;
119
120     bool propertyIsImportant(CSSPropertyID) const;
121     String getPropertyShorthand(CSSPropertyID) const;
122     bool isPropertyImplicit(CSSPropertyID) const;
123
124     RefPtr<CSSValue> getCustomPropertyCSSValue(const String& propertyName) const;
125     String getCustomPropertyValue(const String& propertyName) const;
126     bool customPropertyIsImportant(const String& propertyName) const;
127
128     Ref<MutableStyleProperties> copyBlockProperties() const;
129
130     WEBCORE_EXPORT Ref<MutableStyleProperties> mutableCopy() const;
131     Ref<ImmutableStyleProperties> immutableCopyIfNeeded() const;
132
133     Ref<MutableStyleProperties> copyPropertiesInSet(const CSSPropertyID* set, unsigned length) const;
134     
135     String asText() const;
136
137     bool hasCSSOMWrapper() const;
138     bool isMutable() const { return type() == MutablePropertiesType; }
139
140     bool traverseSubresources(const WTF::Function<bool (const CachedResource&)>& handler) const;
141
142     static unsigned averageSizeInBytes();
143
144 #ifndef NDEBUG
145     void showStyle();
146 #endif
147
148     bool propertyMatches(CSSPropertyID, const CSSValue*) const;
149
150 protected:
151     StyleProperties(CSSParserMode cssParserMode, StylePropertiesType type)
152         : StylePropertiesBase(cssParserMode, type)
153     { }
154
155     StyleProperties(CSSParserMode cssParserMode, unsigned immutableArraySize)
156         : StylePropertiesBase(cssParserMode, immutableArraySize)
157     { }
158
159     int findPropertyIndex(CSSPropertyID) const;
160     int findCustomPropertyIndex(const String& propertyName) const;
161
162 private:
163     String getShorthandValue(const StylePropertyShorthand&) const;
164     String getCommonValue(const StylePropertyShorthand&) const;
165     String getAlignmentShorthandValue(const StylePropertyShorthand&) const;
166     String borderPropertyValue() const;
167     String getLayeredShorthandValue(const StylePropertyShorthand&) const;
168     String get4Values(const StylePropertyShorthand&) const;
169     String borderSpacingValue(const StylePropertyShorthand&) const;
170     String fontValue() const;
171     void appendFontLonghandValueIfExplicit(CSSPropertyID, StringBuilder& result, String& value) const;
172     
173     RefPtr<CSSValue> getPropertyCSSValueInternal(CSSPropertyID) const;
174     
175     friend class PropertySetCSSStyleDeclaration;
176 };
177
178 class ImmutableStyleProperties final : public StyleProperties {
179 public:
180     WEBCORE_EXPORT ~ImmutableStyleProperties();
181     static Ref<ImmutableStyleProperties> create(const CSSProperty* properties, unsigned count, CSSParserMode);
182
183     unsigned propertyCount() const { return m_arraySize; }
184     bool isEmpty() const { return !propertyCount(); }
185     PropertyReference propertyAt(unsigned index) const;
186
187     const CSSValue** valueArray() const;
188     const StylePropertyMetadata* metadataArray() const;
189     int findPropertyIndex(CSSPropertyID) const;
190     int findCustomPropertyIndex(const String& propertyName) const;
191     
192     void* m_storage;
193
194 private:
195     ImmutableStyleProperties(const CSSProperty*, unsigned count, CSSParserMode);
196 };
197
198 inline const CSSValue** ImmutableStyleProperties::valueArray() const
199 {
200     return reinterpret_cast<const CSSValue**>(const_cast<const void**>((&(this->m_storage))));
201 }
202
203 inline const StylePropertyMetadata* ImmutableStyleProperties::metadataArray() const
204 {
205     return reinterpret_cast_ptr<const StylePropertyMetadata*>(&reinterpret_cast_ptr<const char*>(&(this->m_storage))[m_arraySize * sizeof(CSSValue*)]);
206 }
207
208 class MutableStyleProperties final : public StyleProperties {
209 public:
210     WEBCORE_EXPORT static Ref<MutableStyleProperties> create(CSSParserMode = HTMLQuirksMode);
211     static Ref<MutableStyleProperties> create(const CSSProperty* properties, unsigned count);
212
213     WEBCORE_EXPORT ~MutableStyleProperties();
214
215     unsigned propertyCount() const { return m_propertyVector.size(); }
216     bool isEmpty() const { return !propertyCount(); }
217     PropertyReference propertyAt(unsigned index) const;
218
219     PropertySetCSSStyleDeclaration* cssStyleDeclaration();
220
221     bool addParsedProperties(const ParsedPropertyVector&);
222     bool addParsedProperty(const CSSProperty&);
223
224     // These expand shorthand properties into multiple properties.
225     bool setProperty(CSSPropertyID, const String& value, bool important, CSSParserContext);
226     bool setProperty(CSSPropertyID, const String& value, bool important = false);
227     void setProperty(CSSPropertyID, RefPtr<CSSValue>&&, bool important = false);
228
229     // These do not. FIXME: This is too messy, we can do better.
230     bool setProperty(CSSPropertyID, CSSValueID identifier, bool important = false);
231     bool setProperty(CSSPropertyID, CSSPropertyID identifier, bool important = false);
232     bool setProperty(const CSSProperty&, CSSProperty* slot = nullptr);
233
234     bool removeProperty(CSSPropertyID, String* returnText = nullptr);
235     void removeBlockProperties();
236     bool removePropertiesInSet(const CSSPropertyID* set, unsigned length);
237
238     void mergeAndOverrideOnConflict(const StyleProperties&);
239
240     void clear();
241     bool parseDeclaration(const String& styleDeclaration, CSSParserContext);
242
243     WEBCORE_EXPORT CSSStyleDeclaration& ensureCSSStyleDeclaration();
244     CSSStyleDeclaration& ensureInlineCSSStyleDeclaration(StyledElement& parentElement);
245
246     int findPropertyIndex(CSSPropertyID) const;
247     int findCustomPropertyIndex(const String& propertyName) const;
248     
249     Vector<CSSProperty, 4> m_propertyVector;
250
251     // Methods for querying and altering CSS custom properties.
252     bool setCustomProperty(const String& propertyName, const String& value, bool important, CSSParserContext);
253     bool removeCustomProperty(const String& propertyName, String* returnText = nullptr);
254
255 private:
256     explicit MutableStyleProperties(CSSParserMode);
257     explicit MutableStyleProperties(const StyleProperties&);
258     MutableStyleProperties(const CSSProperty* properties, unsigned count);
259
260     bool removeShorthandProperty(CSSPropertyID);
261     CSSProperty* findCSSPropertyWithID(CSSPropertyID);
262     CSSProperty* findCustomCSSPropertyWithName(const String&);
263     std::unique_ptr<PropertySetCSSStyleDeclaration> m_cssomWrapper;
264
265     friend class StyleProperties;
266 };
267
268 class DeferredStyleProperties final : public StylePropertiesBase {
269 public:
270     WEBCORE_EXPORT ~DeferredStyleProperties();
271     static Ref<DeferredStyleProperties> create(const CSSParserTokenRange&, CSSDeferredParser&);
272
273     Ref<ImmutableStyleProperties> parseDeferredProperties();
274     
275 private:
276     DeferredStyleProperties(const CSSParserTokenRange&, CSSDeferredParser&);
277     
278     Vector<CSSParserToken> m_tokens;
279     Ref<CSSDeferredParser> m_parser;
280 };
281
282 inline ImmutableStyleProperties::PropertyReference ImmutableStyleProperties::propertyAt(unsigned index) const
283 {
284     return PropertyReference(metadataArray()[index], valueArray()[index]);
285 }
286
287 inline MutableStyleProperties::PropertyReference MutableStyleProperties::propertyAt(unsigned index) const
288 {
289     const CSSProperty& property = m_propertyVector[index];
290     return PropertyReference(property.metadata(), property.value());
291 }
292
293 inline StyleProperties::PropertyReference StyleProperties::propertyAt(unsigned index) const
294 {
295     if (is<MutableStyleProperties>(*this))
296         return downcast<MutableStyleProperties>(*this).propertyAt(index);
297     return downcast<ImmutableStyleProperties>(*this).propertyAt(index);
298 }
299
300 inline unsigned StyleProperties::propertyCount() const
301 {
302     if (is<MutableStyleProperties>(*this))
303         return downcast<MutableStyleProperties>(*this).propertyCount();
304     return downcast<ImmutableStyleProperties>(*this).propertyCount();
305 }
306
307 inline void StylePropertiesBase::deref()
308 {
309     if (!derefBase())
310         return;
311
312     if (is<MutableStyleProperties>(*this))
313         delete downcast<MutableStyleProperties>(this);
314     else if (is<ImmutableStyleProperties>(*this))
315         delete downcast<ImmutableStyleProperties>(this);
316     else
317         delete downcast<DeferredStyleProperties>(this);
318 }
319
320 inline int StyleProperties::findPropertyIndex(CSSPropertyID propertyID) const
321 {
322     if (is<MutableStyleProperties>(*this))
323         return downcast<MutableStyleProperties>(*this).findPropertyIndex(propertyID);
324     return downcast<ImmutableStyleProperties>(*this).findPropertyIndex(propertyID);
325 }
326
327 inline int StyleProperties::findCustomPropertyIndex(const String& propertyName) const
328 {
329     if (is<MutableStyleProperties>(*this))
330         return downcast<MutableStyleProperties>(*this).findCustomPropertyIndex(propertyName);
331     return downcast<ImmutableStyleProperties>(*this).findCustomPropertyIndex(propertyName);
332 }
333
334 } // namespace WebCore
335
336 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::StyleProperties)
337     static bool isType(const WebCore::StylePropertiesBase& set) { return set.type() != WebCore::DeferredPropertiesType; }
338 SPECIALIZE_TYPE_TRAITS_END()
339
340 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::MutableStyleProperties)
341     static bool isType(const WebCore::StylePropertiesBase& set) { return set.type() == WebCore::MutablePropertiesType; }
342 SPECIALIZE_TYPE_TRAITS_END()
343
344 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ImmutableStyleProperties)
345     static bool isType(const WebCore::StylePropertiesBase& set) { return set.type() == WebCore::ImmutablePropertiesType; }
346 SPECIALIZE_TYPE_TRAITS_END()
347
348 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::DeferredStyleProperties)
349     static bool isType(const WebCore::StylePropertiesBase& set) { return set.type() == WebCore::DeferredPropertiesType; }
350 SPECIALIZE_TYPE_TRAITS_END()