[Refactoring] Node should have youngestShadowRoot.
[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 ShadowRoot;
86 class TagNodeList;
87 class TreeScope;
88
89 #if ENABLE(MICRODATA)
90 class HTMLPropertiesCollection;
91 #endif
92
93 typedef int ExceptionCode;
94
95 const int nodeStyleChangeShift = 20;
96
97 // SyntheticStyleChange means that we need to go through the entire style change logic even though
98 // no style property has actually changed. It is used to restructure the tree when, for instance,
99 // RenderLayers are created or destroyed due to animation changes.
100 enum StyleChangeType { 
101     NoStyleChange = 0, 
102     InlineStyleChange = 1 << nodeStyleChangeShift, 
103     FullStyleChange = 2 << nodeStyleChangeShift, 
104     SyntheticStyleChange = 3 << nodeStyleChangeShift
105 };
106
107 class Node : public EventTarget, public ScriptWrappable, public TreeShared<ContainerNode> {
108     friend class Document;
109     friend class TreeScope;
110     friend class TreeScopeAdopter;
111
112 public:
113     enum NodeType {
114         ELEMENT_NODE = 1,
115         ATTRIBUTE_NODE = 2,
116         TEXT_NODE = 3,
117         CDATA_SECTION_NODE = 4,
118         ENTITY_REFERENCE_NODE = 5,
119         ENTITY_NODE = 6,
120         PROCESSING_INSTRUCTION_NODE = 7,
121         COMMENT_NODE = 8,
122         DOCUMENT_NODE = 9,
123         DOCUMENT_TYPE_NODE = 10,
124         DOCUMENT_FRAGMENT_NODE = 11,
125         NOTATION_NODE = 12,
126         XPATH_NAMESPACE_NODE = 13,
127     };
128     enum DocumentPosition {
129         DOCUMENT_POSITION_EQUIVALENT = 0x00,
130         DOCUMENT_POSITION_DISCONNECTED = 0x01,
131         DOCUMENT_POSITION_PRECEDING = 0x02,
132         DOCUMENT_POSITION_FOLLOWING = 0x04,
133         DOCUMENT_POSITION_CONTAINS = 0x08,
134         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
135         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
136     };
137
138     static bool isSupported(const String& feature, const String& version);
139
140     static void startIgnoringLeaks();
141     static void stopIgnoringLeaks();
142
143     static void dumpStatistics();
144
145     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
146     static StyleChange diff(const RenderStyle*, const RenderStyle*, Document*);
147
148     virtual ~Node();
149
150     // DOM methods & attributes for Node
151
152     bool hasTagName(const QualifiedName&) const;
153     bool hasLocalName(const AtomicString&) const;
154     virtual String nodeName() const = 0;
155     virtual String nodeValue() const;
156     virtual void setNodeValue(const String&, ExceptionCode&);
157     virtual NodeType nodeType() const = 0;
158     ContainerNode* parentNode() const;
159     Element* parentElement() const;
160     Node* previousSibling() const { return m_previous; }
161     Node* nextSibling() const { return m_next; }
162     PassRefPtr<NodeList> childNodes();
163     Node* firstChild() const;
164     Node* lastChild() const;
165     bool hasAttributes() const;
166     NamedNodeMap* attributes() const;
167
168     virtual KURL baseURI() const;
169     
170     void getSubresourceURLs(ListHashSet<KURL>&) const;
171
172     // These should all actually return a node, but this is only important for language bindings,
173     // which will already know and hold a ref on the right node to return. Returning bool allows
174     // these methods to be more efficient since they don't need to return a ref
175     bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
176     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
177     bool removeChild(Node* child, ExceptionCode&);
178     bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
179
180     void remove(ExceptionCode&);
181     bool hasChildNodes() const { return firstChild(); }
182     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
183     const AtomicString& localName() const { return virtualLocalName(); }
184     const AtomicString& namespaceURI() const { return virtualNamespaceURI(); }
185     const AtomicString& prefix() const { return virtualPrefix(); }
186     virtual void setPrefix(const AtomicString&, ExceptionCode&);
187     void normalize();
188
189     bool isSameNode(Node* other) const { return this == other; }
190     bool isEqualNode(Node*) const;
191     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
192     String lookupPrefix(const AtomicString& namespaceURI) const;
193     String lookupNamespaceURI(const String& prefix) const;
194     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
195     
196     String textContent(bool convertBRsToNewlines = false) const;
197     void setTextContent(const String&, ExceptionCode&);
198     
199     Node* lastDescendant() const;
200     Node* firstDescendant() const;
201
202     virtual bool isActiveNode() const { return false; }
203     
204     // Other methods (not part of DOM)
205
206     bool isElementNode() const { return getFlag(IsElementFlag); }
207     bool isContainerNode() const { return getFlag(IsContainerFlag); }
208     bool isTextNode() const { return getFlag(IsTextFlag); }
209     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
210     bool isSVGElement() const { return getFlag(IsSVGFlag); }
211
212     virtual bool isMediaControlElement() const { return false; }
213     virtual bool isMediaControls() const { return false; }
214     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
215     virtual bool isAttributeNode() const { return false; }
216     virtual bool isCharacterDataNode() const { return false; }
217     virtual bool isFrameOwnerElement() const { return false; }
218     bool isDocumentNode() const;
219     bool isShadowRoot() const { return getFlag(IsShadowRootFlag); }
220     bool inNamedFlow() const { return getFlag(InNamedFlowFlag); }
221     bool hasAttrList() const { return getFlag(HasAttrListFlag); }
222     bool hasCustomCallbacks() const { return getFlag(HasCustomCallbacksFlag); }
223
224     Node* shadowAncestorNode() const;
225     ShadowRoot* shadowRoot() const;
226     ShadowRoot* youngestShadowRoot() const;
227
228     // Returns 0, a child of ShadowRoot, or a legacy shadow root.
229     Node* nonBoundaryShadowTreeRootNode();
230     bool isInShadowTree() const;
231     // Node's parent, shadow tree host.
232     ContainerNode* parentOrHostNode() const;
233     Element* parentOrHostElement() const;
234     void setParentOrHostNode(ContainerNode*);
235     Node* highestAncestor() const;
236
237     // Use when it's guaranteed to that shadowHost is 0.
238     ContainerNode* parentNodeGuaranteedHostFree() const;
239     // Returns the parent node, but 0 if the parent node is a ShadowRoot.
240     ContainerNode* nonShadowBoundaryParentNode() const;
241
242     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
243     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
244
245     // Returns the enclosing event parent node (or self) that, when clicked, would trigger a navigation.
246     Node* enclosingLinkEventParentOrSelf();
247
248     bool isBlockFlow() const;
249     bool isBlockFlowOrBlockTable() const;
250     
251     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
252     void setPreviousSibling(Node* previous) { m_previous = previous; }
253     void setNextSibling(Node* next) { m_next = next; }
254
255     virtual bool canContainRangeEndPoint() const { return false; }
256
257     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
258     Node* previousNodeConsideringAtomicNodes() const;
259     Node* nextNodeConsideringAtomicNodes() const;
260     
261     // Returns the next leaf node or 0 if there are no more.
262     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
263     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
264     // out of the Node class into an editing-specific source file.
265     Node* nextLeafNode() const;
266
267     // Returns the previous leaf node or 0 if there are no more.
268     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
269     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
270     // out of the Node class into an editing-specific source file.
271     Node* previousLeafNode() const;
272
273     // enclosingBlockFlowElement() is deprecated. Use enclosingBlock instead.
274     Element* enclosingBlockFlowElement() const;
275
276     bool isRootEditableElement() const;
277     Element* rootEditableElement() const;
278     Element* rootEditableElement(EditableType) const;
279
280     bool inSameContainingBlockFlowElement(Node*);
281
282     // Called by the parser when this element's close tag is reached,
283     // signaling that all child tags have been parsed and added.
284     // This is needed for <applet> and <object> elements, which can't lay themselves out
285     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
286     // Also used for script elements and some SVG elements for similar purposes,
287     // but making parsing a special case in this respect should be avoided if possible.
288     virtual void finishParsingChildren() { }
289     virtual void beginParsingChildren() { }
290
291     // Called on the focused node right before dispatching an unload event.
292     virtual void aboutToUnload() { }
293
294     // For <link> and <style> elements.
295     virtual bool sheetLoaded() { return true; }
296     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
297     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
298
299     bool attributeStyleDirty() const { return getFlag(AttributeStyleDirtyFlag); }
300     bool hasName() const { return getFlag(HasNameFlag); }
301     bool hasID() const;
302     bool hasClass() const;
303
304     bool active() const { return getFlag(IsActiveFlag); }
305     bool inActiveChain() const { return getFlag(InActiveChainFlag); }
306     bool hovered() const { return getFlag(IsHoveredFlag); }
307     bool focused() const { return hasRareData() ? rareDataFocused() : false; }
308     bool attached() const { return getFlag(IsAttachedFlag); }
309     void setAttached() { setFlag(IsAttachedFlag); }
310     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
311     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
312     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
313     bool isLink() const { return getFlag(IsLinkFlag); }
314
315     void setAttributeStyleDirty() { setFlag(AttributeStyleDirtyFlag); }
316     void clearAttributeStyleDirty() { clearFlag(AttributeStyleDirtyFlag); }
317
318     void setHasName(bool f) { setFlag(f, HasNameFlag); }
319     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
320     void clearChildNeedsStyleRecalc() { clearFlag(ChildNeedsStyleRecalcFlag); }
321
322     void setInActiveChain() { setFlag(InActiveChainFlag); }
323     void clearInActiveChain() { clearFlag(InActiveChainFlag); }
324
325     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
326     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
327     virtual void scheduleSetNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange) { setNeedsStyleRecalc(changeType); }
328
329     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
330     void setIsLink() { setFlag(IsLinkFlag); }
331     void clearIsLink() { clearFlag(IsLinkFlag); }
332
333     void setInNamedFlow() { setFlag(InNamedFlowFlag); }
334     void clearInNamedFlow() { clearFlag(InNamedFlowFlag); }
335
336     void setHasAttrList() { setFlag(HasAttrListFlag); }
337     void clearHasAttrList() { clearFlag(HasAttrListFlag); }
338
339     enum ShouldSetAttached {
340         SetAttached,
341         DoNotSetAttached
342     };
343     void lazyAttach(ShouldSetAttached = SetAttached);
344
345     virtual void setFocus(bool = true);
346     virtual void setActive(bool f = true, bool /*pause*/ = false) { setFlag(f, IsActiveFlag); }
347     virtual void setHovered(bool f = true) { setFlag(f, IsHoveredFlag); }
348
349     virtual short tabIndex() const;
350
351     // Whether this kind of node can receive focus by default. Most nodes are
352     // not focusable but some elements, such as form controls and links, are.
353     virtual bool supportsFocus() const;
354     // Whether the node can actually be focused.
355     virtual bool isFocusable() const;
356     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
357     virtual bool isMouseFocusable() const;
358     virtual Node* focusDelegate();
359
360     bool isContentEditable();
361     bool isContentRichlyEditable();
362
363     void inspect();
364
365     bool rendererIsEditable(EditableType editableType = ContentIsEditable) const
366     {
367         switch (editableType) {
368         case ContentIsEditable:
369             return rendererIsEditable(Editable);
370         case HasEditableAXRole:
371             return isEditableToAccessibility(Editable);
372         }
373         ASSERT_NOT_REACHED();
374         return false;
375     }
376
377     bool rendererIsRichlyEditable(EditableType editableType = ContentIsEditable) const
378     {
379         switch (editableType) {
380         case ContentIsEditable:
381             return rendererIsEditable(RichlyEditable);
382         case HasEditableAXRole:
383             return isEditableToAccessibility(RichlyEditable);
384         }
385         ASSERT_NOT_REACHED();
386         return false;
387     }
388
389     virtual bool shouldUseInputMethod();
390     virtual LayoutRect getRect() const;
391     IntRect getPixelSnappedRect() const { return pixelSnappedIntRect(getRect()); }
392     LayoutRect renderRect(bool* isReplaced);
393     IntRect pixelSnappedRenderRect(bool* isReplaced) { return pixelSnappedIntRect(renderRect(isReplaced)); }
394
395     // Returns true if the node has a non-empty bounding box in layout.
396     // This does not 100% guarantee the user can see it, but is pretty close.
397     // Note: This method only works properly after layout has occurred.
398     bool hasNonEmptyBoundingBox() const;
399
400     unsigned nodeIndex() const;
401
402     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
403     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
404     Document* ownerDocument() const;
405
406     // Returns the document associated with this node. This method never returns NULL, except in the case 
407     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
408     Document* document() const
409     {
410         ASSERT(this);
411         // FIXME: below ASSERT is useful, but prevents the use of document() in the constructor or destructor
412         // due to the virtual function call to nodeType().
413         ASSERT(m_document || (nodeType() == DOCUMENT_TYPE_NODE && !inDocument()));
414         return m_document;
415     }
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(m_document || !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 didNotifyDescendantInseretions(), which is called after all the descendant is notified.
531     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallDidNotifyDescendantInseretions
532     // from insrtedInto().
533     //
534     enum InsertionNotificationRequest {
535         InsertionDone,
536         InsertionShouldCallDidNotifyDescendantInseretions
537     };
538
539     virtual InsertionNotificationRequest insertedInto(Node* insertionPoint);
540     virtual void didNotifyDescendantInseretions(Node*) { }
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(Node* 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 registerDynamicSubtreeNodeList(DynamicSubtreeNodeList*);
560     void unregisterDynamicSubtreeNodeList(DynamicSubtreeNodeList*);
561     void invalidateNodeListsCacheAfterAttributeChanged(const QualifiedName&, Element* attributeOwnerElement);
562     void invalidateNodeListsCacheAfterChildrenChanged();
563     void removeCachedClassNodeList(ClassNodeList*, const String&);
564
565     void removeCachedNameNodeList(NameNodeList*, const String&);
566     void removeCachedTagNodeList(TagNodeList*, const AtomicString&);
567     void removeCachedTagNodeList(TagNodeList*, const QualifiedName&);
568     void removeCachedLabelsNodeList(DynamicSubtreeNodeList*);
569
570     void removeCachedChildNodeList();
571
572     PassRefPtr<RadioNodeList> radioNodeList(const AtomicString&);
573     void removeCachedRadioNodeList(RadioNodeList*, const AtomicString&);
574
575     PassRefPtr<NodeList> getElementsByTagName(const AtomicString&);
576     PassRefPtr<NodeList> getElementsByTagNameNS(const AtomicString& namespaceURI, const AtomicString& localName);
577     PassRefPtr<NodeList> getElementsByName(const String& elementName);
578     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
579
580     PassRefPtr<Element> querySelector(const String& selectors, ExceptionCode&);
581     PassRefPtr<NodeList> querySelectorAll(const String& selectors, ExceptionCode&);
582
583     unsigned short compareDocumentPosition(Node*);
584
585     virtual Node* toNode();
586     virtual HTMLInputElement* toInputElement();
587
588     virtual const AtomicString& interfaceName() const;
589     virtual ScriptExecutionContext* scriptExecutionContext() const;
590
591     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
592     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
593
594     // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
595     // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
596     virtual void* preDispatchEventHandler(Event*) { return 0; }
597     virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
598
599     using EventTarget::dispatchEvent;
600     bool dispatchEvent(PassRefPtr<Event>);
601     void dispatchScopedEvent(PassRefPtr<Event>);
602     void dispatchScopedEventDispatchMediator(PassRefPtr<EventDispatchMediator>);
603
604     virtual void handleLocalEvents(Event*);
605
606     void dispatchRegionLayoutUpdateEvent();
607
608     void dispatchSubtreeModifiedEvent();
609     void dispatchDOMActivateEvent(int detail, PassRefPtr<Event> underlyingEvent);
610     void dispatchFocusInEvent(const AtomicString& eventType, PassRefPtr<Node> oldFocusedNode);
611     void dispatchFocusOutEvent(const AtomicString& eventType, PassRefPtr<Node> newFocusedNode);
612
613     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
614     bool dispatchWheelEvent(const PlatformWheelEvent&);
615     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Node* relatedTarget = 0);
616     void dispatchSimulatedClick(PassRefPtr<Event> underlyingEvent, bool sendMouseEvents = false, bool showPressedLook = true);
617     bool dispatchBeforeLoadEvent(const String& sourceURL);
618
619     virtual void dispatchFocusEvent(PassRefPtr<Node> oldFocusedNode);
620     virtual void dispatchBlurEvent(PassRefPtr<Node> newFocusedNode);
621     virtual void dispatchChangeEvent();
622     virtual void dispatchInputEvent();
623
624     // Perform the default action for an event.
625     virtual void defaultEventHandler(Event*);
626
627     // Used for disabled form elements; if true, prevents mouse events from being dispatched
628     // to event listeners, and prevents DOMActivate events from being sent at all.
629     virtual bool disabled() const;
630
631     using TreeShared<ContainerNode>::ref;
632     using TreeShared<ContainerNode>::deref;
633
634     virtual EventTargetData* eventTargetData();
635     virtual EventTargetData* ensureEventTargetData();
636
637 #if ENABLE(MICRODATA)
638     DOMSettableTokenList* itemProp();
639     DOMSettableTokenList* itemRef();
640     DOMSettableTokenList* itemType();
641     HTMLPropertiesCollection* properties();
642 #endif
643
644 #if ENABLE(MUTATION_OBSERVERS)
645     void getRegisteredMutationObserversOfType(HashMap<WebKitMutationObserver*, MutationRecordDeliveryOptions>&, WebKitMutationObserver::MutationType, const QualifiedName* attributeName);
646     MutationObserverRegistration* registerMutationObserver(PassRefPtr<WebKitMutationObserver>);
647     void unregisterMutationObserver(MutationObserverRegistration*);
648     void registerTransientMutationObserver(MutationObserverRegistration*);
649     void unregisterTransientMutationObserver(MutationObserverRegistration*);
650     void notifyMutationObserversNodeWillDetach();
651 #endif // ENABLE(MUTATION_OBSERVERS)
652
653 #if ENABLE(STYLE_SCOPED)
654     void registerScopedHTMLStyleChild();
655     void unregisterScopedHTMLStyleChild();
656 #endif
657     bool hasScopedHTMLStyleChild() const;
658     size_t numberOfScopedHTMLStyleChildren() const;
659
660 private:
661     enum NodeFlags {
662         IsTextFlag = 1,
663         IsContainerFlag = 1 << 1,
664         IsElementFlag = 1 << 2,
665         IsStyledElementFlag = 1 << 3,
666         IsHTMLFlag = 1 << 4,
667         IsSVGFlag = 1 << 5,
668         IsAttachedFlag = 1 << 6,
669         ChildNeedsStyleRecalcFlag = 1 << 7,
670         InDocumentFlag = 1 << 8,
671         IsLinkFlag = 1 << 9,
672         IsActiveFlag = 1 << 10,
673         IsHoveredFlag = 1 << 11,
674         InActiveChainFlag = 1 << 12,
675         HasRareDataFlag = 1 << 13,
676         IsShadowRootFlag = 1 << 14,
677
678         // These bits are used by derived classes, pulled up here so they can
679         // be stored in the same memory word as the Node bits above.
680         IsParsingChildrenFinishedFlag = 1 << 15, // Element
681         IsStyleAttributeValidFlag = 1 << 16, // StyledElement
682 #if ENABLE(SVG)
683         AreSVGAttributesValidFlag = 1 << 17, // Element
684         IsSynchronizingSVGAttributesFlag = 1 << 18, // SVGElement
685         HasSVGRareDataFlag = 1 << 19, // SVGElement
686 #endif
687
688         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1),
689
690         SelfOrAncestorHasDirAutoFlag = 1 << 22,
691
692         HasNameFlag = 1 << 23,
693
694         AttributeStyleDirtyFlag = 1 << 24,
695
696 #if ENABLE(SVG)
697         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag | AreSVGAttributesValidFlag,
698 #else
699         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag,
700 #endif
701         InNamedFlowFlag = 1 << 26,
702         HasAttrListFlag = 1 << 27,
703         HasCustomCallbacksFlag = 1 << 28
704     };
705
706     // 4 bits remaining
707
708     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
709     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
710     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
711     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; } 
712
713 protected:
714     enum ConstructionType { 
715         CreateOther = DefaultNodeFlags,
716         CreateText = DefaultNodeFlags | IsTextFlag,
717         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
718         CreateElement = CreateContainer | IsElementFlag, 
719         CreateShadowRoot = CreateContainer | IsShadowRootFlag,
720         CreateStyledElement = CreateElement | IsStyledElementFlag, 
721         CreateHTMLElement = CreateStyledElement | IsHTMLFlag, 
722         CreateFrameOwnerElement = CreateHTMLElement | HasCustomCallbacksFlag,
723         CreateSVGElement = CreateStyledElement | IsSVGFlag,
724         CreateDocument = CreateContainer | InDocumentFlag
725     };
726     Node(Document*, ConstructionType);
727
728     virtual void didMoveToNewDocument(Document* oldDocument);
729     
730     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const { }
731     void setTabIndexExplicitly(short);
732     void clearTabIndexExplicitly();
733     
734     bool hasRareData() const { return getFlag(HasRareDataFlag); }
735
736     NodeRareData* rareData() const;
737     NodeRareData* ensureRareData();
738     void clearRareData();
739
740     void setHasCustomCallbacks() { setFlag(true, HasCustomCallbacksFlag); }
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     using TreeShared<ContainerNode>::setParent;
780
781     void trackForDebugging();
782
783 #if ENABLE(MUTATION_OBSERVERS)
784     Vector<OwnPtr<MutationObserverRegistration> >* mutationObserverRegistry();
785     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
786     void collectMatchingObserversForMutation(HashMap<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 public:
796     bool isStyleAttributeValid() const { return getFlag(IsStyleAttributeValidFlag); }
797     void setIsStyleAttributeValid(bool f) { setFlag(f, IsStyleAttributeValidFlag); }
798     void setIsStyleAttributeValid() const { setFlag(IsStyleAttributeValidFlag); }
799     void clearIsStyleAttributeValid() { clearFlag(IsStyleAttributeValidFlag); }
800
801 protected:
802     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
803     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
804     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
805
806 #if ENABLE(SVG)
807     bool areSVGAttributesValid() const { return getFlag(AreSVGAttributesValidFlag); }
808     void setAreSVGAttributesValid() const { setFlag(AreSVGAttributesValidFlag); }
809     void clearAreSVGAttributesValid() { clearFlag(AreSVGAttributesValidFlag); }
810     bool isSynchronizingSVGAttributes() const { return getFlag(IsSynchronizingSVGAttributesFlag); }
811     void setIsSynchronizingSVGAttributes() const { setFlag(IsSynchronizingSVGAttributesFlag); }
812     void clearIsSynchronizingSVGAttributes() const { clearFlag(IsSynchronizingSVGAttributesFlag); }
813     bool hasRareSVGData() const { return getFlag(HasSVGRareDataFlag); }
814     void setHasRareSVGData() { setFlag(HasSVGRareDataFlag); }
815     void clearHasRareSVGData() { clearFlag(HasSVGRareDataFlag); }
816 #endif
817
818 #if ENABLE(MICRODATA)
819     void setItemProp(const String&);
820     void setItemRef(const String&);
821     void setItemType(const String&);
822 #endif
823 };
824
825 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
826 inline void addSubresourceURL(ListHashSet<KURL>& urls, const KURL& url)
827 {
828     if (!url.isNull())
829         urls.add(url);
830 }
831
832 inline ContainerNode* Node::parentNode() const
833 {
834     return getFlag(IsShadowRootFlag) ? 0 : parent();
835 }
836
837 inline void Node::setParentOrHostNode(ContainerNode* parent)
838 {
839     setParent(parent);
840 }
841
842 inline ContainerNode* Node::parentOrHostNode() const
843 {
844     return parent();
845 }
846
847 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
848 {
849     ASSERT(!getFlag(IsShadowRootFlag));
850     return parentOrHostNode();
851 }
852
853 inline void Node::reattach()
854 {
855     if (attached())
856         detach();
857     attach();
858 }
859
860 inline void Node::reattachIfAttached()
861 {
862     if (attached())
863         reattach();
864 }
865
866 } //namespace
867
868 #ifndef NDEBUG
869 // Outside the WebCore namespace for ease of invocation from gdb.
870 void showTree(const WebCore::Node*);
871 void showNodePath(const WebCore::Node*);
872 #endif
873
874 #endif