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