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