Element focus appearance update should be either immediate or a post-layout task
[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 "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 CustomElementReactionQueue;
41 class DatasetDOMStringMap;
42 class DOMRect;
43 class DOMRectList;
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     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     // 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     const RenderStyle* computedStyle(PseudoId = NOPSEUDO) override;
317
318     bool needsStyleInvalidation() const;
319
320     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
321     bool styleAffectedByActive() const { return hasRareData() && rareDataStyleAffectedByActive(); }
322     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
323     bool styleAffectedByFocusWithin() const { return hasRareData() && rareDataStyleAffectedByFocusWithin(); }
324     bool childrenAffectedByHover() const { return getFlag(ChildrenAffectedByHoverRulesFlag); }
325     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
326     bool childrenAffectedByFirstChildRules() const { return getFlag(ChildrenAffectedByFirstChildRulesFlag); }
327     bool childrenAffectedByLastChildRules() const { return getFlag(ChildrenAffectedByLastChildRulesFlag); }
328     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
329     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules(); }
330     bool affectsNextSiblingElementStyle() const { return getFlag(AffectsNextSiblingElementStyle); }
331     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
332
333     bool hasFlagsSetDuringStylingOfChildren() const;
334
335     void setStyleAffectedByEmpty();
336     void setStyleAffectedByFocusWithin();
337     void setChildrenAffectedByHover() { setFlag(ChildrenAffectedByHoverRulesFlag); }
338     void setStyleAffectedByActive();
339     void setChildrenAffectedByDrag();
340     void setChildrenAffectedByFirstChildRules() { setFlag(ChildrenAffectedByFirstChildRulesFlag); }
341     void setChildrenAffectedByLastChildRules() { setFlag(ChildrenAffectedByLastChildRulesFlag); }
342     void setChildrenAffectedByBackwardPositionalRules();
343     void setChildrenAffectedByPropertyBasedBackwardPositionalRules();
344     void setAffectsNextSiblingElementStyle() { setFlag(AffectsNextSiblingElementStyle); }
345     void setStyleIsAffectedByPreviousSibling() { setFlag(StyleIsAffectedByPreviousSibling); }
346     void setChildIndex(unsigned);
347
348     void setRegionOversetState(RegionOversetState);
349     RegionOversetState regionOversetState() const;
350
351     AtomicString computeInheritedLanguage() const;
352     Locale& locale() const;
353
354     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
355
356     virtual bool isURLAttribute(const Attribute&) const { return false; }
357     virtual bool attributeContainsURL(const Attribute& attribute) const { return isURLAttribute(attribute); }
358     virtual String completeURLsInAttributeValue(const URL& base, const Attribute&) const;
359     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
360
361     WEBCORE_EXPORT URL getURLAttribute(const QualifiedName&) const;
362     URL getNonEmptyURLAttribute(const QualifiedName&) const;
363
364     virtual const AtomicString& imageSourceURL() const;
365     virtual String target() const { return String(); }
366
367     static AXTextStateChangeIntent defaultFocusTextStateChangeIntent() { return AXTextStateChangeIntent(AXTextStateChangeTypeSelectionMove, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, true }); }
368     void updateFocusAppearanceAfterAttachIfNeeded();
369     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
370     virtual void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode = SelectionRevealMode::Reveal);
371     virtual void blur();
372
373     WEBCORE_EXPORT String innerHTML() const;
374     WEBCORE_EXPORT String outerHTML() const;
375     WEBCORE_EXPORT ExceptionOr<void> setInnerHTML(const String&);
376     WEBCORE_EXPORT ExceptionOr<void> setOuterHTML(const String&);
377     WEBCORE_EXPORT String innerText();
378     WEBCORE_EXPORT String outerText();
379  
380     virtual String title() const;
381
382     const AtomicString& pseudo() const;
383     WEBCORE_EXPORT void setPseudo(const AtomicString&);
384
385     LayoutSize minimumSizeForResizing() const;
386     void setMinimumSizeForResizing(const LayoutSize&);
387
388     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
389     virtual void prepareForDocumentSuspension() { }
390     virtual void resumeFromDocumentSuspension() { }
391
392     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
393     virtual void mediaVolumeDidChange() { }
394
395     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
396     virtual void privateBrowsingStateDidChange() { }
397
398     virtual void willBecomeFullscreenElement();
399     virtual void ancestorWillEnterFullscreen() { }
400     virtual void didBecomeFullscreenElement() { }
401     virtual void willStopBeingFullscreenElement() { }
402
403 #if ENABLE(VIDEO_TRACK)
404     virtual void captionPreferencesChanged() { }
405 #endif
406
407     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
408     void finishParsingChildren() override;
409     void beginParsingChildren() final;
410
411     WEBCORE_EXPORT PseudoElement* beforePseudoElement() const;
412     WEBCORE_EXPORT PseudoElement* afterPseudoElement() const;
413     bool childNeedsShadowWalker() const;
414     void didShadowTreeAwareChildrenChange();
415
416     virtual bool matchesValidPseudoClass() const;
417     virtual bool matchesInvalidPseudoClass() const;
418     virtual bool matchesReadWritePseudoClass() const;
419     virtual bool matchesIndeterminatePseudoClass() const;
420     virtual bool matchesDefaultPseudoClass() const;
421     WEBCORE_EXPORT ExceptionOr<bool> matches(const String& selectors);
422     WEBCORE_EXPORT ExceptionOr<Element*> closest(const String& selectors);
423     virtual bool shouldAppearIndeterminate() const;
424
425     WEBCORE_EXPORT DOMTokenList& classList();
426
427     DatasetDOMStringMap& dataset();
428
429 #if ENABLE(VIDEO)
430     virtual bool isMediaElement() const { return false; }
431 #endif
432
433     virtual bool isFormControlElement() const { return false; }
434     virtual bool isSpinButtonElement() const { return false; }
435     virtual bool isTextFormControl() const { return false; }
436     virtual bool isOptionalFormControl() const { return false; }
437     virtual bool isRequiredFormControl() const { return false; }
438     virtual bool isInRange() const { return false; }
439     virtual bool isOutOfRange() const { return false; }
440     virtual bool isFrameElementBase() const { return false; }
441     virtual bool isUploadButton() const { return false; }
442     virtual bool isSliderContainerElement() const { return false; }
443
444     bool canContainRangeEndPoint() const override;
445
446     // Used for disabled form elements; if true, prevents mouse events from being dispatched
447     // to event listeners, and prevents DOMActivate events from being sent at all.
448     virtual bool isDisabledFormControl() const { return false; }
449
450     virtual bool childShouldCreateRenderer(const Node&) const;
451
452     bool hasPendingResources() const;
453     void setHasPendingResources();
454     void clearHasPendingResources();
455     virtual void buildPendingResource() { };
456
457 #if ENABLE(FULLSCREEN_API)
458     WEBCORE_EXPORT bool containsFullScreenElement() const;
459     void setContainsFullScreenElement(bool);
460     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
461     WEBCORE_EXPORT void webkitRequestFullscreen();
462 #endif
463
464 #if ENABLE(POINTER_LOCK)
465     WEBCORE_EXPORT void requestPointerLock();
466 #endif
467
468     bool isSpellCheckingEnabled() const;
469
470     RenderNamedFlowFragment* renderNamedFlowFragment() const;
471
472 #if ENABLE(CSS_REGIONS)
473     virtual bool shouldMoveToFlowThread(const RenderStyle&) const;
474     
475     WEBCORE_EXPORT const AtomicString& webkitRegionOverset() const;
476     Vector<RefPtr<Range>> webkitGetRegionFlowRanges() const;
477 #endif
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 clearStyleDerivedDataBeforeDetachingRenderer();
519     void clearHoverAndActiveStatusBeforeDetachingRenderer();
520
521     WEBCORE_EXPORT URL absoluteLinkURL() const;
522
523 #if ENABLE(TOUCH_EVENTS)
524     bool allowsDoubleTapGesture() const override;
525 #endif
526
527     StyleResolver& styleResolver();
528     ElementStyle resolveStyle(const RenderStyle* parentStyle);
529
530     // Invalidates the style of a single element. Style is resolved lazily.
531     // Descendant elements are resolved as needed, for example if an inherited property changes.
532     // This should be called whenever an element changes in a manner that can affect its style.
533     void invalidateStyle();
534
535     // As above but also call RenderElement::setStyle with StyleDifferenceRecompositeLayer flag for
536     // the element even when the style doesn't change. This is mostly needed by the animation code.
537     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
538
539     // Invalidate the element and all its descendants. This is used when there is some sort of change
540     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
541     // the case to limit the scope. This is expensive and should be avoided.
542     void invalidateStyleForSubtree();
543
544     // Invalidates renderers for the element and all its descendants causing them to be torn down
545     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
546     // custom (not style based) renderers. This is expensive and should be avoided.
547     // Elements newly added to the tree are also in this state.
548     void invalidateStyleAndRenderersForSubtree();
549
550     bool hasDisplayContents() const;
551     void storeDisplayContentsStyle(std::unique_ptr<RenderStyle>);
552
553     using ContainerNode::setAttributeEventListener;
554     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
555
556     bool isNamedFlowContentElement() const { return hasRareData() && rareDataIsNamedFlowContentElement(); }
557     void setIsNamedFlowContentElement();
558     void clearIsNamedFlowContentElement();
559
560 #if ENABLE(WEB_ANIMATIONS)
561     Vector<WebAnimation*> getAnimations();
562 #endif
563
564     Element* findAnchorElementForLink(String& outAnchorName);
565
566 protected:
567     Element(const QualifiedName&, Document&, ConstructionType);
568
569     InsertionNotificationRequest insertedInto(ContainerNode&) override;
570     void removedFrom(ContainerNode&) override;
571     void childrenChanged(const ChildChange&) override;
572     void removeAllEventListeners() final;
573     virtual void parserDidSetAttributes();
574     void didMoveToNewDocument(Document& oldDocument, Document& newDocument) override;
575
576     void clearTabIndexExplicitlyIfNeeded();
577     void setTabIndexExplicitly(int);
578
579     // classAttributeChanged() exists to share code between
580     // parseAttribute (called via setAttribute()) and
581     // svgAttributeChanged (called when element.className.baseValue is set)
582     void classAttributeChanged(const AtomicString& newClassString);
583
584     void addShadowRoot(Ref<ShadowRoot>&&);
585
586     static ExceptionOr<void> mergeWithNextTextNode(Text&);
587
588 private:
589     bool isTextNode() const;
590
591     bool isUserActionElementInActiveChain() const;
592     bool isUserActionElementActive() const;
593     bool isUserActionElementFocused() const;
594     bool isUserActionElementHovered() const;
595
596     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
597     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
598
599     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
600     friend class Attr;
601
602     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
603
604     void didAddAttribute(const QualifiedName&, const AtomicString&);
605     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
606     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
607     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
608
609     void synchronizeAttribute(const QualifiedName&) const;
610     void synchronizeAttribute(const AtomicString& localName) const;
611
612     void updateName(const AtomicString& oldName, const AtomicString& newName);
613     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
614     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
615
616     enum class NotifyObservers { No, Yes };
617     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
618     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
619
620     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
621     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
622     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
623
624     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
625
626     void scrollByUnits(int units, ScrollGranularity);
627
628     NodeType nodeType() const final;
629     bool childTypeAllowed(NodeType) const final;
630
631     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
632     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
633     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
634
635     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
636     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
637     
638 #if ENABLE(TREE_DEBUGGING)
639     void formatForDebugger(char* buffer, unsigned length) const override;
640 #endif
641
642     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
643     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
644     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
645
646     void removeShadowRoot();
647
648     const RenderStyle& resolveComputedStyle();
649
650     bool rareDataStyleAffectedByEmpty() const;
651     bool rareDataStyleAffectedByFocusWithin() const;
652     bool rareDataIsNamedFlowContentElement() const;
653     bool rareDataChildrenAffectedByHover() const;
654     bool rareDataStyleAffectedByActive() const;
655     bool rareDataChildrenAffectedByDrag() const;
656     bool rareDataChildrenAffectedByLastChildRules() const;
657     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
658     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
659     unsigned rareDataChildIndex() const;
660
661     SpellcheckAttributeState spellcheckAttributeState() const;
662
663     void unregisterNamedFlowContentElement();
664
665     void createUniqueElementData();
666
667     ElementRareData* elementRareData() const;
668     ElementRareData& ensureElementRareData();
669
670     void detachAllAttrNodesFromElement();
671     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
672
673     bool isJavaScriptURLAttribute(const Attribute&) const;
674
675     // Anyone thinking of using this should call document instead of ownerDocument.
676     void ownerDocument() const = delete;
677     
678     void attachAttributeNodeIfNeeded(Attr&);
679
680     QualifiedName m_tagName;
681     RefPtr<ElementData> m_elementData;
682 };
683
684 inline bool Node::hasAttributes() const
685 {
686     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
687 }
688
689 inline NamedNodeMap* Node::attributes() const
690 {
691     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
692 }
693
694 inline Element* Node::parentElement() const
695 {
696     ContainerNode* parent = parentNode();
697     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
698 }
699
700 inline const Element* Element::rootElement() const
701 {
702     if (isConnected())
703         return document().documentElement();
704
705     const Element* highest = this;
706     while (highest->parentElement())
707         highest = highest->parentElement();
708     return highest;
709 }
710
711 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
712 {
713     ASSERT(fastAttributeLookupAllowed(name));
714     return elementData() && findAttributeByName(name);
715 }
716
717 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
718 {
719     ASSERT(fastAttributeLookupAllowed(name));
720     if (elementData()) {
721         if (const Attribute* attribute = findAttributeByName(name))
722             return attribute->value();
723     }
724     return nullAtom();
725 }
726
727 inline bool Element::hasAttributesWithoutUpdate() const
728 {
729     return elementData() && !elementData()->isEmpty();
730 }
731
732 inline const AtomicString& Element::idForStyleResolution() const
733 {
734     return hasID() ? elementData()->idForStyleResolution() : nullAtom();
735 }
736
737 inline const AtomicString& Element::getIdAttribute() const
738 {
739     if (hasID())
740         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
741     return nullAtom();
742 }
743
744 inline const AtomicString& Element::getNameAttribute() const
745 {
746     if (hasName())
747         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
748     return nullAtom();
749 }
750
751 inline void Element::setIdAttribute(const AtomicString& value)
752 {
753     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
754 }
755
756 inline const SpaceSplitString& Element::classNames() const
757 {
758     ASSERT(hasClass());
759     ASSERT(elementData());
760     return elementData()->classNames();
761 }
762
763 inline unsigned Element::attributeCount() const
764 {
765     ASSERT(elementData());
766     return elementData()->length();
767 }
768
769 inline const Attribute& Element::attributeAt(unsigned index) const
770 {
771     ASSERT(elementData());
772     return elementData()->attributeAt(index);
773 }
774
775 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
776 {
777     ASSERT(elementData());
778     return elementData()->findAttributeByName(name);
779 }
780
781 inline bool Element::hasID() const
782 {
783     return elementData() && elementData()->hasID();
784 }
785
786 inline bool Element::hasClass() const
787 {
788     return elementData() && elementData()->hasClass();
789 }
790
791 inline bool Element::hasName() const
792 {
793     return elementData() && elementData()->hasName();
794 }
795
796 inline UniqueElementData& Element::ensureUniqueElementData()
797 {
798     if (!elementData() || !elementData()->isUnique())
799         createUniqueElementData();
800     return static_cast<UniqueElementData&>(*m_elementData);
801 }
802
803 inline bool shouldIgnoreAttributeCase(const Element& element)
804 {
805     return element.isHTMLElement() && element.document().isHTMLDocument();
806 }
807
808 inline void Element::setHasFocusWithin(bool flag)
809 {
810     if (hasFocusWithin() == flag)
811         return;
812     setFlag(flag, HasFocusWithin);
813     if (styleAffectedByFocusWithin())
814         invalidateStyleForSubtree();
815 }
816
817 } // namespace WebCore
818
819 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
820     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
821 SPECIALIZE_TYPE_TRAITS_END()