2009-08-25 Eric Carlson <eric.carlson@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 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 "PlatformString.h"
31 #include "RegisteredEventListener.h"
32 #include "TreeShared.h"
33 #include "FloatPoint.h"
34 #include <wtf/Assertions.h>
35 #include <wtf/ListHashSet.h>
36 #include <wtf/OwnPtr.h>
37 #include <wtf/PassRefPtr.h>
38
39 namespace WebCore {
40
41 class AtomicString;
42 class Attribute;
43 class ContainerNode;
44 class Document;
45 class DynamicNodeList;
46 class Element;
47 class Event;
48 class EventListener;
49 class Frame;
50 class IntRect;
51 class KeyboardEvent;
52 class NSResolver;
53 class NamedNodeMap;
54 class NodeList;
55 class NodeRareData;
56 class PlatformKeyboardEvent;
57 class PlatformMouseEvent;
58 class PlatformWheelEvent;
59 class QualifiedName;
60 class RegisteredEventListener;
61 class RenderArena;
62 class RenderBox;
63 class RenderBoxModelObject;
64 class RenderObject;
65 class RenderStyle;
66 class StringBuilder;
67
68 typedef int ExceptionCode;
69
70 enum StyleChangeType { NoStyleChange, InlineStyleChange, FullStyleChange, AnimationStyleChange };
71
72 const unsigned short DOCUMENT_POSITION_EQUIVALENT = 0x00;
73 const unsigned short DOCUMENT_POSITION_DISCONNECTED = 0x01;
74 const unsigned short DOCUMENT_POSITION_PRECEDING = 0x02;
75 const unsigned short DOCUMENT_POSITION_FOLLOWING = 0x04;
76 const unsigned short DOCUMENT_POSITION_CONTAINS = 0x08;
77 const unsigned short DOCUMENT_POSITION_CONTAINED_BY = 0x10;
78 const unsigned short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;
79
80 // this class implements nodes, which can have a parent but no children:
81 class Node : public EventTarget, public TreeShared<Node> {
82     friend class Document;
83 public:
84     enum NodeType {
85         ELEMENT_NODE = 1,
86         ATTRIBUTE_NODE = 2,
87         TEXT_NODE = 3,
88         CDATA_SECTION_NODE = 4,
89         ENTITY_REFERENCE_NODE = 5,
90         ENTITY_NODE = 6,
91         PROCESSING_INSTRUCTION_NODE = 7,
92         COMMENT_NODE = 8,
93         DOCUMENT_NODE = 9,
94         DOCUMENT_TYPE_NODE = 10,
95         DOCUMENT_FRAGMENT_NODE = 11,
96         NOTATION_NODE = 12,
97         XPATH_NAMESPACE_NODE = 13
98     };
99     
100     static bool isSupported(const String& feature, const String& version);
101
102     static void startIgnoringLeaks();
103     static void stopIgnoringLeaks();
104
105     static void dumpStatistics();
106
107     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
108     static StyleChange diff(const RenderStyle*, const RenderStyle*);
109
110     virtual ~Node();
111
112     // DOM methods & attributes for Node
113
114     bool hasTagName(const QualifiedName&) const;
115     virtual String nodeName() const = 0;
116     virtual String nodeValue() const;
117     virtual void setNodeValue(const String&, ExceptionCode&);
118     virtual NodeType nodeType() const = 0;
119     Node* parentNode() const { return parent(); }
120     Element* parentElement() const;
121     Node* previousSibling() const { return m_previous; }
122     Node* nextSibling() const { return m_next; }
123     PassRefPtr<NodeList> childNodes();
124     Node* firstChild() const { return isContainerNode() ? containerFirstChild() : 0; }
125     Node* lastChild() const { return isContainerNode() ? containerLastChild() : 0; }
126     bool hasAttributes() const;
127     NamedNodeMap* attributes() const;
128
129     virtual KURL baseURI() const;
130     
131     void getSubresourceURLs(ListHashSet<KURL>&) const;
132
133     // These should all actually return a node, but this is only important for language bindings,
134     // which will already know and hold a ref on the right node to return. Returning bool allows
135     // these methods to be more efficient since they don't need to return a ref
136     virtual bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
137     virtual bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
138     virtual bool removeChild(Node* child, ExceptionCode&);
139     virtual bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
140
141     void remove(ExceptionCode&);
142     bool hasChildNodes() const { return firstChild(); }
143     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
144     const AtomicString& localName() const { return virtualLocalName(); }
145     const AtomicString& namespaceURI() const { return virtualNamespaceURI(); }
146     const AtomicString& prefix() const { return virtualPrefix(); }
147     virtual void setPrefix(const AtomicString&, ExceptionCode&);
148     void normalize();
149
150     bool isSameNode(Node* other) const { return this == other; }
151     bool isEqualNode(Node*) const;
152     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
153     String lookupPrefix(const AtomicString& namespaceURI) const;
154     String lookupNamespaceURI(const String& prefix) const;
155     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
156     
157     String textContent(bool convertBRsToNewlines = false) const;
158     void setTextContent(const String&, ExceptionCode&);
159     
160     Node* lastDescendant() const;
161     Node* firstDescendant() const;
162     
163     // Other methods (not part of DOM)
164
165     bool isElementNode() const { return m_isElement; }
166     bool isContainerNode() const { return m_isContainer; }
167     bool isTextNode() const { return m_isText; }
168
169     virtual bool isHTMLElement() const { return false; }
170
171 #if ENABLE(SVG)
172     virtual bool isSVGElement() const { return false; }
173 #else
174     static bool isSVGElement() { return false; }
175 #endif
176
177 #if ENABLE(WML)
178     virtual bool isWMLElement() const { return false; }
179 #else
180     static bool isWMLElement() { return false; }
181 #endif
182
183     virtual bool isMediaControlElement() const { return false; }
184     virtual bool isStyledElement() const { return false; }
185     virtual bool isFrameOwnerElement() const { return false; }
186     virtual bool isAttributeNode() const { return false; }
187     virtual bool isCommentNode() const { return false; }
188     virtual bool isCharacterDataNode() const { return false; }
189     bool isDocumentNode() const;
190     virtual bool isShadowNode() const { return false; }
191     virtual Node* shadowParentNode() { return 0; }
192     Node* shadowAncestorNode();
193     Node* shadowTreeRootNode();
194     bool isInShadowTree();
195
196     // The node's parent for the purpose of event capture and bubbling.
197     virtual ContainerNode* eventParentNode();
198
199     bool isBlockFlow() const;
200     bool isBlockFlowOrBlockTable() const;
201     
202     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
203     void setPreviousSibling(Node* previous) { m_previous = previous; }
204     void setNextSibling(Node* next) { m_next = next; }
205
206     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
207     Node* previousNodeConsideringAtomicNodes() const;
208     Node* nextNodeConsideringAtomicNodes() const;
209     
210     /** (Not part of the official DOM)
211      * Returns the next leaf node.
212      *
213      * Using this function delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
214      * @return next leaf node or 0 if there are no more.
215      */
216     Node* nextLeafNode() const;
217
218     /** (Not part of the official DOM)
219      * Returns the previous leaf node.
220      *
221      * Using this function delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
222      * @return previous leaf node or 0 if there are no more.
223      */
224     Node* previousLeafNode() const;
225
226     bool isEditableBlock() const;
227     
228     // enclosingBlockFlowElement() is deprecated.  Use enclosingBlock instead.
229     Element* enclosingBlockFlowElement() const;
230     
231     Element* enclosingInlineElement() const;
232     Element* rootEditableElement() const;
233     
234     bool inSameContainingBlockFlowElement(Node*);
235     
236     // Used by the parser. Checks against the DTD, unlike DOM operations like appendChild().
237     // Also does not dispatch DOM mutation events.
238     // Returns the appropriate container node for future insertions as you parse, or 0 for failure.
239     virtual ContainerNode* addChild(PassRefPtr<Node>);
240
241     // Called by the parser when this element's close tag is reached,
242     // signalling that all child tags have been parsed and added.
243     // This is needed for <applet> and <object> elements, which can't lay themselves out
244     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
245     // Also used for script elements and some SVG elements for similar purposes,
246     // but making parsing a special case in this respect should be avoided if possible.
247     virtual void finishParsingChildren() { }
248     virtual void beginParsingChildren() { }
249
250     // Called by the frame right before dispatching an unloadEvent. [Radar 4532113]
251     // This is needed for HTMLInputElements to tell the frame that it is done editing 
252     // (sends textFieldDidEndEditing notification)
253     virtual void aboutToUnload() { }
254
255     // For <link> and <style> elements.
256     virtual bool sheetLoaded() { return true; }
257
258     bool hasID() const { return m_hasId; }
259     bool hasClass() const { return m_hasClass; }
260     bool active() const { return m_active; }
261     bool inActiveChain() const { return m_inActiveChain; }
262     bool inDetach() const { return m_inDetach; }
263     bool hovered() const { return m_hovered; }
264     bool focused() const { return hasRareData() ? rareDataFocused() : false; }
265     bool attached() const { return m_attached; }
266     void setAttached(bool b = true) { m_attached = b; }
267     bool needsStyleRecalc() const { return m_styleChange != NoStyleChange; }
268     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_styleChange); }
269     bool childNeedsStyleRecalc() const { return m_childNeedsStyleRecalc; }
270     bool isLink() const { return m_isLink; }
271     void setHasID(bool b = true) { m_hasId = b; }
272     void setHasClass(bool b = true) { m_hasClass = b; }
273     void setChildNeedsStyleRecalc(bool b = true) { m_childNeedsStyleRecalc = b; }
274     void setInDocument(bool b = true) { m_inDocument = b; }
275     void setInActiveChain(bool b = true) { m_inActiveChain = b; }
276     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
277     void setIsLink(bool b = true) { m_isLink = b; }
278
279     bool inSubtreeMark() const { return m_inSubtreeMark; }
280     void setInSubtreeMark(bool b = true) { m_inSubtreeMark = b; }
281
282     void lazyAttach();
283     virtual bool canLazyAttach();
284
285     virtual void setFocus(bool b = true);
286     virtual void setActive(bool b = true, bool /*pause*/ = false) { m_active = b; }
287     virtual void setHovered(bool b = true) { m_hovered = b; }
288
289     virtual short tabIndex() const;
290
291     /**
292      * Whether this node can receive the keyboard focus.
293      */
294     virtual bool supportsFocus() const { return isFocusable(); }
295     virtual bool isFocusable() const;
296     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
297     virtual bool isMouseFocusable() const;
298
299     virtual bool isContentEditable() const;
300     virtual bool isContentRichlyEditable() const;
301     virtual bool shouldUseInputMethod() const;
302     virtual IntRect getRect() const;
303
304     virtual void recalcStyle(StyleChange = NoChange) { }
305
306     unsigned nodeIndex() const;
307
308     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
309     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
310     virtual Document* ownerDocument() const;
311
312     // Returns the document associated with this node. This method never returns NULL, except in the case 
313     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
314     Document* document() const
315     {
316         ASSERT(this);
317         ASSERT(m_document || (nodeType() == DOCUMENT_TYPE_NODE && !inDocument()));
318         return m_document;
319     }
320     void setDocument(Document*);
321
322     // Returns true if this node is associated with a document and is in its associated document's
323     // node tree, false otherwise.
324     bool inDocument() const 
325     { 
326         ASSERT(m_document || !m_inDocument);
327         return m_inDocument; 
328     }
329
330     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
331     virtual bool childTypeAllowed(NodeType) { return false; }
332     unsigned childNodeCount() const { return isContainerNode() ? containerChildNodeCount() : 0; }
333     Node* childNode(unsigned index) const { return isContainerNode() ? containerChildNode(index) : 0; }
334
335     /**
336      * Does a pre-order traversal of the tree to find the node next node after this one. This uses the same order that
337      * the tags appear in the source file.
338      *
339      * @param stayWithin If not null, the traversal will stop once the specified node is reached. This can be used to
340      * restrict traversal to a particular sub-tree.
341      *
342      * @return The next node, in document order
343      *
344      * see @ref traversePreviousNode()
345      */
346     Node* traverseNextNode(const Node* stayWithin = 0) const;
347     
348     // Like traverseNextNode, but skips children and starts with the next sibling.
349     Node* traverseNextSibling(const Node* stayWithin = 0) const;
350
351     /**
352      * Does a reverse pre-order traversal to find the node that comes before the current one in document order
353      *
354      * see @ref traverseNextNode()
355      */
356     Node* traversePreviousNode(const Node * stayWithin = 0) const;
357
358     // Like traverseNextNode, but visits parents after their children.
359     Node* traverseNextNodePostOrder() const;
360
361     // Like traversePreviousNode, but visits parents before their children.
362     Node* traversePreviousNodePostOrder(const Node *stayWithin = 0) const;
363     Node* traversePreviousSiblingPostOrder(const Node *stayWithin = 0) const;
364
365     /**
366      * Finds previous or next editable leaf node.
367      */
368     Node* previousEditable() const;
369     Node* nextEditable() const;
370
371     RenderObject* renderer() const { return m_renderer; }
372     RenderObject* nextRenderer();
373     RenderObject* previousRenderer();
374     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
375     
376     // Use these two methods with caution.
377     RenderBox* renderBox() const;
378     RenderBoxModelObject* renderBoxModelObject() const;
379
380     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
381     bool isDescendantOf(const Node*) const;
382     bool contains(const Node*) const;
383
384     // These two methods are mutually exclusive.  The former is used to do strict error-checking
385     // when adding children via the public DOM API (e.g., appendChild()).  The latter is called only when parsing, 
386     // to sanity-check against the DTD for error recovery.
387     void checkAddChild(Node* newChild, ExceptionCode&); // Error-checking when adding via the DOM API
388     virtual bool childAllowed(Node* newChild);          // Error-checking during parsing that checks the DTD
389
390     void checkReplaceChild(Node* newChild, Node* oldChild, ExceptionCode&);
391     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
392     
393     // Used to determine whether range offsets use characters or node indices.
394     virtual bool offsetInCharacters() const;
395     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
396     // css-transform:capitalize breaking up precomposed characters and ligatures.
397     virtual int maxCharacterOffset() const;
398     
399     // FIXME: We should try to find a better location for these methods.
400     virtual bool canSelectAll() const { return false; }
401     virtual void selectAll() { }
402
403     // Whether or not a selection can be started in this object
404     virtual bool canStartSelection() const;
405
406     // Getting points into and out of screen space
407     FloatPoint convertToPage(const FloatPoint& p) const;
408     FloatPoint convertFromPage(const FloatPoint& p) const;
409
410     // -----------------------------------------------------------------------------
411     // Integration with rendering tree
412
413     /**
414      * Attaches this node to the rendering tree. This calculates the style to be applied to the node and creates an
415      * appropriate RenderObject which will be inserted into the tree (except when the style has display: none). This
416      * makes the node visible in the FrameView.
417      */
418     virtual void attach();
419
420     /**
421      * Detaches the node from the rendering tree, making it invisible in the rendered view. This method will remove
422      * the node's rendering object from the rendering tree and delete it.
423      */
424     virtual void detach();
425
426     virtual void willRemove();
427     void createRendererIfNeeded();
428     PassRefPtr<RenderStyle> styleForRenderer();
429     virtual bool rendererIsNeeded(RenderStyle*);
430 #if ENABLE(SVG) || ENABLE(XHTMLMP)
431     virtual bool childShouldCreateRenderer(Node*) const { return true; }
432 #endif
433     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
434     
435     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
436     RenderStyle* renderStyle() const;
437     virtual void setRenderStyle(PassRefPtr<RenderStyle>);
438
439     virtual RenderStyle* computedStyle();
440
441     // -----------------------------------------------------------------------------
442     // Notification of document structure changes
443
444     /**
445      * Notifies the node that it has been inserted into the document. This is called during document parsing, and also
446      * when a node is added through the DOM methods insertBefore(), appendChild() or replaceChild(). Note that this only
447      * happens when the node becomes part of the document tree, i.e. only when the document is actually an ancestor of
448      * the node. The call happens _after_ the node has been added to the tree.
449      *
450      * This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
451      * dispatching.
452      */
453     virtual void insertedIntoDocument();
454
455     /**
456      * Notifies the node that it is no longer part of the document tree, i.e. when the document is no longer an ancestor
457      * node.
458      *
459      * This is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
460      * dispatching, and is called _after_ the node is removed from the tree.
461      */
462     virtual void removedFromDocument();
463
464     // These functions are called whenever you are connected or disconnected from a tree.  That tree may be the main
465     // document tree, or it could be another disconnected tree.  Override these functions to do any work that depends
466     // on connectedness to some ancestor (e.g., an ancestor <form> for example).
467     virtual void insertedIntoTree(bool /*deep*/) { }
468     virtual void removedFromTree(bool /*deep*/) { }
469
470     /**
471      * Notifies the node that it's list of children have changed (either by adding or removing child nodes), or a child
472      * node that is of the type CDATA_SECTION_NODE, TEXT_NODE or COMMENT_NODE has changed its value.
473      */
474     virtual void childrenChanged(bool /*changedByParser*/ = false, Node* /*beforeChange*/ = 0, Node* /*afterChange*/ = 0, int /*childCountDelta*/ = 0) { }
475
476 #ifndef NDEBUG
477     virtual void formatForDebugger(char* buffer, unsigned length) const;
478
479     void showNode(const char* prefix = "") const;
480     void showTreeForThis() const;
481     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
482 #endif
483
484     void registerDynamicNodeList(DynamicNodeList*);
485     void unregisterDynamicNodeList(DynamicNodeList*);
486     void notifyNodeListsChildrenChanged();
487     void notifyLocalNodeListsChildrenChanged();
488     void notifyNodeListsAttributeChanged();
489     void notifyLocalNodeListsAttributeChanged();
490     
491     PassRefPtr<NodeList> getElementsByTagName(const String&);
492     PassRefPtr<NodeList> getElementsByTagNameNS(const AtomicString& namespaceURI, const String& localName);
493     PassRefPtr<NodeList> getElementsByName(const String& elementName);
494     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
495
496     PassRefPtr<Element> querySelector(const String& selectors, ExceptionCode&);
497     PassRefPtr<NodeList> querySelectorAll(const String& selectors, ExceptionCode&);
498
499     unsigned short compareDocumentPosition(Node*);
500
501     virtual Node* toNode() { return this; }
502
503     virtual ScriptExecutionContext* scriptExecutionContext() const;
504
505     // Used for standard DOM addEventListener / removeEventListener APIs.
506     virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
507     virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
508
509     // Used for legacy "onEvent" property APIs.
510     void setAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
511     void clearAttributeEventListener(const AtomicString& eventType);
512     EventListener* getAttributeEventListener(const AtomicString& eventType) const;
513
514     virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&);
515     bool dispatchEvent(const AtomicString& eventType, bool canBubble, bool cancelable);
516
517     void removeAllEventListeners() { if (hasRareData()) removeAllEventListenersSlowCase(); }
518
519     void dispatchSubtreeModifiedEvent();
520     void dispatchUIEvent(const AtomicString& eventType, int detail, PassRefPtr<Event> underlyingEvent);
521     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
522     void dispatchWheelEvent(PlatformWheelEvent&);
523     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType,
524         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     void dispatchProgressEvent(const AtomicString& eventType, bool lengthComputableArg, unsigned loadedArg, unsigned totalArg);
532     void dispatchWebKitAnimationEvent(const AtomicString& eventType, const String& animationName, double elapsedTime);
533     void dispatchWebKitTransitionEvent(const AtomicString& eventType, const String& propertyName, double elapsedTime);
534     void dispatchMutationEvent(const AtomicString& type, bool canBubble, PassRefPtr<Node> relatedNode, const String& prevValue, const String& newValue, ExceptionCode&);
535
536     bool dispatchGenericEvent(PassRefPtr<Event>);
537
538     virtual void handleLocalEvents(Event*, bool useCapture);
539
540     virtual void dispatchFocusEvent();
541     virtual void dispatchBlurEvent();
542
543     /**
544      * Perform the default action for an event e.g. submitting a form
545      */
546     virtual void defaultEventHandler(Event*);
547
548     /**
549      * Used for disabled form elements; if true, prevents mouse events from being dispatched
550      * to event listeners, and prevents DOMActivate events from being sent at all.
551      */
552     virtual bool disabled() const;
553
554     const RegisteredEventListenerVector& eventListeners() const;
555
556     // These 4 attribute event handler attributes are overrided by HTMLBodyElement
557     // and HTMLFrameSetElement to forward to the DOMWindow.
558     virtual EventListener* onblur() const;
559     virtual void setOnblur(PassRefPtr<EventListener>);
560     virtual EventListener* onerror() const;
561     virtual void setOnerror(PassRefPtr<EventListener>);
562     virtual EventListener* onfocus() const;
563     virtual void setOnfocus(PassRefPtr<EventListener>);
564     virtual EventListener* onload() const;
565     virtual void setOnload(PassRefPtr<EventListener>);
566
567     EventListener* onabort() const;
568     void setOnabort(PassRefPtr<EventListener>);
569     EventListener* onchange() const;
570     void setOnchange(PassRefPtr<EventListener>);
571     EventListener* onclick() const;
572     void setOnclick(PassRefPtr<EventListener>);
573     EventListener* oncontextmenu() const;
574     void setOncontextmenu(PassRefPtr<EventListener>);
575     EventListener* ondblclick() const;
576     void setOndblclick(PassRefPtr<EventListener>);
577     EventListener* ondragenter() const;
578     void setOndragenter(PassRefPtr<EventListener>);
579     EventListener* ondragover() const;
580     void setOndragover(PassRefPtr<EventListener>);
581     EventListener* ondragleave() const;
582     void setOndragleave(PassRefPtr<EventListener>);
583     EventListener* ondrop() const;
584     void setOndrop(PassRefPtr<EventListener>);
585     EventListener* ondragstart() const;
586     void setOndragstart(PassRefPtr<EventListener>);
587     EventListener* ondrag() const;
588     void setOndrag(PassRefPtr<EventListener>);
589     EventListener* ondragend() const;
590     void setOndragend(PassRefPtr<EventListener>);
591     EventListener* oninput() const;
592     void setOninput(PassRefPtr<EventListener>);
593     EventListener* oninvalid() const;
594     void setOninvalid(PassRefPtr<EventListener>);
595     EventListener* onkeydown() const;
596     void setOnkeydown(PassRefPtr<EventListener>);
597     EventListener* onkeypress() const;
598     void setOnkeypress(PassRefPtr<EventListener>);
599     EventListener* onkeyup() const;
600     void setOnkeyup(PassRefPtr<EventListener>);
601     EventListener* onmousedown() const;
602     void setOnmousedown(PassRefPtr<EventListener>);
603     EventListener* onmousemove() const;
604     void setOnmousemove(PassRefPtr<EventListener>);
605     EventListener* onmouseout() const;
606     void setOnmouseout(PassRefPtr<EventListener>);
607     EventListener* onmouseover() const;
608     void setOnmouseover(PassRefPtr<EventListener>);
609     EventListener* onmouseup() const;
610     void setOnmouseup(PassRefPtr<EventListener>);
611     EventListener* onmousewheel() const;
612     void setOnmousewheel(PassRefPtr<EventListener>);
613     EventListener* onscroll() const;
614     void setOnscroll(PassRefPtr<EventListener>);
615     EventListener* onselect() const;
616     void setOnselect(PassRefPtr<EventListener>);
617     EventListener* onsubmit() const;
618     void setOnsubmit(PassRefPtr<EventListener>);
619
620     // WebKit extensions
621     EventListener* onbeforecut() const;
622     void setOnbeforecut(PassRefPtr<EventListener>);
623     EventListener* oncut() const;
624     void setOncut(PassRefPtr<EventListener>);
625     EventListener* onbeforecopy() const;
626     void setOnbeforecopy(PassRefPtr<EventListener>);
627     EventListener* oncopy() const;
628     void setOncopy(PassRefPtr<EventListener>);
629     EventListener* onbeforepaste() const;
630     void setOnbeforepaste(PassRefPtr<EventListener>);
631     EventListener* onpaste() const;
632     void setOnpaste(PassRefPtr<EventListener>);
633     EventListener* onreset() const;
634     void setOnreset(PassRefPtr<EventListener>);
635     EventListener* onsearch() const;
636     void setOnsearch(PassRefPtr<EventListener>);
637     EventListener* onselectstart() const;
638     void setOnselectstart(PassRefPtr<EventListener>);
639
640     using TreeShared<Node>::ref;
641     using TreeShared<Node>::deref;
642
643 protected:
644     // CreateElementZeroRefCount is deprecated and can be removed once we convert all element
645     // classes to start with a reference count of 1.
646     enum ConstructionType { CreateContainer, CreateElement, CreateOther, CreateText, CreateElementZeroRefCount };
647     Node(Document*, ConstructionType);
648
649     virtual void willMoveToNewOwnerDocument();
650     virtual void didMoveToNewOwnerDocument();
651     
652     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const { }
653     void setTabIndexExplicitly(short);
654     
655     bool hasRareData() const { return m_hasRareData; }
656     
657     NodeRareData* rareData() const;
658     NodeRareData* ensureRareData();
659
660 private:
661     static bool initialRefCount(ConstructionType);
662     static bool isContainer(ConstructionType);
663     static bool isElement(ConstructionType);
664     static bool isText(ConstructionType);
665
666     virtual void refEventTarget() { ref(); }
667     virtual void derefEventTarget() { deref(); }
668
669     void removeAllEventListenersSlowCase();
670
671     virtual NodeRareData* createRareData();
672     Node* containerChildNode(unsigned index) const;
673     unsigned containerChildNodeCount() const;
674     Node* containerFirstChild() const;
675     Node* containerLastChild() const;
676     bool rareDataFocused() const;
677
678     virtual RenderStyle* nonRendererRenderStyle() const;
679
680     virtual const AtomicString& virtualPrefix() const;
681     virtual const AtomicString& virtualLocalName() const;
682     virtual const AtomicString& virtualNamespaceURI() const;
683
684     Element* ancestorElement() const;
685
686     void appendTextContent(bool convertBRsToNewlines, StringBuilder&) const;
687
688     Document* m_document;
689     Node* m_previous;
690     Node* m_next;
691     RenderObject* m_renderer;
692
693     unsigned m_styleChange : 2;
694     bool m_hasId : 1;
695     bool m_hasClass : 1;
696     bool m_attached : 1;
697     bool m_childNeedsStyleRecalc : 1;
698     bool m_inDocument : 1;
699     bool m_isLink : 1;
700     bool m_active : 1;
701     bool m_hovered : 1;
702     bool m_inActiveChain : 1;
703     bool m_inDetach : 1;
704     bool m_inSubtreeMark : 1;
705     bool m_hasRareData : 1;
706     const bool m_isElement : 1;
707     const bool m_isContainer : 1;
708     const bool m_isText : 1;
709
710 protected:
711     // These bits are used by derived classes, pulled up here so they can
712     // be stored in the same memory word as the Node bits above.
713
714     bool m_parsingChildrenFinished : 1; // Element
715     mutable bool m_isStyleAttributeValid : 1; // StyledElement
716     mutable bool m_synchronizingStyleAttribute : 1; // StyledElement
717
718 #if ENABLE(SVG)
719     mutable bool m_areSVGAttributesValid : 1; // Element
720     mutable bool m_synchronizingSVGAttributes : 1; // SVGElement
721 #endif
722
723     // 11 bits remaining
724 };
725
726 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
727 inline void addSubresourceURL(ListHashSet<KURL>& urls, const KURL& url)
728 {
729     if (!url.isNull())
730         urls.add(url);
731 }
732
733 } //namespace
734
735 #ifndef NDEBUG
736 // Outside the WebCore namespace for ease of invocation from gdb.
737 void showTree(const WebCore::Node*);
738 #endif
739
740 #endif