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