91750cf31f39d804172bc5e1a266a63d85fe4ed8
[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 "ScrollToOptions.h"
32 #include "ScrollTypes.h"
33 #include "ShadowRootMode.h"
34 #include "SimulatedClickOptions.h"
35 #include "StyleChange.h"
36
37 namespace WebCore {
38
39 class CustomElementReactionQueue;
40 class DatasetDOMStringMap;
41 class DOMRect;
42 class DOMRectList;
43 class DOMTokenList;
44 class ElementRareData;
45 class HTMLDocument;
46 class IntSize;
47 class JSCustomElementInterface;
48 class KeyboardEvent;
49 class Locale;
50 class PlatformKeyboardEvent;
51 class PlatformMouseEvent;
52 class PlatformWheelEvent;
53 class PseudoElement;
54 class RenderTreePosition;
55 class WebAnimation;
56 struct ElementStyle;
57
58 enum SpellcheckAttributeState {
59     SpellcheckAttributeTrue,
60     SpellcheckAttributeFalse,
61     SpellcheckAttributeDefault
62 };
63
64 enum class SelectionRevealMode {
65     Reveal,
66     RevealUpToMainFrame, // Scroll overflow and iframes, but not the main frame.
67     DoNotReveal
68 };
69
70 class Element : public ContainerNode {
71 public:
72     static Ref<Element> create(const QualifiedName&, Document&);
73     virtual ~Element();
74
75     WEBCORE_EXPORT bool hasAttribute(const QualifiedName&) const;
76     WEBCORE_EXPORT const AtomicString& getAttribute(const QualifiedName&) const;
77     WEBCORE_EXPORT void setAttribute(const QualifiedName&, const AtomicString& value);
78     WEBCORE_EXPORT void setAttributeWithoutSynchronization(const QualifiedName&, const AtomicString& value);
79     void setSynchronizedLazyAttribute(const QualifiedName&, const AtomicString& value);
80     bool removeAttribute(const QualifiedName&);
81     Vector<String> getAttributeNames() const;
82
83     // Typed getters and setters for language bindings.
84     WEBCORE_EXPORT int getIntegralAttribute(const QualifiedName& attributeName) const;
85     WEBCORE_EXPORT void setIntegralAttribute(const QualifiedName& attributeName, int value);
86     WEBCORE_EXPORT unsigned getUnsignedIntegralAttribute(const QualifiedName& attributeName) const;
87     WEBCORE_EXPORT void setUnsignedIntegralAttribute(const QualifiedName& attributeName, unsigned value);
88
89     // Call this to get the value of an attribute that is known not to be the style
90     // attribute or one of the SVG animatable attributes.
91     bool hasAttributeWithoutSynchronization(const QualifiedName&) const;
92     const AtomicString& attributeWithoutSynchronization(const QualifiedName&) const;
93 #ifndef NDEBUG
94     WEBCORE_EXPORT bool fastAttributeLookupAllowed(const QualifiedName&) const;
95 #endif
96
97 #ifdef DUMP_NODE_STATISTICS
98     bool hasNamedNodeMap() const;
99 #endif
100     WEBCORE_EXPORT bool hasAttributes() const;
101     // This variant will not update the potentially invalid attributes. To be used when not interested
102     // in style attribute or one of the SVG animation attributes.
103     bool hasAttributesWithoutUpdate() const;
104
105     WEBCORE_EXPORT bool hasAttribute(const AtomicString& name) const;
106     WEBCORE_EXPORT bool hasAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
107
108     WEBCORE_EXPORT const AtomicString& getAttribute(const AtomicString& name) const;
109     WEBCORE_EXPORT const AtomicString& getAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
110
111     WEBCORE_EXPORT ExceptionOr<void> setAttribute(const AtomicString& name, const AtomicString& value);
112     static ExceptionOr<QualifiedName> parseAttributeName(const AtomicString& namespaceURI, const AtomicString& qualifiedName);
113     WEBCORE_EXPORT ExceptionOr<void> setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value);
114
115     const AtomicString& getIdAttribute() const;
116     void setIdAttribute(const AtomicString&);
117
118     const AtomicString& getNameAttribute() const;
119
120     // Call this to get the value of the id attribute for style resolution purposes.
121     // The value will already be lowercased if the document is in compatibility mode,
122     // so this function is not suitable for non-style uses.
123     const AtomicString& idForStyleResolution() const;
124
125     // Internal methods that assume the existence of attribute storage, one should use hasAttributes()
126     // before calling them.
127     AttributeIteratorAccessor attributesIterator() const { return elementData()->attributesIterator(); }
128     unsigned attributeCount() const;
129     const Attribute& attributeAt(unsigned index) const;
130     const Attribute* findAttributeByName(const QualifiedName&) const;
131     unsigned findAttributeIndexByName(const QualifiedName& name) const { return elementData()->findAttributeIndexByName(name); }
132     unsigned findAttributeIndexByName(const AtomicString& name, bool shouldIgnoreAttributeCase) const { return elementData()->findAttributeIndexByName(name, shouldIgnoreAttributeCase); }
133
134     WEBCORE_EXPORT void scrollIntoView(bool alignToTop = true);
135     WEBCORE_EXPORT void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
136     WEBCORE_EXPORT void scrollIntoViewIfNotVisible(bool centerIfNotVisible = true);
137
138     void scrollBy(const ScrollToOptions&);
139     void scrollBy(double x, double y);
140     virtual void scrollTo(const ScrollToOptions&);
141     void scrollTo(double x, double y);
142
143     WEBCORE_EXPORT void scrollByLines(int lines);
144     WEBCORE_EXPORT void scrollByPages(int pages);
145
146     WEBCORE_EXPORT double offsetLeft();
147     WEBCORE_EXPORT double offsetTop();
148     WEBCORE_EXPORT double offsetWidth();
149     WEBCORE_EXPORT double offsetHeight();
150
151     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
152
153     // FIXME: Replace uses of offsetParent in the platform with calls
154     // to the render layer and merge bindingsOffsetParent and offsetParent.
155     WEBCORE_EXPORT Element* bindingsOffsetParent();
156
157     const Element* rootElement() const;
158
159     Element* offsetParent();
160     WEBCORE_EXPORT double clientLeft();
161     WEBCORE_EXPORT double clientTop();
162     WEBCORE_EXPORT double clientWidth();
163     WEBCORE_EXPORT double clientHeight();
164
165     virtual int scrollLeft();
166     virtual int scrollTop();
167     virtual void setScrollLeft(int);
168     virtual void setScrollTop(int);
169     virtual int scrollWidth();
170     virtual int scrollHeight();
171
172     WEBCORE_EXPORT IntRect boundsInRootViewSpace();
173
174     FloatRect boundingClientRect();
175
176     WEBCORE_EXPORT 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     bool isEventHandlerAttribute(const Attribute&) const;
246     bool isJavaScriptURLAttribute(const Attribute&) const;
247
248     // Remove attributes that might introduce scripting from the vector leaving the element unchanged.
249     void stripScriptingAttributes(Vector<Attribute>&) const;
250
251     const ElementData* elementData() const { return m_elementData.get(); }
252     static ptrdiff_t elementDataMemoryOffset() { return OBJECT_OFFSETOF(Element, m_elementData); }
253     UniqueElementData& ensureUniqueElementData();
254
255     void synchronizeAllAttributes() const;
256
257     // Clones attributes only.
258     void cloneAttributesFromElement(const Element&);
259
260     // Clones all attribute-derived data, including subclass specifics (through copyNonAttributeProperties.)
261     void cloneDataFromElement(const Element&);
262
263     virtual void didMoveToNewDocument(Document& oldDocument, Document& newDocument);
264
265     bool hasEquivalentAttributes(const Element* other) const;
266
267     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
268
269     virtual RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&);
270     virtual bool rendererIsNeeded(const RenderStyle&);
271
272     WEBCORE_EXPORT ShadowRoot* shadowRoot() const;
273     ShadowRoot* shadowRootForBindings(JSC::ExecState&) const;
274
275     struct ShadowRootInit {
276         ShadowRootMode mode;
277     };
278     ExceptionOr<ShadowRoot&> attachShadow(const ShadowRootInit&);
279
280     RefPtr<ShadowRoot> userAgentShadowRoot() const;
281     WEBCORE_EXPORT ShadowRoot& ensureUserAgentShadowRoot();
282
283     void setIsDefinedCustomElement(JSCustomElementInterface&);
284     void setIsFailedCustomElement(JSCustomElementInterface&);
285     void setIsCustomElementUpgradeCandidate();
286     void enqueueToUpgrade(JSCustomElementInterface&);
287     CustomElementReactionQueue* reactionQueue() const;
288
289     // FIXME: this should not be virtual, do not override this.
290     virtual const AtomicString& shadowPseudoId() const;
291
292     bool inActiveChain() const { return isUserActionElement() && isUserActionElementInActiveChain(); }
293     bool active() const { return isUserActionElement() && isUserActionElementActive(); }
294     bool hovered() const { return isUserActionElement() && isUserActionElementHovered(); }
295     bool focused() const { return isUserActionElement() && isUserActionElementFocused(); }
296     bool hasFocusWithin() const { return getFlag(HasFocusWithin); };
297
298     virtual void setActive(bool flag = true, bool pause = false);
299     virtual void setHovered(bool flag = true);
300     virtual void setFocus(bool flag);
301     void setHasFocusWithin(bool flag);
302
303     bool tabIndexSetExplicitly() const;
304     virtual bool supportsFocus() const;
305     virtual bool isFocusable() const;
306     virtual bool isKeyboardFocusable(KeyboardEvent&) const;
307     virtual bool isMouseFocusable() const;
308
309     virtual bool shouldUseInputMethod();
310
311     virtual int tabIndex() const;
312     WEBCORE_EXPORT void setTabIndex(int);
313     virtual RefPtr<Element> focusDelegate();
314
315     WEBCORE_EXPORT ExceptionOr<Element*> insertAdjacentElement(const String& where, Element& newChild);
316     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html);
317     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentText(const String& where, const String& text);
318
319     const RenderStyle* computedStyle(PseudoId = NOPSEUDO) override;
320
321     bool needsStyleInvalidation() const;
322
323     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
324     bool styleAffectedByActive() const { return hasRareData() && rareDataStyleAffectedByActive(); }
325     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
326     bool styleAffectedByFocusWithin() const { return hasRareData() && rareDataStyleAffectedByFocusWithin(); }
327     bool childrenAffectedByHover() const { return getFlag(ChildrenAffectedByHoverRulesFlag); }
328     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
329     bool childrenAffectedByFirstChildRules() const { return getFlag(ChildrenAffectedByFirstChildRulesFlag); }
330     bool childrenAffectedByLastChildRules() const { return getFlag(ChildrenAffectedByLastChildRulesFlag); }
331     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
332     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules(); }
333     bool affectsNextSiblingElementStyle() const { return getFlag(AffectsNextSiblingElementStyle); }
334     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
335
336     bool hasFlagsSetDuringStylingOfChildren() const;
337
338     void setStyleAffectedByEmpty();
339     void setStyleAffectedByFocusWithin();
340     void setChildrenAffectedByHover() { setFlag(ChildrenAffectedByHoverRulesFlag); }
341     void setStyleAffectedByActive();
342     void setChildrenAffectedByDrag();
343     void setChildrenAffectedByFirstChildRules() { setFlag(ChildrenAffectedByFirstChildRulesFlag); }
344     void setChildrenAffectedByLastChildRules() { setFlag(ChildrenAffectedByLastChildRulesFlag); }
345     void setChildrenAffectedByBackwardPositionalRules();
346     void setChildrenAffectedByPropertyBasedBackwardPositionalRules();
347     void setAffectsNextSiblingElementStyle() { setFlag(AffectsNextSiblingElementStyle); }
348     void setStyleIsAffectedByPreviousSibling() { setFlag(StyleIsAffectedByPreviousSibling); }
349     void setChildIndex(unsigned);
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     bool hasCSSAnimation() const;
458     void setHasCSSAnimation();
459     void clearHasCSSAnimation();
460
461 #if ENABLE(FULLSCREEN_API)
462     WEBCORE_EXPORT bool containsFullScreenElement() const;
463     void setContainsFullScreenElement(bool);
464     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
465     WEBCORE_EXPORT void webkitRequestFullscreen();
466 #endif
467
468 #if ENABLE(POINTER_LOCK)
469     WEBCORE_EXPORT void requestPointerLock();
470 #endif
471
472     bool isSpellCheckingEnabled() const;
473
474     bool hasID() const;
475     bool hasClass() const;
476     bool hasName() const;
477     const SpaceSplitString& classNames() const;
478
479     IntPoint savedLayerScrollPosition() const;
480     void setSavedLayerScrollPosition(const IntPoint&);
481
482     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
483     bool dispatchWheelEvent(const PlatformWheelEvent&);
484     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
485     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
486     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
487     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
488     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
489     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
490     void dispatchWebKitImageReadyEventForTesting();
491
492     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
493
494     virtual void willRecalcStyle(Style::Change);
495     virtual void didRecalcStyle(Style::Change);
496     virtual void willResetComputedStyle();
497     virtual void willAttachRenderers();
498     virtual void didAttachRenderers();
499     virtual void willDetachRenderers();
500     virtual void didDetachRenderers();
501     virtual std::optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
502
503     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
504
505     const RenderStyle* existingComputedStyle() const;
506
507     void setBeforePseudoElement(Ref<PseudoElement>&&);
508     void setAfterPseudoElement(Ref<PseudoElement>&&);
509     void clearBeforePseudoElement();
510     void clearAfterPseudoElement();
511     void resetComputedStyle();
512     void resetStyleRelations();
513     void clearStyleDerivedDataBeforeDetachingRenderer();
514     void clearHoverAndActiveStatusBeforeDetachingRenderer();
515
516     WEBCORE_EXPORT URL absoluteLinkURL() const;
517
518 #if ENABLE(TOUCH_EVENTS)
519     bool allowsDoubleTapGesture() const override;
520 #endif
521
522     StyleResolver& styleResolver();
523     ElementStyle resolveStyle(const RenderStyle* parentStyle);
524
525     // Invalidates the style of a single element. Style is resolved lazily.
526     // Descendant elements are resolved as needed, for example if an inherited property changes.
527     // This should be called whenever an element changes in a manner that can affect its style.
528     void invalidateStyle();
529
530     // As above but also call RenderElement::setStyle with StyleDifferenceRecompositeLayer flag for
531     // the element even when the style doesn't change. This is mostly needed by the animation code.
532     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
533
534     // Invalidate the element and all its descendants. This is used when there is some sort of change
535     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
536     // the case to limit the scope. This is expensive and should be avoided.
537     void invalidateStyleForSubtree();
538
539     // Invalidates renderers for the element and all its descendants causing them to be torn down
540     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
541     // custom (not style based) renderers. This is expensive and should be avoided.
542     // Elements newly added to the tree are also in this state.
543     void invalidateStyleAndRenderersForSubtree();
544
545     bool hasDisplayContents() const;
546     void storeDisplayContentsStyle(std::unique_ptr<RenderStyle>);
547
548     using ContainerNode::setAttributeEventListener;
549     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
550
551     Element* findAnchorElementForLink(String& outAnchorName);
552
553 protected:
554     Element(const QualifiedName&, Document&, ConstructionType);
555
556     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
557     void removedFromAncestor(RemovalType, ContainerNode&) override;
558     void childrenChanged(const ChildChange&) override;
559     void removeAllEventListeners() final;
560     virtual void parserDidSetAttributes();
561
562     void clearTabIndexExplicitlyIfNeeded();
563     void setTabIndexExplicitly(int);
564
565     // classAttributeChanged() exists to share code between
566     // parseAttribute (called via setAttribute()) and
567     // svgAttributeChanged (called when element.className.baseValue is set)
568     void classAttributeChanged(const AtomicString& newClassString);
569
570     void addShadowRoot(Ref<ShadowRoot>&&);
571
572     static ExceptionOr<void> mergeWithNextTextNode(Text&);
573
574 private:
575     bool isTextNode() const;
576
577     bool isUserActionElementInActiveChain() const;
578     bool isUserActionElementActive() const;
579     bool isUserActionElementFocused() const;
580     bool isUserActionElementHovered() const;
581
582     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
583     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
584
585     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
586     friend class Attr;
587
588     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
589
590     void didAddAttribute(const QualifiedName&, const AtomicString&);
591     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
592     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
593     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
594
595     void synchronizeAttribute(const QualifiedName&) const;
596     void synchronizeAttribute(const AtomicString& localName) const;
597
598     void updateName(const AtomicString& oldName, const AtomicString& newName);
599     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
600     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
601
602     enum class NotifyObservers { No, Yes };
603     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
604     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
605
606     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
607     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
608     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
609
610     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
611
612     void scrollByUnits(int units, ScrollGranularity);
613
614     NodeType nodeType() const final;
615     bool childTypeAllowed(NodeType) const final;
616
617     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
618     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
619     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
620
621     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
622     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
623     
624 #if ENABLE(TREE_DEBUGGING)
625     void formatForDebugger(char* buffer, unsigned length) const override;
626 #endif
627
628     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
629     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
630     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
631
632     void removeShadowRoot();
633
634     const RenderStyle& resolveComputedStyle();
635     const RenderStyle& resolvePseudoElementStyle(PseudoId);
636
637     bool rareDataStyleAffectedByEmpty() const;
638     bool rareDataStyleAffectedByFocusWithin() const;
639     bool rareDataChildrenAffectedByHover() const;
640     bool rareDataStyleAffectedByActive() const;
641     bool rareDataChildrenAffectedByDrag() const;
642     bool rareDataChildrenAffectedByLastChildRules() const;
643     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
644     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
645     unsigned rareDataChildIndex() const;
646
647     SpellcheckAttributeState spellcheckAttributeState() const;
648
649     void createUniqueElementData();
650
651     ElementRareData* elementRareData() const;
652     ElementRareData& ensureElementRareData();
653
654     void detachAllAttrNodesFromElement();
655     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
656
657     // Anyone thinking of using this should call document instead of ownerDocument.
658     void ownerDocument() const = delete;
659     
660     void attachAttributeNodeIfNeeded(Attr&);
661
662     QualifiedName m_tagName;
663     RefPtr<ElementData> m_elementData;
664 };
665
666 inline bool Node::hasAttributes() const
667 {
668     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
669 }
670
671 inline NamedNodeMap* Node::attributes() const
672 {
673     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
674 }
675
676 inline Element* Node::parentElement() const
677 {
678     ContainerNode* parent = parentNode();
679     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
680 }
681
682 inline const Element* Element::rootElement() const
683 {
684     if (isConnected())
685         return document().documentElement();
686
687     const Element* highest = this;
688     while (highest->parentElement())
689         highest = highest->parentElement();
690     return highest;
691 }
692
693 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
694 {
695     ASSERT(fastAttributeLookupAllowed(name));
696     return elementData() && findAttributeByName(name);
697 }
698
699 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
700 {
701     ASSERT(fastAttributeLookupAllowed(name));
702     if (elementData()) {
703         if (const Attribute* attribute = findAttributeByName(name))
704             return attribute->value();
705     }
706     return nullAtom();
707 }
708
709 inline bool Element::hasAttributesWithoutUpdate() const
710 {
711     return elementData() && !elementData()->isEmpty();
712 }
713
714 inline const AtomicString& Element::idForStyleResolution() const
715 {
716     return hasID() ? elementData()->idForStyleResolution() : nullAtom();
717 }
718
719 inline const AtomicString& Element::getIdAttribute() const
720 {
721     if (hasID())
722         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
723     return nullAtom();
724 }
725
726 inline const AtomicString& Element::getNameAttribute() const
727 {
728     if (hasName())
729         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
730     return nullAtom();
731 }
732
733 inline void Element::setIdAttribute(const AtomicString& value)
734 {
735     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
736 }
737
738 inline const SpaceSplitString& Element::classNames() const
739 {
740     ASSERT(hasClass());
741     ASSERT(elementData());
742     return elementData()->classNames();
743 }
744
745 inline unsigned Element::attributeCount() const
746 {
747     ASSERT(elementData());
748     return elementData()->length();
749 }
750
751 inline const Attribute& Element::attributeAt(unsigned index) const
752 {
753     ASSERT(elementData());
754     return elementData()->attributeAt(index);
755 }
756
757 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
758 {
759     ASSERT(elementData());
760     return elementData()->findAttributeByName(name);
761 }
762
763 inline bool Element::hasID() const
764 {
765     return elementData() && elementData()->hasID();
766 }
767
768 inline bool Element::hasClass() const
769 {
770     return elementData() && elementData()->hasClass();
771 }
772
773 inline bool Element::hasName() const
774 {
775     return elementData() && elementData()->hasName();
776 }
777
778 inline UniqueElementData& Element::ensureUniqueElementData()
779 {
780     if (!elementData() || !elementData()->isUnique())
781         createUniqueElementData();
782     return static_cast<UniqueElementData&>(*m_elementData);
783 }
784
785 inline bool shouldIgnoreAttributeCase(const Element& element)
786 {
787     return element.isHTMLElement() && element.document().isHTMLDocument();
788 }
789
790 inline void Element::setHasFocusWithin(bool flag)
791 {
792     if (hasFocusWithin() == flag)
793         return;
794     setFlag(flag, HasFocusWithin);
795     if (styleAffectedByFocusWithin())
796         invalidateStyleForSubtree();
797 }
798
799 } // namespace WebCore
800
801 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
802     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
803 SPECIALIZE_TYPE_TRAITS_END()