Use 'childOfType' template when retrieving Shadow DOM elements
[WebKit-https.git] / Source / WebCore / dom / Element.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Peter Kelly (pmk@post.com)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2003-2016 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "AXTextStateChangeIntent.h"
28 #include "Document.h"
29 #include "ElementData.h"
30 #include "HTMLNames.h"
31 #include "RegionOversetState.h"
32 #include "ScrollToOptions.h"
33 #include "ScrollTypes.h"
34 #include "ShadowRootMode.h"
35 #include "SimulatedClickOptions.h"
36 #include "StyleChange.h"
37
38 namespace WebCore {
39
40 class ClientRect;
41 class ClientRectList;
42 class CustomElementReactionQueue;
43 class DatasetDOMStringMap;
44 class Dictionary;
45 class DOMTokenList;
46 class ElementRareData;
47 class HTMLDocument;
48 class IntSize;
49 class JSCustomElementInterface;
50 class KeyboardEvent;
51 class Locale;
52 class PlatformKeyboardEvent;
53 class PlatformMouseEvent;
54 class PlatformWheelEvent;
55 class PseudoElement;
56 class RenderNamedFlowFragment;
57 class RenderTreePosition;
58 class WebAnimation;
59 struct ElementStyle;
60
61 enum SpellcheckAttributeState {
62     SpellcheckAttributeTrue,
63     SpellcheckAttributeFalse,
64     SpellcheckAttributeDefault
65 };
66
67 enum class SelectionRevealMode {
68     Reveal,
69     RevealUpToMainFrame, // Scroll overflow and iframes, but not the main frame.
70     DoNotReveal
71 };
72
73 class Element : public ContainerNode {
74 public:
75     static Ref<Element> create(const QualifiedName&, Document&);
76     virtual ~Element();
77
78     WEBCORE_EXPORT bool hasAttribute(const QualifiedName&) const;
79     WEBCORE_EXPORT const AtomicString& getAttribute(const QualifiedName&) const;
80     WEBCORE_EXPORT void setAttribute(const QualifiedName&, const AtomicString& value);
81     WEBCORE_EXPORT void setAttributeWithoutSynchronization(const QualifiedName&, const AtomicString& value);
82     void setSynchronizedLazyAttribute(const QualifiedName&, const AtomicString& value);
83     bool removeAttribute(const QualifiedName&);
84     Vector<String> getAttributeNames() const;
85
86     // Typed getters and setters for language bindings.
87     WEBCORE_EXPORT int getIntegralAttribute(const QualifiedName& attributeName) const;
88     WEBCORE_EXPORT void setIntegralAttribute(const QualifiedName& attributeName, int value);
89     WEBCORE_EXPORT unsigned getUnsignedIntegralAttribute(const QualifiedName& attributeName) const;
90     WEBCORE_EXPORT void setUnsignedIntegralAttribute(const QualifiedName& attributeName, unsigned value);
91
92     // Call this to get the value of an attribute that is known not to be the style
93     // attribute or one of the SVG animatable attributes.
94     bool hasAttributeWithoutSynchronization(const QualifiedName&) const;
95     const AtomicString& attributeWithoutSynchronization(const QualifiedName&) const;
96 #ifndef NDEBUG
97     WEBCORE_EXPORT bool fastAttributeLookupAllowed(const QualifiedName&) const;
98 #endif
99
100 #ifdef DUMP_NODE_STATISTICS
101     bool hasNamedNodeMap() const;
102 #endif
103     WEBCORE_EXPORT bool hasAttributes() const;
104     // This variant will not update the potentially invalid attributes. To be used when not interested
105     // in style attribute or one of the SVG animation attributes.
106     bool hasAttributesWithoutUpdate() const;
107
108     WEBCORE_EXPORT bool hasAttribute(const AtomicString& name) const;
109     WEBCORE_EXPORT bool hasAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
110
111     WEBCORE_EXPORT const AtomicString& getAttribute(const AtomicString& name) const;
112     WEBCORE_EXPORT const AtomicString& getAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
113
114     WEBCORE_EXPORT ExceptionOr<void> setAttribute(const AtomicString& name, const AtomicString& value);
115     static ExceptionOr<QualifiedName> parseAttributeName(const AtomicString& namespaceURI, const AtomicString& qualifiedName);
116     WEBCORE_EXPORT ExceptionOr<void> setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value);
117
118     const AtomicString& getIdAttribute() const;
119     void setIdAttribute(const AtomicString&);
120
121     const AtomicString& getNameAttribute() const;
122
123     // Call this to get the value of the id attribute for style resolution purposes.
124     // The value will already be lowercased if the document is in compatibility mode,
125     // so this function is not suitable for non-style uses.
126     const AtomicString& idForStyleResolution() const;
127
128     // Internal methods that assume the existence of attribute storage, one should use hasAttributes()
129     // before calling them.
130     AttributeIteratorAccessor attributesIterator() const { return elementData()->attributesIterator(); }
131     unsigned attributeCount() const;
132     const Attribute& attributeAt(unsigned index) const;
133     const Attribute* findAttributeByName(const QualifiedName&) const;
134     unsigned findAttributeIndexByName(const QualifiedName& name) const { return elementData()->findAttributeIndexByName(name); }
135     unsigned findAttributeIndexByName(const AtomicString& name, bool shouldIgnoreAttributeCase) const { return elementData()->findAttributeIndexByName(name, shouldIgnoreAttributeCase); }
136
137     WEBCORE_EXPORT void scrollIntoView(bool alignToTop = true);
138     WEBCORE_EXPORT void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
139     WEBCORE_EXPORT void scrollIntoViewIfNotVisible(bool centerIfNotVisible = true);
140
141     void scrollBy(const ScrollToOptions&);
142     void scrollBy(double x, double y);
143     virtual void scrollTo(const ScrollToOptions&);
144     void scrollTo(double x, double y);
145
146     WEBCORE_EXPORT void scrollByLines(int lines);
147     WEBCORE_EXPORT void scrollByPages(int pages);
148
149     WEBCORE_EXPORT double offsetLeft();
150     WEBCORE_EXPORT double offsetTop();
151     WEBCORE_EXPORT double offsetWidth();
152     WEBCORE_EXPORT double offsetHeight();
153
154     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
155
156     // FIXME: Replace uses of offsetParent in the platform with calls
157     // to the render layer and merge bindingsOffsetParent and offsetParent.
158     WEBCORE_EXPORT Element* bindingsOffsetParent();
159
160     const Element* rootElement() const;
161
162     Element* offsetParent();
163     WEBCORE_EXPORT double clientLeft();
164     WEBCORE_EXPORT double clientTop();
165     WEBCORE_EXPORT double clientWidth();
166     WEBCORE_EXPORT double clientHeight();
167
168     virtual int scrollLeft();
169     virtual int scrollTop();
170     virtual void setScrollLeft(int);
171     virtual void setScrollTop(int);
172     virtual int scrollWidth();
173     virtual int scrollHeight();
174
175     WEBCORE_EXPORT IntRect boundsInRootViewSpace();
176
177     Ref<ClientRectList> getClientRects();
178     Ref<ClientRect> getBoundingClientRect();
179
180     // Returns the absolute bounding box translated into client coordinates.
181     WEBCORE_EXPORT IntRect clientRect() const;
182     // Returns the absolute bounding box translated into screen coordinates.
183     WEBCORE_EXPORT IntRect screenRect() const;
184
185     WEBCORE_EXPORT bool removeAttribute(const AtomicString& name);
186     WEBCORE_EXPORT bool removeAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName);
187
188     Ref<Attr> detachAttribute(unsigned index);
189
190     WEBCORE_EXPORT RefPtr<Attr> getAttributeNode(const AtomicString& name);
191     WEBCORE_EXPORT RefPtr<Attr> getAttributeNodeNS(const AtomicString& namespaceURI, const AtomicString& localName);
192     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNode(Attr&);
193     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNodeNS(Attr&);
194     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> removeAttributeNode(Attr&);
195
196     RefPtr<Attr> attrIfExists(const QualifiedName&);
197     RefPtr<Attr> attrIfExists(const AtomicString& localName, bool shouldIgnoreAttributeCase);
198     Ref<Attr> ensureAttr(const QualifiedName&);
199
200     const Vector<RefPtr<Attr>>& attrNodeList();
201
202     virtual CSSStyleDeclaration* cssomStyle();
203
204     const QualifiedName& tagQName() const { return m_tagName; }
205 #if ENABLE(JIT)
206     static ptrdiff_t tagQNameMemoryOffset() { return OBJECT_OFFSETOF(Element, m_tagName); }
207 #endif // ENABLE(JIT)
208     String tagName() const { return nodeName(); }
209     bool hasTagName(const QualifiedName& tagName) const { return m_tagName.matches(tagName); }
210     bool hasTagName(const HTMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
211     bool hasTagName(const MathMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
212     bool hasTagName(const SVGQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
213
214     // A fast function for checking the local name against another atomic string.
215     bool hasLocalName(const AtomicString& other) const { return m_tagName.localName() == other; }
216
217     const AtomicString& localName() const final { return m_tagName.localName(); }
218     const AtomicString& prefix() const final { return m_tagName.prefix(); }
219     const AtomicString& namespaceURI() const final { return m_tagName.namespaceURI(); }
220
221     ExceptionOr<void> setPrefix(const AtomicString&) final;
222
223     String nodeName() const override;
224
225     Ref<Element> cloneElementWithChildren(Document&);
226     Ref<Element> cloneElementWithoutChildren(Document&);
227
228     void normalizeAttributes();
229     String nodeNamePreservingCase() const;
230
231     WEBCORE_EXPORT void setBooleanAttribute(const QualifiedName& name, bool);
232
233     // For exposing to DOM only.
234     WEBCORE_EXPORT NamedNodeMap& attributes() const;
235
236     enum AttributeModificationReason {
237         ModifiedDirectly,
238         ModifiedByCloning
239     };
240
241     // This method is called whenever an attribute is added, changed or removed.
242     virtual void attributeChanged(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason = ModifiedDirectly);
243     virtual void parseAttribute(const QualifiedName&, const AtomicString&) { }
244
245     // Only called by the parser immediately after element construction.
246     void parserSetAttributes(const Vector<Attribute>&);
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     bool hasEquivalentAttributes(const Element* other) const;
264
265     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
266
267     virtual RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&);
268     virtual bool rendererIsNeeded(const RenderStyle&);
269
270     WEBCORE_EXPORT ShadowRoot* shadowRoot() const;
271     ShadowRoot* shadowRootForBindings(JSC::ExecState&) const;
272
273     struct ShadowRootInit {
274         ShadowRootMode mode;
275     };
276     ExceptionOr<ShadowRoot&> attachShadow(const ShadowRootInit&);
277
278     ShadowRoot* userAgentShadowRoot() const;
279     WEBCORE_EXPORT ShadowRoot& ensureUserAgentShadowRoot();
280
281     void setIsDefinedCustomElement(JSCustomElementInterface&);
282     void setIsFailedCustomElement(JSCustomElementInterface&);
283     void setIsCustomElementUpgradeCandidate();
284     void enqueueToUpgrade(JSCustomElementInterface&);
285     CustomElementReactionQueue* reactionQueue() const;
286
287     // FIXME: this should not be virtual, do not override this.
288     virtual const AtomicString& shadowPseudoId() const;
289
290     bool inActiveChain() const { return isUserActionElement() && isUserActionElementInActiveChain(); }
291     bool active() const { return isUserActionElement() && isUserActionElementActive(); }
292     bool hovered() const { return isUserActionElement() && isUserActionElementHovered(); }
293     bool focused() const { return isUserActionElement() && isUserActionElementFocused(); }
294     bool hasFocusWithin() const { return getFlag(HasFocusWithin); };
295
296     virtual void setActive(bool flag = true, bool pause = false);
297     virtual void setHovered(bool flag = true);
298     virtual void setFocus(bool flag);
299     void setHasFocusWithin(bool flag);
300
301     bool tabIndexSetExplicitly() const;
302     virtual bool supportsFocus() const;
303     virtual bool isFocusable() const;
304     virtual bool isKeyboardFocusable(KeyboardEvent&) const;
305     virtual bool isMouseFocusable() const;
306
307     virtual bool shouldUseInputMethod();
308
309     virtual int tabIndex() const;
310     WEBCORE_EXPORT void setTabIndex(int);
311     virtual Element* focusDelegate();
312
313     WEBCORE_EXPORT ExceptionOr<Element*> insertAdjacentElement(const String& where, Element& newChild);
314     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html);
315     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentText(const String& where, const String& text);
316
317     bool ieForbidsInsertHTML() const;
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     void setRegionOversetState(RegionOversetState);
352     RegionOversetState regionOversetState() const;
353
354     AtomicString computeInheritedLanguage() const;
355     Locale& locale() const;
356
357     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
358
359     virtual bool isURLAttribute(const Attribute&) const { return false; }
360     virtual bool attributeContainsURL(const Attribute& attribute) const { return isURLAttribute(attribute); }
361     virtual String completeURLsInAttributeValue(const URL& base, const Attribute&) const;
362     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
363
364     WEBCORE_EXPORT URL getURLAttribute(const QualifiedName&) const;
365     URL getNonEmptyURLAttribute(const QualifiedName&) const;
366
367     virtual const AtomicString& imageSourceURL() const;
368     virtual String target() const { return String(); }
369
370     static AXTextStateChangeIntent defaultFocusTextStateChangeIntent() { return AXTextStateChangeIntent(AXTextStateChangeTypeSelectionMove, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, true }); }
371     void updateFocusAppearanceAfterAttachIfNeeded();
372     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
373     virtual void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode = SelectionRevealMode::Reveal);
374     virtual void blur();
375
376     WEBCORE_EXPORT String innerHTML() const;
377     WEBCORE_EXPORT String outerHTML() const;
378     WEBCORE_EXPORT ExceptionOr<void> setInnerHTML(const String&);
379     WEBCORE_EXPORT ExceptionOr<void> setOuterHTML(const String&);
380     WEBCORE_EXPORT String innerText();
381     WEBCORE_EXPORT String outerText();
382  
383     virtual String title() const;
384
385     const AtomicString& pseudo() const;
386     WEBCORE_EXPORT void setPseudo(const AtomicString&);
387
388     LayoutSize minimumSizeForResizing() const;
389     void setMinimumSizeForResizing(const LayoutSize&);
390
391     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
392     virtual void prepareForDocumentSuspension() { }
393     virtual void resumeFromDocumentSuspension() { }
394
395     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
396     virtual void mediaVolumeDidChange() { }
397
398     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
399     virtual void privateBrowsingStateDidChange() { }
400
401     virtual void willBecomeFullscreenElement();
402     virtual void ancestorWillEnterFullscreen() { }
403     virtual void didBecomeFullscreenElement() { }
404     virtual void willStopBeingFullscreenElement() { }
405
406     // Use Document::registerForVisibilityStateChangedCallbacks() to subscribe to this.
407     virtual void visibilityStateChanged() { }
408
409 #if ENABLE(VIDEO_TRACK)
410     virtual void captionPreferencesChanged() { }
411 #endif
412
413     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
414     void finishParsingChildren() override;
415     void beginParsingChildren() final;
416
417     WEBCORE_EXPORT PseudoElement* beforePseudoElement() const;
418     WEBCORE_EXPORT PseudoElement* afterPseudoElement() const;
419     bool childNeedsShadowWalker() const;
420     void didShadowTreeAwareChildrenChange();
421
422     virtual bool matchesValidPseudoClass() const;
423     virtual bool matchesInvalidPseudoClass() const;
424     virtual bool matchesReadWritePseudoClass() const;
425     virtual bool matchesIndeterminatePseudoClass() const;
426     virtual bool matchesDefaultPseudoClass() const;
427     WEBCORE_EXPORT ExceptionOr<bool> matches(const String& selectors);
428     WEBCORE_EXPORT ExceptionOr<Element*> closest(const String& selectors);
429     virtual bool shouldAppearIndeterminate() const;
430
431     WEBCORE_EXPORT DOMTokenList& classList();
432
433     DatasetDOMStringMap& dataset();
434
435 #if ENABLE(VIDEO)
436     virtual bool isMediaElement() const { return false; }
437 #endif
438
439     virtual bool isFormControlElement() const { return false; }
440     virtual bool isSpinButtonElement() const { return false; }
441     virtual bool isTextFormControl() const { return false; }
442     virtual bool isOptionalFormControl() const { return false; }
443     virtual bool isRequiredFormControl() const { return false; }
444     virtual bool isInRange() const { return false; }
445     virtual bool isOutOfRange() const { return false; }
446     virtual bool isFrameElementBase() const { return false; }
447     virtual bool isUploadButton() const { return false; }
448     virtual bool isSliderContainerElement() const { return false; }
449
450     bool canContainRangeEndPoint() const override;
451
452     // Used for disabled form elements; if true, prevents mouse events from being dispatched
453     // to event listeners, and prevents DOMActivate events from being sent at all.
454     virtual bool isDisabledFormControl() const { return false; }
455
456     virtual bool childShouldCreateRenderer(const Node&) const;
457
458     bool hasPendingResources() const;
459     void setHasPendingResources();
460     void clearHasPendingResources();
461     virtual void buildPendingResource() { };
462
463 #if ENABLE(FULLSCREEN_API)
464     enum {
465         ALLOW_KEYBOARD_INPUT = 1 << 0,
466         LEGACY_MOZILLA_REQUEST = 1 << 1,
467     };
468     
469     WEBCORE_EXPORT void webkitRequestFullScreen(unsigned short flags);
470     WEBCORE_EXPORT bool containsFullScreenElement() const;
471     void setContainsFullScreenElement(bool);
472     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
473
474     // W3C API
475     WEBCORE_EXPORT void webkitRequestFullscreen();
476 #endif
477
478 #if ENABLE(POINTER_LOCK)
479     WEBCORE_EXPORT void requestPointerLock();
480 #endif
481
482 #if ENABLE(INDIE_UI)
483     void setUIActions(const AtomicString&);
484     const AtomicString& UIActions() const;
485 #endif
486     
487     bool isSpellCheckingEnabled() const;
488
489     RenderNamedFlowFragment* renderNamedFlowFragment() const;
490
491 #if ENABLE(CSS_REGIONS)
492     virtual bool shouldMoveToFlowThread(const RenderStyle&) const;
493     
494     WEBCORE_EXPORT const AtomicString& webkitRegionOverset() const;
495     Vector<RefPtr<Range>> webkitGetRegionFlowRanges() const;
496 #endif
497
498     bool hasID() const;
499     bool hasClass() const;
500     bool hasName() const;
501     const SpaceSplitString& classNames() const;
502
503     IntPoint savedLayerScrollPosition() const;
504     void setSavedLayerScrollPosition(const IntPoint&);
505
506     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
507     bool dispatchWheelEvent(const PlatformWheelEvent&);
508     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
509     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
510     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
511     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
512     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
513     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
514
515     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
516
517     virtual void willRecalcStyle(Style::Change);
518     virtual void didRecalcStyle(Style::Change);
519     virtual void willResetComputedStyle();
520     virtual void willAttachRenderers();
521     virtual void didAttachRenderers();
522     virtual void willDetachRenderers();
523     virtual void didDetachRenderers();
524     virtual std::optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
525
526     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
527
528     void setBeforePseudoElement(Ref<PseudoElement>&&);
529     void setAfterPseudoElement(Ref<PseudoElement>&&);
530     void clearBeforePseudoElement();
531     void clearAfterPseudoElement();
532     void resetComputedStyle();
533     void clearStyleDerivedDataBeforeDetachingRenderer();
534     void clearHoverAndActiveStatusBeforeDetachingRenderer();
535
536     WEBCORE_EXPORT URL absoluteLinkURL() const;
537
538 #if ENABLE(TOUCH_EVENTS)
539     bool allowsDoubleTapGesture() const override;
540 #endif
541
542     StyleResolver& styleResolver();
543     ElementStyle resolveStyle(const RenderStyle* parentStyle);
544
545     // Invalidates the style of a single element. Style is resolved lazily.
546     // Descendant elements are resolved as needed, for example if an inherited property changes.
547     // This should be called whenever an element changes in a manner that can affect its style.
548     void invalidateStyle();
549
550     // As above but also call RenderElement::setStyle with StyleDifferenceRecompositeLayer flag for
551     // the element even when the style doesn't change. This is mostly needed by the animation code.
552     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
553
554     // Invalidate the element and all its descendants. This is used when there is some sort of change
555     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
556     // the case to limit the scope. This is expensive and should be avoided.
557     void invalidateStyleForSubtree();
558
559     // Invalidates renderers for the element and all its descendants causing them to be torn down
560     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
561     // custom (not style based) renderers. This is expensive and should be avoided.
562     // Elements newly added to the tree are also in this state.
563     void invalidateStyleAndRenderersForSubtree();
564
565     bool hasDisplayContents() const;
566     void setHasDisplayContents(bool);
567
568     virtual void isVisibleInViewportChanged() { }
569
570     using ContainerNode::setAttributeEventListener;
571     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
572
573     bool isNamedFlowContentElement() const { return hasRareData() && rareDataIsNamedFlowContentElement(); }
574     void setIsNamedFlowContentElement();
575     void clearIsNamedFlowContentElement();
576
577 #if ENABLE(WEB_ANIMATIONS)
578     Vector<WebAnimation*> getAnimations();
579 #endif
580
581     Element* findAnchorElementForLink(String& outAnchorName);
582
583 protected:
584     Element(const QualifiedName&, Document&, ConstructionType);
585
586     InsertionNotificationRequest insertedInto(ContainerNode&) override;
587     void removedFrom(ContainerNode&) override;
588     void childrenChanged(const ChildChange&) override;
589     void removeAllEventListeners() final;
590     virtual void parserDidSetAttributes();
591     void didMoveToNewDocument(Document&) override;
592
593     void clearTabIndexExplicitlyIfNeeded();
594     void setTabIndexExplicitly(int);
595
596     // classAttributeChanged() exists to share code between
597     // parseAttribute (called via setAttribute()) and
598     // svgAttributeChanged (called when element.className.baseValue is set)
599     void classAttributeChanged(const AtomicString& newClassString);
600
601     void addShadowRoot(Ref<ShadowRoot>&&);
602
603     static ExceptionOr<void> mergeWithNextTextNode(Text&);
604
605 private:
606     bool isTextNode() const;
607
608     bool isUserActionElementInActiveChain() const;
609     bool isUserActionElementActive() const;
610     bool isUserActionElementFocused() const;
611     bool isUserActionElementHovered() const;
612
613     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
614     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
615
616     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
617     friend class Attr;
618
619     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
620
621     void didAddAttribute(const QualifiedName&, const AtomicString&);
622     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
623     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
624     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
625
626     void synchronizeAttribute(const QualifiedName&) const;
627     void synchronizeAttribute(const AtomicString& localName) const;
628
629     void updateName(const AtomicString& oldName, const AtomicString& newName);
630     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
631     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
632
633     enum class NotifyObservers { No, Yes };
634     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
635     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
636
637     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
638     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
639     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
640
641     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
642
643     void scrollByUnits(int units, ScrollGranularity);
644
645     NodeType nodeType() const final;
646     bool childTypeAllowed(NodeType) const final;
647
648     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
649     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
650     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
651
652     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
653     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
654     
655 #if ENABLE(TREE_DEBUGGING)
656     void formatForDebugger(char* buffer, unsigned length) const override;
657 #endif
658
659     void cancelFocusAppearanceUpdate();
660
661     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
662     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
663     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
664
665     void removeShadowRoot();
666
667     const RenderStyle* existingComputedStyle();
668     const RenderStyle& resolveComputedStyle();
669
670     bool rareDataStyleAffectedByEmpty() const;
671     bool rareDataStyleAffectedByFocusWithin() const;
672     bool rareDataIsNamedFlowContentElement() const;
673     bool rareDataChildrenAffectedByHover() const;
674     bool rareDataStyleAffectedByActive() const;
675     bool rareDataChildrenAffectedByDrag() const;
676     bool rareDataChildrenAffectedByLastChildRules() const;
677     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
678     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
679     unsigned rareDataChildIndex() const;
680
681     SpellcheckAttributeState spellcheckAttributeState() const;
682
683     void unregisterNamedFlowContentElement();
684
685     void createUniqueElementData();
686
687     ElementRareData* elementRareData() const;
688     ElementRareData& ensureElementRareData();
689
690     void detachAllAttrNodesFromElement();
691     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
692
693     bool isJavaScriptURLAttribute(const Attribute&) const;
694
695     // Anyone thinking of using this should call document instead of ownerDocument.
696     void ownerDocument() const = delete;
697
698     QualifiedName m_tagName;
699     RefPtr<ElementData> m_elementData;
700 };
701
702 inline bool Node::hasAttributes() const
703 {
704     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
705 }
706
707 inline NamedNodeMap* Node::attributes() const
708 {
709     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
710 }
711
712 inline Element* Node::parentElement() const
713 {
714     ContainerNode* parent = parentNode();
715     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
716 }
717
718 inline const Element* Element::rootElement() const
719 {
720     if (inDocument())
721         return document().documentElement();
722
723     const Element* highest = this;
724     while (highest->parentElement())
725         highest = highest->parentElement();
726     return highest;
727 }
728
729 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
730 {
731     ASSERT(fastAttributeLookupAllowed(name));
732     return elementData() && findAttributeByName(name);
733 }
734
735 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
736 {
737     ASSERT(fastAttributeLookupAllowed(name));
738     if (elementData()) {
739         if (const Attribute* attribute = findAttributeByName(name))
740             return attribute->value();
741     }
742     return nullAtom;
743 }
744
745 inline bool Element::hasAttributesWithoutUpdate() const
746 {
747     return elementData() && !elementData()->isEmpty();
748 }
749
750 inline const AtomicString& Element::idForStyleResolution() const
751 {
752     return hasID() ? elementData()->idForStyleResolution() : nullAtom;
753 }
754
755 inline const AtomicString& Element::getIdAttribute() const
756 {
757     if (hasID())
758         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
759     return nullAtom;
760 }
761
762 inline const AtomicString& Element::getNameAttribute() const
763 {
764     if (hasName())
765         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
766     return nullAtom;
767 }
768
769 inline void Element::setIdAttribute(const AtomicString& value)
770 {
771     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
772 }
773
774 inline const SpaceSplitString& Element::classNames() const
775 {
776     ASSERT(hasClass());
777     ASSERT(elementData());
778     return elementData()->classNames();
779 }
780
781 inline unsigned Element::attributeCount() const
782 {
783     ASSERT(elementData());
784     return elementData()->length();
785 }
786
787 inline const Attribute& Element::attributeAt(unsigned index) const
788 {
789     ASSERT(elementData());
790     return elementData()->attributeAt(index);
791 }
792
793 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
794 {
795     ASSERT(elementData());
796     return elementData()->findAttributeByName(name);
797 }
798
799 inline bool Element::hasID() const
800 {
801     return elementData() && elementData()->hasID();
802 }
803
804 inline bool Element::hasClass() const
805 {
806     return elementData() && elementData()->hasClass();
807 }
808
809 inline bool Element::hasName() const
810 {
811     return elementData() && elementData()->hasName();
812 }
813
814 inline UniqueElementData& Element::ensureUniqueElementData()
815 {
816     if (!elementData() || !elementData()->isUnique())
817         createUniqueElementData();
818     return static_cast<UniqueElementData&>(*m_elementData);
819 }
820
821 inline bool shouldIgnoreAttributeCase(const Element& element)
822 {
823     return element.isHTMLElement() && element.document().isHTMLDocument();
824 }
825
826 inline void Element::setHasFocusWithin(bool flag)
827 {
828     if (hasFocusWithin() == flag)
829         return;
830     setFlag(flag, HasFocusWithin);
831     if (styleAffectedByFocusWithin())
832         invalidateStyleForSubtree();
833 }
834
835 } // namespace WebCore
836
837 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
838     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
839 SPECIALIZE_TYPE_TRAITS_END()