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