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