1dbdc75227b62219f45f256f00fbbbd00a4e037c
[WebKit-https.git] / Source / WebCore / dom / Node.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
6  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
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 Node_h
26 #define Node_h
27
28 #include "EventTarget.h"
29 #include "URLHash.h"
30 #include "LayoutRect.h"
31 #include "MutationObserver.h"
32 #include "RenderStyleConstants.h"
33 #include "TreeScope.h"
34 #include <wtf/Forward.h>
35 #include <wtf/ListHashSet.h>
36 #include <wtf/MainThread.h>
37 #include <wtf/TypeCasts.h>
38
39 // This needs to be here because Document.h also depends on it.
40 #define DUMP_NODE_STATISTICS 0
41
42 namespace WebCore {
43
44 class ContainerNode;
45 class Document;
46 class Element;
47 class FloatPoint;
48 class HTMLQualifiedName;
49 class HTMLSlotElement;
50 class MathMLQualifiedName;
51 class NamedNodeMap;
52 class NodeList;
53 class NodeListsNodeData;
54 class NodeOrString;
55 class NodeRareData;
56 class QualifiedName;
57 class RenderBox;
58 class RenderBoxModelObject;
59 class RenderObject;
60 class RenderStyle;
61 class SVGQualifiedName;
62 class ShadowRoot;
63 class TouchEvent;
64 class UIRequestEvent;
65
66 const int nodeStyleChangeShift = 14;
67
68 // SyntheticStyleChange means that we need to go through the entire style change logic even though
69 // no style property has actually changed. It is used to restructure the tree when, for instance,
70 // RenderLayers are created or destroyed due to animation changes.
71 enum StyleChangeType { 
72     NoStyleChange = 0, 
73     InlineStyleChange = 1 << nodeStyleChangeShift, 
74     FullStyleChange = 2 << nodeStyleChangeShift, 
75     SyntheticStyleChange = 3 << nodeStyleChangeShift,
76     ReconstructRenderTree = 4 << nodeStyleChangeShift,
77 };
78
79 class NodeRareDataBase {
80 public:
81     RenderObject* renderer() const { return m_renderer; }
82     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
83
84 protected:
85     NodeRareDataBase(RenderObject* renderer)
86         : m_renderer(renderer)
87     { }
88
89 private:
90     RenderObject* m_renderer;
91 };
92
93 class Node : public EventTarget {
94     WTF_MAKE_FAST_ALLOCATED;
95
96     friend class Document;
97     friend class TreeScope;
98     friend class TreeScopeAdopter;
99 public:
100     enum NodeType {
101         ELEMENT_NODE = 1,
102         ATTRIBUTE_NODE = 2,
103         TEXT_NODE = 3,
104         CDATA_SECTION_NODE = 4,
105         PROCESSING_INSTRUCTION_NODE = 7,
106         COMMENT_NODE = 8,
107         DOCUMENT_NODE = 9,
108         DOCUMENT_TYPE_NODE = 10,
109         DOCUMENT_FRAGMENT_NODE = 11,
110     };
111     enum DeprecatedNodeType {
112         ENTITY_REFERENCE_NODE = 5,
113         ENTITY_NODE = 6,
114         NOTATION_NODE = 12,
115     };
116     enum DocumentPosition {
117         DOCUMENT_POSITION_EQUIVALENT = 0x00,
118         DOCUMENT_POSITION_DISCONNECTED = 0x01,
119         DOCUMENT_POSITION_PRECEDING = 0x02,
120         DOCUMENT_POSITION_FOLLOWING = 0x04,
121         DOCUMENT_POSITION_CONTAINS = 0x08,
122         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
123         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
124     };
125
126     // Only used by ObjC / GObject bindings.
127     static bool isSupportedForBindings(const String& feature, const String& version);
128
129     WEBCORE_EXPORT static void startIgnoringLeaks();
130     WEBCORE_EXPORT static void stopIgnoringLeaks();
131
132     static void dumpStatistics();
133
134     virtual ~Node();
135     void willBeDeletedFrom(Document&);
136
137     // DOM methods & attributes for Node
138
139     bool hasTagName(const HTMLQualifiedName&) const;
140     bool hasTagName(const MathMLQualifiedName&) const;
141     bool hasTagName(const SVGQualifiedName&) const;
142     virtual String nodeName() const = 0;
143     virtual String nodeValue() const;
144     virtual void setNodeValue(const String&, ExceptionCode&);
145     virtual NodeType nodeType() const = 0;
146     ContainerNode* parentNode() const;
147     static ptrdiff_t parentNodeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_parentNode); }
148     Element* parentElement() const;
149     Node* previousSibling() const { return m_previous; }
150     static ptrdiff_t previousSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_previous); }
151     Node* nextSibling() const { return m_next; }
152     static ptrdiff_t nextSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_next); }
153     RefPtr<NodeList> childNodes();
154     Node* firstChild() const;
155     Node* lastChild() const;
156     bool hasAttributes() const;
157     NamedNodeMap* attributes() const;
158     Node* pseudoAwareNextSibling() const;
159     Node* pseudoAwarePreviousSibling() const;
160     Node* pseudoAwareFirstChild() const;
161     Node* pseudoAwareLastChild() const;
162
163     URL baseURI() const;
164     
165     void getSubresourceURLs(ListHashSet<URL>&) const;
166
167     // These should all actually return a node, but this is only important for language bindings,
168     // which will already know and hold a ref on the right node to return. Returning bool allows
169     // these methods to be more efficient since they don't need to return a ref
170     WEBCORE_EXPORT bool insertBefore(Node& newChild, Node* refChild, ExceptionCode&);
171     bool replaceChild(Node& newChild, Node& oldChild, ExceptionCode&);
172     WEBCORE_EXPORT bool removeChild(Node& child, ExceptionCode&);
173     WEBCORE_EXPORT bool appendChild(Node& newChild, ExceptionCode&);
174
175     bool hasChildNodes() const { return firstChild(); }
176
177     enum class CloningOperation {
178         OnlySelf,
179         SelfWithTemplateContent,
180         Everything,
181     };
182     virtual Ref<Node> cloneNodeInternal(Document&, CloningOperation) = 0;
183     Ref<Node> cloneNode(bool deep) { return cloneNodeInternal(document(), deep ? CloningOperation::Everything : CloningOperation::OnlySelf); }
184     RefPtr<Node> cloneNodeForBindings(bool deep, ExceptionCode&);
185
186     virtual const AtomicString& localName() const;
187     virtual const AtomicString& namespaceURI() const;
188     virtual const AtomicString& prefix() const;
189     virtual void setPrefix(const AtomicString&, ExceptionCode&);
190     void normalize();
191
192     bool isSameNode(Node* other) const { return this == other; }
193     bool isEqualNode(Node*) const;
194     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
195     String lookupPrefix(const AtomicString& namespaceURI) const;
196     String lookupNamespaceURI(const String& prefix) const;
197     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
198     
199     WEBCORE_EXPORT String textContent(bool convertBRsToNewlines = false) const;
200     WEBCORE_EXPORT void setTextContent(const String&, ExceptionCode&);
201     
202     Node* lastDescendant() const;
203     Node* firstDescendant() const;
204
205     // From the NonDocumentTypeChildNode - https://dom.spec.whatwg.org/#nondocumenttypechildnode
206     Element* previousElementSibling() const;
207     Element* nextElementSibling() const;
208
209     // From the ChildNode - https://dom.spec.whatwg.org/#childnode
210     void before(Vector<NodeOrString>&&, ExceptionCode&);
211     void after(Vector<NodeOrString>&&, ExceptionCode&);
212     void replaceWith(Vector<NodeOrString>&&, ExceptionCode&);
213     WEBCORE_EXPORT void remove(ExceptionCode&);
214
215     // Other methods (not part of DOM)
216
217     bool isElementNode() const { return getFlag(IsElementFlag); }
218     bool isContainerNode() const { return getFlag(IsContainerFlag); }
219     bool isTextNode() const { return getFlag(IsTextFlag); }
220     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
221     bool isSVGElement() const { return getFlag(IsSVGFlag); }
222     bool isMathMLElement() const { return getFlag(IsMathMLFlag); }
223
224     bool isPseudoElement() const { return pseudoId() != NOPSEUDO; }
225     bool isBeforePseudoElement() const { return pseudoId() == BEFORE; }
226     bool isAfterPseudoElement() const { return pseudoId() == AFTER; }
227     PseudoId pseudoId() const { return (isElementNode() && hasCustomStyleResolveCallbacks()) ? customPseudoId() : NOPSEUDO; }
228
229     virtual bool isMediaControlElement() const { return false; }
230     virtual bool isMediaControls() const { return false; }
231 #if ENABLE(VIDEO_TRACK)
232     virtual bool isWebVTTElement() const { return false; }
233 #endif
234     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
235     virtual bool isAttributeNode() const { return false; }
236     virtual bool isCharacterDataNode() const { return false; }
237     virtual bool isFrameOwnerElement() const { return false; }
238     virtual bool isPluginElement() const { return false; }
239 #if ENABLE(SERVICE_CONTROLS)
240     virtual bool isImageControlsRootElement() const { return false; }
241     virtual bool isImageControlsButtonElement() const { return false; }
242 #endif
243
244     bool isDocumentNode() const;
245     bool isTreeScope() const;
246     bool isDocumentFragment() const { return getFlag(IsDocumentFragmentFlag); }
247     bool isShadowRoot() const { return isDocumentFragment() && isTreeScope(); }
248
249     bool isNamedFlowContentNode() const { return getFlag(IsNamedFlowContentNodeFlag); }
250     bool hasCustomStyleResolveCallbacks() const { return getFlag(HasCustomStyleResolveCallbacksFlag); }
251
252     bool hasSyntheticAttrChildNodes() const { return getFlag(HasSyntheticAttrChildNodesFlag); }
253     void setHasSyntheticAttrChildNodes(bool flag) { setFlag(flag, HasSyntheticAttrChildNodesFlag); }
254
255     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns null.
256     WEBCORE_EXPORT Element* shadowHost() const;
257     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
258     // Deprecated. Should use shadowHost() and check the return value.
259     WEBCORE_EXPORT Node* deprecatedShadowAncestorNode() const;
260     ShadowRoot* containingShadowRoot() const;
261     ShadowRoot* shadowRoot() const;
262     bool isUnclosedNode(const Node&) const;
263
264 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
265     HTMLSlotElement* assignedSlot() const;
266     HTMLSlotElement* assignedSlotForBindings() const;
267 #endif
268
269 #if ENABLE(CUSTOM_ELEMENTS)
270     bool isCustomElement() const { return getFlag(IsCustomElement); }
271     void setIsCustomElement() { setFlag(IsCustomElement); }
272
273     bool isUnresolvedCustomElement() const { return isElementNode() && getFlag(IsEditingTextOrUnresolvedCustomElementFlag); }
274     void setIsUnresolvedCustomElement() { setFlag(IsEditingTextOrUnresolvedCustomElementFlag); }
275     void setCustomElementIsResolved();
276 #endif
277
278     // Returns null, a child of ShadowRoot, or a legacy shadow root.
279     Node* nonBoundaryShadowTreeRootNode();
280
281     // Node's parent or shadow tree host.
282     ContainerNode* parentOrShadowHostNode() const;
283     ContainerNode* parentInComposedTree() const;
284     Element* parentOrShadowHostElement() const;
285     void setParentNode(ContainerNode*);
286     Node* rootNode() const;
287
288     // Use when it's guaranteed to that shadowHost is null.
289     ContainerNode* parentNodeGuaranteedHostFree() const;
290     // Returns the parent node, but null if the parent node is a ShadowRoot.
291     ContainerNode* nonShadowBoundaryParentNode() const;
292
293     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
294     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
295
296     // Returns the enclosing event parent Element (or self) that, when clicked, would trigger a navigation.
297     Element* enclosingLinkEventParentOrSelf();
298
299     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
300     void setPreviousSibling(Node* previous) { m_previous = previous; }
301     void setNextSibling(Node* next) { m_next = next; }
302
303     virtual bool canContainRangeEndPoint() const { return false; }
304
305     bool isRootEditableElement() const;
306     WEBCORE_EXPORT Element* rootEditableElement() const;
307
308     // Called by the parser when this element's close tag is reached,
309     // signaling that all child tags have been parsed and added.
310     // This is needed for <applet> and <object> elements, which can't lay themselves out
311     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
312     // Also used for script elements and some SVG elements for similar purposes,
313     // but making parsing a special case in this respect should be avoided if possible.
314     virtual void finishParsingChildren() { }
315     virtual void beginParsingChildren() { }
316
317     // For <link> and <style> elements.
318     virtual bool sheetLoaded() { return true; }
319     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
320     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
321
322     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
323     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
324
325     bool inRenderedDocument() const;
326     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
327     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
328     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
329     bool styleIsAffectedByPreviousSibling() const { return getFlag(StyleIsAffectedByPreviousSibling); }
330     bool isEditingText() const { return getFlag(IsTextFlag) && getFlag(IsEditingTextOrUnresolvedCustomElementFlag); }
331
332     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
333     void clearChildNeedsStyleRecalc() { m_nodeFlags &= ~(ChildNeedsStyleRecalcFlag | DirectChildNeedsStyleRecalcFlag); }
334
335     WEBCORE_EXPORT void setNeedsStyleRecalc(StyleChangeType = FullStyleChange);
336     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
337
338     bool isLink() const { return getFlag(IsLinkFlag); }
339     void setIsLink(bool flag) { setFlag(flag, IsLinkFlag); }
340
341     void setIsNamedFlowContentNode() { setFlag(IsNamedFlowContentNodeFlag); }
342     void clearIsNamedFlowContentNode() { clearFlag(IsNamedFlowContentNodeFlag); }
343
344     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
345     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
346
347     enum UserSelectAllTreatment {
348         UserSelectAllDoesNotAffectEditability,
349         UserSelectAllIsAlwaysNonEditable
350     };
351     WEBCORE_EXPORT bool isContentEditable();
352     bool isContentRichlyEditable();
353
354     WEBCORE_EXPORT void inspect();
355
356     bool hasEditableStyle(UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
357     {
358         return computeEditability(treatment, ShouldUpdateStyle::DoNotUpdate) != Editability::ReadOnly;
359     }
360     // FIXME: Replace every use of this function by helpers in htmlediting.h
361     bool hasRichlyEditableStyle() const
362     {
363         return computeEditability(UserSelectAllIsAlwaysNonEditable, ShouldUpdateStyle::DoNotUpdate) == Editability::CanEditRichly;
364     }
365
366     enum class Editability { ReadOnly, CanEditPlainText, CanEditRichly };
367     enum class ShouldUpdateStyle { Update, DoNotUpdate };
368     WEBCORE_EXPORT Editability computeEditability(UserSelectAllTreatment, ShouldUpdateStyle) const;
369
370     WEBCORE_EXPORT LayoutRect renderRect(bool* isReplaced);
371     IntRect pixelSnappedRenderRect(bool* isReplaced) { return snappedIntRect(renderRect(isReplaced)); }
372
373     WEBCORE_EXPORT unsigned computeNodeIndex() const;
374
375     // Returns the DOM ownerDocument attribute. This method never returns null, except in the case
376     // of a Document node.
377     WEBCORE_EXPORT Document* ownerDocument() const;
378
379     // Returns the document associated with this node.
380     // A Document node returns itself.
381     Document& document() const
382     {
383         return treeScope().documentScope();
384     }
385
386     TreeScope& treeScope() const
387     {
388         ASSERT(m_treeScope);
389         return *m_treeScope;
390     }
391     static ptrdiff_t treeScopeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_treeScope); }
392
393     // Returns true if this node is associated with a document and is in its associated document's
394     // node tree, false otherwise.
395     bool inDocument() const 
396     { 
397         return getFlag(InDocumentFlag);
398     }
399     bool isInUserAgentShadowTree() const;
400     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
401     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(InDocumentFlag | IsInShadowTreeFlag)); }
402
403     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
404     virtual bool childTypeAllowed(NodeType) const { return false; }
405     unsigned countChildNodes() const;
406     Node* traverseToChildAt(unsigned) const;
407
408     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
409
410     WEBCORE_EXPORT bool isDescendantOf(const Node*) const;
411     bool isDescendantOrShadowDescendantOf(const Node*) const;
412     bool contains(const Node*) const;
413     bool containsIncludingShadowDOM(const Node*) const;
414     bool containsIncludingHostElements(const Node*) const;
415
416     // Used to determine whether range offsets use characters or node indices.
417     virtual bool offsetInCharacters() const;
418     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
419     // css-transform:capitalize breaking up precomposed characters and ligatures.
420     virtual int maxCharacterOffset() const;
421
422     // Whether or not a selection can be started in this object
423     virtual bool canStartSelection() const;
424
425     virtual bool shouldSelectOnMouseDown() { return false; }
426
427     // Getting points into and out of screen space
428     FloatPoint convertToPage(const FloatPoint&) const;
429     FloatPoint convertFromPage(const FloatPoint&) const;
430
431     // -----------------------------------------------------------------------------
432     // Integration with rendering tree
433
434     // As renderer() includes a branch you should avoid calling it repeatedly in hot code paths.
435     RenderObject* renderer() const { return hasRareData() ? m_data.m_rareData->renderer() : m_data.m_renderer; };
436     void setRenderer(RenderObject* renderer)
437     {
438         if (hasRareData())
439             m_data.m_rareData->setRenderer(renderer);
440         else
441             m_data.m_renderer = renderer;
442     }
443
444     // Use these two methods with caution.
445     WEBCORE_EXPORT RenderBox* renderBox() const;
446     RenderBoxModelObject* renderBoxModelObject() const;
447     
448     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
449     const RenderStyle* renderStyle() const;
450
451     virtual const RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO);
452
453     // -----------------------------------------------------------------------------
454     // Notification of document structure changes (see ContainerNode.h for more notification methods)
455     //
456     // At first, WebKit notifies the node that it has been inserted into the document. This is called during document parsing, and also
457     // when a node is added through the DOM methods insertBefore(), appendChild() or replaceChild(). The call happens _after_ the node has been added to the tree.
458     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
459     // dispatching.
460     //
461     // WebKit notifies this callback regardless if the subtree of the node is a document tree or a floating subtree.
462     // Implementation can determine the type of subtree by seeing insertionPoint->inDocument().
463     // For a performance reason, notifications are delivered only to ContainerNode subclasses if the insertionPoint is out of document.
464     //
465     // There is another callback named finishedInsertingSubtree(), which is called after all descendants are notified.
466     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallFinishedInsertingSubtree
467     // from insrtedInto().
468     //
469     enum InsertionNotificationRequest {
470         InsertionDone,
471         InsertionShouldCallFinishedInsertingSubtree
472     };
473
474     virtual InsertionNotificationRequest insertedInto(ContainerNode& insertionPoint);
475     virtual void finishedInsertingSubtree() { }
476
477     // Notifies the node that it is no longer part of the tree.
478     //
479     // This is a dual of insertedInto(), and is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
480     // dispatching, and is called _after_ the node is removed from the tree.
481     //
482     virtual void removedFrom(ContainerNode& insertionPoint);
483
484 #if ENABLE(TREE_DEBUGGING)
485     virtual void formatForDebugger(char* buffer, unsigned length) const;
486
487     void showNode(const char* prefix = "") const;
488     void showTreeForThis() const;
489     void showNodePathForThis() const;
490     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = nullptr, const char* markedLabel2 = nullptr) const;
491     void showTreeForThisAcrossFrame() const;
492 #endif // ENABLE(TREE_DEBUGGING)
493
494     void invalidateNodeListAndCollectionCachesInAncestors(const QualifiedName* attrName = nullptr, Element* attributeOwnerElement = nullptr);
495     NodeListsNodeData* nodeLists();
496     void clearNodeLists();
497
498     virtual bool willRespondToMouseMoveEvents();
499     virtual bool willRespondToMouseClickEvents();
500     virtual bool willRespondToMouseWheelEvents();
501
502     WEBCORE_EXPORT unsigned short compareDocumentPosition(Node*);
503
504     Node* toNode() override;
505
506     EventTargetInterface eventTargetInterface() const override;
507     ScriptExecutionContext* scriptExecutionContext() const final; // Implemented in Document.h
508
509     bool addEventListener(const AtomicString& eventType, RefPtr<EventListener>&&, bool useCapture) override;
510     bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) override;
511
512     using EventTarget::dispatchEvent;
513     bool dispatchEvent(Event&) override;
514
515     void dispatchScopedEvent(Event&);
516
517     virtual void handleLocalEvents(Event&);
518
519     void dispatchSubtreeModifiedEvent();
520     bool dispatchDOMActivateEvent(int detail, PassRefPtr<Event> underlyingEvent);
521
522 #if ENABLE(TOUCH_EVENTS)
523     virtual bool allowsDoubleTapGesture() const { return true; }
524 #endif
525
526 #if ENABLE(TOUCH_EVENTS) && !PLATFORM(IOS)
527     bool dispatchTouchEvent(TouchEvent&);
528 #endif
529 #if ENABLE(INDIE_UI)
530     bool dispatchUIRequestEvent(UIRequestEvent&);
531 #endif
532
533     bool dispatchBeforeLoadEvent(const String& sourceURL);
534
535     virtual void dispatchInputEvent();
536
537     // Perform the default action for an event.
538     virtual void defaultEventHandler(Event*);
539
540     void ref();
541     void deref();
542     bool hasOneRef() const;
543     int refCount() const;
544
545 #ifndef NDEBUG
546     bool m_deletionHasBegun { false };
547     bool m_inRemovedLastRefFunction { false };
548     bool m_adoptionIsRequired { true };
549 #endif
550
551     EventTargetData* eventTargetData() final;
552     EventTargetData& ensureEventTargetData() final;
553
554     void getRegisteredMutationObserversOfType(HashMap<MutationObserver*, MutationRecordDeliveryOptions>&, MutationObserver::MutationType, const QualifiedName* attributeName);
555     void registerMutationObserver(MutationObserver*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
556     void unregisterMutationObserver(MutationObserverRegistration*);
557     void registerTransientMutationObserver(MutationObserverRegistration*);
558     void unregisterTransientMutationObserver(MutationObserverRegistration*);
559     void notifyMutationObserversNodeWillDetach();
560
561     WEBCORE_EXPORT void textRects(Vector<IntRect>&) const;
562
563     unsigned connectedSubframeCount() const;
564     void incrementConnectedSubframeCount(unsigned amount = 1);
565     void decrementConnectedSubframeCount(unsigned amount = 1);
566     void updateAncestorConnectedSubframeCountForRemoval() const;
567     void updateAncestorConnectedSubframeCountForInsertion() const;
568
569 #if ENABLE(CSS_SELECTOR_JIT)
570     static ptrdiff_t nodeFlagsMemoryOffset() { return OBJECT_OFFSETOF(Node, m_nodeFlags); }
571     static ptrdiff_t rareDataMemoryOffset() { return OBJECT_OFFSETOF(Node, m_data.m_rareData); }
572     static int32_t flagIsText() { return IsTextFlag; }
573     static int32_t flagIsElement() { return IsElementFlag; }
574     static int32_t flagIsHTML() { return IsHTMLFlag; }
575     static int32_t flagIsLink() { return IsLinkFlag; }
576     static int32_t flagHasRareData() { return HasRareDataFlag; }
577     static int32_t flagIsParsingChildrenFinished() { return IsParsingChildrenFinishedFlag; }
578     static int32_t flagChildrenAffectedByFirstChildRulesFlag() { return ChildrenAffectedByFirstChildRulesFlag; }
579     static int32_t flagChildrenAffectedByLastChildRulesFlag() { return ChildrenAffectedByLastChildRulesFlag; }
580
581     static int32_t flagAffectsNextSiblingElementStyle() { return AffectsNextSiblingElementStyle; }
582     static int32_t flagStyleIsAffectedByPreviousSibling() { return StyleIsAffectedByPreviousSibling; }
583 #endif // ENABLE(CSS_SELECTOR_JIT)
584
585 protected:
586     enum NodeFlags {
587         IsTextFlag = 1,
588         IsContainerFlag = 1 << 1,
589         IsElementFlag = 1 << 2,
590         IsStyledElementFlag = 1 << 3,
591         IsHTMLFlag = 1 << 4,
592         IsSVGFlag = 1 << 5,
593         ChildNeedsStyleRecalcFlag = 1 << 7,
594         InDocumentFlag = 1 << 8,
595         IsLinkFlag = 1 << 9,
596         IsUserActionElement = 1 << 10,
597         HasRareDataFlag = 1 << 11,
598         IsDocumentFragmentFlag = 1 << 12,
599
600         // These bits are used by derived classes, pulled up here so they can
601         // be stored in the same memory word as the Node bits above.
602         IsParsingChildrenFinishedFlag = 1 << 13, // Element
603
604         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1) | 1 << (nodeStyleChangeShift + 2),
605         IsEditingTextOrUnresolvedCustomElementFlag = 1 << 17,
606         IsNamedFlowContentNodeFlag = 1 << 18,
607         HasSyntheticAttrChildNodesFlag = 1 << 19,
608         HasCustomStyleResolveCallbacksFlag = 1 << 20,
609         HasEventTargetDataFlag = 1 << 21,
610         IsCustomElement = 1 << 22,
611         IsInShadowTreeFlag = 1 << 23,
612         IsMathMLFlag = 1 << 24,
613
614         ChildrenAffectedByFirstChildRulesFlag = 1 << 25,
615         ChildrenAffectedByLastChildRulesFlag = 1 << 26,
616         ChildrenAffectedByHoverRulesFlag = 1 << 27,
617
618         DirectChildNeedsStyleRecalcFlag = 1 << 28,
619         AffectsNextSiblingElementStyle = 1 << 29,
620         StyleIsAffectedByPreviousSibling = 1 << 30,
621
622         SelfOrAncestorHasDirAutoFlag = 1 << 31,
623
624         DefaultNodeFlags = IsParsingChildrenFinishedFlag
625     };
626
627     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
628     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
629     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
630     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; }
631
632     enum ConstructionType {
633         CreateOther = DefaultNodeFlags,
634         CreateText = DefaultNodeFlags | IsTextFlag,
635         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
636         CreateElement = CreateContainer | IsElementFlag, 
637         CreatePseudoElement =  CreateElement | InDocumentFlag,
638         CreateShadowRoot = CreateContainer | IsDocumentFragmentFlag | IsInShadowTreeFlag,
639         CreateDocumentFragment = CreateContainer | IsDocumentFragmentFlag,
640         CreateStyledElement = CreateElement | IsStyledElementFlag, 
641         CreateHTMLElement = CreateStyledElement | IsHTMLFlag,
642         CreateSVGElement = CreateStyledElement | IsSVGFlag | HasCustomStyleResolveCallbacksFlag,
643         CreateDocument = CreateContainer | InDocumentFlag,
644         CreateEditingText = CreateText | IsEditingTextOrUnresolvedCustomElementFlag,
645         CreateMathMLElement = CreateStyledElement | IsMathMLFlag
646     };
647     Node(Document&, ConstructionType);
648
649     virtual void didMoveToNewDocument(Document* oldDocument);
650     
651     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
652
653     bool hasRareData() const { return getFlag(HasRareDataFlag); }
654
655     NodeRareData* rareData() const;
656     NodeRareData& ensureRareData();
657     void clearRareData();
658
659     void clearEventTargetData();
660
661     void setHasCustomStyleResolveCallbacks() { setFlag(true, HasCustomStyleResolveCallbacksFlag); }
662
663     void setTreeScope(TreeScope& scope) { m_treeScope = &scope; }
664
665     void setStyleChange(StyleChangeType changeType) { m_nodeFlags = (m_nodeFlags & ~StyleChangeMask) | changeType; }
666     void updateAncestorsForStyleRecalc();
667
668 private:
669     virtual PseudoId customPseudoId() const
670     {
671         ASSERT(hasCustomStyleResolveCallbacks());
672         return NOPSEUDO;
673     }
674
675     WEBCORE_EXPORT void removedLastRef();
676
677     void refEventTarget() override;
678     void derefEventTarget() override;
679
680     void trackForDebugging();
681     void materializeRareData();
682
683     Vector<std::unique_ptr<MutationObserverRegistration>>* mutationObserverRegistry();
684     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
685
686     int m_refCount;
687     mutable uint32_t m_nodeFlags;
688
689     ContainerNode* m_parentNode { nullptr };
690     TreeScope* m_treeScope { nullptr };
691     Node* m_previous { nullptr };
692     Node* m_next { nullptr };
693     // When a node has rare data we move the renderer into the rare data.
694     union DataUnion {
695         RenderObject* m_renderer;
696         NodeRareDataBase* m_rareData;
697     } m_data { nullptr };
698
699 protected:
700     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
701     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
702     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
703 };
704
705 #ifndef NDEBUG
706 inline void adopted(Node* node)
707 {
708     if (!node)
709         return;
710     ASSERT(!node->m_deletionHasBegun);
711     ASSERT(!node->m_inRemovedLastRefFunction);
712     node->m_adoptionIsRequired = false;
713 }
714 #endif
715
716 ALWAYS_INLINE void Node::ref()
717 {
718     ASSERT(isMainThread());
719     ASSERT(!m_deletionHasBegun);
720     ASSERT(!m_inRemovedLastRefFunction);
721     ASSERT(!m_adoptionIsRequired);
722     ++m_refCount;
723 }
724
725 ALWAYS_INLINE void Node::deref()
726 {
727     ASSERT(isMainThread());
728     ASSERT(m_refCount >= 0);
729     ASSERT(!m_deletionHasBegun);
730     ASSERT(!m_inRemovedLastRefFunction);
731     ASSERT(!m_adoptionIsRequired);
732     if (--m_refCount <= 0 && !parentNode()) {
733 #ifndef NDEBUG
734         m_inRemovedLastRefFunction = true;
735 #endif
736         removedLastRef();
737     }
738 }
739
740 ALWAYS_INLINE bool Node::hasOneRef() const
741 {
742     ASSERT(!m_deletionHasBegun);
743     ASSERT(!m_inRemovedLastRefFunction);
744     return m_refCount == 1;
745 }
746
747 ALWAYS_INLINE int Node::refCount() const
748 {
749     return m_refCount;
750 }
751
752 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
753 inline void addSubresourceURL(ListHashSet<URL>& urls, const URL& url)
754 {
755     if (!url.isNull())
756         urls.add(url);
757 }
758
759 inline void Node::setParentNode(ContainerNode* parent)
760 {
761     ASSERT(isMainThread());
762     m_parentNode = parent;
763 }
764
765 inline ContainerNode* Node::parentNode() const
766 {
767     ASSERT(isMainThreadOrGCThread());
768     return m_parentNode;
769 }
770
771 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
772 {
773     ASSERT(!isShadowRoot());
774     return parentNode();
775 }
776
777 #if ENABLE(CUSTOM_ELEMENTS)
778
779 inline void Node::setCustomElementIsResolved()
780 {
781     clearFlag(IsEditingTextOrUnresolvedCustomElementFlag);
782     setFlag(IsCustomElement);
783 }
784
785 #endif
786
787 } // namespace WebCore
788
789 #if ENABLE(TREE_DEBUGGING)
790 // Outside the WebCore namespace for ease of invocation from gdb.
791 void showTree(const WebCore::Node*);
792 void showNodePath(const WebCore::Node*);
793 #endif
794
795 #endif