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