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