2010-10-18 Darin Adler <darin@apple.com>
[WebKit-https.git] / 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 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 "EventTarget.h"
29 #include "KURLHash.h"
30 #include "RenderStyleConstants.h"
31 #include "ScriptWrappable.h"
32 #include "TreeShared.h"
33 #include <wtf/Forward.h>
34 #include <wtf/ListHashSet.h>
35
36 #if USE(JSC)
37 namespace JSC {
38     class JSGlobalData;
39     class MarkStack;
40 }
41 #endif
42
43 namespace WebCore {
44
45 class Attribute;
46 class ClassNodeList;
47 class ContainerNode;
48 class Document;
49 class DynamicNodeList;
50 class Element;
51 class Event;
52 class EventListener;
53 class FloatPoint;
54 class Frame;
55 class IntRect;
56 class KeyboardEvent;
57 class NSResolver;
58 class NamedNodeMap;
59 class NameNodeList;
60 class NodeList;
61 class NodeRareData;
62 class PlatformKeyboardEvent;
63 class PlatformMouseEvent;
64 class PlatformWheelEvent;
65 class QualifiedName;
66 class RegisteredEventListener;
67 class RenderArena;
68 class RenderBox;
69 class RenderBoxModelObject;
70 class RenderObject;
71 class RenderStyle;
72 class TagNodeList;
73
74 typedef int ExceptionCode;
75
76 const int nodeStyleChangeShift = 24;
77
78 // SyntheticStyleChange means that we need to go through the entire style change logic even though
79 // no style property has actually changed. It is used to restructure the tree when, for instance,
80 // RenderLayers are created or destroyed due to animation changes.
81 enum StyleChangeType { 
82     NoStyleChange = 0, 
83     InlineStyleChange = 1 << nodeStyleChangeShift, 
84     FullStyleChange = 2 << nodeStyleChangeShift, 
85     SyntheticStyleChange = 3 << nodeStyleChangeShift
86 };
87
88 class Node : public EventTarget, public TreeShared<ContainerNode>, public ScriptWrappable {
89     friend class Document;
90 public:
91     enum NodeType {
92         ELEMENT_NODE = 1,
93         ATTRIBUTE_NODE = 2,
94         TEXT_NODE = 3,
95         CDATA_SECTION_NODE = 4,
96         ENTITY_REFERENCE_NODE = 5,
97         ENTITY_NODE = 6,
98         PROCESSING_INSTRUCTION_NODE = 7,
99         COMMENT_NODE = 8,
100         DOCUMENT_NODE = 9,
101         DOCUMENT_TYPE_NODE = 10,
102         DOCUMENT_FRAGMENT_NODE = 11,
103         NOTATION_NODE = 12,
104         XPATH_NAMESPACE_NODE = 13
105     };
106     enum DocumentPosition {
107         DOCUMENT_POSITION_EQUIVALENT = 0x00,
108         DOCUMENT_POSITION_DISCONNECTED = 0x01,
109         DOCUMENT_POSITION_PRECEDING = 0x02,
110         DOCUMENT_POSITION_FOLLOWING = 0x04,
111         DOCUMENT_POSITION_CONTAINS = 0x08,
112         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
113         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
114     };
115
116     static bool isSupported(const String& feature, const String& version);
117
118     static void startIgnoringLeaks();
119     static void stopIgnoringLeaks();
120
121     static void dumpStatistics();
122
123     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
124     static StyleChange diff(const RenderStyle*, const RenderStyle*);
125
126     virtual ~Node();
127
128     // DOM methods & attributes for Node
129
130     bool hasTagName(const QualifiedName&) const;
131     virtual String nodeName() const = 0;
132     virtual String nodeValue() const;
133     virtual void setNodeValue(const String&, ExceptionCode&);
134     virtual NodeType nodeType() const = 0;
135     ContainerNode* parentNode() const { return parent(); }
136     Element* parentElement() const;
137     Node* previousSibling() const { return m_previous; }
138     Node* nextSibling() const { return m_next; }
139     PassRefPtr<NodeList> childNodes();
140     Node* firstChild() const;
141     Node* lastChild() const;
142     bool hasAttributes() const;
143     NamedNodeMap* attributes() const;
144
145     virtual KURL baseURI() const;
146     
147     void getSubresourceURLs(ListHashSet<KURL>&) const;
148
149     // These should all actually return a node, but this is only important for language bindings,
150     // which will already know and hold a ref on the right node to return. Returning bool allows
151     // these methods to be more efficient since they don't need to return a ref
152     bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
153     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
154     bool removeChild(Node* child, ExceptionCode&);
155     bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
156
157     void remove(ExceptionCode&);
158     bool hasChildNodes() const { return firstChild(); }
159     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
160     const AtomicString& localName() const { return virtualLocalName(); }
161     const AtomicString& namespaceURI() const { return virtualNamespaceURI(); }
162     const AtomicString& prefix() const { return virtualPrefix(); }
163     virtual void setPrefix(const AtomicString&, ExceptionCode&);
164     void normalize();
165
166     bool isSameNode(Node* other) const { return this == other; }
167     bool isEqualNode(Node*) const;
168     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
169     String lookupPrefix(const AtomicString& namespaceURI) const;
170     String lookupNamespaceURI(const String& prefix) const;
171     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
172     
173     String textContent(bool convertBRsToNewlines = false) const;
174     void setTextContent(const String&, ExceptionCode&);
175     
176     Node* lastDescendant() const;
177     Node* firstDescendant() const;
178     
179     // Other methods (not part of DOM)
180
181     bool isElementNode() const { return getFlag(IsElementFlag); }
182     bool isContainerNode() const { return getFlag(IsContainerFlag); }
183     bool isTextNode() const { return getFlag(IsTextFlag); }
184
185     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
186
187     bool isSVGElement() const { return getFlag(IsSVGFlag); }
188
189 #if ENABLE(WML)
190     virtual bool isWMLElement() const { return false; }
191 #else
192     static bool isWMLElement() { return false; }
193 #endif
194
195     virtual bool isMediaControlElement() const { return false; }
196     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
197     virtual bool isFrameOwnerElement() const { return false; }
198     virtual bool isAttributeNode() const { return false; }
199     bool isCommentNode() const { return getFlag(IsCommentFlag); }
200     virtual bool isCharacterDataNode() const { return false; }
201     bool isDocumentNode() const;
202     virtual bool isShadowNode() const { return false; }
203     virtual ContainerNode* shadowParentNode() { return 0; }
204     Node* shadowAncestorNode();
205     Node* shadowTreeRootNode();
206     bool isInShadowTree();
207
208     // The node's parent for the purpose of event capture and bubbling.
209     virtual ContainerNode* eventParentNode();
210
211     // Returns the enclosing event parent node (or self) that, when clicked, would trigger a navigation.
212     Node* enclosingLinkEventParentOrSelf();
213
214     // Node ancestors when concerned about event flow.
215     // FIXME: Should be named getEventAncestors.
216     void eventAncestors(Vector<RefPtr<ContainerNode> > &ancestors);
217
218     bool isBlockFlow() const;
219     bool isBlockFlowOrBlockTable() const;
220     
221     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
222     void setPreviousSibling(Node* previous) { m_previous = previous; }
223     void setNextSibling(Node* next) { m_next = next; }
224
225     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
226     Node* previousNodeConsideringAtomicNodes() const;
227     Node* nextNodeConsideringAtomicNodes() const;
228     
229     // Returns the next leaf node or 0 if there are no more.
230     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
231     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
232     // out of the Node class into an editing-specific source file.
233     Node* nextLeafNode() const;
234
235     // Returns the previous leaf node or 0 if there are no more.
236     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
237     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
238     // out of the Node class into an editing-specific source file.
239     Node* previousLeafNode() const;
240
241     // enclosingBlockFlowElement() is deprecated. Use enclosingBlock instead.
242     Element* enclosingBlockFlowElement() const;
243     
244     Element* rootEditableElement() const;
245     
246     bool inSameContainingBlockFlowElement(Node*);
247
248     // FIXME: All callers of this function are almost certainly wrong!
249     virtual void deprecatedParserAddChild(PassRefPtr<Node>);
250
251     // Called by the parser when this element's close tag is reached,
252     // signaling that all child tags have been parsed and added.
253     // This is needed for <applet> and <object> elements, which can't lay themselves out
254     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
255     // Also used for script elements and some SVG elements for similar purposes,
256     // but making parsing a special case in this respect should be avoided if possible.
257     virtual void finishParsingChildren() { }
258     virtual void beginParsingChildren() { }
259
260     // Called on the focused node right before dispatching an unload event.
261     virtual void aboutToUnload() { }
262
263     // For <link> and <style> elements.
264     virtual bool sheetLoaded() { return true; }
265
266     bool hasID() const { return getFlag(HasIDFlag); }
267     bool hasClass() const { return getFlag(HasClassFlag); }
268     bool active() const { return getFlag(IsActiveFlag); }
269     bool inActiveChain() const { return getFlag(InActiveChainFlag); }
270     bool inDetach() const { return getFlag(InDetachFlag); }
271     bool hovered() const { return getFlag(IsHoveredFlag); }
272     bool focused() const { return hasRareData() ? rareDataFocused() : false; }
273     bool attached() const { return getFlag(IsAttachedFlag); }
274     void setAttached() { setFlag(IsAttachedFlag); }
275     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
276     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
277     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
278     bool isLink() const { return getFlag(IsLinkFlag); }
279
280     void setHasID(bool f) { setFlag(f, HasIDFlag); }
281     void setHasClass(bool f) { setFlag(f, HasClassFlag); }
282     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
283     void clearChildNeedsStyleRecalc() { clearFlag(ChildNeedsStyleRecalcFlag); }
284     void setInDocument() { setFlag(InDocumentFlag); }
285     void clearInDocument() { clearFlag(InDocumentFlag); }
286
287     void setInActiveChain() { setFlag(InActiveChainFlag); }
288     void clearInActiveChain() { clearFlag(InActiveChainFlag); }
289
290     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
291     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
292
293     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
294     void setIsLink() { setFlag(IsLinkFlag); }
295     void clearIsLink() { clearFlag(IsLinkFlag); }
296
297     enum ShouldSetAttached {
298         SetAttached,
299         DoNotSetAttached
300     };
301     void lazyAttach(ShouldSetAttached = SetAttached);
302
303     virtual void setFocus(bool = true);
304     virtual void setActive(bool f = true, bool /*pause*/ = false) { setFlag(f, IsActiveFlag); }
305     virtual void setHovered(bool f = true) { setFlag(f, IsHoveredFlag); }
306
307     virtual short tabIndex() const;
308
309     // Whether this kind of node can receive focus by default. Most nodes are
310     // not focusable but some elements, such as form controls and links, are.
311     virtual bool supportsFocus() const;
312     // Whether the node can actually be focused.
313     virtual bool isFocusable() const;
314     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
315     virtual bool isMouseFocusable() const;
316
317     virtual bool isContentEditable() const;
318     virtual bool isContentRichlyEditable() const;
319     virtual bool shouldUseInputMethod() const;
320     virtual IntRect getRect() const;
321     IntRect renderRect(bool* isReplaced);
322
323     // Returns true if the node has a non-empty bounding box in layout.
324     // This does not 100% guarantee the user can see it, but is pretty close.
325     // Note: This method only works properly after layout has occurred.
326     bool hasNonEmptyBoundingBox() const;
327
328     virtual void recalcStyle(StyleChange = NoChange) { }
329
330     unsigned nodeIndex() const;
331
332     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
333     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
334     virtual Document* ownerDocument() const;
335
336     // Returns the document associated with this node. This method never returns NULL, except in the case 
337     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
338     Document* document() const
339     {
340         ASSERT(this);
341         ASSERT(m_document || (nodeType() == DOCUMENT_TYPE_NODE && !inDocument()));
342         return m_document;
343     }
344
345     // Do not use this method to change the document of a node until after the node has been
346     // removed from its previous document.
347     void setDocument(Document*);
348
349     // Returns true if this node is associated with a document and is in its associated document's
350     // node tree, false otherwise.
351     bool inDocument() const 
352     { 
353         ASSERT(m_document || !getFlag(InDocumentFlag));
354         return getFlag(InDocumentFlag);
355     }
356
357     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
358     virtual bool childTypeAllowed(NodeType) { return false; }
359     unsigned childNodeCount() const;
360     Node* childNode(unsigned index) const;
361
362     // Does a pre-order traversal of the tree to find the node next node after this one.
363     // This uses the same order that tags appear in the source file. If the stayWithin
364     // argument is non-null, the traversal will stop once the specified node is reached.
365     // This can be used to restrict traversal to a particular sub-tree.
366     Node* traverseNextNode(const Node* stayWithin = 0) const;
367     
368     // Like traverseNextNode, but skips children and starts with the next sibling.
369     Node* traverseNextSibling(const Node* stayWithin = 0) const;
370
371     // Does a reverse pre-order traversal to find the node that comes before the current one in document order
372     Node* traversePreviousNode(const Node* stayWithin = 0) const;
373
374     // Like traverseNextNode, but visits parents after their children.
375     Node* traverseNextNodePostOrder() const;
376
377     // Like traversePreviousNode, but visits parents before their children.
378     Node* traversePreviousNodePostOrder(const Node* stayWithin = 0) const;
379     Node* traversePreviousSiblingPostOrder(const Node* stayWithin = 0) const;
380
381     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
382     bool isDescendantOf(const Node*) const;
383     bool contains(const Node*) const;
384
385     // This method is used to do strict error-checking when adding children via
386     // the public DOM API (e.g., appendChild()).
387     void checkAddChild(Node* newChild, ExceptionCode&); // Error-checking when adding via the DOM API
388
389     void checkReplaceChild(Node* newChild, Node* oldChild, ExceptionCode&);
390     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
391     
392     // Used to determine whether range offsets use characters or node indices.
393     virtual bool offsetInCharacters() const;
394     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
395     // css-transform:capitalize breaking up precomposed characters and ligatures.
396     virtual int maxCharacterOffset() const;
397     
398     // FIXME: We should try to find a better location for these methods.
399     virtual bool canSelectAll() const { return false; }
400     virtual void selectAll() { }
401
402     // Whether or not a selection can be started in this object
403     virtual bool canStartSelection() const;
404
405     // Getting points into and out of screen space
406     FloatPoint convertToPage(const FloatPoint&) const;
407     FloatPoint convertFromPage(const FloatPoint&) const;
408
409     // -----------------------------------------------------------------------------
410     // Integration with rendering tree
411
412     RenderObject* renderer() const { return m_renderer; }
413     RenderObject* nextRenderer();
414     RenderObject* previousRenderer();
415     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
416     
417     // Use these two methods with caution.
418     RenderBox* renderBox() const;
419     RenderBoxModelObject* renderBoxModelObject() const;
420
421     // Attaches this node to the rendering tree. This calculates the style to be applied to the node and creates an
422     // appropriate RenderObject which will be inserted into the tree (except when the style has display: none). This
423     // makes the node visible in the FrameView.
424     virtual void attach();
425
426     // Detaches the node from the rendering tree, making it invisible in the rendered view. This method will remove
427     // the node's rendering object from the rendering tree and delete it.
428     virtual void detach();
429
430     virtual void willRemove();
431     void createRendererIfNeeded();
432     PassRefPtr<RenderStyle> styleForRenderer();
433     virtual bool rendererIsNeeded(RenderStyle*);
434     virtual bool childShouldCreateRenderer(Node*) const { return true; }
435     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
436     
437     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
438     RenderStyle* renderStyle() const;
439     virtual void setRenderStyle(PassRefPtr<RenderStyle>);
440
441     RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return virtualComputedStyle(pseudoElementSpecifier); }
442
443     // -----------------------------------------------------------------------------
444     // Notification of document structure changes
445
446     // Notifies the node that it has been inserted into the document. This is called during document parsing, and also
447     // when a node is added through the DOM methods insertBefore(), appendChild() or replaceChild(). Note that this only
448     // happens when the node becomes part of the document tree, i.e. only when the document is actually an ancestor of
449     // the node. The call happens _after_ the node has been added to the tree.
450     //
451     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
452     // dispatching.
453     virtual void insertedIntoDocument();
454
455     // Notifies the node that it is no longer part of the document tree, i.e. when the document is no longer an ancestor
456     // node.
457     //
458     // This is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
459     // dispatching, and is called _after_ the node is removed from the tree.
460     virtual void removedFromDocument();
461
462     // These functions are called whenever you are connected or disconnected from a tree.  That tree may be the main
463     // document tree, or it could be another disconnected tree.  Override these functions to do any work that depends
464     // on connectedness to some ancestor (e.g., an ancestor <form> for example).
465     virtual void insertedIntoTree(bool /*deep*/) { }
466     virtual void removedFromTree(bool /*deep*/) { }
467
468     // Notifies the node that it's list of children have changed (either by adding or removing child nodes), or a child
469     // node that is of the type CDATA_SECTION_NODE, TEXT_NODE or COMMENT_NODE has changed its value.
470     virtual void childrenChanged(bool /*changedByParser*/ = false, Node* /*beforeChange*/ = 0, Node* /*afterChange*/ = 0, int /*childCountDelta*/ = 0) { }
471
472 #ifndef NDEBUG
473     virtual void formatForDebugger(char* buffer, unsigned length) const;
474
475     void showNode(const char* prefix = "") const;
476     void showTreeForThis() const;
477     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
478 #endif
479
480     void registerDynamicNodeList(DynamicNodeList*);
481     void unregisterDynamicNodeList(DynamicNodeList*);
482     void notifyNodeListsChildrenChanged();
483     void notifyLocalNodeListsChildrenChanged();
484     void notifyNodeListsAttributeChanged();
485     void notifyLocalNodeListsAttributeChanged();
486     void notifyLocalNodeListsLabelChanged();
487     void removeCachedClassNodeList(ClassNodeList*, const String&);
488     void removeCachedNameNodeList(NameNodeList*, const String&);
489     void removeCachedTagNodeList(TagNodeList*, const QualifiedName&);
490     void removeCachedLabelsNodeList(DynamicNodeList*);
491     
492     PassRefPtr<NodeList> getElementsByTagName(const AtomicString&);
493     PassRefPtr<NodeList> getElementsByTagNameNS(const AtomicString& namespaceURI, const AtomicString& localName);
494     PassRefPtr<NodeList> getElementsByName(const String& elementName);
495     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
496
497     PassRefPtr<Element> querySelector(const String& selectors, ExceptionCode&);
498     PassRefPtr<NodeList> querySelectorAll(const String& selectors, ExceptionCode&);
499
500     unsigned short compareDocumentPosition(Node*);
501
502     virtual Node* toNode() { return this; }
503
504     virtual ScriptExecutionContext* scriptExecutionContext() const;
505
506     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
507     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
508
509     // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
510     // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
511     virtual void* preDispatchEventHandler(Event*) { return 0; }
512     virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
513
514     using EventTarget::dispatchEvent;
515     virtual bool dispatchEvent(PassRefPtr<Event>);
516
517     bool dispatchGenericEvent(PassRefPtr<Event>);
518     virtual void handleLocalEvents(Event*);
519
520     void dispatchSubtreeModifiedEvent();
521     void dispatchUIEvent(const AtomicString& eventType, int detail, PassRefPtr<Event> underlyingEvent);
522     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
523     void dispatchWheelEvent(PlatformWheelEvent&);
524     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Node* relatedTarget = 0);
525     bool dispatchMouseEvent(const AtomicString& eventType, int button, int clickCount,
526         int pageX, int pageY, int screenX, int screenY,
527         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
528         bool isSimulated, Node* relatedTarget, PassRefPtr<Event> underlyingEvent);
529     void dispatchSimulatedMouseEvent(const AtomicString& eventType, PassRefPtr<Event> underlyingEvent);
530     void dispatchSimulatedClick(PassRefPtr<Event> underlyingEvent, bool sendMouseEvents = false, bool showPressedLook = true);
531
532     virtual void dispatchFocusEvent();
533     virtual void dispatchBlurEvent();
534
535     // Perform the default action for an event.
536     virtual void defaultEventHandler(Event*);
537
538     // Used for disabled form elements; if true, prevents mouse events from being dispatched
539     // to event listeners, and prevents DOMActivate events from being sent at all.
540     virtual bool disabled() const;
541
542     using TreeShared<ContainerNode>::ref;
543     using TreeShared<ContainerNode>::deref;
544
545     virtual EventTargetData* eventTargetData();
546     virtual EventTargetData* ensureEventTargetData();
547
548 #if USE(JSC)
549     void markCachedNodeLists(JSC::MarkStack& markStack, JSC::JSGlobalData& globalData)
550     {
551         // NodeLists may be present.  If so, they need to be marked.
552         if (!hasRareData())
553             return;
554
555         markCachedNodeListsSlow(markStack, globalData);
556     }
557 #endif
558
559 private:
560     enum NodeFlags {
561         IsTextFlag = 1,
562         IsCommentFlag = 1 << 1,
563         IsContainerFlag = 1 << 2,
564         IsElementFlag = 1 << 3,
565         IsStyledElementFlag = 1 << 4,
566         IsHTMLFlag = 1 << 5,
567         IsSVGFlag = 1 << 6,
568         HasIDFlag = 1 << 7,
569         HasClassFlag = 1 << 8,
570         IsAttachedFlag = 1 << 9,
571         ChildNeedsStyleRecalcFlag = 1 << 10,
572         InDocumentFlag = 1 << 11,
573         IsLinkFlag = 1 << 12,
574         IsActiveFlag = 1 << 13,
575         IsHoveredFlag = 1 << 14,
576         InActiveChainFlag = 1 << 15,
577         InDetachFlag = 1 << 16,
578         HasRareDataFlag = 1 << 17,
579
580         // These bits are used by derived classes, pulled up here so they can
581         // be stored in the same memory word as the Node bits above.
582         IsParsingChildrenFinishedFlag = 1 << 18, // Element
583         IsStyleAttributeValidFlag = 1 << 19, // StyledElement
584         IsSynchronizingStyleAttributeFlag = 1 << 20, // StyledElement
585 #if ENABLE(SVG)
586         AreSVGAttributesValidFlag = 1 << 21, // Element
587         IsSynchronizingSVGAttributesFlag = 1 << 22, // SVGElement
588         HasSVGRareDataFlag = 1 << 23, // SVGElement
589 #endif
590         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1),
591
592 #if ENABLE(SVG)
593         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag | AreSVGAttributesValidFlag
594 #else
595         DefaultNodeFlags = IsParsingChildrenFinishedFlag | IsStyleAttributeValidFlag
596 #endif
597     };
598
599     // 5 bits remaining
600
601     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
602     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
603     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
604     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; } 
605
606 protected:
607     enum ConstructionType { 
608         CreateOther = DefaultNodeFlags,
609         CreateText = DefaultNodeFlags | IsTextFlag,
610         CreateComment = DefaultNodeFlags | IsCommentFlag,
611         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
612         CreateElement = CreateContainer | IsElementFlag, 
613         CreateStyledElement = CreateElement | IsStyledElementFlag, 
614         CreateHTMLElement = CreateStyledElement | IsHTMLFlag, 
615         CreateSVGElement = CreateStyledElement | IsSVGFlag, 
616     };
617     Node(Document*, ConstructionType);
618
619     virtual void willMoveToNewOwnerDocument();
620     virtual void didMoveToNewOwnerDocument();
621     
622     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const { }
623     void setTabIndexExplicitly(short);
624     
625     bool hasRareData() const { return getFlag(HasRareDataFlag); }
626
627     NodeRareData* rareData() const;
628     NodeRareData* ensureRareData();
629
630 private:
631 #if USE(JSC)
632     void markCachedNodeListsSlow(JSC::MarkStack&, JSC::JSGlobalData&);
633 #endif
634
635     void setStyleChange(StyleChangeType);
636
637     // Used to share code between lazyAttach and setNeedsStyleRecalc.
638     void markAncestorsWithChildNeedsStyleRecalc();
639
640     virtual void refEventTarget();
641     virtual void derefEventTarget();
642
643     virtual NodeRareData* createRareData();
644     bool rareDataFocused() const;
645
646     virtual RenderStyle* nonRendererRenderStyle() const;
647
648     virtual const AtomicString& virtualPrefix() const;
649     virtual const AtomicString& virtualLocalName() const;
650     virtual const AtomicString& virtualNamespaceURI() const;
651     virtual RenderStyle* virtualComputedStyle(PseudoId = NOPSEUDO);
652
653     Element* ancestorElement() const;
654
655     void trackForDebugging();
656
657     Document* m_document;
658     Node* m_previous;
659     Node* m_next;
660     RenderObject* m_renderer;
661     mutable uint32_t m_nodeFlags;
662
663 protected:
664     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
665     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
666     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
667     bool isStyleAttributeValid() const { return getFlag(IsStyleAttributeValidFlag); }
668     void setIsStyleAttributeValid(bool f) { setFlag(f, IsStyleAttributeValidFlag); }
669     void setIsStyleAttributeValid() const { setFlag(IsStyleAttributeValidFlag); }
670     void clearIsStyleAttributeValid() { clearFlag(IsStyleAttributeValidFlag); }
671     bool isSynchronizingStyleAttribute() const { return getFlag(IsSynchronizingStyleAttributeFlag); }
672     void setIsSynchronizingStyleAttribute(bool f) { setFlag(f, IsSynchronizingStyleAttributeFlag); }
673     void setIsSynchronizingStyleAttribute() const { setFlag(IsSynchronizingStyleAttributeFlag); }
674     void clearIsSynchronizingStyleAttribute() const { clearFlag(IsSynchronizingStyleAttributeFlag); }
675
676 #if ENABLE(SVG)
677     bool areSVGAttributesValid() const { return getFlag(AreSVGAttributesValidFlag); }
678     void setAreSVGAttributesValid() const { setFlag(AreSVGAttributesValidFlag); }
679     void clearAreSVGAttributesValid() { clearFlag(AreSVGAttributesValidFlag); }
680     bool isSynchronizingSVGAttributes() const { return getFlag(IsSynchronizingSVGAttributesFlag); }
681     void setIsSynchronizingSVGAttributes() const { setFlag(IsSynchronizingSVGAttributesFlag); }
682     void clearIsSynchronizingSVGAttributes() const { clearFlag(IsSynchronizingSVGAttributesFlag); }
683     bool hasRareSVGData() const { return getFlag(HasSVGRareDataFlag); }
684     void setHasRareSVGData() { setFlag(HasSVGRareDataFlag); }
685     void clearHasRareSVGData() { clearFlag(HasSVGRareDataFlag); }
686 #endif
687 };
688
689 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
690 inline void addSubresourceURL(ListHashSet<KURL>& urls, const KURL& url)
691 {
692     if (!url.isNull())
693         urls.add(url);
694 }
695
696 } //namespace
697
698 #ifndef NDEBUG
699 // Outside the WebCore namespace for ease of invocation from gdb.
700 void showTree(const WebCore::Node*);
701 #endif
702
703 #endif