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