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