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