fe80e331d5cb210ba7b05d219278a037591b939f
[WebKit-https.git] / Source / WebCore / dom / ElementRareData.h
1 /*
2  * Copyright (C) 2008, 2009, 2010, 2014, 2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 David Smith <catfish.man@gmail.com>
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
22 #pragma once
23
24 #include "CustomElementReactionQueue.h"
25 #include "DOMTokenList.h"
26 #include "DatasetDOMStringMap.h"
27 #include "IntersectionObserver.h"
28 #include "NamedNodeMap.h"
29 #include "NodeRareData.h"
30 #include "PseudoElement.h"
31 #include "RenderElement.h"
32 #include "ShadowRoot.h"
33 #include "StylePropertyMap.h"
34
35 namespace WebCore {
36
37 inline IntSize defaultMinimumSizeForResizing()
38 {
39     return IntSize(LayoutUnit::max(), LayoutUnit::max());
40 }
41
42 class ElementRareData : public NodeRareData {
43 public:
44     explicit ElementRareData(RenderElement*);
45     ~ElementRareData();
46
47     void setBeforePseudoElement(RefPtr<PseudoElement>&&);
48     void setAfterPseudoElement(RefPtr<PseudoElement>&&);
49
50     PseudoElement* beforePseudoElement() const { return m_beforePseudoElement.get(); }
51     PseudoElement* afterPseudoElement() const { return m_afterPseudoElement.get(); }
52
53     void resetComputedStyle();
54     void resetStyleRelations();
55     
56     int tabIndex() const { return m_tabIndex; }
57     void setTabIndexExplicitly(int index) { m_tabIndex = index; m_tabIndexWasSetExplicitly = true; }
58     bool tabIndexSetExplicitly() const { return m_tabIndexWasSetExplicitly; }
59     void clearTabIndexExplicitly() { m_tabIndex = 0; m_tabIndexWasSetExplicitly = false; }
60
61     bool styleAffectedByActive() const { return m_styleAffectedByActive; }
62     void setStyleAffectedByActive(bool value) { m_styleAffectedByActive = value; }
63
64     bool styleAffectedByEmpty() const { return m_styleAffectedByEmpty; }
65     void setStyleAffectedByEmpty(bool value) { m_styleAffectedByEmpty = value; }
66
67     bool styleAffectedByFocusWithin() const { return m_styleAffectedByFocusWithin; }
68     void setStyleAffectedByFocusWithin(bool value) { m_styleAffectedByFocusWithin = value; }
69
70 #if ENABLE(FULLSCREEN_API)
71     bool containsFullScreenElement() { return m_containsFullScreenElement; }
72     void setContainsFullScreenElement(bool value) { m_containsFullScreenElement = value; }
73 #endif
74
75     bool childrenAffectedByDrag() const { return m_childrenAffectedByDrag; }
76     void setChildrenAffectedByDrag(bool value) { m_childrenAffectedByDrag = value; }
77
78     bool childrenAffectedByLastChildRules() const { return m_childrenAffectedByLastChildRules; }
79     void setChildrenAffectedByLastChildRules(bool value) { m_childrenAffectedByLastChildRules = value; }
80     bool childrenAffectedByForwardPositionalRules() const { return m_childrenAffectedByForwardPositionalRules; }
81     void setChildrenAffectedByForwardPositionalRules(bool value) { m_childrenAffectedByForwardPositionalRules = value; }
82     bool descendantsAffectedByForwardPositionalRules() const { return m_descendantsAffectedByForwardPositionalRules; }
83     void setDescendantsAffectedByForwardPositionalRules(bool value) { m_descendantsAffectedByForwardPositionalRules = value; }
84     bool childrenAffectedByBackwardPositionalRules() const { return m_childrenAffectedByBackwardPositionalRules; }
85     void setChildrenAffectedByBackwardPositionalRules(bool value) { m_childrenAffectedByBackwardPositionalRules = value; }
86     bool descendantsAffectedByBackwardPositionalRules() const { return m_descendantsAffectedByBackwardPositionalRules; }
87     void setDescendantsAffectedByBackwardPositionalRules(bool value) { m_descendantsAffectedByBackwardPositionalRules = value; }
88     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return m_childrenAffectedByPropertyBasedBackwardPositionalRules; }
89     void setChildrenAffectedByPropertyBasedBackwardPositionalRules(bool value) { m_childrenAffectedByPropertyBasedBackwardPositionalRules = value; }
90
91     unsigned childIndex() const { return m_childIndex; }
92     void setChildIndex(unsigned index) { m_childIndex = index; }
93     static ptrdiff_t childIndexMemoryOffset() { return OBJECT_OFFSETOF(ElementRareData, m_childIndex); }
94
95     void clearShadowRoot() { m_shadowRoot = nullptr; }
96     ShadowRoot* shadowRoot() const { return m_shadowRoot.get(); }
97     void setShadowRoot(RefPtr<ShadowRoot>&& shadowRoot) { m_shadowRoot = WTFMove(shadowRoot); }
98
99     CustomElementReactionQueue* customElementReactionQueue() { return m_customElementReactionQueue.get(); }
100     void setCustomElementReactionQueue(std::unique_ptr<CustomElementReactionQueue>&& queue) { m_customElementReactionQueue = WTFMove(queue); }
101
102     NamedNodeMap* attributeMap() const { return m_attributeMap.get(); }
103     void setAttributeMap(std::unique_ptr<NamedNodeMap> attributeMap) { m_attributeMap = WTFMove(attributeMap); }
104
105     RenderStyle* computedStyle() const { return m_computedStyle.get(); }
106     void setComputedStyle(std::unique_ptr<RenderStyle> computedStyle) { m_computedStyle = WTFMove(computedStyle); }
107
108     DOMTokenList* classList() const { return m_classList.get(); }
109     void setClassList(std::unique_ptr<DOMTokenList> classList) { m_classList = WTFMove(classList); }
110
111     DatasetDOMStringMap* dataset() const { return m_dataset.get(); }
112     void setDataset(std::unique_ptr<DatasetDOMStringMap> dataset) { m_dataset = WTFMove(dataset); }
113
114     LayoutSize minimumSizeForResizing() const { return m_minimumSizeForResizing; }
115     void setMinimumSizeForResizing(LayoutSize size) { m_minimumSizeForResizing = size; }
116
117     IntPoint savedLayerScrollPosition() const { return m_savedLayerScrollPosition; }
118     void setSavedLayerScrollPosition(IntPoint position) { m_savedLayerScrollPosition = position; }
119
120     bool hasPendingResources() const { return m_hasPendingResources; }
121     void setHasPendingResources(bool has) { m_hasPendingResources = has; }
122
123     bool hasCSSAnimation() const { return m_hasCSSAnimation; }
124     void setHasCSSAnimation(bool value) { m_hasCSSAnimation = value; }
125
126 #if ENABLE(INTERSECTION_OBSERVER)
127     IntersectionObserverData* intersectionObserverData() { return m_intersectionObserverData.get(); }
128     void setIntersectionObserverData(std::unique_ptr<IntersectionObserverData>&& data) { m_intersectionObserverData = WTFMove(data); }
129 #endif
130
131 #if ENABLE(CSS_TYPED_OM)
132     StylePropertyMap* attributeStyleMap() { return m_attributeStyleMap.get(); }
133     void setAttributeStyleMap(Ref<StylePropertyMap>&& map) { m_attributeStyleMap = WTFMove(map); }
134 #endif
135
136 #if DUMP_NODE_STATISTICS
137     OptionSet<UseType> useTypes() const
138     {
139         auto result = NodeRareData::useTypes();
140         if (m_tabIndexWasSetExplicitly)
141             result.add(UseType::TabIndex);
142         if (m_styleAffectedByActive || m_styleAffectedByEmpty || m_styleAffectedByFocusWithin || m_childrenAffectedByHover
143             || m_childrenAffectedByDrag || m_childrenAffectedByLastChildRules || m_childrenAffectedByForwardPositionalRules
144             || m_descendantsAffectedByForwardPositionalRules || m_childrenAffectedByBackwardPositionalRules
145             || m_descendantsAffectedByBackwardPositionalRules || m_childrenAffectedByPropertyBasedBackwardPositionalRules)
146             result.add(UseType::StyleFlags);
147         if (m_minimumSizeForResizing != defaultMinimumSizeForResizing())
148             result.add(UseType::MinimumSize);
149         if (!m_savedLayerScrollPosition.isZero())
150             result.add(UseType::ScrollingPosition);
151         if (m_computedStyle)
152             result.add(UseType::ComputedStyle);
153         if (m_dataset)
154             result.add(UseType::Dataset);
155         if (m_classList)
156             result.add(UseType::ClassList);
157         if (m_shadowRoot)
158             result.add(UseType::ShadowRoot);
159         if (m_customElementReactionQueue)
160             result.add(UseType::CustomElementQueue);
161         if (m_attributeMap)
162             result.add(UseType::AttributeMap);
163         if (m_intersectionObserverData)
164             result.add(UseType::InteractionObserver);
165         if (m_beforePseudoElement || m_afterPseudoElement)
166             result.add(UseType::PseudoElements);
167         return result;
168     }
169 #endif
170
171 private:
172     int m_tabIndex;
173     unsigned short m_childIndex;
174     unsigned m_tabIndexWasSetExplicitly : 1;
175     unsigned m_styleAffectedByActive : 1;
176     unsigned m_styleAffectedByEmpty : 1;
177     unsigned m_styleAffectedByFocusWithin : 1;
178 #if ENABLE(FULLSCREEN_API)
179     unsigned m_containsFullScreenElement : 1;
180 #endif
181     unsigned m_hasPendingResources : 1;
182     unsigned m_hasCSSAnimation : 1;
183     unsigned m_childrenAffectedByHover : 1;
184     unsigned m_childrenAffectedByDrag : 1;
185     // Bits for dynamic child matching.
186     // We optimize for :first-child and :last-child. The other positional child selectors like nth-child or
187     // *-child-of-type, we will just give up and re-evaluate whenever children change at all.
188     unsigned m_childrenAffectedByLastChildRules : 1;
189     unsigned m_childrenAffectedByForwardPositionalRules : 1;
190     unsigned m_descendantsAffectedByForwardPositionalRules : 1;
191     unsigned m_childrenAffectedByBackwardPositionalRules : 1;
192     unsigned m_descendantsAffectedByBackwardPositionalRules : 1;
193     unsigned m_childrenAffectedByPropertyBasedBackwardPositionalRules : 1;
194
195     LayoutSize m_minimumSizeForResizing;
196     IntPoint m_savedLayerScrollPosition;
197     std::unique_ptr<RenderStyle> m_computedStyle;
198
199     std::unique_ptr<DatasetDOMStringMap> m_dataset;
200     std::unique_ptr<DOMTokenList> m_classList;
201     RefPtr<ShadowRoot> m_shadowRoot;
202     std::unique_ptr<CustomElementReactionQueue> m_customElementReactionQueue;
203     std::unique_ptr<NamedNodeMap> m_attributeMap;
204 #if ENABLE(INTERSECTION_OBSERVER)
205     std::unique_ptr<IntersectionObserverData> m_intersectionObserverData;
206 #endif
207
208     RefPtr<PseudoElement> m_beforePseudoElement;
209     RefPtr<PseudoElement> m_afterPseudoElement;
210
211 #if ENABLE(CSS_TYPED_OM)
212     RefPtr<StylePropertyMap> m_attributeStyleMap;
213 #endif
214
215     void releasePseudoElement(PseudoElement*);
216 };
217
218 inline ElementRareData::ElementRareData(RenderElement* renderer)
219     : NodeRareData(renderer)
220     , m_tabIndex(0)
221     , m_childIndex(0)
222     , m_tabIndexWasSetExplicitly(false)
223     , m_styleAffectedByActive(false)
224     , m_styleAffectedByEmpty(false)
225     , m_styleAffectedByFocusWithin(false)
226 #if ENABLE(FULLSCREEN_API)
227     , m_containsFullScreenElement(false)
228 #endif
229     , m_hasPendingResources(false)
230     , m_hasCSSAnimation(false)
231     , m_childrenAffectedByHover(false)
232     , m_childrenAffectedByDrag(false)
233     , m_childrenAffectedByLastChildRules(false)
234     , m_childrenAffectedByForwardPositionalRules(false)
235     , m_descendantsAffectedByForwardPositionalRules(false)
236     , m_childrenAffectedByBackwardPositionalRules(false)
237     , m_descendantsAffectedByBackwardPositionalRules(false)
238     , m_childrenAffectedByPropertyBasedBackwardPositionalRules(false)
239     , m_minimumSizeForResizing(defaultMinimumSizeForResizing())
240 {
241 }
242
243 inline ElementRareData::~ElementRareData()
244 {
245     ASSERT(!m_shadowRoot);
246     ASSERT(!m_beforePseudoElement);
247     ASSERT(!m_afterPseudoElement);
248 }
249
250 inline void ElementRareData::setBeforePseudoElement(RefPtr<PseudoElement>&& pseudoElement)
251 {
252     ASSERT(!m_beforePseudoElement || !pseudoElement);
253     m_beforePseudoElement = WTFMove(pseudoElement);
254 }
255
256 inline void ElementRareData::setAfterPseudoElement(RefPtr<PseudoElement>&& pseudoElement)
257 {
258     ASSERT(!m_afterPseudoElement || !pseudoElement);
259     m_afterPseudoElement = WTFMove(pseudoElement);
260 }
261
262 inline void ElementRareData::resetComputedStyle()
263 {
264     m_computedStyle = nullptr;
265 }
266
267 inline void ElementRareData::resetStyleRelations()
268 {
269     setStyleAffectedByEmpty(false);
270     setStyleAffectedByFocusWithin(false);
271     setChildIndex(0);
272     setStyleAffectedByActive(false);
273     setChildrenAffectedByDrag(false);
274     setChildrenAffectedByLastChildRules(false);
275     setChildrenAffectedByForwardPositionalRules(false);
276     setDescendantsAffectedByForwardPositionalRules(false);
277     setChildrenAffectedByBackwardPositionalRules(false);
278     setDescendantsAffectedByBackwardPositionalRules(false);
279     setChildrenAffectedByPropertyBasedBackwardPositionalRules(false);
280 }
281
282 } // namespace WebCore