Add SPI to retrieve the set of text inputs in a given rect, and later focus one
[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     bool hasElementIdentifier() const { return m_hasElementIdentifier; }
127     void setHasElementIdentifier(bool value) { m_hasElementIdentifier = value; }
128
129 #if ENABLE(INTERSECTION_OBSERVER)
130     IntersectionObserverData* intersectionObserverData() { return m_intersectionObserverData.get(); }
131     void setIntersectionObserverData(std::unique_ptr<IntersectionObserverData>&& data) { m_intersectionObserverData = WTFMove(data); }
132 #endif
133
134 #if ENABLE(CSS_TYPED_OM)
135     StylePropertyMap* attributeStyleMap() { return m_attributeStyleMap.get(); }
136     void setAttributeStyleMap(Ref<StylePropertyMap>&& map) { m_attributeStyleMap = WTFMove(map); }
137 #endif
138
139 #if DUMP_NODE_STATISTICS
140     OptionSet<UseType> useTypes() const
141     {
142         auto result = NodeRareData::useTypes();
143         if (m_tabIndexWasSetExplicitly)
144             result.add(UseType::TabIndex);
145         if (m_styleAffectedByActive || m_styleAffectedByEmpty || m_styleAffectedByFocusWithin || m_childrenAffectedByHover
146             || m_childrenAffectedByDrag || m_childrenAffectedByLastChildRules || m_childrenAffectedByForwardPositionalRules
147             || m_descendantsAffectedByForwardPositionalRules || m_childrenAffectedByBackwardPositionalRules
148             || m_descendantsAffectedByBackwardPositionalRules || m_childrenAffectedByPropertyBasedBackwardPositionalRules)
149             result.add(UseType::StyleFlags);
150         if (m_minimumSizeForResizing != defaultMinimumSizeForResizing())
151             result.add(UseType::MinimumSize);
152         if (!m_savedLayerScrollPosition.isZero())
153             result.add(UseType::ScrollingPosition);
154         if (m_computedStyle)
155             result.add(UseType::ComputedStyle);
156         if (m_dataset)
157             result.add(UseType::Dataset);
158         if (m_classList)
159             result.add(UseType::ClassList);
160         if (m_shadowRoot)
161             result.add(UseType::ShadowRoot);
162         if (m_customElementReactionQueue)
163             result.add(UseType::CustomElementQueue);
164         if (m_attributeMap)
165             result.add(UseType::AttributeMap);
166         if (m_intersectionObserverData)
167             result.add(UseType::InteractionObserver);
168         if (m_beforePseudoElement || m_afterPseudoElement)
169             result.add(UseType::PseudoElements);
170         return result;
171     }
172 #endif
173
174 private:
175     int m_tabIndex;
176     unsigned short m_childIndex;
177     unsigned m_tabIndexWasSetExplicitly : 1;
178     unsigned m_styleAffectedByActive : 1;
179     unsigned m_styleAffectedByEmpty : 1;
180     unsigned m_styleAffectedByFocusWithin : 1;
181 #if ENABLE(FULLSCREEN_API)
182     unsigned m_containsFullScreenElement : 1;
183 #endif
184     unsigned m_hasPendingResources : 1;
185     unsigned m_hasCSSAnimation : 1;
186     unsigned m_hasElementIdentifier : 1;
187     unsigned m_childrenAffectedByHover : 1;
188     unsigned m_childrenAffectedByDrag : 1;
189     // Bits for dynamic child matching.
190     // We optimize for :first-child and :last-child. The other positional child selectors like nth-child or
191     // *-child-of-type, we will just give up and re-evaluate whenever children change at all.
192     unsigned m_childrenAffectedByLastChildRules : 1;
193     unsigned m_childrenAffectedByForwardPositionalRules : 1;
194     unsigned m_descendantsAffectedByForwardPositionalRules : 1;
195     unsigned m_childrenAffectedByBackwardPositionalRules : 1;
196     unsigned m_descendantsAffectedByBackwardPositionalRules : 1;
197     unsigned m_childrenAffectedByPropertyBasedBackwardPositionalRules : 1;
198
199     LayoutSize m_minimumSizeForResizing;
200     IntPoint m_savedLayerScrollPosition;
201     std::unique_ptr<RenderStyle> m_computedStyle;
202
203     std::unique_ptr<DatasetDOMStringMap> m_dataset;
204     std::unique_ptr<DOMTokenList> m_classList;
205     RefPtr<ShadowRoot> m_shadowRoot;
206     std::unique_ptr<CustomElementReactionQueue> m_customElementReactionQueue;
207     std::unique_ptr<NamedNodeMap> m_attributeMap;
208 #if ENABLE(INTERSECTION_OBSERVER)
209     std::unique_ptr<IntersectionObserverData> m_intersectionObserverData;
210 #endif
211
212     RefPtr<PseudoElement> m_beforePseudoElement;
213     RefPtr<PseudoElement> m_afterPseudoElement;
214
215 #if ENABLE(CSS_TYPED_OM)
216     RefPtr<StylePropertyMap> m_attributeStyleMap;
217 #endif
218
219     void releasePseudoElement(PseudoElement*);
220 };
221
222 inline ElementRareData::ElementRareData(RenderElement* renderer)
223     : NodeRareData(renderer)
224     , m_tabIndex(0)
225     , m_childIndex(0)
226     , m_tabIndexWasSetExplicitly(false)
227     , m_styleAffectedByActive(false)
228     , m_styleAffectedByEmpty(false)
229     , m_styleAffectedByFocusWithin(false)
230 #if ENABLE(FULLSCREEN_API)
231     , m_containsFullScreenElement(false)
232 #endif
233     , m_hasPendingResources(false)
234     , m_hasCSSAnimation(false)
235     , m_hasElementIdentifier(false)
236     , m_childrenAffectedByHover(false)
237     , m_childrenAffectedByDrag(false)
238     , m_childrenAffectedByLastChildRules(false)
239     , m_childrenAffectedByForwardPositionalRules(false)
240     , m_descendantsAffectedByForwardPositionalRules(false)
241     , m_childrenAffectedByBackwardPositionalRules(false)
242     , m_descendantsAffectedByBackwardPositionalRules(false)
243     , m_childrenAffectedByPropertyBasedBackwardPositionalRules(false)
244     , m_minimumSizeForResizing(defaultMinimumSizeForResizing())
245 {
246 }
247
248 inline ElementRareData::~ElementRareData()
249 {
250     ASSERT(!m_shadowRoot);
251     ASSERT(!m_beforePseudoElement);
252     ASSERT(!m_afterPseudoElement);
253 }
254
255 inline void ElementRareData::setBeforePseudoElement(RefPtr<PseudoElement>&& pseudoElement)
256 {
257     ASSERT(!m_beforePseudoElement || !pseudoElement);
258     m_beforePseudoElement = WTFMove(pseudoElement);
259 }
260
261 inline void ElementRareData::setAfterPseudoElement(RefPtr<PseudoElement>&& pseudoElement)
262 {
263     ASSERT(!m_afterPseudoElement || !pseudoElement);
264     m_afterPseudoElement = WTFMove(pseudoElement);
265 }
266
267 inline void ElementRareData::resetComputedStyle()
268 {
269     m_computedStyle = nullptr;
270 }
271
272 inline void ElementRareData::resetStyleRelations()
273 {
274     setStyleAffectedByEmpty(false);
275     setStyleAffectedByFocusWithin(false);
276     setChildIndex(0);
277     setStyleAffectedByActive(false);
278     setChildrenAffectedByDrag(false);
279     setChildrenAffectedByLastChildRules(false);
280     setChildrenAffectedByForwardPositionalRules(false);
281     setDescendantsAffectedByForwardPositionalRules(false);
282     setChildrenAffectedByBackwardPositionalRules(false);
283     setDescendantsAffectedByBackwardPositionalRules(false);
284     setChildrenAffectedByPropertyBasedBackwardPositionalRules(false);
285 }
286
287 } // namespace WebCore