Simplify and clarify MutationObserverRegistration interface and usage
[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 "FractionalLayoutRect.h"
31 #include "KURLHash.h"
32 #include "LayoutTypes.h"
33 #include "MutationObserver.h"
34 #include "RenderStyleConstants.h"
35 #include "ScriptWrappable.h"
36 #include "TreeShared.h"
37 #include <wtf/Forward.h>
38 #include <wtf/ListHashSet.h>
39 #include <wtf/text/AtomicString.h>
40
41 #if USE(JSC)
42 namespace JSC {
43     class JSGlobalData;
44     class SlotVisitor;
45 }
46 #endif
47
48 // This needs to be here because Document.h also depends on it.
49 #define DUMP_NODE_STATISTICS 0
50
51 namespace WebCore {
52
53 class Attribute;
54 class ClassNodeList;
55 class ContainerNode;
56 class DOMSettableTokenList;
57 class Document;
58 class DynamicSubtreeNodeList;
59 class Element;
60 class Event;
61 class EventContext;
62 class EventDispatchMediator;
63 class EventListener;
64 class FloatPoint;
65 class Frame;
66 class HTMLInputElement;
67 class IntRect;
68 class KeyboardEvent;
69 class NSResolver;
70 class NamedNodeMap;
71 class NameNodeList;
72 class NodeList;
73 class NodeListsNodeData;
74 class NodeRareData;
75 class NodeRenderingContext;
76 class PlatformKeyboardEvent;
77 class PlatformMouseEvent;
78 class PlatformWheelEvent;
79 class QualifiedName;
80 class RadioNodeList;
81 class RegisteredEventListener;
82 class RenderArena;
83 class RenderBox;
84 class RenderBoxModelObject;
85 class RenderObject;
86 class RenderStyle;
87 class ShadowRoot;
88 class TagNodeList;
89 class TreeScope;
90
91 #if ENABLE(GESTURE_EVENTS)
92 class PlatformGestureEvent;
93 #endif
94
95 #if ENABLE(MICRODATA)
96 class HTMLPropertiesCollection;
97 class PropertyNodeList;
98 #endif
99
100 typedef int ExceptionCode;
101
102 const int nodeStyleChangeShift = 20;
103
104 // SyntheticStyleChange means that we need to go through the entire style change logic even though
105 // no style property has actually changed. It is used to restructure the tree when, for instance,
106 // RenderLayers are created or destroyed due to animation changes.
107 enum StyleChangeType { 
108     NoStyleChange = 0, 
109     InlineStyleChange = 1 << nodeStyleChangeShift, 
110     FullStyleChange = 2 << nodeStyleChangeShift, 
111     SyntheticStyleChange = 3 << nodeStyleChangeShift
112 };
113
114 class Node : public EventTarget, public ScriptWrappable, public TreeShared<Node, ContainerNode> {
115     friend class Document;
116     friend class TreeScope;
117     friend class TreeScopeAdopter;
118
119 public:
120     enum NodeType {
121         ELEMENT_NODE = 1,
122         ATTRIBUTE_NODE = 2,
123         TEXT_NODE = 3,
124         CDATA_SECTION_NODE = 4,
125         ENTITY_REFERENCE_NODE = 5,
126         ENTITY_NODE = 6,
127         PROCESSING_INSTRUCTION_NODE = 7,
128         COMMENT_NODE = 8,
129         DOCUMENT_NODE = 9,
130         DOCUMENT_TYPE_NODE = 10,
131         DOCUMENT_FRAGMENT_NODE = 11,
132         NOTATION_NODE = 12,
133         XPATH_NAMESPACE_NODE = 13,
134     };
135     enum DocumentPosition {
136         DOCUMENT_POSITION_EQUIVALENT = 0x00,
137         DOCUMENT_POSITION_DISCONNECTED = 0x01,
138         DOCUMENT_POSITION_PRECEDING = 0x02,
139         DOCUMENT_POSITION_FOLLOWING = 0x04,
140         DOCUMENT_POSITION_CONTAINS = 0x08,
141         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
142         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
143     };
144
145     static bool isSupported(const String& feature, const String& version);
146
147     static void startIgnoringLeaks();
148     static void stopIgnoringLeaks();
149
150     static void dumpStatistics();
151
152     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
153     static StyleChange diff(const RenderStyle*, const RenderStyle*, Document*);
154
155     virtual ~Node();
156
157     // DOM methods & attributes for Node
158
159     bool hasTagName(const QualifiedName&) const;
160     bool hasLocalName(const AtomicString&) const;
161     virtual String nodeName() const = 0;
162     virtual String nodeValue() const;
163     virtual void setNodeValue(const String&, ExceptionCode&);
164     virtual NodeType nodeType() const = 0;
165     ContainerNode* parentNode() const;
166     Element* parentElement() const;
167     Node* previousSibling() const { return m_previous; }
168     Node* nextSibling() const { return m_next; }
169     PassRefPtr<NodeList> childNodes();
170     Node* firstChild() const;
171     Node* lastChild() const;
172     bool hasAttributes() const;
173     NamedNodeMap* attributes() const;
174
175     virtual KURL baseURI() const;
176     
177     void getSubresourceURLs(ListHashSet<KURL>&) const;
178
179     // These should all actually return a node, but this is only important for language bindings,
180     // which will already know and hold a ref on the right node to return. Returning bool allows
181     // these methods to be more efficient since they don't need to return a ref
182     bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
183     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
184     bool removeChild(Node* child, ExceptionCode&);
185     bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
186
187     void remove(ExceptionCode&);
188     bool hasChildNodes() const { return firstChild(); }
189     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
190     const AtomicString& localName() const { return virtualLocalName(); }
191     const AtomicString& namespaceURI() const { return virtualNamespaceURI(); }
192     const AtomicString& prefix() const { return virtualPrefix(); }
193     virtual void setPrefix(const AtomicString&, ExceptionCode&);
194     void normalize();
195
196     bool isSameNode(Node* other) const { return this == other; }
197     bool isEqualNode(Node*) const;
198     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
199     String lookupPrefix(const AtomicString& namespaceURI) const;
200     String lookupNamespaceURI(const String& prefix) const;
201     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
202     
203     String textContent(bool convertBRsToNewlines = false) const;
204     void setTextContent(const String&, ExceptionCode&);
205     
206     Node* lastDescendant() const;
207     Node* firstDescendant() const;
208
209     virtual bool isActiveNode() const { return false; }
210     
211     // Other methods (not part of DOM)
212
213     bool isElementNode() const { return getFlag(IsElementFlag); }
214     bool isContainerNode() const { return getFlag(IsContainerFlag); }
215     bool isTextNode() const { return getFlag(IsTextFlag); }
216     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
217     bool isSVGElement() const { return getFlag(IsSVGFlag); }
218
219     virtual bool isMediaControlElement() const { return false; }
220     virtual bool isMediaControls() const { return false; }
221     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
222     virtual bool isAttributeNode() const { return false; }
223     virtual bool isCharacterDataNode() const { return false; }
224     virtual bool isFrameOwnerElement() const { return false; }
225     virtual bool isPluginElement() const { return false; }
226     bool isDocumentNode() const;
227     bool isShadowRoot() const { return getFlag(IsShadowRootFlag); }
228     bool inNamedFlow() const { return getFlag(InNamedFlowFlag); }
229     bool hasAttrList() const { return getFlag(HasAttrListFlag); }
230     bool hasCustomCallbacks() const { return getFlag(HasCustomCallbacksFlag); }
231
232     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns 0.
233     Element* shadowHost() const;
234     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
235     // Deprecated. Should use shadowHost() and check the return value.
236     Node* shadowAncestorNode() const;
237     ShadowRoot* shadowRoot() const;
238     ShadowRoot* youngestShadowRoot() const;
239
240     // Returns 0, a child of ShadowRoot, or a legacy shadow root.
241     Node* nonBoundaryShadowTreeRootNode();
242     bool isInShadowTree() const;
243     // Node's parent, shadow tree host.
244     ContainerNode* parentOrHostNode() const;
245     Element* parentOrHostElement() const;
246     void setParentOrHostNode(ContainerNode*);
247     Node* highestAncestor() const;
248
249     // Use when it's guaranteed to that shadowHost is 0.
250     ContainerNode* parentNodeGuaranteedHostFree() const;
251     // Returns the parent node, but 0 if the parent node is a ShadowRoot.
252     ContainerNode* nonShadowBoundaryParentNode() const;
253
254     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
255     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
256
257     // Returns the enclosing event parent node (or self) that, when clicked, would trigger a navigation.
258     Node* enclosingLinkEventParentOrSelf();
259
260     bool isBlockFlow() const;
261     bool isBlockFlowOrBlockTable() const;
262     
263     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
264     void setPreviousSibling(Node* previous) { m_previous = previous; }
265     void setNextSibling(Node* next) { m_next = next; }
266
267     virtual bool canContainRangeEndPoint() const { return false; }
268
269     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
270     Node* previousNodeConsideringAtomicNodes() const;
271     Node* nextNodeConsideringAtomicNodes() const;
272     
273     // Returns the next leaf node or 0 if there are no more.
274     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
275     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
276     // out of the Node class into an editing-specific source file.
277     Node* nextLeafNode() const;
278
279     // Returns the previous leaf node or 0 if there are no more.
280     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
281     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
282     // out of the Node class into an editing-specific source file.
283     Node* previousLeafNode() const;
284
285     // enclosingBlockFlowElement() is deprecated. Use enclosingBlock instead.
286     Element* enclosingBlockFlowElement() const;
287
288     bool isRootEditableElement() const;
289     Element* rootEditableElement() const;
290     Element* rootEditableElement(EditableType) const;
291
292     bool inSameContainingBlockFlowElement(Node*);
293
294     // Called by the parser when this element's close tag is reached,
295     // signaling that all child tags have been parsed and added.
296     // This is needed for <applet> and <object> elements, which can't lay themselves out
297     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
298     // Also used for script elements and some SVG elements for similar purposes,
299     // but making parsing a special case in this respect should be avoided if possible.
300     virtual void finishParsingChildren() { }
301     virtual void beginParsingChildren() { }
302
303     // Called on the focused node right before dispatching an unload event.
304     virtual void aboutToUnload() { }
305
306     // For <link> and <style> elements.
307     virtual bool sheetLoaded() { return true; }
308     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
309     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
310
311     bool attributeStyleDirty() const { return getFlag(AttributeStyleDirtyFlag); }
312     bool hasName() const { return getFlag(HasNameFlag); }
313     bool hasID() const;
314     bool hasClass() const;
315
316     bool active() const { return getFlag(IsActiveFlag); }
317     bool inActiveChain() const { return getFlag(InActiveChainFlag); }
318     bool hovered() const { return getFlag(IsHoveredFlag); }
319     bool focused() const { return hasRareData() ? rareDataFocused() : false; }
320     bool attached() const { return getFlag(IsAttachedFlag); }
321     void setAttached() { setFlag(IsAttachedFlag); }
322     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
323     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
324     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
325     bool isLink() const { return getFlag(IsLinkFlag); }
326
327     void setAttributeStyleDirty() { setFlag(AttributeStyleDirtyFlag); }
328     void clearAttributeStyleDirty() { clearFlag(AttributeStyleDirtyFlag); }
329
330     void setHasName(bool f) { setFlag(f, HasNameFlag); }
331     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
332     void clearChildNeedsStyleRecalc() { clearFlag(ChildNeedsStyleRecalcFlag); }
333
334     void setInActiveChain() { setFlag(InActiveChainFlag); }
335     void clearInActiveChain() { clearFlag(InActiveChainFlag); }
336
337     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
338     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
339     virtual void scheduleSetNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange) { setNeedsStyleRecalc(changeType); }
340
341     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
342     void setIsLink() { setFlag(IsLinkFlag); }
343     void clearIsLink() { clearFlag(IsLinkFlag); }
344
345     void setInNamedFlow() { setFlag(InNamedFlowFlag); }
346     void clearInNamedFlow() { clearFlag(InNamedFlowFlag); }
347
348     void setHasAttrList() { setFlag(HasAttrListFlag); }
349     void clearHasAttrList() { clearFlag(HasAttrListFlag); }
350
351     bool hasScopedHTMLStyleChild() const { return getFlag(HasScopedHTMLStyleChildFlag); }
352     void setHasScopedHTMLStyleChild(bool flag) { setFlag(flag, HasScopedHTMLStyleChildFlag); }
353
354     enum ShouldSetAttached {
355         SetAttached,
356         DoNotSetAttached
357     };
358     void lazyAttach(ShouldSetAttached = SetAttached);
359     void lazyReattach(ShouldSetAttached = SetAttached);
360
361     virtual void setFocus(bool = true);
362     virtual void setActive(bool f = true, bool /*pause*/ = false) { setFlag(f, IsActiveFlag); }
363     virtual void setHovered(bool f = true) { setFlag(f, IsHoveredFlag); }
364
365     virtual short tabIndex() const;
366
367     // Whether this kind of node can receive focus by default. Most nodes are
368     // not focusable but some elements, such as form controls and links, are.
369     virtual bool supportsFocus() const;
370     // Whether the node can actually be focused.
371     virtual bool isFocusable() const;
372     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
373     virtual bool isMouseFocusable() const;
374     virtual Node* focusDelegate();
375
376     bool isContentEditable();
377     bool isContentRichlyEditable();
378
379     void inspect();
380
381     bool rendererIsEditable(EditableType editableType = ContentIsEditable) const
382     {
383         switch (editableType) {
384         case ContentIsEditable:
385             return rendererIsEditable(Editable);
386         case HasEditableAXRole:
387             return isEditableToAccessibility(Editable);
388         }
389         ASSERT_NOT_REACHED();
390         return false;
391     }
392
393     bool rendererIsRichlyEditable(EditableType editableType = ContentIsEditable) const
394     {
395         switch (editableType) {
396         case ContentIsEditable:
397             return rendererIsEditable(RichlyEditable);
398         case HasEditableAXRole:
399             return isEditableToAccessibility(RichlyEditable);
400         }
401         ASSERT_NOT_REACHED();
402         return false;
403     }
404
405     virtual bool shouldUseInputMethod();
406     virtual LayoutRect boundingBox() const;
407     IntRect pixelSnappedBoundingBox() const { return pixelSnappedIntRect(boundingBox()); }
408     LayoutRect renderRect(bool* isReplaced);
409     IntRect pixelSnappedRenderRect(bool* isReplaced) { return pixelSnappedIntRect(renderRect(isReplaced)); }
410
411     // Returns true if the node has a non-empty bounding box in layout.
412     // This does not 100% guarantee the user can see it, but is pretty close.
413     // Note: This method only works properly after layout has occurred.
414     bool hasNonEmptyBoundingBox() const;
415
416     unsigned nodeIndex() const;
417
418     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
419     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
420     Document* ownerDocument() const;
421
422     // Returns the document associated with this node. This method never returns NULL, except in the case 
423     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
424     Document* document() const
425     {
426         ASSERT(this);
427         // FIXME: below ASSERT is useful, but prevents the use of document() in the constructor or destructor
428         // due to the virtual function call to nodeType().
429         ASSERT(m_document || (nodeType() == DOCUMENT_TYPE_NODE && !inDocument()));
430         return m_document;
431     }
432
433     TreeScope* treeScope() const;
434
435     // Returns true if this node is associated with a document and is in its associated document's
436     // node tree, false otherwise.
437     bool inDocument() const 
438     { 
439         ASSERT(m_document || !getFlag(InDocumentFlag));
440         return getFlag(InDocumentFlag);
441     }
442
443     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
444     virtual bool childTypeAllowed(NodeType) const { return false; }
445     unsigned childNodeCount() const;
446     Node* childNode(unsigned index) const;
447
448     // Does a pre-order traversal of the tree to find the next node after this one.
449     // This uses the same order that tags appear in the source file. If the stayWithin
450     // argument is non-null, the traversal will stop once the specified node is reached.
451     // This can be used to restrict traversal to a particular sub-tree.
452     Node* traverseNextNode() const;
453     Node* traverseNextNode(const Node* stayWithin) const;
454
455     // Like traverseNextNode, but skips children and starts with the next sibling.
456     Node* traverseNextSibling() const;
457     Node* traverseNextSibling(const Node* stayWithin) const;
458
459     // Does a reverse pre-order traversal to find the node that comes before the current one in document order
460     Node* traversePreviousNode(const Node* stayWithin = 0) const;
461
462     // Like traversePreviousNode, but skips children and starts with the next sibling.
463     Node* traversePreviousSibling(const Node* stayWithin = 0) const;
464
465     // Like traverseNextNode, but visits parents after their children.
466     Node* traverseNextNodePostOrder() const;
467
468     // Like traversePreviousNode, but visits parents before their children.
469     Node* traversePreviousNodePostOrder(const Node* stayWithin = 0) const;
470     Node* traversePreviousSiblingPostOrder(const Node* stayWithin = 0) const;
471
472     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
473     bool isDescendantOf(const Node*) const;
474     bool contains(const Node*) const;
475     bool containsIncludingShadowDOM(Node*);
476
477     // This method is used to do strict error-checking when adding children via
478     // the public DOM API (e.g., appendChild()).
479     void checkAddChild(Node* newChild, ExceptionCode&); // Error-checking when adding via the DOM API
480
481     void checkReplaceChild(Node* newChild, Node* oldChild, ExceptionCode&);
482     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
483     
484     // Used to determine whether range offsets use characters or node indices.
485     virtual bool offsetInCharacters() const;
486     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
487     // css-transform:capitalize breaking up precomposed characters and ligatures.
488     virtual int maxCharacterOffset() const;
489
490     // Whether or not a selection can be started in this object
491     virtual bool canStartSelection() const;
492
493     // Getting points into and out of screen space
494     FloatPoint convertToPage(const FloatPoint&) const;
495     FloatPoint convertFromPage(const FloatPoint&) const;
496
497     // -----------------------------------------------------------------------------
498     // Integration with rendering tree
499
500     RenderObject* renderer() const { return m_renderer; }
501     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
502     
503     // Use these two methods with caution.
504     RenderBox* renderBox() const;
505     RenderBoxModelObject* renderBoxModelObject() const;
506
507     // Attaches this node to the rendering tree. This calculates the style to be applied to the node and creates an
508     // appropriate RenderObject which will be inserted into the tree (except when the style has display: none). This
509     // makes the node visible in the FrameView.
510     virtual void attach();
511
512     // Detaches the node from the rendering tree, making it invisible in the rendered view. This method will remove
513     // the node's rendering object from the rendering tree and delete it.
514     virtual void detach();
515
516 #ifndef NDEBUG
517     bool inDetach() const;
518 #endif
519
520     void reattach();
521     void reattachIfAttached();
522     void createRendererIfNeeded();
523     virtual bool rendererIsNeeded(const NodeRenderingContext&);
524     virtual bool childShouldCreateRenderer(const NodeRenderingContext&) const { return true; }
525     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
526     ContainerNode* parentNodeForRenderingAndStyle();
527     
528     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
529     RenderStyle* renderStyle() const;
530     virtual void setRenderStyle(PassRefPtr<RenderStyle>);
531
532     RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return virtualComputedStyle(pseudoElementSpecifier); }
533
534     // -----------------------------------------------------------------------------
535     // Notification of document structure changes (see ContainerNode.h for more notification methods)
536     //
537     // At first, WebKit notifies the node that it has been inserted into the document. This is called during document parsing, and also
538     // 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.
539     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
540     // dispatching.
541     //
542     // WebKit notifies this callback regardless if the subtree of the node is a document tree or a floating subtree.
543     // Implementation can determine the type of subtree by seeing insertionPoint->inDocument().
544     // For a performance reason, notifications are delivered only to ContainerNode subclasses if the insertionPoint is out of document.
545     //
546     // There are another callback named didNotifyDescendantInsertions(), which is called after all the descendant is notified.
547     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallDidNotifyDescendantInsertions
548     // from insrtedInto().
549     //
550     enum InsertionNotificationRequest {
551         InsertionDone,
552         InsertionShouldCallDidNotifySubtreeInsertions
553     };
554
555     virtual InsertionNotificationRequest insertedInto(ContainerNode* insertionPoint);
556     virtual void didNotifySubtreeInsertions(ContainerNode*) { }
557
558     // Notifies the node that it is no longer part of the tree.
559     //
560     // This is a dual of insertedInto(), and is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
561     // dispatching, and is called _after_ the node is removed from the tree.
562     //
563     virtual void removedFrom(ContainerNode* insertionPoint);
564
565 #ifndef NDEBUG
566     virtual void formatForDebugger(char* buffer, unsigned length) const;
567
568     void showNode(const char* prefix = "") const;
569     void showTreeForThis() const;
570     void showNodePathForThis() const;
571     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
572     void showTreeForThisAcrossFrame() const;
573 #endif
574
575     void invalidateNodeListCachesInAncestors(const QualifiedName* attrName = 0, Element* attributeOwnerElement = 0);
576     NodeListsNodeData* nodeLists();
577     void removeCachedChildNodeList();
578
579     PassRefPtr<NodeList> getElementsByTagName(const AtomicString&);
580     PassRefPtr<NodeList> getElementsByTagNameNS(const AtomicString& namespaceURI, const AtomicString& localName);
581     PassRefPtr<NodeList> getElementsByName(const String& elementName);
582     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
583     PassRefPtr<RadioNodeList> radioNodeList(const AtomicString&);
584
585     virtual bool willRespondToMouseMoveEvents();
586     virtual bool willRespondToMouseClickEvents();
587     virtual bool willRespondToTouchEvents();
588
589     PassRefPtr<Element> querySelector(const AtomicString& selectors, ExceptionCode&);
590     PassRefPtr<NodeList> querySelectorAll(const AtomicString& selectors, ExceptionCode&);
591
592     unsigned short compareDocumentPosition(Node*);
593
594     virtual Node* toNode();
595     virtual HTMLInputElement* toInputElement();
596
597     virtual const AtomicString& interfaceName() const;
598     virtual ScriptExecutionContext* scriptExecutionContext() const;
599
600     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
601     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
602
603     // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
604     // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
605     virtual void* preDispatchEventHandler(Event*) { return 0; }
606     virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
607
608     using EventTarget::dispatchEvent;
609     bool dispatchEvent(PassRefPtr<Event>);
610     void dispatchScopedEvent(PassRefPtr<Event>);
611     void dispatchScopedEventDispatchMediator(PassRefPtr<EventDispatchMediator>);
612
613     virtual void handleLocalEvents(Event*);
614
615     void dispatchSubtreeModifiedEvent();
616     bool dispatchDOMActivateEvent(int detail, PassRefPtr<Event> underlyingEvent);
617     void dispatchFocusInEvent(const AtomicString& eventType, PassRefPtr<Node> oldFocusedNode);
618     void dispatchFocusOutEvent(const AtomicString& eventType, PassRefPtr<Node> newFocusedNode);
619
620     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
621     bool dispatchWheelEvent(const PlatformWheelEvent&);
622     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Node* relatedTarget = 0);
623 #if ENABLE(GESTURE_EVENTS)
624     bool dispatchGestureEvent(const PlatformGestureEvent&);
625 #endif
626     void dispatchSimulatedClick(PassRefPtr<Event> underlyingEvent, bool sendMouseEvents = false, bool showPressedLook = true);
627     bool dispatchBeforeLoadEvent(const String& sourceURL);
628
629     virtual void dispatchFocusEvent(PassRefPtr<Node> oldFocusedNode);
630     virtual void dispatchBlurEvent(PassRefPtr<Node> newFocusedNode);
631     virtual void dispatchChangeEvent();
632     virtual void dispatchInputEvent();
633
634     // Perform the default action for an event.
635     virtual void defaultEventHandler(Event*);
636
637     // Used for disabled form elements; if true, prevents mouse events from being dispatched
638     // to event listeners, and prevents DOMActivate events from being sent at all.
639     virtual bool disabled() const;
640
641     using TreeShared<Node, ContainerNode>::ref;
642     using TreeShared<Node, ContainerNode>::deref;
643
644     virtual EventTargetData* eventTargetData();
645     virtual EventTargetData* ensureEventTargetData();
646
647 #if ENABLE(MICRODATA)
648     DOMSettableTokenList* itemProp();
649     DOMSettableTokenList* itemRef();
650     DOMSettableTokenList* itemType();
651     PassRefPtr<PropertyNodeList> propertyNodeList(const String&);
652 #endif
653
654 #if ENABLE(MUTATION_OBSERVERS)
655     void getRegisteredMutationObserversOfType(HashMap<MutationObserver*, MutationRecordDeliveryOptions>&, MutationObserver::MutationType, const QualifiedName* attributeName);
656     MutationObserverRegistration* registerMutationObserver(MutationObserver*);
657     void unregisterMutationObserver(MutationObserverRegistration*);
658     void registerTransientMutationObserver(MutationObserverRegistration*);
659     void unregisterTransientMutationObserver(MutationObserverRegistration*);
660     void notifyMutationObserversNodeWillDetach();
661 #endif // ENABLE(MUTATION_OBSERVERS)
662
663     void registerScopedHTMLStyleChild();
664     void unregisterScopedHTMLStyleChild();
665     size_t numberOfScopedHTMLStyleChildren() const;
666
667     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
668
669 private:
670     enum NodeFlags {
671         IsTextFlag = 1,
672         IsContainerFlag = 1 << 1,
673         IsElementFlag = 1 << 2,
674         IsStyledElementFlag = 1 << 3,
675         IsHTMLFlag = 1 << 4,
676         IsSVGFlag = 1 << 5,
677         IsAttachedFlag = 1 << 6,
678         ChildNeedsStyleRecalcFlag = 1 << 7,
679         InDocumentFlag = 1 << 8,
680         IsLinkFlag = 1 << 9,
681         IsActiveFlag = 1 << 10,
682         IsHoveredFlag = 1 << 11,
683         InActiveChainFlag = 1 << 12,
684         HasRareDataFlag = 1 << 13,
685         IsShadowRootFlag = 1 << 14,
686
687         // These bits are used by derived classes, pulled up here so they can
688         // be stored in the same memory word as the Node bits above.
689         IsParsingChildrenFinishedFlag = 1 << 15, // Element
690         IsStyleAttributeValidFlag = 1 << 16, // StyledElement
691 #if ENABLE(SVG)
692         AreSVGAttributesValidFlag = 1 << 17, // Element
693         IsSynchronizingSVGAttributesFlag = 1 << 18, // SVGElement
694         HasSVGRareDataFlag = 1 << 19, // SVGElement
695 #endif
696
697         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1),
698
699         SelfOrAncestorHasDirAutoFlag = 1 << 22,
700
701         HasNameFlag = 1 << 23,
702
703         AttributeStyleDirtyFlag = 1 << 24,
704
705 #if ENABLE(SVG)
706         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag | AreSVGAttributesValidFlag,
707 #else
708         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag,
709 #endif
710         InNamedFlowFlag = 1 << 26,
711         HasAttrListFlag = 1 << 27,
712         HasCustomCallbacksFlag = 1 << 28,
713         HasScopedHTMLStyleChildFlag = 1 << 29
714     };
715
716     // 3 bits remaining
717
718     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
719     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
720     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
721     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; } 
722
723 protected:
724     enum ConstructionType { 
725         CreateOther = DefaultNodeFlags,
726         CreateText = DefaultNodeFlags | IsTextFlag,
727         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
728         CreateElement = CreateContainer | IsElementFlag, 
729         CreateShadowRoot = CreateContainer | IsShadowRootFlag,
730         CreateStyledElement = CreateElement | IsStyledElementFlag, 
731         CreateHTMLElement = CreateStyledElement | IsHTMLFlag, 
732         CreateFrameOwnerElement = CreateHTMLElement | HasCustomCallbacksFlag,
733         CreateSVGElement = CreateStyledElement | IsSVGFlag,
734         CreateDocument = CreateContainer | InDocumentFlag
735     };
736     Node(Document*, ConstructionType);
737
738     virtual void didMoveToNewDocument(Document* oldDocument);
739     
740     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const { }
741     void setTabIndexExplicitly(short);
742     void clearTabIndexExplicitly();
743     
744     bool hasRareData() const { return getFlag(HasRareDataFlag); }
745
746     NodeRareData* rareData() const;
747     NodeRareData* ensureRareData();
748     void clearRareData();
749
750     void setHasCustomCallbacks() { setFlag(true, HasCustomCallbacksFlag); }
751
752 private:
753     friend class TreeShared<Node, ContainerNode>;
754
755     void removedLastRef();
756
757     // These API should be only used for a tree scope migration.
758     // setTreeScope() returns NodeRareData to save extra nodeRareData() invocations on the caller site.
759     NodeRareData* setTreeScope(TreeScope*);
760     void setDocument(Document*);
761
762     enum EditableLevel { Editable, RichlyEditable };
763     bool rendererIsEditable(EditableLevel) const;
764     bool isEditableToAccessibility(EditableLevel) const;
765
766     void setStyleChange(StyleChangeType);
767
768     // Used to share code between lazyAttach and setNeedsStyleRecalc.
769     void markAncestorsWithChildNeedsStyleRecalc();
770
771     virtual void refEventTarget();
772     virtual void derefEventTarget();
773
774     virtual OwnPtr<NodeRareData> createRareData();
775     bool rareDataFocused() const;
776
777     virtual RenderStyle* nonRendererRenderStyle() const;
778
779     virtual const AtomicString& virtualPrefix() const;
780     virtual const AtomicString& virtualLocalName() const;
781     virtual const AtomicString& virtualNamespaceURI() const;
782     virtual RenderStyle* virtualComputedStyle(PseudoId = NOPSEUDO);
783
784     Element* ancestorElement() const;
785
786     Node* traverseNextAncestorSibling() const;
787     Node* traverseNextAncestorSibling(const Node* stayWithin) const;
788
789     // Use Node::parentNode as the consistent way of querying a parent node.
790     // This method is made private to ensure a compiler error on call sites that
791     // don't follow this rule.
792     using TreeShared<Node, ContainerNode>::parent;
793     using TreeShared<Node, ContainerNode>::setParent;
794
795     void trackForDebugging();
796
797 #if ENABLE(MUTATION_OBSERVERS)
798     Vector<OwnPtr<MutationObserverRegistration> >* mutationObserverRegistry();
799     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
800 #endif
801
802     mutable uint32_t m_nodeFlags;
803     Document* m_document;
804     Node* m_previous;
805     Node* m_next;
806     RenderObject* m_renderer;
807
808 public:
809     bool isStyleAttributeValid() const { return getFlag(IsStyleAttributeValidFlag); }
810     void setIsStyleAttributeValid(bool f) { setFlag(f, IsStyleAttributeValidFlag); }
811     void setIsStyleAttributeValid() const { setFlag(IsStyleAttributeValidFlag); }
812     void clearIsStyleAttributeValid() { clearFlag(IsStyleAttributeValidFlag); }
813
814 protected:
815     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
816     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
817     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
818
819 #if ENABLE(SVG)
820     bool areSVGAttributesValid() const { return getFlag(AreSVGAttributesValidFlag); }
821     void setAreSVGAttributesValid() const { setFlag(AreSVGAttributesValidFlag); }
822     void clearAreSVGAttributesValid() { clearFlag(AreSVGAttributesValidFlag); }
823     bool isSynchronizingSVGAttributes() const { return getFlag(IsSynchronizingSVGAttributesFlag); }
824     void setIsSynchronizingSVGAttributes() const { setFlag(IsSynchronizingSVGAttributesFlag); }
825     void clearIsSynchronizingSVGAttributes() const { clearFlag(IsSynchronizingSVGAttributesFlag); }
826     bool hasSVGRareData() const { return getFlag(HasSVGRareDataFlag); }
827     void setHasSVGRareData() { setFlag(HasSVGRareDataFlag); }
828     void clearHasSVGRareData() { clearFlag(HasSVGRareDataFlag); }
829 #endif
830
831 #if ENABLE(MICRODATA)
832     void setItemProp(const String&);
833     void setItemRef(const String&);
834     void setItemType(const String&);
835 #endif
836 };
837
838 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
839 inline void addSubresourceURL(ListHashSet<KURL>& urls, const KURL& url)
840 {
841     if (!url.isNull())
842         urls.add(url);
843 }
844
845 inline ContainerNode* Node::parentNode() const
846 {
847     return getFlag(IsShadowRootFlag) ? 0 : parent();
848 }
849
850 inline void Node::setParentOrHostNode(ContainerNode* parent)
851 {
852     setParent(parent);
853 }
854
855 inline ContainerNode* Node::parentOrHostNode() const
856 {
857     return parent();
858 }
859
860 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
861 {
862     ASSERT(!getFlag(IsShadowRootFlag));
863     return parentOrHostNode();
864 }
865
866 inline void Node::reattach()
867 {
868     if (attached())
869         detach();
870     attach();
871 }
872
873 inline void Node::reattachIfAttached()
874 {
875     if (attached())
876         reattach();
877 }
878
879 inline void Node::lazyReattach(ShouldSetAttached shouldSetAttached)
880 {
881     if (attached())
882         detach();
883     lazyAttach(shouldSetAttached);
884 }
885
886 } //namespace
887
888 #ifndef NDEBUG
889 // Outside the WebCore namespace for ease of invocation from gdb.
890 void showTree(const WebCore::Node*);
891 void showNodePath(const WebCore::Node*);
892 #endif
893
894 #endif