Add SPI to retrieve the set of text inputs in a given rect, and later focus one
[WebKit-https.git] / Source / WebCore / dom / Element.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Peter Kelly (pmk@post.com)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2003-2017 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "AXTextStateChangeIntent.h"
28 #include "Document.h"
29 #include "ElementData.h"
30 #include "HTMLNames.h"
31 #include "KeyframeAnimationOptions.h"
32 #include "ScrollToOptions.h"
33 #include "ScrollTypes.h"
34 #include "ShadowRootMode.h"
35 #include "SimulatedClickOptions.h"
36 #include "StyleChange.h"
37
38 namespace WebCore {
39
40 class CustomElementReactionQueue;
41 class DatasetDOMStringMap;
42 class DOMRect;
43 class DOMRectList;
44 class DOMTokenList;
45 class ElementRareData;
46 class Frame;
47 class HTMLDocument;
48 class IntSize;
49 class JSCustomElementInterface;
50 class KeyboardEvent;
51 class Locale;
52 class PlatformKeyboardEvent;
53 class PlatformMouseEvent;
54 class PlatformWheelEvent;
55 class PseudoElement;
56 class RenderTreePosition;
57 class StylePropertyMap;
58 class WebAnimation;
59 struct ElementStyle;
60 struct ScrollIntoViewOptions;
61
62 #if ENABLE(INTERSECTION_OBSERVER)
63 struct IntersectionObserverData;
64 #endif
65
66 enum SpellcheckAttributeState {
67     SpellcheckAttributeTrue,
68     SpellcheckAttributeFalse,
69     SpellcheckAttributeDefault
70 };
71
72 #if ENABLE(POINTER_EVENTS)
73 enum class TouchAction : uint8_t;
74 #endif
75
76 class Element : public ContainerNode {
77     WTF_MAKE_ISO_ALLOCATED(Element);
78 public:
79     static Ref<Element> create(const QualifiedName&, Document&);
80     virtual ~Element();
81
82     WEBCORE_EXPORT bool hasAttribute(const QualifiedName&) const;
83     WEBCORE_EXPORT const AtomicString& getAttribute(const QualifiedName&) const;
84     template<typename... QualifiedNames>
85     const AtomicString& getAttribute(const QualifiedName&, const QualifiedNames&...) const;
86     WEBCORE_EXPORT void setAttribute(const QualifiedName&, const AtomicString& value);
87     WEBCORE_EXPORT void setAttributeWithoutSynchronization(const QualifiedName&, const AtomicString& value);
88     void setSynchronizedLazyAttribute(const QualifiedName&, const AtomicString& value);
89     bool removeAttribute(const QualifiedName&);
90     Vector<String> getAttributeNames() const;
91
92     // Typed getters and setters for language bindings.
93     WEBCORE_EXPORT int getIntegralAttribute(const QualifiedName& attributeName) const;
94     WEBCORE_EXPORT void setIntegralAttribute(const QualifiedName& attributeName, int value);
95     WEBCORE_EXPORT unsigned getUnsignedIntegralAttribute(const QualifiedName& attributeName) const;
96     WEBCORE_EXPORT void setUnsignedIntegralAttribute(const QualifiedName& attributeName, unsigned value);
97
98     // Call this to get the value of an attribute that is known not to be the style
99     // attribute or one of the SVG animatable attributes.
100     bool hasAttributeWithoutSynchronization(const QualifiedName&) const;
101     const AtomicString& attributeWithoutSynchronization(const QualifiedName&) const;
102 #ifndef NDEBUG
103     WEBCORE_EXPORT bool fastAttributeLookupAllowed(const QualifiedName&) const;
104 #endif
105
106 #if DUMP_NODE_STATISTICS
107     bool hasNamedNodeMap() const;
108 #endif
109     WEBCORE_EXPORT bool hasAttributes() const;
110     // This variant will not update the potentially invalid attributes. To be used when not interested
111     // in style attribute or one of the SVG animation attributes.
112     bool hasAttributesWithoutUpdate() const;
113
114     WEBCORE_EXPORT bool hasAttribute(const AtomicString& qualifiedName) const;
115     WEBCORE_EXPORT bool hasAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
116
117     WEBCORE_EXPORT const AtomicString& getAttribute(const AtomicString& qualifiedName) const;
118     WEBCORE_EXPORT const AtomicString& getAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
119
120     WEBCORE_EXPORT ExceptionOr<void> setAttribute(const AtomicString& qualifiedName, const AtomicString& value);
121     static ExceptionOr<QualifiedName> parseAttributeName(const AtomicString& namespaceURI, const AtomicString& qualifiedName);
122     WEBCORE_EXPORT ExceptionOr<void> setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value);
123
124     ExceptionOr<bool> toggleAttribute(const AtomicString& qualifiedName, Optional<bool> force);
125
126     const AtomicString& getIdAttribute() const;
127     void setIdAttribute(const AtomicString&);
128
129     const AtomicString& getNameAttribute() const;
130
131     // Call this to get the value of the id attribute for style resolution purposes.
132     // The value will already be lowercased if the document is in compatibility mode,
133     // so this function is not suitable for non-style uses.
134     const AtomicString& idForStyleResolution() const;
135
136     // Internal methods that assume the existence of attribute storage, one should use hasAttributes()
137     // before calling them.
138     AttributeIteratorAccessor attributesIterator() const { return elementData()->attributesIterator(); }
139     unsigned attributeCount() const;
140     const Attribute& attributeAt(unsigned index) const;
141     const Attribute* findAttributeByName(const QualifiedName&) const;
142     unsigned findAttributeIndexByName(const QualifiedName& name) const { return elementData()->findAttributeIndexByName(name); }
143     unsigned findAttributeIndexByName(const AtomicString& name, bool shouldIgnoreAttributeCase) const { return elementData()->findAttributeIndexByName(name, shouldIgnoreAttributeCase); }
144
145     WEBCORE_EXPORT void scrollIntoView(Optional<Variant<bool, ScrollIntoViewOptions>>&& arg);
146     WEBCORE_EXPORT void scrollIntoView(bool alignToTop = true);
147     WEBCORE_EXPORT void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
148     WEBCORE_EXPORT void scrollIntoViewIfNotVisible(bool centerIfNotVisible = true);
149
150     void scrollBy(const ScrollToOptions&);
151     void scrollBy(double x, double y);
152     virtual void scrollTo(const ScrollToOptions&, ScrollClamping = ScrollClamping::Clamped);
153     void scrollTo(double x, double y);
154
155     WEBCORE_EXPORT void scrollByLines(int lines);
156     WEBCORE_EXPORT void scrollByPages(int pages);
157
158     WEBCORE_EXPORT double offsetLeftForBindings();
159     WEBCORE_EXPORT double offsetLeft();
160     WEBCORE_EXPORT double offsetTopForBindings();
161     WEBCORE_EXPORT double offsetTop();
162     WEBCORE_EXPORT double offsetWidth();
163     WEBCORE_EXPORT double offsetHeight();
164
165     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
166
167     // FIXME: Replace uses of offsetParent in the platform with calls
168     // to the render layer and merge bindingsOffsetParent and offsetParent.
169     WEBCORE_EXPORT Element* offsetParentForBindings();
170
171     const Element* rootElement() const;
172
173     Element* offsetParent();
174     WEBCORE_EXPORT double clientLeft();
175     WEBCORE_EXPORT double clientTop();
176     WEBCORE_EXPORT double clientWidth();
177     WEBCORE_EXPORT double clientHeight();
178
179     virtual int scrollLeft();
180     virtual int scrollTop();
181     virtual void setScrollLeft(int);
182     virtual void setScrollTop(int);
183     virtual int scrollWidth();
184     virtual int scrollHeight();
185
186     WEBCORE_EXPORT IntRect boundsInRootViewSpace();
187
188     WEBCORE_EXPORT FloatRect boundingClientRect();
189
190     WEBCORE_EXPORT Ref<DOMRectList> getClientRects();
191     Ref<DOMRect> getBoundingClientRect();
192
193     // Returns the absolute bounding box translated into client coordinates.
194     WEBCORE_EXPORT IntRect clientRect() const;
195     // Returns the absolute bounding box translated into screen coordinates.
196     WEBCORE_EXPORT IntRect screenRect() const;
197
198     WEBCORE_EXPORT bool removeAttribute(const AtomicString& qualifiedName);
199     WEBCORE_EXPORT bool removeAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName);
200
201     Ref<Attr> detachAttribute(unsigned index);
202
203     WEBCORE_EXPORT RefPtr<Attr> getAttributeNode(const AtomicString& qualifiedName);
204     WEBCORE_EXPORT RefPtr<Attr> getAttributeNodeNS(const AtomicString& namespaceURI, const AtomicString& localName);
205     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNode(Attr&);
206     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNodeNS(Attr&);
207     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> removeAttributeNode(Attr&);
208
209     RefPtr<Attr> attrIfExists(const QualifiedName&);
210     RefPtr<Attr> attrIfExists(const AtomicString& localName, bool shouldIgnoreAttributeCase);
211     Ref<Attr> ensureAttr(const QualifiedName&);
212
213     const Vector<RefPtr<Attr>>& attrNodeList();
214
215     const QualifiedName& tagQName() const { return m_tagName; }
216 #if ENABLE(JIT)
217     static ptrdiff_t tagQNameMemoryOffset() { return OBJECT_OFFSETOF(Element, m_tagName); }
218 #endif // ENABLE(JIT)
219     String tagName() const { return nodeName(); }
220     bool hasTagName(const QualifiedName& tagName) const { return m_tagName.matches(tagName); }
221     bool hasTagName(const HTMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
222     bool hasTagName(const MathMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
223     bool hasTagName(const SVGQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
224
225     // A fast function for checking the local name against another atomic string.
226     bool hasLocalName(const AtomicString& other) const { return m_tagName.localName() == other; }
227
228     const AtomicString& localName() const final { return m_tagName.localName(); }
229     const AtomicString& prefix() const final { return m_tagName.prefix(); }
230     const AtomicString& namespaceURI() const final { return m_tagName.namespaceURI(); }
231
232     ExceptionOr<void> setPrefix(const AtomicString&) final;
233
234     String nodeName() const override;
235
236     Ref<Element> cloneElementWithChildren(Document&);
237     Ref<Element> cloneElementWithoutChildren(Document&);
238
239     void normalizeAttributes();
240     String nodeNamePreservingCase() const;
241
242     WEBCORE_EXPORT void setBooleanAttribute(const QualifiedName& name, bool);
243
244     // For exposing to DOM only.
245     WEBCORE_EXPORT NamedNodeMap& attributes() const;
246
247     enum AttributeModificationReason {
248         ModifiedDirectly,
249         ModifiedByCloning
250     };
251
252     // This method is called whenever an attribute is added, changed or removed.
253     virtual void attributeChanged(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason = ModifiedDirectly);
254     virtual void parseAttribute(const QualifiedName&, const AtomicString&) { }
255
256     // Only called by the parser immediately after element construction.
257     void parserSetAttributes(const Vector<Attribute>&);
258
259     bool isEventHandlerAttribute(const Attribute&) const;
260     bool isJavaScriptURLAttribute(const Attribute&) const;
261
262     // Remove attributes that might introduce scripting from the vector leaving the element unchanged.
263     void stripScriptingAttributes(Vector<Attribute>&) const;
264
265     const ElementData* elementData() const { return m_elementData.get(); }
266     static ptrdiff_t elementDataMemoryOffset() { return OBJECT_OFFSETOF(Element, m_elementData); }
267     UniqueElementData& ensureUniqueElementData();
268
269     void synchronizeAllAttributes() const;
270
271     // Clones attributes only.
272     void cloneAttributesFromElement(const Element&);
273
274     // Clones all attribute-derived data, including subclass specifics (through copyNonAttributeProperties.)
275     void cloneDataFromElement(const Element&);
276
277     virtual void didMoveToNewDocument(Document& oldDocument, Document& newDocument);
278
279     bool hasEquivalentAttributes(const Element& other) const;
280
281     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
282
283     virtual RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&);
284     virtual bool rendererIsNeeded(const RenderStyle&);
285
286     WEBCORE_EXPORT ShadowRoot* shadowRoot() const;
287     ShadowRoot* shadowRootForBindings(JSC::ExecState&) const;
288
289     struct ShadowRootInit {
290         ShadowRootMode mode;
291     };
292     ExceptionOr<ShadowRoot&> attachShadow(const ShadowRootInit&);
293
294     RefPtr<ShadowRoot> userAgentShadowRoot() const;
295     WEBCORE_EXPORT ShadowRoot& ensureUserAgentShadowRoot();
296
297     void setIsDefinedCustomElement(JSCustomElementInterface&);
298     void setIsFailedCustomElement(JSCustomElementInterface&);
299     void setIsCustomElementUpgradeCandidate();
300     void enqueueToUpgrade(JSCustomElementInterface&);
301     CustomElementReactionQueue* reactionQueue() const;
302
303     // FIXME: this should not be virtual, do not override this.
304     virtual const AtomicString& shadowPseudoId() const;
305
306     bool isInActiveChain() const { return isUserActionElement() && isUserActionElementInActiveChain(); }
307     bool active() const { return isUserActionElement() && isUserActionElementActive(); }
308     bool hovered() const { return isUserActionElement() && isUserActionElementHovered(); }
309     bool focused() const { return isUserActionElement() && isUserActionElementFocused(); }
310     bool hasFocusWithin() const { return getFlag(HasFocusWithin); };
311
312     virtual void setActive(bool flag = true, bool pause = false);
313     virtual void setHovered(bool flag = true);
314     virtual void setFocus(bool flag);
315     void setHasFocusWithin(bool flag);
316
317     bool tabIndexSetExplicitly() const;
318     virtual bool supportsFocus() const;
319     virtual bool isFocusable() const;
320     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
321     virtual bool isMouseFocusable() const;
322
323     virtual bool shouldUseInputMethod();
324
325     virtual int tabIndex() const;
326     WEBCORE_EXPORT void setTabIndex(int);
327     virtual RefPtr<Element> focusDelegate();
328
329     ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html, NodeVector* addedNodes);
330
331     WEBCORE_EXPORT ExceptionOr<Element*> insertAdjacentElement(const String& where, Element& newChild);
332     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html);
333     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentText(const String& where, const String& text);
334
335     const RenderStyle* computedStyle(PseudoId = PseudoId::None) override;
336
337     bool needsStyleInvalidation() const;
338
339     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
340     bool styleAffectedByActive() const { return hasRareData() && rareDataStyleAffectedByActive(); }
341     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
342     bool styleAffectedByFocusWithin() const { return hasRareData() && rareDataStyleAffectedByFocusWithin(); }
343     bool descendantsAffectedByPreviousSibling() const { return getFlag(DescendantsAffectedByPreviousSiblingFlag); }
344     bool childrenAffectedByHover() const { return getFlag(ChildrenAffectedByHoverRulesFlag); }
345     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
346     bool childrenAffectedByFirstChildRules() const { return getFlag(ChildrenAffectedByFirstChildRulesFlag); }
347     bool childrenAffectedByLastChildRules() const { return getFlag(ChildrenAffectedByLastChildRulesFlag); }
348     bool childrenAffectedByForwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByForwardPositionalRules(); }
349     bool descendantsAffectedByForwardPositionalRules() const { return hasRareData() && rareDataDescendantsAffectedByForwardPositionalRules(); }
350     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
351     bool descendantsAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataDescendantsAffectedByBackwardPositionalRules(); }
352     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules(); }
353     bool affectsNextSiblingElementStyle() const { return getFlag(AffectsNextSiblingElementStyle); }
354     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
355
356     bool hasFlagsSetDuringStylingOfChildren() const;
357
358     void setStyleAffectedByEmpty();
359     void setStyleAffectedByFocusWithin();
360     void setDescendantsAffectedByPreviousSibling() const { return setFlag(DescendantsAffectedByPreviousSiblingFlag); }
361     void setChildrenAffectedByHover() { setFlag(ChildrenAffectedByHoverRulesFlag); }
362     void setStyleAffectedByActive();
363     void setChildrenAffectedByDrag();
364     void setChildrenAffectedByFirstChildRules() { setFlag(ChildrenAffectedByFirstChildRulesFlag); }
365     void setChildrenAffectedByLastChildRules() { setFlag(ChildrenAffectedByLastChildRulesFlag); }
366     void setChildrenAffectedByForwardPositionalRules();
367     void setDescendantsAffectedByForwardPositionalRules();
368     void setChildrenAffectedByBackwardPositionalRules();
369     void setDescendantsAffectedByBackwardPositionalRules();
370     void setChildrenAffectedByPropertyBasedBackwardPositionalRules();
371     void setAffectsNextSiblingElementStyle() { setFlag(AffectsNextSiblingElementStyle); }
372     void setStyleIsAffectedByPreviousSibling() { setFlag(StyleIsAffectedByPreviousSibling); }
373     void setChildIndex(unsigned);
374
375     WEBCORE_EXPORT AtomicString computeInheritedLanguage() const;
376     Locale& locale() const;
377
378     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
379
380     virtual bool isURLAttribute(const Attribute&) const { return false; }
381     virtual bool attributeContainsURL(const Attribute& attribute) const { return isURLAttribute(attribute); }
382     virtual String completeURLsInAttributeValue(const URL& base, const Attribute&) const;
383     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
384
385     WEBCORE_EXPORT URL getURLAttribute(const QualifiedName&) const;
386     URL getNonEmptyURLAttribute(const QualifiedName&) const;
387
388     virtual const AtomicString& imageSourceURL() const;
389     virtual String target() const { return String(); }
390
391     static AXTextStateChangeIntent defaultFocusTextStateChangeIntent() { return AXTextStateChangeIntent(AXTextStateChangeTypeSelectionMove, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, true }); }
392     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
393     virtual RefPtr<Element> focusAppearanceUpdateTarget();
394     virtual void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode = SelectionRevealMode::Reveal);
395     virtual void blur();
396
397     WEBCORE_EXPORT String innerHTML() const;
398     WEBCORE_EXPORT String outerHTML() const;
399     WEBCORE_EXPORT ExceptionOr<void> setInnerHTML(const String&);
400     WEBCORE_EXPORT ExceptionOr<void> setOuterHTML(const String&);
401     WEBCORE_EXPORT String innerText();
402     WEBCORE_EXPORT String outerText();
403  
404     virtual String title() const;
405
406     const AtomicString& pseudo() const;
407     WEBCORE_EXPORT void setPseudo(const AtomicString&);
408
409     LayoutSize minimumSizeForResizing() const;
410     void setMinimumSizeForResizing(const LayoutSize&);
411
412     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
413     virtual void prepareForDocumentSuspension() { }
414     virtual void resumeFromDocumentSuspension() { }
415
416     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
417     virtual void mediaVolumeDidChange() { }
418
419     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
420     virtual void privateBrowsingStateDidChange() { }
421
422     virtual void willBecomeFullscreenElement();
423     virtual void ancestorWillEnterFullscreen() { }
424     virtual void didBecomeFullscreenElement() { }
425     virtual void willStopBeingFullscreenElement() { }
426
427 #if ENABLE(VIDEO_TRACK)
428     virtual void captionPreferencesChanged() { }
429 #endif
430
431     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
432     void finishParsingChildren() override;
433     void beginParsingChildren() final;
434
435     WEBCORE_EXPORT PseudoElement* beforePseudoElement() const;
436     WEBCORE_EXPORT PseudoElement* afterPseudoElement() const;
437     bool childNeedsShadowWalker() const;
438     void didShadowTreeAwareChildrenChange();
439
440     virtual bool matchesValidPseudoClass() const;
441     virtual bool matchesInvalidPseudoClass() const;
442     virtual bool matchesReadWritePseudoClass() const;
443     virtual bool matchesIndeterminatePseudoClass() const;
444     virtual bool matchesDefaultPseudoClass() const;
445     WEBCORE_EXPORT ExceptionOr<bool> matches(const String& selectors);
446     WEBCORE_EXPORT ExceptionOr<Element*> closest(const String& selectors);
447     virtual bool shouldAppearIndeterminate() const;
448
449     WEBCORE_EXPORT DOMTokenList& classList();
450
451     DatasetDOMStringMap& dataset();
452
453 #if ENABLE(VIDEO)
454     virtual bool isMediaElement() const { return false; }
455 #endif
456
457     virtual bool isFormControlElement() const { return false; }
458     virtual bool isSpinButtonElement() const { return false; }
459     virtual bool isTextFormControlElement() const { return false; }
460     virtual bool isTextField() const { return false; }
461     virtual bool isOptionalFormControl() const { return false; }
462     virtual bool isRequiredFormControl() const { return false; }
463     virtual bool isInRange() const { return false; }
464     virtual bool isOutOfRange() const { return false; }
465     virtual bool isFrameElementBase() const { return false; }
466     virtual bool isUploadButton() const { return false; }
467     virtual bool isSliderContainerElement() const { return false; }
468
469     bool canContainRangeEndPoint() const override;
470
471     // Used for disabled form elements; if true, prevents mouse events from being dispatched
472     // to event listeners, and prevents DOMActivate events from being sent at all.
473     virtual bool isDisabledFormControl() const { return false; }
474
475     virtual bool childShouldCreateRenderer(const Node&) const;
476
477     bool hasPendingResources() const;
478     void setHasPendingResources();
479     void clearHasPendingResources();
480     virtual void buildPendingResource() { };
481
482     bool hasCSSAnimation() const;
483     void setHasCSSAnimation();
484     void clearHasCSSAnimation();
485
486 #if ENABLE(FULLSCREEN_API)
487     WEBCORE_EXPORT bool containsFullScreenElement() const;
488     void setContainsFullScreenElement(bool);
489     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
490     WEBCORE_EXPORT virtual void webkitRequestFullscreen();
491 #endif
492
493 #if ENABLE(POINTER_EVENTS)
494     ExceptionOr<void> setPointerCapture(int32_t);
495     ExceptionOr<void> releasePointerCapture(int32_t);
496     bool hasPointerCapture(int32_t);
497 #endif
498
499 #if ENABLE(POINTER_LOCK)
500     WEBCORE_EXPORT void requestPointerLock();
501 #endif
502
503     bool isSpellCheckingEnabled() const;
504
505     bool hasID() const;
506     bool hasClass() const;
507     bool hasName() const;
508     const SpaceSplitString& classNames() const;
509
510     IntPoint savedLayerScrollPosition() const;
511     void setSavedLayerScrollPosition(const IntPoint&);
512
513     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
514     bool dispatchWheelEvent(const PlatformWheelEvent&);
515     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
516     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
517     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
518     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
519     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
520     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
521     void dispatchWebKitImageReadyEventForTesting();
522
523     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
524
525     virtual void willRecalcStyle(Style::Change);
526     virtual void didRecalcStyle(Style::Change);
527     virtual void willResetComputedStyle();
528     virtual void willAttachRenderers();
529     virtual void didAttachRenderers();
530     virtual void willDetachRenderers();
531     virtual void didDetachRenderers();
532     virtual Optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
533
534     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
535
536     const RenderStyle* existingComputedStyle() const;
537     const RenderStyle* renderOrDisplayContentsStyle() const;
538
539     void setBeforePseudoElement(Ref<PseudoElement>&&);
540     void setAfterPseudoElement(Ref<PseudoElement>&&);
541     void clearBeforePseudoElement();
542     void clearAfterPseudoElement();
543     void resetComputedStyle();
544     void resetStyleRelations();
545     void clearHoverAndActiveStatusBeforeDetachingRenderer();
546
547     WEBCORE_EXPORT URL absoluteLinkURL() const;
548
549 #if ENABLE(TOUCH_EVENTS)
550     bool allowsDoubleTapGesture() const override;
551 #endif
552
553     StyleResolver& styleResolver();
554     ElementStyle resolveStyle(const RenderStyle* parentStyle);
555
556     // Invalidates the style of a single element. Style is resolved lazily.
557     // Descendant elements are resolved as needed, for example if an inherited property changes.
558     // This should be called whenever an element changes in a manner that can affect its style.
559     void invalidateStyle();
560
561     // As above but also call RenderElement::setStyle with StyleDifference::RecompositeLayer flag for
562     // the element even when the style doesn't change. This is mostly needed by the animation code.
563     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
564
565     // Invalidate the element and all its descendants. This is used when there is some sort of change
566     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
567     // the case to limit the scope. This is expensive and should be avoided.
568     void invalidateStyleForSubtree();
569
570     // Invalidates renderers for the element and all its descendants causing them to be torn down
571     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
572     // custom (not style based) renderers. This is expensive and should be avoided.
573     // Elements newly added to the tree are also in this state.
574     void invalidateStyleAndRenderersForSubtree();
575
576     void invalidateStyleInternal();
577     void invalidateStyleForSubtreeInternal();
578
579     bool hasDisplayContents() const;
580     void storeDisplayContentsStyle(std::unique_ptr<RenderStyle>);
581
582     using ContainerNode::setAttributeEventListener;
583     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
584
585 #if ENABLE(INTERSECTION_OBSERVER)
586     IntersectionObserverData& ensureIntersectionObserverData();
587     IntersectionObserverData* intersectionObserverData();
588 #endif
589
590     Element* findAnchorElementForLink(String& outAnchorName);
591
592     ExceptionOr<Ref<WebAnimation>> animate(JSC::ExecState&, JSC::Strong<JSC::JSObject>&&, Optional<Variant<double, KeyframeAnimationOptions>>&&);
593     Vector<RefPtr<WebAnimation>> getAnimations();
594
595     ElementIdentifier createElementIdentifier();
596
597 #if ENABLE(POINTER_EVENTS)
598     OptionSet<TouchAction> computedTouchActions() const;
599 #if ENABLE(ACCELERATED_OVERFLOW_SCROLLING)
600     ScrollingNodeID nearestScrollingNodeIDUsingTouchOverflowScrolling() const;
601 #endif
602 #endif
603
604 protected:
605     Element(const QualifiedName&, Document&, ConstructionType);
606
607     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
608     void removedFromAncestor(RemovalType, ContainerNode&) override;
609     void childrenChanged(const ChildChange&) override;
610     void removeAllEventListeners() final;
611     virtual void parserDidSetAttributes();
612
613     void clearTabIndexExplicitlyIfNeeded();
614     void setTabIndexExplicitly(int);
615
616     // classAttributeChanged() exists to share code between
617     // parseAttribute (called via setAttribute()) and
618     // svgAttributeChanged (called when element.className.baseValue is set)
619     void classAttributeChanged(const AtomicString& newClassString);
620
621     void addShadowRoot(Ref<ShadowRoot>&&);
622
623     static ExceptionOr<void> mergeWithNextTextNode(Text&);
624
625 #if ENABLE(CSS_TYPED_OM)
626     StylePropertyMap* attributeStyleMap();
627     void setAttributeStyleMap(Ref<StylePropertyMap>&&);
628 #endif
629
630 private:
631     Frame* documentFrameWithNonNullView() const;
632
633     bool isTextNode() const;
634
635     bool isUserActionElementInActiveChain() const;
636     bool isUserActionElementActive() const;
637     bool isUserActionElementFocused() const;
638     bool isUserActionElementHovered() const;
639
640     virtual void didAddUserAgentShadowRoot(ShadowRoot&) { }
641
642     void didAddAttribute(const QualifiedName&, const AtomicString&);
643     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
644     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
645     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
646
647     void synchronizeAttribute(const QualifiedName&) const;
648     void synchronizeAttribute(const AtomicString& localName) const;
649
650     void updateName(const AtomicString& oldName, const AtomicString& newName);
651     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
652     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
653
654     enum class NotifyObservers { No, Yes };
655     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
656     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
657
658     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
659     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
660     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
661
662     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
663
664     void scrollByUnits(int units, ScrollGranularity);
665
666     NodeType nodeType() const final;
667     bool childTypeAllowed(NodeType) const final;
668
669     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute, InSynchronizationOfLazyAttribute };
670     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
671     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
672     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
673
674     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
675     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
676     
677 #if ENABLE(TREE_DEBUGGING)
678     void formatForDebugger(char* buffer, unsigned length) const override;
679 #endif
680
681 #if ENABLE(INTERSECTION_OBSERVER)
682     void disconnectFromIntersectionObservers();
683 #endif
684
685     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
686     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
687     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
688
689     void removeShadowRoot();
690
691     const RenderStyle& resolveComputedStyle();
692     const RenderStyle& resolvePseudoElementStyle(PseudoId);
693
694     bool rareDataStyleAffectedByEmpty() const;
695     bool rareDataStyleAffectedByFocusWithin() const;
696     bool rareDataChildrenAffectedByHover() const;
697     bool rareDataStyleAffectedByActive() const;
698     bool rareDataChildrenAffectedByDrag() const;
699     bool rareDataChildrenAffectedByLastChildRules() const;
700     bool rareDataChildrenAffectedByForwardPositionalRules() const;
701     bool rareDataDescendantsAffectedByForwardPositionalRules() const;
702     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
703     bool rareDataDescendantsAffectedByBackwardPositionalRules() const;
704     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
705     unsigned rareDataChildIndex() const;
706
707     SpellcheckAttributeState spellcheckAttributeState() const;
708
709     void createUniqueElementData();
710
711     ElementRareData* elementRareData() const;
712     ElementRareData& ensureElementRareData();
713
714     void detachAllAttrNodesFromElement();
715     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
716
717     // Anyone thinking of using this should call document instead of ownerDocument.
718     void ownerDocument() const = delete;
719     
720     void attachAttributeNodeIfNeeded(Attr&);
721
722     QualifiedName m_tagName;
723     RefPtr<ElementData> m_elementData;
724 };
725
726 inline bool Node::hasAttributes() const
727 {
728     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
729 }
730
731 inline NamedNodeMap* Node::attributes() const
732 {
733     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
734 }
735
736 inline Element* Node::parentElement() const
737 {
738     ContainerNode* parent = parentNode();
739     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
740 }
741
742 inline const Element* Element::rootElement() const
743 {
744     if (isConnected())
745         return document().documentElement();
746
747     const Element* highest = this;
748     while (highest->parentElement())
749         highest = highest->parentElement();
750     return highest;
751 }
752
753 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
754 {
755     ASSERT(fastAttributeLookupAllowed(name));
756     return elementData() && findAttributeByName(name);
757 }
758
759 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
760 {
761     if (elementData()) {
762         if (const Attribute* attribute = findAttributeByName(name))
763             return attribute->value();
764     }
765     return nullAtom();
766 }
767
768 inline bool Element::hasAttributesWithoutUpdate() const
769 {
770     return elementData() && !elementData()->isEmpty();
771 }
772
773 inline const AtomicString& Element::idForStyleResolution() const
774 {
775     return hasID() ? elementData()->idForStyleResolution() : nullAtom();
776 }
777
778 inline const AtomicString& Element::getIdAttribute() const
779 {
780     if (hasID())
781         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
782     return nullAtom();
783 }
784
785 inline const AtomicString& Element::getNameAttribute() const
786 {
787     if (hasName())
788         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
789     return nullAtom();
790 }
791
792 inline void Element::setIdAttribute(const AtomicString& value)
793 {
794     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
795 }
796
797 inline const SpaceSplitString& Element::classNames() const
798 {
799     ASSERT(hasClass());
800     ASSERT(elementData());
801     return elementData()->classNames();
802 }
803
804 inline unsigned Element::attributeCount() const
805 {
806     ASSERT(elementData());
807     return elementData()->length();
808 }
809
810 inline const Attribute& Element::attributeAt(unsigned index) const
811 {
812     ASSERT(elementData());
813     return elementData()->attributeAt(index);
814 }
815
816 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
817 {
818     ASSERT(elementData());
819     return elementData()->findAttributeByName(name);
820 }
821
822 inline bool Element::hasID() const
823 {
824     return elementData() && elementData()->hasID();
825 }
826
827 inline bool Element::hasClass() const
828 {
829     return elementData() && elementData()->hasClass();
830 }
831
832 inline bool Element::hasName() const
833 {
834     return elementData() && elementData()->hasName();
835 }
836
837 inline UniqueElementData& Element::ensureUniqueElementData()
838 {
839     if (!elementData() || !elementData()->isUnique())
840         createUniqueElementData();
841     return static_cast<UniqueElementData&>(*m_elementData);
842 }
843
844 inline bool shouldIgnoreAttributeCase(const Element& element)
845 {
846     return element.isHTMLElement() && element.document().isHTMLDocument();
847 }
848
849 inline void Element::setHasFocusWithin(bool flag)
850 {
851     if (hasFocusWithin() == flag)
852         return;
853     setFlag(flag, HasFocusWithin);
854     if (styleAffectedByFocusWithin())
855         invalidateStyleForSubtree();
856 }
857
858 template<typename... QualifiedNames>
859 inline const AtomicString& Element::getAttribute(const QualifiedName& name, const QualifiedNames&... names) const
860 {
861     const AtomicString& value = getAttribute(name);
862     if (!value.isNull())
863         return value;
864     return getAttribute(names...);
865 }
866
867 } // namespace WebCore
868
869 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
870     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
871     static bool isType(const WebCore::EventTarget& target) { return is<WebCore::Node>(target) && isType(downcast<WebCore::Node>(target)); }
872 SPECIALIZE_TYPE_TRAITS_END()