a16c200824e29d5d9d048299194469b39952de03
[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-2016 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 "RegionOversetState.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 ClientRect;
41 class ClientRectList;
42 class CustomElementReactionQueue;
43 class DatasetDOMStringMap;
44 class DOMTokenList;
45 class ElementRareData;
46 class HTMLDocument;
47 class IntSize;
48 class JSCustomElementInterface;
49 class KeyboardEvent;
50 class Locale;
51 class PlatformKeyboardEvent;
52 class PlatformMouseEvent;
53 class PlatformWheelEvent;
54 class PseudoElement;
55 class RenderNamedFlowFragment;
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&);
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     Ref<ClientRectList> getClientRects();
177     Ref<ClientRect> getBoundingClientRect();
178
179     // Returns the absolute bounding box translated into client coordinates.
180     WEBCORE_EXPORT IntRect clientRect() const;
181     // Returns the absolute bounding box translated into screen coordinates.
182     WEBCORE_EXPORT IntRect screenRect() const;
183
184     WEBCORE_EXPORT bool removeAttribute(const AtomicString& name);
185     WEBCORE_EXPORT bool removeAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName);
186
187     Ref<Attr> detachAttribute(unsigned index);
188
189     WEBCORE_EXPORT RefPtr<Attr> getAttributeNode(const AtomicString& name);
190     WEBCORE_EXPORT RefPtr<Attr> getAttributeNodeNS(const AtomicString& namespaceURI, const AtomicString& localName);
191     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNode(Attr&);
192     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNodeNS(Attr&);
193     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> removeAttributeNode(Attr&);
194
195     RefPtr<Attr> attrIfExists(const QualifiedName&);
196     RefPtr<Attr> attrIfExists(const AtomicString& localName, bool shouldIgnoreAttributeCase);
197     Ref<Attr> ensureAttr(const QualifiedName&);
198
199     const Vector<RefPtr<Attr>>& attrNodeList();
200
201     virtual CSSStyleDeclaration* cssomStyle();
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     // Remove attributes that might introduce scripting from the vector leaving the element unchanged.
248     void stripScriptingAttributes(Vector<Attribute>&) const;
249
250     const ElementData* elementData() const { return m_elementData.get(); }
251     static ptrdiff_t elementDataMemoryOffset() { return OBJECT_OFFSETOF(Element, m_elementData); }
252     UniqueElementData& ensureUniqueElementData();
253
254     void synchronizeAllAttributes() const;
255
256     // Clones attributes only.
257     void cloneAttributesFromElement(const Element&);
258
259     // Clones all attribute-derived data, including subclass specifics (through copyNonAttributeProperties.)
260     void cloneDataFromElement(const Element&);
261
262     bool hasEquivalentAttributes(const Element* other) const;
263
264     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
265
266     virtual RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&);
267     virtual bool rendererIsNeeded(const RenderStyle&);
268
269     WEBCORE_EXPORT ShadowRoot* shadowRoot() const;
270     ShadowRoot* shadowRootForBindings(JSC::ExecState&) const;
271
272     struct ShadowRootInit {
273         ShadowRootMode mode;
274     };
275     ExceptionOr<ShadowRoot&> attachShadow(const ShadowRootInit&);
276
277     ShadowRoot* userAgentShadowRoot() const;
278     WEBCORE_EXPORT ShadowRoot& ensureUserAgentShadowRoot();
279
280     void setIsDefinedCustomElement(JSCustomElementInterface&);
281     void setIsFailedCustomElement(JSCustomElementInterface&);
282     void setIsCustomElementUpgradeCandidate();
283     void enqueueToUpgrade(JSCustomElementInterface&);
284     CustomElementReactionQueue* reactionQueue() const;
285
286     // FIXME: this should not be virtual, do not override this.
287     virtual const AtomicString& shadowPseudoId() const;
288
289     bool inActiveChain() const { return isUserActionElement() && isUserActionElementInActiveChain(); }
290     bool active() const { return isUserActionElement() && isUserActionElementActive(); }
291     bool hovered() const { return isUserActionElement() && isUserActionElementHovered(); }
292     bool focused() const { return isUserActionElement() && isUserActionElementFocused(); }
293     bool hasFocusWithin() const { return getFlag(HasFocusWithin); };
294
295     virtual void setActive(bool flag = true, bool pause = false);
296     virtual void setHovered(bool flag = true);
297     virtual void setFocus(bool flag);
298     void setHasFocusWithin(bool flag);
299
300     bool tabIndexSetExplicitly() const;
301     virtual bool supportsFocus() const;
302     virtual bool isFocusable() const;
303     virtual bool isKeyboardFocusable(KeyboardEvent&) const;
304     virtual bool isMouseFocusable() const;
305
306     virtual bool shouldUseInputMethod();
307
308     virtual int tabIndex() const;
309     WEBCORE_EXPORT void setTabIndex(int);
310     virtual Element* focusDelegate();
311
312     WEBCORE_EXPORT ExceptionOr<Element*> insertAdjacentElement(const String& where, Element& newChild);
313     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html);
314     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentText(const String& where, const String& text);
315
316     bool ieForbidsInsertHTML() const;
317
318     const RenderStyle* computedStyle(PseudoId = NOPSEUDO) override;
319
320     bool needsStyleInvalidation() const;
321
322     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
323     bool styleAffectedByActive() const { return hasRareData() && rareDataStyleAffectedByActive(); }
324     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
325     bool styleAffectedByFocusWithin() const { return hasRareData() && rareDataStyleAffectedByFocusWithin(); }
326     bool childrenAffectedByHover() const { return getFlag(ChildrenAffectedByHoverRulesFlag); }
327     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
328     bool childrenAffectedByFirstChildRules() const { return getFlag(ChildrenAffectedByFirstChildRulesFlag); }
329     bool childrenAffectedByLastChildRules() const { return getFlag(ChildrenAffectedByLastChildRulesFlag); }
330     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
331     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules(); }
332     bool affectsNextSiblingElementStyle() const { return getFlag(AffectsNextSiblingElementStyle); }
333     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
334
335     bool hasFlagsSetDuringStylingOfChildren() const;
336
337     void setStyleAffectedByEmpty();
338     void setStyleAffectedByFocusWithin();
339     void setChildrenAffectedByHover() { setFlag(ChildrenAffectedByHoverRulesFlag); }
340     void setStyleAffectedByActive();
341     void setChildrenAffectedByDrag();
342     void setChildrenAffectedByFirstChildRules() { setFlag(ChildrenAffectedByFirstChildRulesFlag); }
343     void setChildrenAffectedByLastChildRules() { setFlag(ChildrenAffectedByLastChildRulesFlag); }
344     void setChildrenAffectedByBackwardPositionalRules();
345     void setChildrenAffectedByPropertyBasedBackwardPositionalRules();
346     void setAffectsNextSiblingElementStyle() { setFlag(AffectsNextSiblingElementStyle); }
347     void setStyleIsAffectedByPreviousSibling() { setFlag(StyleIsAffectedByPreviousSibling); }
348     void setChildIndex(unsigned);
349
350     void setRegionOversetState(RegionOversetState);
351     RegionOversetState regionOversetState() const;
352
353     AtomicString computeInheritedLanguage() const;
354     Locale& locale() const;
355
356     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
357
358     virtual bool isURLAttribute(const Attribute&) const { return false; }
359     virtual bool attributeContainsURL(const Attribute& attribute) const { return isURLAttribute(attribute); }
360     virtual String completeURLsInAttributeValue(const URL& base, const Attribute&) const;
361     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
362
363     WEBCORE_EXPORT URL getURLAttribute(const QualifiedName&) const;
364     URL getNonEmptyURLAttribute(const QualifiedName&) const;
365
366     virtual const AtomicString& imageSourceURL() const;
367     virtual String target() const { return String(); }
368
369     static AXTextStateChangeIntent defaultFocusTextStateChangeIntent() { return AXTextStateChangeIntent(AXTextStateChangeTypeSelectionMove, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, true }); }
370     void updateFocusAppearanceAfterAttachIfNeeded();
371     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
372     virtual void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode = SelectionRevealMode::Reveal);
373     virtual void blur();
374
375     WEBCORE_EXPORT String innerHTML() const;
376     WEBCORE_EXPORT String outerHTML() const;
377     WEBCORE_EXPORT ExceptionOr<void> setInnerHTML(const String&);
378     WEBCORE_EXPORT ExceptionOr<void> setOuterHTML(const String&);
379     WEBCORE_EXPORT String innerText();
380     WEBCORE_EXPORT String outerText();
381  
382     virtual String title() const;
383
384     const AtomicString& pseudo() const;
385     WEBCORE_EXPORT void setPseudo(const AtomicString&);
386
387     LayoutSize minimumSizeForResizing() const;
388     void setMinimumSizeForResizing(const LayoutSize&);
389
390     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
391     virtual void prepareForDocumentSuspension() { }
392     virtual void resumeFromDocumentSuspension() { }
393
394     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
395     virtual void mediaVolumeDidChange() { }
396
397     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
398     virtual void privateBrowsingStateDidChange() { }
399
400     virtual void willBecomeFullscreenElement();
401     virtual void ancestorWillEnterFullscreen() { }
402     virtual void didBecomeFullscreenElement() { }
403     virtual void willStopBeingFullscreenElement() { }
404
405     // Use Document::registerForVisibilityStateChangedCallbacks() to subscribe to this.
406     virtual void visibilityStateChanged() { }
407
408 #if ENABLE(VIDEO_TRACK)
409     virtual void captionPreferencesChanged() { }
410 #endif
411
412     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
413     void finishParsingChildren() override;
414     void beginParsingChildren() final;
415
416     WEBCORE_EXPORT PseudoElement* beforePseudoElement() const;
417     WEBCORE_EXPORT PseudoElement* afterPseudoElement() const;
418     bool childNeedsShadowWalker() const;
419     void didShadowTreeAwareChildrenChange();
420
421     virtual bool matchesValidPseudoClass() const;
422     virtual bool matchesInvalidPseudoClass() const;
423     virtual bool matchesReadWritePseudoClass() const;
424     virtual bool matchesIndeterminatePseudoClass() const;
425     virtual bool matchesDefaultPseudoClass() const;
426     WEBCORE_EXPORT ExceptionOr<bool> matches(const String& selectors);
427     WEBCORE_EXPORT ExceptionOr<Element*> closest(const String& selectors);
428     virtual bool shouldAppearIndeterminate() const;
429
430     WEBCORE_EXPORT DOMTokenList& classList();
431
432     DatasetDOMStringMap& dataset();
433
434 #if ENABLE(VIDEO)
435     virtual bool isMediaElement() const { return false; }
436 #endif
437
438     virtual bool isFormControlElement() const { return false; }
439     virtual bool isSpinButtonElement() const { return false; }
440     virtual bool isTextFormControl() 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 #if ENABLE(FULLSCREEN_API)
463     WEBCORE_EXPORT bool containsFullScreenElement() const;
464     void setContainsFullScreenElement(bool);
465     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
466     WEBCORE_EXPORT void webkitRequestFullscreen();
467 #endif
468
469 #if ENABLE(POINTER_LOCK)
470     WEBCORE_EXPORT void requestPointerLock();
471 #endif
472
473     bool isSpellCheckingEnabled() const;
474
475     RenderNamedFlowFragment* renderNamedFlowFragment() const;
476
477 #if ENABLE(CSS_REGIONS)
478     virtual bool shouldMoveToFlowThread(const RenderStyle&) const;
479     
480     WEBCORE_EXPORT const AtomicString& webkitRegionOverset() const;
481     Vector<RefPtr<Range>> webkitGetRegionFlowRanges() const;
482 #endif
483
484     bool hasID() const;
485     bool hasClass() const;
486     bool hasName() const;
487     const SpaceSplitString& classNames() const;
488
489     IntPoint savedLayerScrollPosition() const;
490     void setSavedLayerScrollPosition(const IntPoint&);
491
492     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
493     bool dispatchWheelEvent(const PlatformWheelEvent&);
494     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
495     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
496     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
497     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
498     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
499     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
500
501     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
502
503     virtual void willRecalcStyle(Style::Change);
504     virtual void didRecalcStyle(Style::Change);
505     virtual void willResetComputedStyle();
506     virtual void willAttachRenderers();
507     virtual void didAttachRenderers();
508     virtual void willDetachRenderers();
509     virtual void didDetachRenderers();
510     virtual std::optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
511
512     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
513
514     void setBeforePseudoElement(Ref<PseudoElement>&&);
515     void setAfterPseudoElement(Ref<PseudoElement>&&);
516     void clearBeforePseudoElement();
517     void clearAfterPseudoElement();
518     void resetComputedStyle();
519     void clearStyleDerivedDataBeforeDetachingRenderer();
520     void clearHoverAndActiveStatusBeforeDetachingRenderer();
521
522     WEBCORE_EXPORT URL absoluteLinkURL() const;
523
524 #if ENABLE(TOUCH_EVENTS)
525     bool allowsDoubleTapGesture() const override;
526 #endif
527
528     StyleResolver& styleResolver();
529     ElementStyle resolveStyle(const RenderStyle* parentStyle);
530
531     // Invalidates the style of a single element. Style is resolved lazily.
532     // Descendant elements are resolved as needed, for example if an inherited property changes.
533     // This should be called whenever an element changes in a manner that can affect its style.
534     void invalidateStyle();
535
536     // As above but also call RenderElement::setStyle with StyleDifferenceRecompositeLayer flag for
537     // the element even when the style doesn't change. This is mostly needed by the animation code.
538     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
539
540     // Invalidate the element and all its descendants. This is used when there is some sort of change
541     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
542     // the case to limit the scope. This is expensive and should be avoided.
543     void invalidateStyleForSubtree();
544
545     // Invalidates renderers for the element and all its descendants causing them to be torn down
546     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
547     // custom (not style based) renderers. This is expensive and should be avoided.
548     // Elements newly added to the tree are also in this state.
549     void invalidateStyleAndRenderersForSubtree();
550
551     bool hasDisplayContents() const;
552     void setHasDisplayContents(bool);
553
554     virtual void isVisibleInViewportChanged() { }
555
556     using ContainerNode::setAttributeEventListener;
557     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
558
559     bool isNamedFlowContentElement() const { return hasRareData() && rareDataIsNamedFlowContentElement(); }
560     void setIsNamedFlowContentElement();
561     void clearIsNamedFlowContentElement();
562
563 #if ENABLE(WEB_ANIMATIONS)
564     Vector<WebAnimation*> getAnimations();
565 #endif
566
567     Element* findAnchorElementForLink(String& outAnchorName);
568
569 protected:
570     Element(const QualifiedName&, Document&, ConstructionType);
571
572     InsertionNotificationRequest insertedInto(ContainerNode&) override;
573     void removedFrom(ContainerNode&) override;
574     void childrenChanged(const ChildChange&) override;
575     void removeAllEventListeners() final;
576     virtual void parserDidSetAttributes();
577     void didMoveToNewDocument(Document&) override;
578
579     void clearTabIndexExplicitlyIfNeeded();
580     void setTabIndexExplicitly(int);
581
582     // classAttributeChanged() exists to share code between
583     // parseAttribute (called via setAttribute()) and
584     // svgAttributeChanged (called when element.className.baseValue is set)
585     void classAttributeChanged(const AtomicString& newClassString);
586
587     void addShadowRoot(Ref<ShadowRoot>&&);
588
589     static ExceptionOr<void> mergeWithNextTextNode(Text&);
590
591 private:
592     bool isTextNode() const;
593
594     bool isUserActionElementInActiveChain() const;
595     bool isUserActionElementActive() const;
596     bool isUserActionElementFocused() const;
597     bool isUserActionElementHovered() const;
598
599     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
600     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
601
602     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
603     friend class Attr;
604
605     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
606
607     void didAddAttribute(const QualifiedName&, const AtomicString&);
608     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
609     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
610     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
611
612     void synchronizeAttribute(const QualifiedName&) const;
613     void synchronizeAttribute(const AtomicString& localName) const;
614
615     void updateName(const AtomicString& oldName, const AtomicString& newName);
616     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
617     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
618
619     enum class NotifyObservers { No, Yes };
620     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
621     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
622
623     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
624     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
625     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
626
627     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
628
629     void scrollByUnits(int units, ScrollGranularity);
630
631     NodeType nodeType() const final;
632     bool childTypeAllowed(NodeType) const final;
633
634     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
635     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
636     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
637
638     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
639     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
640     
641 #if ENABLE(TREE_DEBUGGING)
642     void formatForDebugger(char* buffer, unsigned length) const override;
643 #endif
644
645     void cancelFocusAppearanceUpdate();
646
647     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
648     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
649     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
650
651     void removeShadowRoot();
652
653     const RenderStyle* existingComputedStyle();
654     const RenderStyle& resolveComputedStyle();
655
656     bool rareDataStyleAffectedByEmpty() const;
657     bool rareDataStyleAffectedByFocusWithin() const;
658     bool rareDataIsNamedFlowContentElement() const;
659     bool rareDataChildrenAffectedByHover() const;
660     bool rareDataStyleAffectedByActive() const;
661     bool rareDataChildrenAffectedByDrag() const;
662     bool rareDataChildrenAffectedByLastChildRules() const;
663     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
664     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
665     unsigned rareDataChildIndex() const;
666
667     SpellcheckAttributeState spellcheckAttributeState() const;
668
669     void unregisterNamedFlowContentElement();
670
671     void createUniqueElementData();
672
673     ElementRareData* elementRareData() const;
674     ElementRareData& ensureElementRareData();
675
676     void detachAllAttrNodesFromElement();
677     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
678
679     bool isJavaScriptURLAttribute(const Attribute&) const;
680
681     // Anyone thinking of using this should call document instead of ownerDocument.
682     void ownerDocument() const = delete;
683
684     QualifiedName m_tagName;
685     RefPtr<ElementData> m_elementData;
686 };
687
688 inline bool Node::hasAttributes() const
689 {
690     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
691 }
692
693 inline NamedNodeMap* Node::attributes() const
694 {
695     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
696 }
697
698 inline Element* Node::parentElement() const
699 {
700     ContainerNode* parent = parentNode();
701     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
702 }
703
704 inline const Element* Element::rootElement() const
705 {
706     if (inDocument())
707         return document().documentElement();
708
709     const Element* highest = this;
710     while (highest->parentElement())
711         highest = highest->parentElement();
712     return highest;
713 }
714
715 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
716 {
717     ASSERT(fastAttributeLookupAllowed(name));
718     return elementData() && findAttributeByName(name);
719 }
720
721 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
722 {
723     ASSERT(fastAttributeLookupAllowed(name));
724     if (elementData()) {
725         if (const Attribute* attribute = findAttributeByName(name))
726             return attribute->value();
727     }
728     return nullAtom;
729 }
730
731 inline bool Element::hasAttributesWithoutUpdate() const
732 {
733     return elementData() && !elementData()->isEmpty();
734 }
735
736 inline const AtomicString& Element::idForStyleResolution() const
737 {
738     return hasID() ? elementData()->idForStyleResolution() : nullAtom;
739 }
740
741 inline const AtomicString& Element::getIdAttribute() const
742 {
743     if (hasID())
744         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
745     return nullAtom;
746 }
747
748 inline const AtomicString& Element::getNameAttribute() const
749 {
750     if (hasName())
751         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
752     return nullAtom;
753 }
754
755 inline void Element::setIdAttribute(const AtomicString& value)
756 {
757     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
758 }
759
760 inline const SpaceSplitString& Element::classNames() const
761 {
762     ASSERT(hasClass());
763     ASSERT(elementData());
764     return elementData()->classNames();
765 }
766
767 inline unsigned Element::attributeCount() const
768 {
769     ASSERT(elementData());
770     return elementData()->length();
771 }
772
773 inline const Attribute& Element::attributeAt(unsigned index) const
774 {
775     ASSERT(elementData());
776     return elementData()->attributeAt(index);
777 }
778
779 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
780 {
781     ASSERT(elementData());
782     return elementData()->findAttributeByName(name);
783 }
784
785 inline bool Element::hasID() const
786 {
787     return elementData() && elementData()->hasID();
788 }
789
790 inline bool Element::hasClass() const
791 {
792     return elementData() && elementData()->hasClass();
793 }
794
795 inline bool Element::hasName() const
796 {
797     return elementData() && elementData()->hasName();
798 }
799
800 inline UniqueElementData& Element::ensureUniqueElementData()
801 {
802     if (!elementData() || !elementData()->isUnique())
803         createUniqueElementData();
804     return static_cast<UniqueElementData&>(*m_elementData);
805 }
806
807 inline bool shouldIgnoreAttributeCase(const Element& element)
808 {
809     return element.isHTMLElement() && element.document().isHTMLDocument();
810 }
811
812 inline void Element::setHasFocusWithin(bool flag)
813 {
814     if (hasFocusWithin() == flag)
815         return;
816     setFlag(flag, HasFocusWithin);
817     if (styleAffectedByFocusWithin())
818         invalidateStyleForSubtree();
819 }
820
821 } // namespace WebCore
822
823 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
824     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
825 SPECIALIZE_TYPE_TRAITS_END()