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