[WTF] Import std::optional reference implementation as WTF::Optional
[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
448     bool canContainRangeEndPoint() const override;
449
450     // Used for disabled form elements; if true, prevents mouse events from being dispatched
451     // to event listeners, and prevents DOMActivate events from being sent at all.
452     virtual bool isDisabledFormControl() const { return false; }
453
454     virtual bool childShouldCreateRenderer(const Node&) const;
455
456     bool hasPendingResources() const;
457     void setHasPendingResources();
458     void clearHasPendingResources();
459     virtual void buildPendingResource() { };
460
461 #if ENABLE(FULLSCREEN_API)
462     enum {
463         ALLOW_KEYBOARD_INPUT = 1 << 0,
464         LEGACY_MOZILLA_REQUEST = 1 << 1,
465     };
466     
467     WEBCORE_EXPORT void webkitRequestFullScreen(unsigned short flags);
468     WEBCORE_EXPORT bool containsFullScreenElement() const;
469     void setContainsFullScreenElement(bool);
470     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
471
472     // W3C API
473     WEBCORE_EXPORT void webkitRequestFullscreen();
474 #endif
475
476 #if ENABLE(POINTER_LOCK)
477     WEBCORE_EXPORT void requestPointerLock();
478 #endif
479
480 #if ENABLE(INDIE_UI)
481     void setUIActions(const AtomicString&);
482     const AtomicString& UIActions() const;
483 #endif
484     
485     bool isSpellCheckingEnabled() const;
486
487     RenderNamedFlowFragment* renderNamedFlowFragment() const;
488
489 #if ENABLE(CSS_REGIONS)
490     virtual bool shouldMoveToFlowThread(const RenderStyle&) const;
491     
492     WEBCORE_EXPORT const AtomicString& webkitRegionOverset() const;
493     Vector<RefPtr<Range>> webkitGetRegionFlowRanges() const;
494 #endif
495
496     bool hasID() const;
497     bool hasClass() const;
498     bool hasName() const;
499     const SpaceSplitString& classNames() const;
500
501     IntPoint savedLayerScrollPosition() const;
502     void setSavedLayerScrollPosition(const IntPoint&);
503
504     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
505     bool dispatchWheelEvent(const PlatformWheelEvent&);
506     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
507     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
508     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
509     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
510     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
511     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
512
513     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
514
515     virtual void willRecalcStyle(Style::Change);
516     virtual void didRecalcStyle(Style::Change);
517     virtual void willResetComputedStyle();
518     virtual void willAttachRenderers();
519     virtual void didAttachRenderers();
520     virtual void willDetachRenderers();
521     virtual void didDetachRenderers();
522     virtual std::optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
523
524     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
525
526     void setBeforePseudoElement(Ref<PseudoElement>&&);
527     void setAfterPseudoElement(Ref<PseudoElement>&&);
528     void clearBeforePseudoElement();
529     void clearAfterPseudoElement();
530     void resetComputedStyle();
531     void clearStyleDerivedDataBeforeDetachingRenderer();
532     void clearHoverAndActiveStatusBeforeDetachingRenderer();
533
534     WEBCORE_EXPORT URL absoluteLinkURL() const;
535
536 #if ENABLE(TOUCH_EVENTS)
537     bool allowsDoubleTapGesture() const override;
538 #endif
539
540     StyleResolver& styleResolver();
541     ElementStyle resolveStyle(const RenderStyle* parentStyle);
542
543     // Invalidates the style of a single element. Style is resolved lazily.
544     // Descendant elements are resolved as needed, for example if an inherited property changes.
545     // This should be called whenever an element changes in a manner that can affect its style.
546     void invalidateStyle();
547
548     // As above but also call RenderElement::setStyle with StyleDifferenceRecompositeLayer flag for
549     // the element even when the style doesn't change. This is mostly needed by the animation code.
550     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
551
552     // Invalidate the element and all its descendants. This is used when there is some sort of change
553     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
554     // the case to limit the scope. This is expensive and should be avoided.
555     void invalidateStyleForSubtree();
556
557     // Invalidates renderers for the element and all its descendants causing them to be torn down
558     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
559     // custom (not style based) renderers. This is expensive and should be avoided.
560     // Elements newly added to the tree are also in this state.
561     void invalidateStyleAndRenderersForSubtree();
562
563     bool hasDisplayContents() const;
564     void setHasDisplayContents(bool);
565
566     virtual void isVisibleInViewportChanged() { }
567
568     using ContainerNode::setAttributeEventListener;
569     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
570
571     bool isNamedFlowContentElement() const { return hasRareData() && rareDataIsNamedFlowContentElement(); }
572     void setIsNamedFlowContentElement();
573     void clearIsNamedFlowContentElement();
574
575 #if ENABLE(WEB_ANIMATIONS)
576     Vector<WebAnimation*> getAnimations();
577 #endif
578
579     Element* findAnchorElementForLink(String& outAnchorName);
580
581 protected:
582     Element(const QualifiedName&, Document&, ConstructionType);
583
584     InsertionNotificationRequest insertedInto(ContainerNode&) override;
585     void removedFrom(ContainerNode&) override;
586     void childrenChanged(const ChildChange&) override;
587     void removeAllEventListeners() final;
588     virtual void parserDidSetAttributes();
589     void didMoveToNewDocument(Document&) override;
590
591     void clearTabIndexExplicitlyIfNeeded();
592     void setTabIndexExplicitly(int);
593
594     // classAttributeChanged() exists to share code between
595     // parseAttribute (called via setAttribute()) and
596     // svgAttributeChanged (called when element.className.baseValue is set)
597     void classAttributeChanged(const AtomicString& newClassString);
598
599     void addShadowRoot(Ref<ShadowRoot>&&);
600
601     static ExceptionOr<void> mergeWithNextTextNode(Text&);
602
603 private:
604     bool isTextNode() const;
605
606     bool isUserActionElementInActiveChain() const;
607     bool isUserActionElementActive() const;
608     bool isUserActionElementFocused() const;
609     bool isUserActionElementHovered() const;
610
611     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
612     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
613
614     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
615     friend class Attr;
616
617     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
618
619     void didAddAttribute(const QualifiedName&, const AtomicString&);
620     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
621     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
622     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
623
624     void synchronizeAttribute(const QualifiedName&) const;
625     void synchronizeAttribute(const AtomicString& localName) const;
626
627     void updateName(const AtomicString& oldName, const AtomicString& newName);
628     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
629     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
630
631     enum class NotifyObservers { No, Yes };
632     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
633     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
634
635     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
636     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
637     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
638
639     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
640
641     void scrollByUnits(int units, ScrollGranularity);
642
643     NodeType nodeType() const final;
644     bool childTypeAllowed(NodeType) const final;
645
646     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
647     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
648     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
649
650     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
651     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
652     
653 #if ENABLE(TREE_DEBUGGING)
654     void formatForDebugger(char* buffer, unsigned length) const override;
655 #endif
656
657     void cancelFocusAppearanceUpdate();
658
659     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
660     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
661     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
662
663     void removeShadowRoot();
664
665     const RenderStyle* existingComputedStyle();
666     const RenderStyle& resolveComputedStyle();
667
668     bool rareDataStyleAffectedByEmpty() const;
669     bool rareDataStyleAffectedByFocusWithin() const;
670     bool rareDataIsNamedFlowContentElement() const;
671     bool rareDataChildrenAffectedByHover() const;
672     bool rareDataStyleAffectedByActive() const;
673     bool rareDataChildrenAffectedByDrag() const;
674     bool rareDataChildrenAffectedByLastChildRules() const;
675     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
676     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
677     unsigned rareDataChildIndex() const;
678
679     SpellcheckAttributeState spellcheckAttributeState() const;
680
681     void unregisterNamedFlowContentElement();
682
683     void createUniqueElementData();
684
685     ElementRareData* elementRareData() const;
686     ElementRareData& ensureElementRareData();
687
688     void detachAllAttrNodesFromElement();
689     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
690
691     bool isJavaScriptURLAttribute(const Attribute&) const;
692
693     // Anyone thinking of using this should call document instead of ownerDocument.
694     void ownerDocument() const = delete;
695
696     QualifiedName m_tagName;
697     RefPtr<ElementData> m_elementData;
698 };
699
700 inline bool Node::hasAttributes() const
701 {
702     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
703 }
704
705 inline NamedNodeMap* Node::attributes() const
706 {
707     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
708 }
709
710 inline Element* Node::parentElement() const
711 {
712     ContainerNode* parent = parentNode();
713     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
714 }
715
716 inline const Element* Element::rootElement() const
717 {
718     if (inDocument())
719         return document().documentElement();
720
721     const Element* highest = this;
722     while (highest->parentElement())
723         highest = highest->parentElement();
724     return highest;
725 }
726
727 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
728 {
729     ASSERT(fastAttributeLookupAllowed(name));
730     return elementData() && findAttributeByName(name);
731 }
732
733 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
734 {
735     ASSERT(fastAttributeLookupAllowed(name));
736     if (elementData()) {
737         if (const Attribute* attribute = findAttributeByName(name))
738             return attribute->value();
739     }
740     return nullAtom;
741 }
742
743 inline bool Element::hasAttributesWithoutUpdate() const
744 {
745     return elementData() && !elementData()->isEmpty();
746 }
747
748 inline const AtomicString& Element::idForStyleResolution() const
749 {
750     return hasID() ? elementData()->idForStyleResolution() : nullAtom;
751 }
752
753 inline const AtomicString& Element::getIdAttribute() const
754 {
755     if (hasID())
756         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
757     return nullAtom;
758 }
759
760 inline const AtomicString& Element::getNameAttribute() const
761 {
762     if (hasName())
763         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
764     return nullAtom;
765 }
766
767 inline void Element::setIdAttribute(const AtomicString& value)
768 {
769     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
770 }
771
772 inline const SpaceSplitString& Element::classNames() const
773 {
774     ASSERT(hasClass());
775     ASSERT(elementData());
776     return elementData()->classNames();
777 }
778
779 inline unsigned Element::attributeCount() const
780 {
781     ASSERT(elementData());
782     return elementData()->length();
783 }
784
785 inline const Attribute& Element::attributeAt(unsigned index) const
786 {
787     ASSERT(elementData());
788     return elementData()->attributeAt(index);
789 }
790
791 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
792 {
793     ASSERT(elementData());
794     return elementData()->findAttributeByName(name);
795 }
796
797 inline bool Element::hasID() const
798 {
799     return elementData() && elementData()->hasID();
800 }
801
802 inline bool Element::hasClass() const
803 {
804     return elementData() && elementData()->hasClass();
805 }
806
807 inline bool Element::hasName() const
808 {
809     return elementData() && elementData()->hasName();
810 }
811
812 inline UniqueElementData& Element::ensureUniqueElementData()
813 {
814     if (!elementData() || !elementData()->isUnique())
815         createUniqueElementData();
816     return static_cast<UniqueElementData&>(*m_elementData);
817 }
818
819 inline bool shouldIgnoreAttributeCase(const Element& element)
820 {
821     return element.isHTMLElement() && element.document().isHTMLDocument();
822 }
823
824 inline void Element::setHasFocusWithin(bool flag)
825 {
826     if (hasFocusWithin() == flag)
827         return;
828     setFlag(flag, HasFocusWithin);
829     if (styleAffectedByFocusWithin())
830         invalidateStyleForSubtree();
831 }
832
833 } // namespace WebCore
834
835 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
836     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
837 SPECIALIZE_TYPE_TRAITS_END()