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