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