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