c881725265929faac50de4e8c3757a03c1f2bc0b
[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 "EditingBoundary.h"
29 #include "EventTarget.h"
30 #include "URLHash.h"
31 #include "LayoutRect.h"
32 #include "MutationObserver.h"
33 #include "RenderStyleConstants.h"
34 #include "ScriptWrappable.h"
35 #include "TreeScope.h"
36 #include "TreeShared.h"
37 #include <wtf/Forward.h>
38 #include <wtf/ListHashSet.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         NOTATION_NODE = 12,
141         XPATH_NAMESPACE_NODE = 13,
142     };
143     enum DocumentPosition {
144         DOCUMENT_POSITION_EQUIVALENT = 0x00,
145         DOCUMENT_POSITION_DISCONNECTED = 0x01,
146         DOCUMENT_POSITION_PRECEDING = 0x02,
147         DOCUMENT_POSITION_FOLLOWING = 0x04,
148         DOCUMENT_POSITION_CONTAINS = 0x08,
149         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
150         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
151     };
152
153     static bool isSupported(const String& feature, const String& version);
154
155     WEBCORE_EXPORT static void startIgnoringLeaks();
156     WEBCORE_EXPORT static void stopIgnoringLeaks();
157
158     static void dumpStatistics();
159
160     virtual ~Node();
161     void willBeDeletedFrom(Document&);
162
163     // DOM methods & attributes for Node
164
165     bool hasTagName(const HTMLQualifiedName&) const;
166     bool hasTagName(const MathMLQualifiedName&) const;
167     bool hasTagName(const SVGQualifiedName&) const;
168     virtual String nodeName() const = 0;
169     virtual String nodeValue() const;
170     virtual void setNodeValue(const String&, ExceptionCode&);
171     virtual NodeType nodeType() const = 0;
172     ContainerNode* parentNode() const;
173     static ptrdiff_t parentNodeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_parentNode); }
174     Element* parentElement() const;
175     Node* previousSibling() const { return m_previous; }
176     static ptrdiff_t previousSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_previous); }
177     Node* nextSibling() const { return m_next; }
178     static ptrdiff_t nextSiblingMemoryOffset() { return OBJECT_OFFSETOF(Node, m_next); }
179     PassRefPtr<NodeList> childNodes();
180     Node* firstChild() const;
181     Node* lastChild() const;
182     bool hasAttributes() const;
183     NamedNodeMap* attributes() const;
184     Node* pseudoAwareNextSibling() const;
185     Node* pseudoAwarePreviousSibling() const;
186     Node* pseudoAwareFirstChild() const;
187     Node* pseudoAwareLastChild() const;
188
189     virtual URL baseURI() const;
190     
191     void getSubresourceURLs(ListHashSet<URL>&) const;
192
193     // These should all actually return a node, but this is only important for language bindings,
194     // which will already know and hold a ref on the right node to return. Returning bool allows
195     // these methods to be more efficient since they don't need to return a ref
196     WEBCORE_EXPORT bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&);
197     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&);
198     WEBCORE_EXPORT bool removeChild(Node* child, ExceptionCode&);
199     WEBCORE_EXPORT bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&);
200
201     WEBCORE_EXPORT void remove(ExceptionCode&);
202     bool hasChildNodes() const { return firstChild(); }
203     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
204     virtual const AtomicString& localName() const;
205     virtual const AtomicString& namespaceURI() const;
206     virtual const AtomicString& prefix() const;
207     virtual void setPrefix(const AtomicString&, ExceptionCode&);
208     void normalize();
209
210     bool isSameNode(Node* other) const { return this == other; }
211     bool isEqualNode(Node*) const;
212     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
213     String lookupPrefix(const AtomicString& namespaceURI) const;
214     String lookupNamespaceURI(const String& prefix) const;
215     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
216     
217     WEBCORE_EXPORT String textContent(bool convertBRsToNewlines = false) const;
218     WEBCORE_EXPORT void setTextContent(const String&, ExceptionCode&);
219     
220     Node* lastDescendant() const;
221     Node* firstDescendant() const;
222
223     // Other methods (not part of DOM)
224
225     bool isElementNode() const { return getFlag(IsElementFlag); }
226     bool isContainerNode() const { return getFlag(IsContainerFlag); }
227     bool isTextNode() const { return getFlag(IsTextFlag); }
228     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
229     bool isSVGElement() const { return getFlag(IsSVGFlag); }
230     bool isMathMLElement() const { return getFlag(IsMathMLFlag); }
231
232     bool isPseudoElement() const { return pseudoId() != NOPSEUDO; }
233     bool isBeforePseudoElement() const { return pseudoId() == BEFORE; }
234     bool isAfterPseudoElement() const { return pseudoId() == AFTER; }
235     PseudoId pseudoId() const { return (isElementNode() && hasCustomStyleResolveCallbacks()) ? customPseudoId() : NOPSEUDO; }
236
237     virtual bool isMediaControlElement() const { return false; }
238     virtual bool isMediaControls() const { return false; }
239 #if ENABLE(VIDEO_TRACK)
240     virtual bool isWebVTTElement() const { return false; }
241 #endif
242     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
243     virtual bool isAttributeNode() const { return false; }
244     virtual bool isCharacterDataNode() const { return false; }
245     virtual bool isFrameOwnerElement() const { return false; }
246     virtual bool isPluginElement() const { return false; }
247     virtual bool isInsertionPointNode() const { return false; }
248 #if ENABLE(SERVICE_CONTROLS)
249     virtual bool isImageControlsRootElement() const { return false; }
250     virtual bool isImageControlsButtonElement() const { return false; }
251 #endif
252
253     bool isDocumentNode() const;
254     bool isTreeScope() const;
255     bool isDocumentFragment() const { return getFlag(IsDocumentFragmentFlag); }
256     bool isShadowRoot() const { return isDocumentFragment() && isTreeScope(); }
257     bool isInsertionPoint() const { return getFlag(NeedsNodeRenderingTraversalSlowPathFlag) && isInsertionPointNode(); }
258     // Returns Node rather than InsertionPoint. Should be used only for language bindings.
259     Node* insertionParentForBinding() const;
260
261     bool needsNodeRenderingTraversalSlowPath() const;
262
263     bool isNamedFlowContentNode() const { return getFlag(IsNamedFlowContentNodeFlag); }
264     bool hasCustomStyleResolveCallbacks() const { return getFlag(HasCustomStyleResolveCallbacksFlag); }
265
266     bool hasSyntheticAttrChildNodes() const { return getFlag(HasSyntheticAttrChildNodesFlag); }
267     void setHasSyntheticAttrChildNodes(bool flag) { setFlag(flag, HasSyntheticAttrChildNodesFlag); }
268
269     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns null.
270     Element* shadowHost() const;
271     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
272     // Deprecated. Should use shadowHost() and check the return value.
273     WEBCORE_EXPORT Node* deprecatedShadowAncestorNode() const;
274     ShadowRoot* containingShadowRoot() const;
275     ShadowRoot* shadowRoot() const;
276
277     // Returns null, a child of ShadowRoot, or a legacy shadow root.
278     Node* nonBoundaryShadowTreeRootNode();
279
280     // Node's parent or shadow tree host.
281     ContainerNode* parentOrShadowHostNode() const;
282     Element* parentOrShadowHostElement() const;
283     void setParentNode(ContainerNode*);
284     Node* highestAncestor() const;
285
286     // Use when it's guaranteed to that shadowHost is null.
287     ContainerNode* parentNodeGuaranteedHostFree() const;
288     // Returns the parent node, but null if the parent node is a ShadowRoot.
289     ContainerNode* nonShadowBoundaryParentNode() const;
290
291     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
292     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
293
294     // Returns the enclosing event parent Element (or self) that, when clicked, would trigger a navigation.
295     Element* enclosingLinkEventParentOrSelf();
296
297     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
298     void setPreviousSibling(Node* previous) { m_previous = previous; }
299     void setNextSibling(Node* next) { m_next = next; }
300
301     virtual bool canContainRangeEndPoint() const { return false; }
302
303     bool isRootEditableElement() const;
304     WEBCORE_EXPORT Element* rootEditableElement() const;
305     Element* rootEditableElement(EditableType) const;
306
307     // Called by the parser when this element's close tag is reached,
308     // signaling that all child tags have been parsed and added.
309     // This is needed for <applet> and <object> elements, which can't lay themselves out
310     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
311     // Also used for script elements and some SVG elements for similar purposes,
312     // but making parsing a special case in this respect should be avoided if possible.
313     virtual void finishParsingChildren() { }
314     virtual void beginParsingChildren() { }
315
316     // For <link> and <style> elements.
317     virtual bool sheetLoaded() { return true; }
318     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
319     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
320
321     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
322     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
323
324     bool inRenderedDocument() const;
325     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
326     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
327     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
328     bool styleIsAffectedByPreviousSibling() const { return getFlag(StyleIsAffectedByPreviousSibling); }
329     bool isLink() const { return getFlag(IsLinkFlag); }
330     bool isEditingText() const { return getFlag(IsEditingTextFlag); }
331
332     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
333     void clearChildNeedsStyleRecalc() { m_nodeFlags &= ~(ChildNeedsStyleRecalcFlag | DirectChildNeedsStyleRecalcFlag); }
334
335     WEBCORE_EXPORT void setNeedsStyleRecalc(StyleChangeType = FullStyleChange);
336     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
337
338     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
339     void setIsLink() { setFlag(IsLinkFlag); }
340     void clearIsLink() { clearFlag(IsLinkFlag); }
341
342     void setIsNamedFlowContentNode() { setFlag(IsNamedFlowContentNodeFlag); }
343     void clearIsNamedFlowContentNode() { clearFlag(IsNamedFlowContentNodeFlag); }
344
345     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
346     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
347
348     enum UserSelectAllTreatment {
349         UserSelectAllDoesNotAffectEditability,
350         UserSelectAllIsAlwaysNonEditable
351     };
352     WEBCORE_EXPORT bool isContentEditable(UserSelectAllTreatment = UserSelectAllDoesNotAffectEditability);
353     bool isContentRichlyEditable();
354
355     WEBCORE_EXPORT void inspect();
356
357     WEBCORE_EXPORT bool hasEditableStyle(EditableType editableType = ContentIsEditable, UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
358     {
359         switch (editableType) {
360         case ContentIsEditable:
361             return hasEditableStyle(Editable, treatment);
362         case HasEditableAXRole:
363             return isEditableToAccessibility(Editable);
364         }
365         ASSERT_NOT_REACHED();
366         return false;
367     }
368
369     bool hasRichlyEditableStyle(EditableType editableType = ContentIsEditable) const
370     {
371         switch (editableType) {
372         case ContentIsEditable:
373             return hasEditableStyle(RichlyEditable, UserSelectAllIsAlwaysNonEditable);
374         case HasEditableAXRole:
375             return isEditableToAccessibility(RichlyEditable);
376         }
377         ASSERT_NOT_REACHED();
378         return false;
379     }
380
381     virtual LayoutRect boundingBox() const;
382     IntRect pixelSnappedBoundingBox() const { return snappedIntRect(boundingBox()); }
383     WEBCORE_EXPORT LayoutRect renderRect(bool* isReplaced);
384     IntRect pixelSnappedRenderRect(bool* isReplaced) { return snappedIntRect(renderRect(isReplaced)); }
385
386     WEBCORE_EXPORT unsigned computeNodeIndex() const;
387
388     // Returns the DOM ownerDocument attribute. This method never returns null, except in the case
389     // of a Document node.
390     WEBCORE_EXPORT Document* ownerDocument() const;
391
392     // Returns the document associated with this node.
393     // A Document node returns itself.
394     Document& document() const
395     {
396         ASSERT(this);
397         return treeScope().documentScope();
398     }
399
400     TreeScope& treeScope() const
401     {
402         ASSERT(m_treeScope);
403         return *m_treeScope;
404     }
405     static ptrdiff_t treeScopeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_treeScope); }
406
407     // Returns true if this node is associated with a document and is in its associated document's
408     // node tree, false otherwise.
409     bool inDocument() const 
410     { 
411         return getFlag(InDocumentFlag);
412     }
413     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
414     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(InDocumentFlag | IsInShadowTreeFlag)); }
415
416     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
417     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
418     virtual bool childTypeAllowed(NodeType) const { return false; }
419     unsigned countChildNodes() const;
420     Node* traverseToChildAt(unsigned) const;
421
422     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
423
424     WEBCORE_EXPORT bool isDescendantOf(const Node*) const;
425     bool isDescendantOrShadowDescendantOf(const Node*) const;
426     bool contains(const Node*) const;
427     bool containsIncludingShadowDOM(const Node*) const;
428     bool containsIncludingHostElements(const Node*) const;
429
430     // Used to determine whether range offsets use characters or node indices.
431     virtual bool offsetInCharacters() const;
432     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
433     // css-transform:capitalize breaking up precomposed characters and ligatures.
434     virtual int maxCharacterOffset() const;
435
436     // Whether or not a selection can be started in this object
437     virtual bool canStartSelection() const;
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     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 are another callback named didNotifyDescendantInsertions(), which is called after all the descendant is notified.
478     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallDidNotifyDescendantInsertions
479     // from insrtedInto().
480     //
481     enum InsertionNotificationRequest {
482         InsertionDone,
483         InsertionShouldCallDidNotifySubtreeInsertions
484     };
485
486     virtual InsertionNotificationRequest insertedInto(ContainerNode& insertionPoint);
487     virtual void didNotifySubtreeInsertions(ContainerNode*) { }
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 #ifndef NDEBUG
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
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, PassRefPtr<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     using TreeShared<Node>::ref;
551     using TreeShared<Node>::deref;
552
553     virtual EventTargetData* eventTargetData() override final;
554     virtual EventTargetData& ensureEventTargetData() override final;
555
556     void getRegisteredMutationObserversOfType(HashMap<MutationObserver*, MutationRecordDeliveryOptions>&, MutationObserver::MutationType, const QualifiedName* attributeName);
557     void registerMutationObserver(MutationObserver*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
558     void unregisterMutationObserver(MutationObserverRegistration*);
559     void registerTransientMutationObserver(MutationObserverRegistration*);
560     void unregisterTransientMutationObserver(MutationObserverRegistration*);
561     void notifyMutationObserversNodeWillDetach();
562
563     WEBCORE_EXPORT void textRects(Vector<IntRect>&) const;
564
565     unsigned connectedSubframeCount() const;
566     void incrementConnectedSubframeCount(unsigned amount = 1);
567     void decrementConnectedSubframeCount(unsigned amount = 1);
568     void updateAncestorConnectedSubframeCountForRemoval() const;
569     void updateAncestorConnectedSubframeCountForInsertion() const;
570
571 #if ENABLE(CSS_SELECTOR_JIT)
572     static ptrdiff_t nodeFlagsMemoryOffset() { return OBJECT_OFFSETOF(Node, m_nodeFlags); }
573     static ptrdiff_t rareDataMemoryOffset() { return OBJECT_OFFSETOF(Node, m_data.m_rareData); }
574     static int32_t flagIsText() { return IsTextFlag; }
575     static int32_t flagIsElement() { return IsElementFlag; }
576     static int32_t flagIsHTML() { return IsHTMLFlag; }
577     static int32_t flagIsLink() { return IsLinkFlag; }
578     static int32_t flagHasRareData() { return HasRareDataFlag; }
579     static int32_t flagIsParsingChildrenFinished() { return IsParsingChildrenFinishedFlag; }
580     static int32_t flagChildrenAffectedByFirstChildRulesFlag() { return ChildrenAffectedByFirstChildRulesFlag; }
581     static int32_t flagChildrenAffectedByLastChildRulesFlag() { return ChildrenAffectedByLastChildRulesFlag; }
582
583     static int32_t flagAffectsNextSiblingElementStyle() { return AffectsNextSiblingElementStyle; }
584     static int32_t flagStyleIsAffectedByPreviousSibling() { return StyleIsAffectedByPreviousSibling; }
585 #endif // ENABLE(CSS_SELECTOR_JIT)
586
587 protected:
588     enum NodeFlags {
589         IsTextFlag = 1,
590         IsContainerFlag = 1 << 1,
591         IsElementFlag = 1 << 2,
592         IsStyledElementFlag = 1 << 3,
593         IsHTMLFlag = 1 << 4,
594         IsSVGFlag = 1 << 5,
595         ChildNeedsStyleRecalcFlag = 1 << 7,
596         InDocumentFlag = 1 << 8,
597         IsLinkFlag = 1 << 9,
598         IsUserActionElement = 1 << 10,
599         HasRareDataFlag = 1 << 11,
600         IsDocumentFragmentFlag = 1 << 12,
601
602         // These bits are used by derived classes, pulled up here so they can
603         // be stored in the same memory word as the Node bits above.
604         IsParsingChildrenFinishedFlag = 1 << 13, // Element
605
606         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1) | 1 << (nodeStyleChangeShift + 2),
607         IsEditingTextFlag = 1 << 17,
608         IsNamedFlowContentNodeFlag = 1 << 18,
609         HasSyntheticAttrChildNodesFlag = 1 << 19,
610         HasCustomStyleResolveCallbacksFlag = 1 << 20,
611         HasEventTargetDataFlag = 1 << 21,
612         NeedsNodeRenderingTraversalSlowPathFlag = 1 << 22,
613         IsInShadowTreeFlag = 1 << 23,
614         IsMathMLFlag = 1 << 24,
615
616         ChildrenAffectedByFirstChildRulesFlag = 1 << 25,
617         ChildrenAffectedByLastChildRulesFlag = 1 << 26,
618         ChildrenAffectedByHoverRulesFlag = 1 << 27,
619
620         DirectChildNeedsStyleRecalcFlag = 1 << 28,
621         AffectsNextSiblingElementStyle = 1 << 29,
622         StyleIsAffectedByPreviousSibling = 1 << 30,
623
624         SelfOrAncestorHasDirAutoFlag = 1 << 31,
625
626         DefaultNodeFlags = IsParsingChildrenFinishedFlag
627     };
628
629     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
630     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
631     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
632     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; }
633
634     enum ConstructionType {
635         CreateOther = DefaultNodeFlags,
636         CreateText = DefaultNodeFlags | IsTextFlag,
637         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
638         CreateElement = CreateContainer | IsElementFlag, 
639         CreatePseudoElement =  CreateElement | InDocumentFlag | NeedsNodeRenderingTraversalSlowPathFlag,
640         CreateShadowRoot = CreateContainer | IsDocumentFragmentFlag | NeedsNodeRenderingTraversalSlowPathFlag | IsInShadowTreeFlag,
641         CreateDocumentFragment = CreateContainer | IsDocumentFragmentFlag,
642         CreateStyledElement = CreateElement | IsStyledElementFlag, 
643         CreateHTMLElement = CreateStyledElement | IsHTMLFlag,
644         CreateSVGElement = CreateStyledElement | IsSVGFlag | HasCustomStyleResolveCallbacksFlag,
645         CreateDocument = CreateContainer | InDocumentFlag,
646         CreateInsertionPoint = CreateHTMLElement | NeedsNodeRenderingTraversalSlowPathFlag,
647         CreateEditingText = CreateText | IsEditingTextFlag,
648         CreateMathMLElement = CreateStyledElement | IsMathMLFlag
649     };
650     Node(Document&, ConstructionType);
651
652     virtual void didMoveToNewDocument(Document* oldDocument);
653     
654     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
655
656     bool hasRareData() const { return getFlag(HasRareDataFlag); }
657
658     NodeRareData* rareData() const;
659     NodeRareData& ensureRareData();
660     void clearRareData();
661
662     void clearEventTargetData();
663
664     void setHasCustomStyleResolveCallbacks() { setFlag(true, HasCustomStyleResolveCallbacksFlag); }
665
666     void setNeedsNodeRenderingTraversalSlowPath(bool flag) { setFlag(flag, NeedsNodeRenderingTraversalSlowPathFlag); }
667
668     void setTreeScope(TreeScope& scope) { m_treeScope = &scope; }
669
670     void setStyleChange(StyleChangeType changeType) { m_nodeFlags = (m_nodeFlags & ~StyleChangeMask) | changeType; }
671
672 private:
673     friend class TreeShared<Node>;
674
675     virtual PseudoId customPseudoId() const
676     {
677         ASSERT(hasCustomStyleResolveCallbacks());
678         return NOPSEUDO;
679     }
680
681     WEBCORE_EXPORT void removedLastRef();
682     bool hasTreeSharedParent() const { return !!parentNode(); }
683
684     enum EditableLevel { Editable, RichlyEditable };
685     bool hasEditableStyle(EditableLevel, UserSelectAllTreatment = UserSelectAllIsAlwaysNonEditable) const;
686     WEBCORE_EXPORT bool isEditableToAccessibility(EditableLevel) const;
687
688     virtual void refEventTarget() override;
689     virtual void derefEventTarget() override;
690
691     Element* ancestorElement() const;
692
693     void trackForDebugging();
694     void materializeRareData();
695
696     Vector<std::unique_ptr<MutationObserverRegistration>>* mutationObserverRegistry();
697     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
698
699     mutable uint32_t m_nodeFlags;
700     ContainerNode* m_parentNode;
701     TreeScope* m_treeScope;
702     Node* m_previous;
703     Node* m_next;
704     // When a node has rare data we move the renderer into the rare data.
705     union DataUnion {
706         DataUnion() : m_renderer(0) { }
707         RenderObject* m_renderer;
708         NodeRareDataBase* m_rareData;
709     } m_data;
710
711 protected:
712     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
713     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
714     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
715 };
716
717 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
718 inline void addSubresourceURL(ListHashSet<URL>& urls, const URL& url)
719 {
720     if (!url.isNull())
721         urls.add(url);
722 }
723
724 inline void Node::setParentNode(ContainerNode* parent)
725 {
726     ASSERT(isMainThread());
727     m_parentNode = parent;
728 }
729
730 inline ContainerNode* Node::parentNode() const
731 {
732     ASSERT(isMainThreadOrGCThread());
733     return m_parentNode;
734 }
735
736 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
737 {
738     ASSERT(!isShadowRoot());
739     return parentNode();
740 }
741
742 template <typename ExpectedType, typename ArgType>
743 struct NodeTypeCastTraits {
744     static bool is(ArgType&);
745 };
746
747 template <typename ExpectedType>
748 struct NodeTypeCastTraits<ExpectedType, ExpectedType> {
749     static bool is(ExpectedType&) { return true; }
750 };
751
752 // Type checking function for Nodes, to use before casting with downcast<>().
753 template <typename ExpectedType, typename ArgType>
754 inline bool is(ArgType& node)
755 {
756     static_assert(!std::is_base_of<ExpectedType, ArgType>::value, "Unnecessary type check");
757     return NodeTypeCastTraits<const ExpectedType, const ArgType>::is(node);
758 }
759
760 template <typename ExpectedType, typename ArgType>
761 inline bool is(ArgType* node)
762 {
763     ASSERT(node);
764     static_assert(!std::is_base_of<ExpectedType, ArgType>::value, "Unnecessary type check");
765     return NodeTypeCastTraits<const ExpectedType, const ArgType>::is(*node);
766 }
767
768 // Downcasting functions for Node types.
769 template<typename Target, typename Source>
770 inline typename std::conditional<std::is_const<Source>::value, const Target&, Target&>::type downcast(Source& source)
771 {
772     static_assert(!std::is_base_of<Target, Source>::value, "Unnecessary cast");
773     ASSERT_WITH_SECURITY_IMPLICATION(is<Target>(source));
774     return static_cast<typename std::conditional<std::is_const<Source>::value, const Target&, Target&>::type>(source);
775 }
776 template<typename Target, typename Source> inline typename std::conditional<std::is_const<Source>::value, const Target*, Target*>::type downcast(Source* source)
777 {
778     static_assert(!std::is_base_of<Target, Source>::value, "Unnecessary cast");
779     ASSERT_WITH_SECURITY_IMPLICATION(!source || is<Target>(*source));
780     return static_cast<typename std::conditional<std::is_const<Source>::value, const Target*, Target*>::type>(source);
781 }
782
783 // Add support for type checking / casting using is<>() / downcast<>() helpers for a specific class.
784 #define SPECIALIZE_TYPE_TRAITS_BEGIN(ClassName) \
785     template <typename ArgType> \
786     class NodeTypeCastTraits<const ClassName, ArgType> { \
787     public: \
788         static bool is(ArgType& node) { return is##ClassName(node); } \
789     private:
790
791 #define SPECIALIZE_TYPE_TRAITS_END() \
792     };
793
794 // FIXME: This should be removed and all uses should be replaced with SPECIALIZE_TYPE_TRAITS_*().
795 #define NODE_TYPE_CASTS(ToClassName) \
796     TYPE_CASTS_BASE(ToClassName, Node, node, WebCore::is##ToClassName(*node), WebCore::is##ToClassName(node))
797
798 } // namespace WebCore
799
800 #ifndef NDEBUG
801 // Outside the WebCore namespace for ease of invocation from gdb.
802 void showTree(const WebCore::Node*);
803 void showNodePath(const WebCore::Node*);
804 #endif
805
806 #endif