c5eb6cb8c448b099c5e0126ad5a1e7c4e8842b86
[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 "KeyframeAnimationOptions.h"
32 #include "ScrollToOptions.h"
33 #include "ScrollTypes.h"
34 #include "ShadowRootMode.h"
35 #include "SimulatedClickOptions.h"
36 #include "StyleChange.h"
37
38 namespace WebCore {
39
40 class CustomElementReactionQueue;
41 class DatasetDOMStringMap;
42 class DOMRect;
43 class DOMRectList;
44 class DOMTokenList;
45 class ElementRareData;
46 class Frame;
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 RenderTreePosition;
57 class StylePropertyMap;
58 class WebAnimation;
59 struct ElementStyle;
60 struct ScrollIntoViewOptions;
61
62 #if ENABLE(INTERSECTION_OBSERVER)
63 struct IntersectionObserverData;
64 #endif
65
66 enum SpellcheckAttributeState {
67     SpellcheckAttributeTrue,
68     SpellcheckAttributeFalse,
69     SpellcheckAttributeDefault
70 };
71
72 enum class SelectionRevealMode {
73     Reveal,
74     RevealUpToMainFrame, // Scroll overflow and iframes, but not the main frame.
75     DoNotReveal
76 };
77
78 class Element : public ContainerNode {
79     WTF_MAKE_ISO_ALLOCATED(Element);
80 public:
81     static Ref<Element> create(const QualifiedName&, Document&);
82     virtual ~Element();
83
84     WEBCORE_EXPORT bool hasAttribute(const QualifiedName&) const;
85     WEBCORE_EXPORT const AtomicString& getAttribute(const QualifiedName&) const;
86     template<typename... QualifiedNames>
87     const AtomicString& getAttribute(const QualifiedName&, const QualifiedNames&...) const;
88     WEBCORE_EXPORT void setAttribute(const QualifiedName&, const AtomicString& value);
89     WEBCORE_EXPORT void setAttributeWithoutSynchronization(const QualifiedName&, const AtomicString& value);
90     void setSynchronizedLazyAttribute(const QualifiedName&, const AtomicString& value);
91     bool removeAttribute(const QualifiedName&);
92     Vector<String> getAttributeNames() const;
93
94     // Typed getters and setters for language bindings.
95     WEBCORE_EXPORT int getIntegralAttribute(const QualifiedName& attributeName) const;
96     WEBCORE_EXPORT void setIntegralAttribute(const QualifiedName& attributeName, int value);
97     WEBCORE_EXPORT unsigned getUnsignedIntegralAttribute(const QualifiedName& attributeName) const;
98     WEBCORE_EXPORT void setUnsignedIntegralAttribute(const QualifiedName& attributeName, unsigned value);
99
100     // Call this to get the value of an attribute that is known not to be the style
101     // attribute or one of the SVG animatable attributes.
102     bool hasAttributeWithoutSynchronization(const QualifiedName&) const;
103     const AtomicString& attributeWithoutSynchronization(const QualifiedName&) const;
104 #ifndef NDEBUG
105     WEBCORE_EXPORT bool fastAttributeLookupAllowed(const QualifiedName&) const;
106 #endif
107
108 #if DUMP_NODE_STATISTICS
109     bool hasNamedNodeMap() const;
110 #endif
111     WEBCORE_EXPORT bool hasAttributes() const;
112     // This variant will not update the potentially invalid attributes. To be used when not interested
113     // in style attribute or one of the SVG animation attributes.
114     bool hasAttributesWithoutUpdate() const;
115
116     WEBCORE_EXPORT bool hasAttribute(const AtomicString& qualifiedName) const;
117     WEBCORE_EXPORT bool hasAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
118
119     WEBCORE_EXPORT const AtomicString& getAttribute(const AtomicString& qualifiedName) const;
120     WEBCORE_EXPORT const AtomicString& getAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
121
122     WEBCORE_EXPORT ExceptionOr<void> setAttribute(const AtomicString& qualifiedName, const AtomicString& value);
123     static ExceptionOr<QualifiedName> parseAttributeName(const AtomicString& namespaceURI, const AtomicString& qualifiedName);
124     WEBCORE_EXPORT ExceptionOr<void> setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value);
125
126     ExceptionOr<bool> toggleAttribute(const AtomicString& qualifiedName, Optional<bool> force);
127
128     const AtomicString& getIdAttribute() const;
129     void setIdAttribute(const AtomicString&);
130
131     const AtomicString& getNameAttribute() const;
132
133     // Call this to get the value of the id attribute for style resolution purposes.
134     // The value will already be lowercased if the document is in compatibility mode,
135     // so this function is not suitable for non-style uses.
136     const AtomicString& idForStyleResolution() const;
137
138     // Internal methods that assume the existence of attribute storage, one should use hasAttributes()
139     // before calling them.
140     AttributeIteratorAccessor attributesIterator() const { return elementData()->attributesIterator(); }
141     unsigned attributeCount() const;
142     const Attribute& attributeAt(unsigned index) const;
143     const Attribute* findAttributeByName(const QualifiedName&) const;
144     unsigned findAttributeIndexByName(const QualifiedName& name) const { return elementData()->findAttributeIndexByName(name); }
145     unsigned findAttributeIndexByName(const AtomicString& name, bool shouldIgnoreAttributeCase) const { return elementData()->findAttributeIndexByName(name, shouldIgnoreAttributeCase); }
146
147     WEBCORE_EXPORT void scrollIntoView(Optional<Variant<bool, ScrollIntoViewOptions>>&& arg);
148     WEBCORE_EXPORT void scrollIntoView(bool alignToTop = true);
149     WEBCORE_EXPORT void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
150     WEBCORE_EXPORT void scrollIntoViewIfNotVisible(bool centerIfNotVisible = true);
151
152     void scrollBy(const ScrollToOptions&);
153     void scrollBy(double x, double y);
154     virtual void scrollTo(const ScrollToOptions&, ScrollClamping = ScrollClamping::Clamped);
155     void scrollTo(double x, double y);
156
157     WEBCORE_EXPORT void scrollByLines(int lines);
158     WEBCORE_EXPORT void scrollByPages(int pages);
159
160     WEBCORE_EXPORT double offsetLeftForBindings();
161     WEBCORE_EXPORT double offsetLeft();
162     WEBCORE_EXPORT double offsetTopForBindings();
163     WEBCORE_EXPORT double offsetTop();
164     WEBCORE_EXPORT double offsetWidth();
165     WEBCORE_EXPORT double offsetHeight();
166
167     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
168
169     // FIXME: Replace uses of offsetParent in the platform with calls
170     // to the render layer and merge bindingsOffsetParent and offsetParent.
171     WEBCORE_EXPORT Element* offsetParentForBindings();
172
173     const Element* rootElement() const;
174
175     Element* offsetParent();
176     WEBCORE_EXPORT double clientLeft();
177     WEBCORE_EXPORT double clientTop();
178     WEBCORE_EXPORT double clientWidth();
179     WEBCORE_EXPORT double clientHeight();
180
181     virtual int scrollLeft();
182     virtual int scrollTop();
183     virtual void setScrollLeft(int);
184     virtual void setScrollTop(int);
185     virtual int scrollWidth();
186     virtual int scrollHeight();
187
188     WEBCORE_EXPORT IntRect boundsInRootViewSpace();
189
190     WEBCORE_EXPORT FloatRect boundingClientRect();
191
192     WEBCORE_EXPORT Ref<DOMRectList> getClientRects();
193     Ref<DOMRect> getBoundingClientRect();
194
195     // Returns the absolute bounding box translated into client coordinates.
196     WEBCORE_EXPORT IntRect clientRect() const;
197     // Returns the absolute bounding box translated into screen coordinates.
198     WEBCORE_EXPORT IntRect screenRect() const;
199
200     WEBCORE_EXPORT bool removeAttribute(const AtomicString& qualifiedName);
201     WEBCORE_EXPORT bool removeAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName);
202
203     Ref<Attr> detachAttribute(unsigned index);
204
205     WEBCORE_EXPORT RefPtr<Attr> getAttributeNode(const AtomicString& qualifiedName);
206     WEBCORE_EXPORT RefPtr<Attr> getAttributeNodeNS(const AtomicString& namespaceURI, const AtomicString& localName);
207     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNode(Attr&);
208     WEBCORE_EXPORT ExceptionOr<RefPtr<Attr>> setAttributeNodeNS(Attr&);
209     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> removeAttributeNode(Attr&);
210
211     RefPtr<Attr> attrIfExists(const QualifiedName&);
212     RefPtr<Attr> attrIfExists(const AtomicString& localName, bool shouldIgnoreAttributeCase);
213     Ref<Attr> ensureAttr(const QualifiedName&);
214
215     const Vector<RefPtr<Attr>>& attrNodeList();
216
217     const QualifiedName& tagQName() const { return m_tagName; }
218 #if ENABLE(JIT)
219     static ptrdiff_t tagQNameMemoryOffset() { return OBJECT_OFFSETOF(Element, m_tagName); }
220 #endif // ENABLE(JIT)
221     String tagName() const { return nodeName(); }
222     bool hasTagName(const QualifiedName& tagName) const { return m_tagName.matches(tagName); }
223     bool hasTagName(const HTMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
224     bool hasTagName(const MathMLQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
225     bool hasTagName(const SVGQualifiedName& tagName) const { return ContainerNode::hasTagName(tagName); }
226
227     // A fast function for checking the local name against another atomic string.
228     bool hasLocalName(const AtomicString& other) const { return m_tagName.localName() == other; }
229
230     const AtomicString& localName() const final { return m_tagName.localName(); }
231     const AtomicString& prefix() const final { return m_tagName.prefix(); }
232     const AtomicString& namespaceURI() const final { return m_tagName.namespaceURI(); }
233
234     ExceptionOr<void> setPrefix(const AtomicString&) final;
235
236     String nodeName() const override;
237
238     Ref<Element> cloneElementWithChildren(Document&);
239     Ref<Element> cloneElementWithoutChildren(Document&);
240
241     void normalizeAttributes();
242     String nodeNamePreservingCase() const;
243
244     WEBCORE_EXPORT void setBooleanAttribute(const QualifiedName& name, bool);
245
246     // For exposing to DOM only.
247     WEBCORE_EXPORT NamedNodeMap& attributes() const;
248
249     enum AttributeModificationReason {
250         ModifiedDirectly,
251         ModifiedByCloning
252     };
253
254     // This method is called whenever an attribute is added, changed or removed.
255     virtual void attributeChanged(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason = ModifiedDirectly);
256     virtual void parseAttribute(const QualifiedName&, const AtomicString&) { }
257
258     // Only called by the parser immediately after element construction.
259     void parserSetAttributes(const Vector<Attribute>&);
260
261     bool isEventHandlerAttribute(const Attribute&) const;
262     bool isJavaScriptURLAttribute(const Attribute&) const;
263
264     // Remove attributes that might introduce scripting from the vector leaving the element unchanged.
265     void stripScriptingAttributes(Vector<Attribute>&) const;
266
267     const ElementData* elementData() const { return m_elementData.get(); }
268     static ptrdiff_t elementDataMemoryOffset() { return OBJECT_OFFSETOF(Element, m_elementData); }
269     UniqueElementData& ensureUniqueElementData();
270
271     void synchronizeAllAttributes() const;
272
273     // Clones attributes only.
274     void cloneAttributesFromElement(const Element&);
275
276     // Clones all attribute-derived data, including subclass specifics (through copyNonAttributeProperties.)
277     void cloneDataFromElement(const Element&);
278
279     virtual void didMoveToNewDocument(Document& oldDocument, Document& newDocument);
280
281     bool hasEquivalentAttributes(const Element& other) const;
282
283     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
284
285     virtual RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&);
286     virtual bool rendererIsNeeded(const RenderStyle&);
287
288     WEBCORE_EXPORT ShadowRoot* shadowRoot() const;
289     ShadowRoot* shadowRootForBindings(JSC::ExecState&) const;
290
291     struct ShadowRootInit {
292         ShadowRootMode mode;
293     };
294     ExceptionOr<ShadowRoot&> attachShadow(const ShadowRootInit&);
295
296     RefPtr<ShadowRoot> userAgentShadowRoot() const;
297     WEBCORE_EXPORT ShadowRoot& ensureUserAgentShadowRoot();
298
299     void setIsDefinedCustomElement(JSCustomElementInterface&);
300     void setIsFailedCustomElement(JSCustomElementInterface&);
301     void setIsCustomElementUpgradeCandidate();
302     void enqueueToUpgrade(JSCustomElementInterface&);
303     CustomElementReactionQueue* reactionQueue() const;
304
305     // FIXME: this should not be virtual, do not override this.
306     virtual const AtomicString& shadowPseudoId() const;
307
308     bool isInActiveChain() const { return isUserActionElement() && isUserActionElementInActiveChain(); }
309     bool active() const { return isUserActionElement() && isUserActionElementActive(); }
310     bool hovered() const { return isUserActionElement() && isUserActionElementHovered(); }
311     bool focused() const { return isUserActionElement() && isUserActionElementFocused(); }
312     bool hasFocusWithin() const { return getFlag(HasFocusWithin); };
313
314     virtual void setActive(bool flag = true, bool pause = false);
315     virtual void setHovered(bool flag = true);
316     virtual void setFocus(bool flag);
317     void setHasFocusWithin(bool flag);
318
319     bool tabIndexSetExplicitly() const;
320     virtual bool supportsFocus() const;
321     virtual bool isFocusable() const;
322     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
323     virtual bool isMouseFocusable() const;
324
325     virtual bool shouldUseInputMethod();
326
327     virtual int tabIndex() const;
328     WEBCORE_EXPORT void setTabIndex(int);
329     virtual RefPtr<Element> focusDelegate();
330
331     ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html, NodeVector* addedNodes);
332
333     WEBCORE_EXPORT ExceptionOr<Element*> insertAdjacentElement(const String& where, Element& newChild);
334     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentHTML(const String& where, const String& html);
335     WEBCORE_EXPORT ExceptionOr<void> insertAdjacentText(const String& where, const String& text);
336
337     const RenderStyle* computedStyle(PseudoId = PseudoId::None) override;
338
339     bool needsStyleInvalidation() const;
340
341     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
342     bool styleAffectedByActive() const { return hasRareData() && rareDataStyleAffectedByActive(); }
343     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
344     bool styleAffectedByFocusWithin() const { return hasRareData() && rareDataStyleAffectedByFocusWithin(); }
345     bool descendantsAffectedByPreviousSibling() const { return getFlag(DescendantsAffectedByPreviousSiblingFlag); }
346     bool childrenAffectedByHover() const { return getFlag(ChildrenAffectedByHoverRulesFlag); }
347     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
348     bool childrenAffectedByFirstChildRules() const { return getFlag(ChildrenAffectedByFirstChildRulesFlag); }
349     bool childrenAffectedByLastChildRules() const { return getFlag(ChildrenAffectedByLastChildRulesFlag); }
350     bool childrenAffectedByForwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByForwardPositionalRules(); }
351     bool descendantsAffectedByForwardPositionalRules() const { return hasRareData() && rareDataDescendantsAffectedByForwardPositionalRules(); }
352     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
353     bool descendantsAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataDescendantsAffectedByBackwardPositionalRules(); }
354     bool childrenAffectedByPropertyBasedBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules(); }
355     bool affectsNextSiblingElementStyle() const { return getFlag(AffectsNextSiblingElementStyle); }
356     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
357
358     bool hasFlagsSetDuringStylingOfChildren() const;
359
360     void setStyleAffectedByEmpty();
361     void setStyleAffectedByFocusWithin();
362     void setDescendantsAffectedByPreviousSibling() const { return setFlag(DescendantsAffectedByPreviousSiblingFlag); }
363     void setChildrenAffectedByHover() { setFlag(ChildrenAffectedByHoverRulesFlag); }
364     void setStyleAffectedByActive();
365     void setChildrenAffectedByDrag();
366     void setChildrenAffectedByFirstChildRules() { setFlag(ChildrenAffectedByFirstChildRulesFlag); }
367     void setChildrenAffectedByLastChildRules() { setFlag(ChildrenAffectedByLastChildRulesFlag); }
368     void setChildrenAffectedByForwardPositionalRules();
369     void setDescendantsAffectedByForwardPositionalRules();
370     void setChildrenAffectedByBackwardPositionalRules();
371     void setDescendantsAffectedByBackwardPositionalRules();
372     void setChildrenAffectedByPropertyBasedBackwardPositionalRules();
373     void setAffectsNextSiblingElementStyle() { setFlag(AffectsNextSiblingElementStyle); }
374     void setStyleIsAffectedByPreviousSibling() { setFlag(StyleIsAffectedByPreviousSibling); }
375     void setChildIndex(unsigned);
376
377     WEBCORE_EXPORT AtomicString computeInheritedLanguage() const;
378     Locale& locale() const;
379
380     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
381
382     virtual bool isURLAttribute(const Attribute&) const { return false; }
383     virtual bool attributeContainsURL(const Attribute& attribute) const { return isURLAttribute(attribute); }
384     virtual String completeURLsInAttributeValue(const URL& base, const Attribute&) const;
385     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
386
387     WEBCORE_EXPORT URL getURLAttribute(const QualifiedName&) const;
388     URL getNonEmptyURLAttribute(const QualifiedName&) const;
389
390     virtual const AtomicString& imageSourceURL() const;
391     virtual String target() const { return String(); }
392
393     static AXTextStateChangeIntent defaultFocusTextStateChangeIntent() { return AXTextStateChangeIntent(AXTextStateChangeTypeSelectionMove, AXTextSelection { AXTextSelectionDirectionDiscontiguous, AXTextSelectionGranularityUnknown, true }); }
394     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
395     virtual RefPtr<Element> focusAppearanceUpdateTarget();
396     virtual void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode = SelectionRevealMode::Reveal);
397     virtual void blur();
398
399     WEBCORE_EXPORT String innerHTML() const;
400     WEBCORE_EXPORT String outerHTML() const;
401     WEBCORE_EXPORT ExceptionOr<void> setInnerHTML(const String&);
402     WEBCORE_EXPORT ExceptionOr<void> setOuterHTML(const String&);
403     WEBCORE_EXPORT String innerText();
404     WEBCORE_EXPORT String outerText();
405  
406     virtual String title() const;
407
408     const AtomicString& pseudo() const;
409     WEBCORE_EXPORT void setPseudo(const AtomicString&);
410
411     LayoutSize minimumSizeForResizing() const;
412     void setMinimumSizeForResizing(const LayoutSize&);
413
414     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
415     virtual void prepareForDocumentSuspension() { }
416     virtual void resumeFromDocumentSuspension() { }
417
418     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
419     virtual void mediaVolumeDidChange() { }
420
421     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
422     virtual void privateBrowsingStateDidChange() { }
423
424     virtual void willBecomeFullscreenElement();
425     virtual void ancestorWillEnterFullscreen() { }
426     virtual void didBecomeFullscreenElement() { }
427     virtual void willStopBeingFullscreenElement() { }
428
429 #if ENABLE(VIDEO_TRACK)
430     virtual void captionPreferencesChanged() { }
431 #endif
432
433     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
434     void finishParsingChildren() override;
435     void beginParsingChildren() final;
436
437     WEBCORE_EXPORT PseudoElement* beforePseudoElement() const;
438     WEBCORE_EXPORT PseudoElement* afterPseudoElement() const;
439     bool childNeedsShadowWalker() const;
440     void didShadowTreeAwareChildrenChange();
441
442     virtual bool matchesValidPseudoClass() const;
443     virtual bool matchesInvalidPseudoClass() const;
444     virtual bool matchesReadWritePseudoClass() const;
445     virtual bool matchesIndeterminatePseudoClass() const;
446     virtual bool matchesDefaultPseudoClass() const;
447     WEBCORE_EXPORT ExceptionOr<bool> matches(const String& selectors);
448     WEBCORE_EXPORT ExceptionOr<Element*> closest(const String& selectors);
449     virtual bool shouldAppearIndeterminate() const;
450
451     WEBCORE_EXPORT DOMTokenList& classList();
452
453     DatasetDOMStringMap& dataset();
454
455 #if ENABLE(VIDEO)
456     virtual bool isMediaElement() const { return false; }
457 #endif
458
459     virtual bool isFormControlElement() const { return false; }
460     virtual bool isSpinButtonElement() const { return false; }
461     virtual bool isTextFormControlElement() const { return false; }
462     virtual bool isTextField() const { return false; }
463     virtual bool isOptionalFormControl() const { return false; }
464     virtual bool isRequiredFormControl() const { return false; }
465     virtual bool isInRange() const { return false; }
466     virtual bool isOutOfRange() const { return false; }
467     virtual bool isFrameElementBase() const { return false; }
468     virtual bool isUploadButton() const { return false; }
469     virtual bool isSliderContainerElement() const { return false; }
470
471     bool canContainRangeEndPoint() const override;
472
473     // Used for disabled form elements; if true, prevents mouse events from being dispatched
474     // to event listeners, and prevents DOMActivate events from being sent at all.
475     virtual bool isDisabledFormControl() const { return false; }
476
477     virtual bool childShouldCreateRenderer(const Node&) const;
478
479     bool hasPendingResources() const;
480     void setHasPendingResources();
481     void clearHasPendingResources();
482     virtual void buildPendingResource() { };
483
484     bool hasCSSAnimation() const;
485     void setHasCSSAnimation();
486     void clearHasCSSAnimation();
487
488 #if ENABLE(FULLSCREEN_API)
489     WEBCORE_EXPORT bool containsFullScreenElement() const;
490     void setContainsFullScreenElement(bool);
491     void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
492     WEBCORE_EXPORT virtual void webkitRequestFullscreen();
493 #endif
494
495 #if ENABLE(POINTER_LOCK)
496     WEBCORE_EXPORT void requestPointerLock();
497 #endif
498
499     bool isSpellCheckingEnabled() const;
500
501     bool hasID() const;
502     bool hasClass() const;
503     bool hasName() const;
504     const SpaceSplitString& classNames() const;
505
506     IntPoint savedLayerScrollPosition() const;
507     void setSavedLayerScrollPosition(const IntPoint&);
508
509     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Element* relatedTarget = nullptr);
510     bool dispatchWheelEvent(const PlatformWheelEvent&);
511     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
512     void dispatchSimulatedClick(Event* underlyingEvent, SimulatedClickMouseEventOptions = SendNoEvents, SimulatedClickVisualOptions = ShowPressedLook);
513     void dispatchFocusInEvent(const AtomicString& eventType, RefPtr<Element>&& oldFocusedElement);
514     void dispatchFocusOutEvent(const AtomicString& eventType, RefPtr<Element>&& newFocusedElement);
515     virtual void dispatchFocusEvent(RefPtr<Element>&& oldFocusedElement, FocusDirection);
516     virtual void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement);
517     void dispatchWebKitImageReadyEventForTesting();
518
519     WEBCORE_EXPORT bool dispatchMouseForceWillBegin();
520
521     virtual void willRecalcStyle(Style::Change);
522     virtual void didRecalcStyle(Style::Change);
523     virtual void willResetComputedStyle();
524     virtual void willAttachRenderers();
525     virtual void didAttachRenderers();
526     virtual void willDetachRenderers();
527     virtual void didDetachRenderers();
528     virtual Optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle);
529
530     LayoutRect absoluteEventHandlerBounds(bool& includesFixedPositionElements) override;
531
532     const RenderStyle* existingComputedStyle() const;
533     const RenderStyle* renderOrDisplayContentsStyle() const;
534
535     void setBeforePseudoElement(Ref<PseudoElement>&&);
536     void setAfterPseudoElement(Ref<PseudoElement>&&);
537     void clearBeforePseudoElement();
538     void clearAfterPseudoElement();
539     void resetComputedStyle();
540     void resetStyleRelations();
541     void clearHoverAndActiveStatusBeforeDetachingRenderer();
542
543     WEBCORE_EXPORT URL absoluteLinkURL() const;
544
545 #if ENABLE(TOUCH_EVENTS)
546     bool allowsDoubleTapGesture() const override;
547 #endif
548
549     StyleResolver& styleResolver();
550     ElementStyle resolveStyle(const RenderStyle* parentStyle);
551
552     // Invalidates the style of a single element. Style is resolved lazily.
553     // Descendant elements are resolved as needed, for example if an inherited property changes.
554     // This should be called whenever an element changes in a manner that can affect its style.
555     void invalidateStyle();
556
557     // As above but also call RenderElement::setStyle with StyleDifference::RecompositeLayer flag for
558     // the element even when the style doesn't change. This is mostly needed by the animation code.
559     WEBCORE_EXPORT void invalidateStyleAndLayerComposition();
560
561     // Invalidate the element and all its descendants. This is used when there is some sort of change
562     // in the tree that may affect the style of any of the descendants and we don't know how to optimize
563     // the case to limit the scope. This is expensive and should be avoided.
564     void invalidateStyleForSubtree();
565
566     // Invalidates renderers for the element and all its descendants causing them to be torn down
567     // and rebuild during style resolution. Style is also recomputed. This is used in code dealing with
568     // custom (not style based) renderers. This is expensive and should be avoided.
569     // Elements newly added to the tree are also in this state.
570     void invalidateStyleAndRenderersForSubtree();
571
572     void invalidateStyleInternal();
573     void invalidateStyleForSubtreeInternal();
574
575     bool hasDisplayContents() const;
576     void storeDisplayContentsStyle(std::unique_ptr<RenderStyle>);
577
578     using ContainerNode::setAttributeEventListener;
579     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
580
581 #if ENABLE(INTERSECTION_OBSERVER)
582     IntersectionObserverData& ensureIntersectionObserverData();
583     IntersectionObserverData* intersectionObserverData();
584 #endif
585
586     Element* findAnchorElementForLink(String& outAnchorName);
587
588     ExceptionOr<Ref<WebAnimation>> animate(JSC::ExecState&, JSC::Strong<JSC::JSObject>&&, Optional<Variant<double, KeyframeAnimationOptions>>&&);
589     Vector<RefPtr<WebAnimation>> getAnimations();
590
591 protected:
592     Element(const QualifiedName&, Document&, ConstructionType);
593
594     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
595     void removedFromAncestor(RemovalType, ContainerNode&) override;
596     void childrenChanged(const ChildChange&) override;
597     void removeAllEventListeners() final;
598     virtual void parserDidSetAttributes();
599
600     void clearTabIndexExplicitlyIfNeeded();
601     void setTabIndexExplicitly(int);
602
603     // classAttributeChanged() exists to share code between
604     // parseAttribute (called via setAttribute()) and
605     // svgAttributeChanged (called when element.className.baseValue is set)
606     void classAttributeChanged(const AtomicString& newClassString);
607
608     void addShadowRoot(Ref<ShadowRoot>&&);
609
610     static ExceptionOr<void> mergeWithNextTextNode(Text&);
611
612 #if ENABLE(CSS_TYPED_OM)
613     StylePropertyMap* attributeStyleMap();
614     void setAttributeStyleMap(Ref<StylePropertyMap>&&);
615 #endif
616
617 private:
618     Frame* documentFrameWithNonNullView() const;
619
620     bool isTextNode() const;
621
622     bool isUserActionElementInActiveChain() const;
623     bool isUserActionElementActive() const;
624     bool isUserActionElementFocused() const;
625     bool isUserActionElementHovered() const;
626
627     virtual void didAddUserAgentShadowRoot(ShadowRoot&) { }
628
629     void didAddAttribute(const QualifiedName&, const AtomicString&);
630     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
631     void didModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
632     void didRemoveAttribute(const QualifiedName&, const AtomicString& oldValue);
633
634     void synchronizeAttribute(const QualifiedName&) const;
635     void synchronizeAttribute(const AtomicString& localName) const;
636
637     void updateName(const AtomicString& oldName, const AtomicString& newName);
638     void updateNameForTreeScope(TreeScope&, const AtomicString& oldName, const AtomicString& newName);
639     void updateNameForDocument(HTMLDocument&, const AtomicString& oldName, const AtomicString& newName);
640
641     enum class NotifyObservers { No, Yes };
642     void updateId(const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
643     void updateIdForTreeScope(TreeScope&, const AtomicString& oldId, const AtomicString& newId, NotifyObservers = NotifyObservers::Yes);
644
645     enum HTMLDocumentNamedItemMapsUpdatingCondition { AlwaysUpdateHTMLDocumentNamedItemMaps, UpdateHTMLDocumentNamedItemMapsOnlyIfDiffersFromNameAttribute };
646     void updateIdForDocument(HTMLDocument&, const AtomicString& oldId, const AtomicString& newId, HTMLDocumentNamedItemMapsUpdatingCondition);
647     void updateLabel(TreeScope&, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
648
649     ExceptionOr<Node*> insertAdjacent(const String& where, Ref<Node>&& newChild);
650
651     void scrollByUnits(int units, ScrollGranularity);
652
653     NodeType nodeType() const final;
654     bool childTypeAllowed(NodeType) const final;
655
656     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute, InSynchronizationOfLazyAttribute };
657     void setAttributeInternal(unsigned index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
658     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
659     void removeAttributeInternal(unsigned index, SynchronizationOfLazyAttribute);
660
661     LayoutRect absoluteEventBounds(bool& boundsIncludeAllDescendantElements, bool& includesFixedPositionElements);
662     LayoutRect absoluteEventBoundsOfElementAndDescendants(bool& includesFixedPositionElements);
663     
664 #if ENABLE(TREE_DEBUGGING)
665     void formatForDebugger(char* buffer, unsigned length) const override;
666 #endif
667
668 #if ENABLE(INTERSECTION_OBSERVER)
669     void disconnectFromIntersectionObservers();
670 #endif
671
672     // The cloneNode function is private so that non-virtual cloneElementWith/WithoutChildren are used instead.
673     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
674     virtual Ref<Element> cloneElementWithoutAttributesAndChildren(Document&);
675
676     void removeShadowRoot();
677
678     const RenderStyle& resolveComputedStyle();
679     const RenderStyle& resolvePseudoElementStyle(PseudoId);
680
681     bool rareDataStyleAffectedByEmpty() const;
682     bool rareDataStyleAffectedByFocusWithin() const;
683     bool rareDataChildrenAffectedByHover() const;
684     bool rareDataStyleAffectedByActive() const;
685     bool rareDataChildrenAffectedByDrag() const;
686     bool rareDataChildrenAffectedByLastChildRules() const;
687     bool rareDataChildrenAffectedByForwardPositionalRules() const;
688     bool rareDataDescendantsAffectedByForwardPositionalRules() const;
689     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
690     bool rareDataDescendantsAffectedByBackwardPositionalRules() const;
691     bool rareDataChildrenAffectedByPropertyBasedBackwardPositionalRules() const;
692     unsigned rareDataChildIndex() const;
693
694     SpellcheckAttributeState spellcheckAttributeState() const;
695
696     void createUniqueElementData();
697
698     ElementRareData* elementRareData() const;
699     ElementRareData& ensureElementRareData();
700
701     void detachAllAttrNodesFromElement();
702     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
703
704     // Anyone thinking of using this should call document instead of ownerDocument.
705     void ownerDocument() const = delete;
706     
707     void attachAttributeNodeIfNeeded(Attr&);
708
709     QualifiedName m_tagName;
710     RefPtr<ElementData> m_elementData;
711 };
712
713 inline bool Node::hasAttributes() const
714 {
715     return is<Element>(*this) && downcast<Element>(*this).hasAttributes();
716 }
717
718 inline NamedNodeMap* Node::attributes() const
719 {
720     return is<Element>(*this) ? &downcast<Element>(*this).attributes() : nullptr;
721 }
722
723 inline Element* Node::parentElement() const
724 {
725     ContainerNode* parent = parentNode();
726     return is<Element>(parent) ? downcast<Element>(parent) : nullptr;
727 }
728
729 inline const Element* Element::rootElement() const
730 {
731     if (isConnected())
732         return document().documentElement();
733
734     const Element* highest = this;
735     while (highest->parentElement())
736         highest = highest->parentElement();
737     return highest;
738 }
739
740 inline bool Element::hasAttributeWithoutSynchronization(const QualifiedName& name) const
741 {
742     ASSERT(fastAttributeLookupAllowed(name));
743     return elementData() && findAttributeByName(name);
744 }
745
746 inline const AtomicString& Element::attributeWithoutSynchronization(const QualifiedName& name) const
747 {
748     if (elementData()) {
749         if (const Attribute* attribute = findAttributeByName(name))
750             return attribute->value();
751     }
752     return nullAtom();
753 }
754
755 inline bool Element::hasAttributesWithoutUpdate() const
756 {
757     return elementData() && !elementData()->isEmpty();
758 }
759
760 inline const AtomicString& Element::idForStyleResolution() const
761 {
762     return hasID() ? elementData()->idForStyleResolution() : nullAtom();
763 }
764
765 inline const AtomicString& Element::getIdAttribute() const
766 {
767     if (hasID())
768         return elementData()->findAttributeByName(HTMLNames::idAttr)->value();
769     return nullAtom();
770 }
771
772 inline const AtomicString& Element::getNameAttribute() const
773 {
774     if (hasName())
775         return elementData()->findAttributeByName(HTMLNames::nameAttr)->value();
776     return nullAtom();
777 }
778
779 inline void Element::setIdAttribute(const AtomicString& value)
780 {
781     setAttributeWithoutSynchronization(HTMLNames::idAttr, value);
782 }
783
784 inline const SpaceSplitString& Element::classNames() const
785 {
786     ASSERT(hasClass());
787     ASSERT(elementData());
788     return elementData()->classNames();
789 }
790
791 inline unsigned Element::attributeCount() const
792 {
793     ASSERT(elementData());
794     return elementData()->length();
795 }
796
797 inline const Attribute& Element::attributeAt(unsigned index) const
798 {
799     ASSERT(elementData());
800     return elementData()->attributeAt(index);
801 }
802
803 inline const Attribute* Element::findAttributeByName(const QualifiedName& name) const
804 {
805     ASSERT(elementData());
806     return elementData()->findAttributeByName(name);
807 }
808
809 inline bool Element::hasID() const
810 {
811     return elementData() && elementData()->hasID();
812 }
813
814 inline bool Element::hasClass() const
815 {
816     return elementData() && elementData()->hasClass();
817 }
818
819 inline bool Element::hasName() const
820 {
821     return elementData() && elementData()->hasName();
822 }
823
824 inline UniqueElementData& Element::ensureUniqueElementData()
825 {
826     if (!elementData() || !elementData()->isUnique())
827         createUniqueElementData();
828     return static_cast<UniqueElementData&>(*m_elementData);
829 }
830
831 inline bool shouldIgnoreAttributeCase(const Element& element)
832 {
833     return element.isHTMLElement() && element.document().isHTMLDocument();
834 }
835
836 inline void Element::setHasFocusWithin(bool flag)
837 {
838     if (hasFocusWithin() == flag)
839         return;
840     setFlag(flag, HasFocusWithin);
841     if (styleAffectedByFocusWithin())
842         invalidateStyleForSubtree();
843 }
844
845 template<typename... QualifiedNames>
846 inline const AtomicString& Element::getAttribute(const QualifiedName& name, const QualifiedNames&... names) const
847 {
848     const AtomicString& value = getAttribute(name);
849     if (!value.isNull())
850         return value;
851     return getAttribute(names...);
852 }
853
854 } // namespace WebCore
855
856 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Element)
857     static bool isType(const WebCore::Node& node) { return node.isElementNode(); }
858     static bool isType(const WebCore::EventTarget& target) { return is<WebCore::Node>(target) && isType(downcast<WebCore::Node>(target)); }
859 SPECIALIZE_TYPE_TRAITS_END()