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