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