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