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