Move dispatching of focus-related events from Node to Element.
[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 "LayoutRect.h"
32 #include "MutationObserver.h"
33 #include "RenderStyleConstants.h"
34 #include "ScriptWrappable.h"
35 #include "SimulatedClickOptions.h"
36 #include "TreeScope.h"
37 #include "TreeShared.h"
38 #include <wtf/Forward.h>
39 #include <wtf/ListHashSet.h>
40 #include <wtf/text/AtomicString.h>
41
42 namespace JSC {
43     class VM;
44     class SlotVisitor;
45 }
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 Element;
58 class Event;
59 class EventContext;
60 class EventDispatchMediator;
61 class EventListener;
62 class FloatPoint;
63 class Frame;
64 class HTMLInputElement;
65 class IntRect;
66 class KeyboardEvent;
67 class NSResolver;
68 class NamedNodeMap;
69 class NameNodeList;
70 class NodeList;
71 class NodeListsNodeData;
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
88 #if ENABLE(GESTURE_EVENTS)
89 class PlatformGestureEvent;
90 #endif
91
92 #if ENABLE(TOUCH_EVENTS)
93 class TouchEvent;
94 #endif
95
96 #if ENABLE(MICRODATA)
97 class HTMLPropertiesCollection;
98 class PropertyNodeList;
99 #endif
100
101 typedef int ExceptionCode;
102
103 const int nodeStyleChangeShift = 15;
104
105 // SyntheticStyleChange means that we need to go through the entire style change logic even though
106 // no style property has actually changed. It is used to restructure the tree when, for instance,
107 // RenderLayers are created or destroyed due to animation changes.
108 enum StyleChangeType { 
109     NoStyleChange = 0, 
110     InlineStyleChange = 1 << nodeStyleChangeShift, 
111     FullStyleChange = 2 << nodeStyleChangeShift, 
112     SyntheticStyleChange = 3 << nodeStyleChangeShift
113 };
114
115 class NodeRareDataBase {
116 public:
117     RenderObject* renderer() const { return m_renderer; }
118     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
119
120 protected:
121     NodeRareDataBase(RenderObject* renderer)
122         : m_renderer(renderer)
123     { }
124
125 private:
126     RenderObject* m_renderer;
127 };
128
129 enum AttachBehavior {
130     AttachNow,
131     AttachLazily,
132 };
133
134 class Node : public EventTarget, public ScriptWrappable, public TreeShared<Node> {
135     friend class Document;
136     friend class TreeScope;
137     friend class TreeScopeAdopter;
138
139 public:
140     enum NodeType {
141         ELEMENT_NODE = 1,
142         ATTRIBUTE_NODE = 2,
143         TEXT_NODE = 3,
144         CDATA_SECTION_NODE = 4,
145         ENTITY_REFERENCE_NODE = 5,
146         ENTITY_NODE = 6,
147         PROCESSING_INSTRUCTION_NODE = 7,
148         COMMENT_NODE = 8,
149         DOCUMENT_NODE = 9,
150         DOCUMENT_TYPE_NODE = 10,
151         DOCUMENT_FRAGMENT_NODE = 11,
152         NOTATION_NODE = 12,
153         XPATH_NAMESPACE_NODE = 13,
154     };
155     enum DocumentPosition {
156         DOCUMENT_POSITION_EQUIVALENT = 0x00,
157         DOCUMENT_POSITION_DISCONNECTED = 0x01,
158         DOCUMENT_POSITION_PRECEDING = 0x02,
159         DOCUMENT_POSITION_FOLLOWING = 0x04,
160         DOCUMENT_POSITION_CONTAINS = 0x08,
161         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
162         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
163     };
164
165     static bool isSupported(const String& feature, const String& version);
166
167     static void startIgnoringLeaks();
168     static void stopIgnoringLeaks();
169
170     static void dumpStatistics();
171
172     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
173     static StyleChange diff(const RenderStyle*, const RenderStyle*, Document*);
174
175     virtual ~Node();
176     void willBeDeletedFrom(Document*);
177
178     // DOM methods & attributes for Node
179
180     bool hasTagName(const QualifiedName&) const;
181     bool hasLocalName(const AtomicString&) const;
182     virtual String nodeName() const = 0;
183     virtual String nodeValue() const;
184     virtual void setNodeValue(const String&, ExceptionCode&);
185     virtual NodeType nodeType() const = 0;
186     ContainerNode* parentNode() const;
187     Element* parentElement() const;
188     Node* previousSibling() const { return m_previous; }
189     Node* nextSibling() const { return m_next; }
190     PassRefPtr<NodeList> childNodes();
191     Node* firstChild() const;
192     Node* lastChild() const;
193     bool hasAttributes() const;
194     NamedNodeMap* attributes() const;
195     Node* pseudoAwareNextSibling() const;
196     Node* pseudoAwarePreviousSibling() const;
197     Node* pseudoAwareFirstChild() const;
198     Node* pseudoAwareLastChild() const;
199
200     virtual KURL baseURI() const;
201     
202     void getSubresourceURLs(ListHashSet<KURL>&) const;
203
204     // These should all actually return a node, but this is only important for language bindings,
205     // which will already know and hold a ref on the right node to return. Returning bool allows
206     // these methods to be more efficient since they don't need to return a ref
207     bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, AttachBehavior = AttachNow);
208     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, AttachBehavior = AttachNow);
209     bool removeChild(Node* child, ExceptionCode&);
210     bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, AttachBehavior = AttachNow);
211
212     void remove(ExceptionCode&);
213     bool hasChildNodes() const { return firstChild(); }
214     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
215     virtual const AtomicString& localName() const;
216     virtual const AtomicString& namespaceURI() const;
217     virtual const AtomicString& prefix() const;
218     virtual void setPrefix(const AtomicString&, ExceptionCode&);
219     void normalize();
220
221     bool isSameNode(Node* other) const { return this == other; }
222     bool isEqualNode(Node*) const;
223     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
224     String lookupPrefix(const AtomicString& namespaceURI) const;
225     String lookupNamespaceURI(const String& prefix) const;
226     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
227     
228     String textContent(bool convertBRsToNewlines = false) const;
229     void setTextContent(const String&, ExceptionCode&);
230     
231     Node* lastDescendant() const;
232     Node* firstDescendant() const;
233
234     // Other methods (not part of DOM)
235
236     bool isElementNode() const { return getFlag(IsElementFlag); }
237     bool isContainerNode() const { return getFlag(IsContainerFlag); }
238     bool isTextNode() const { return getFlag(IsTextFlag); }
239     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
240     bool isSVGElement() const { return getFlag(IsSVGFlag); }
241
242     bool isPseudoElement() const { return pseudoId() != NOPSEUDO; }
243     bool isBeforePseudoElement() const { return pseudoId() == BEFORE; }
244     bool isAfterPseudoElement() const { return pseudoId() == AFTER; }
245     PseudoId pseudoId() const { return (isElementNode() && hasCustomStyleCallbacks()) ? customPseudoId() : NOPSEUDO; }
246
247     virtual bool isMediaControlElement() const { return false; }
248     virtual bool isMediaControls() const { return false; }
249 #if ENABLE(VIDEO_TRACK)
250     virtual bool isWebVTTElement() const { return false; }
251 #endif
252     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
253     virtual bool isAttributeNode() const { return false; }
254     virtual bool isCharacterDataNode() const { return false; }
255     virtual bool isFrameOwnerElement() const { return false; }
256     virtual bool isPluginElement() const { return false; }
257     virtual bool isInsertionPointNode() const { return false; }
258
259     bool isDocumentNode() const;
260     bool isTreeScope() const;
261     bool isDocumentFragment() const { return getFlag(IsDocumentFragmentFlag); }
262     bool isShadowRoot() const { return isDocumentFragment() && isTreeScope(); }
263     bool isInsertionPoint() const { return getFlag(NeedsShadowTreeWalkerFlag) && isInsertionPointNode(); }
264     // Returns Node rather than InsertionPoint. Should be used only for language bindings.
265     Node* insertionParentForBinding() const;
266
267     bool needsShadowTreeWalker() const;
268     bool needsShadowTreeWalkerSlow() const;
269     void setNeedsShadowTreeWalker() { setFlag(NeedsShadowTreeWalkerFlag); }
270     void resetNeedsShadowTreeWalker() { setFlag(needsShadowTreeWalkerSlow(), NeedsShadowTreeWalkerFlag); }
271
272     bool inNamedFlow() const { return getFlag(InNamedFlowFlag); }
273     bool hasCustomStyleCallbacks() const { return getFlag(HasCustomStyleCallbacksFlag); }
274
275     bool hasSyntheticAttrChildNodes() const { return getFlag(HasSyntheticAttrChildNodesFlag); }
276     void setHasSyntheticAttrChildNodes(bool flag) { setFlag(flag, HasSyntheticAttrChildNodesFlag); }
277
278     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns 0.
279     Element* shadowHost() const;
280     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
281     // Deprecated. Should use shadowHost() and check the return value.
282     Node* deprecatedShadowAncestorNode() const;
283     ShadowRoot* containingShadowRoot() const;
284     ShadowRoot* shadowRoot() const;
285
286     // Returns 0, a child of ShadowRoot, or a legacy shadow root.
287     Node* nonBoundaryShadowTreeRootNode();
288
289     // Node's parent, shadow tree host.
290     ContainerNode* parentOrShadowHostNode() const;
291     Element* parentOrShadowHostElement() const;
292     void setParentOrShadowHostNode(ContainerNode*);
293     Node* highestAncestor() const;
294
295     // Use when it's guaranteed to that shadowHost is 0.
296     ContainerNode* parentNodeGuaranteedHostFree() const;
297     // Returns the parent node, but 0 if the parent node is a ShadowRoot.
298     ContainerNode* nonShadowBoundaryParentNode() const;
299
300     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
301     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
302
303     // Returns the enclosing event parent node (or self) that, when clicked, would trigger a navigation.
304     Node* enclosingLinkEventParentOrSelf();
305
306     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
307     void setPreviousSibling(Node* previous) { m_previous = previous; }
308     void setNextSibling(Node* next) { m_next = next; }
309
310     virtual bool canContainRangeEndPoint() const { return false; }
311
312     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
313     Node* previousNodeConsideringAtomicNodes() const;
314     Node* nextNodeConsideringAtomicNodes() const;
315     
316     // Returns the next leaf node or 0 if there are no more.
317     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
318     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
319     // out of the Node class into an editing-specific source file.
320     Node* nextLeafNode() const;
321
322     // Returns the previous leaf node or 0 if there are no more.
323     // Delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
324     // Uses an editing-specific concept of what a leaf node is, and should probably be moved
325     // out of the Node class into an editing-specific source file.
326     Node* previousLeafNode() const;
327
328     bool isRootEditableElement() const;
329     Element* rootEditableElement() const;
330     Element* rootEditableElement(EditableType) const;
331
332     // Called by the parser when this element's close tag is reached,
333     // signaling that all child tags have been parsed and added.
334     // This is needed for <applet> and <object> elements, which can't lay themselves out
335     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
336     // Also used for script elements and some SVG elements for similar purposes,
337     // but making parsing a special case in this respect should be avoided if possible.
338     virtual void finishParsingChildren() { }
339     virtual void beginParsingChildren() { }
340
341     // For <link> and <style> elements.
342     virtual bool sheetLoaded() { return true; }
343     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
344     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
345
346     bool hasName() const { return !isTextNode() && getFlag(HasNameOrIsEditingTextFlag); }
347     bool hasID() const;
348     bool hasClass() const;
349
350     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
351     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
352
353     bool attached() const { return getFlag(IsAttachedFlag); }
354     void setAttached() { setFlag(IsAttachedFlag); }
355     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
356     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
357     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
358     bool isLink() const { return getFlag(IsLinkFlag); }
359     bool isEditingText() const { return isTextNode() && getFlag(HasNameOrIsEditingTextFlag); }
360
361     void setHasName(bool f) { ASSERT(!isTextNode()); setFlag(f, HasNameOrIsEditingTextFlag); }
362     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
363     void clearChildNeedsStyleRecalc() { clearFlag(ChildNeedsStyleRecalcFlag); }
364
365     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
366     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
367     virtual void scheduleSetNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange) { setNeedsStyleRecalc(changeType); }
368
369     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
370     void setIsLink() { setFlag(IsLinkFlag); }
371     void clearIsLink() { clearFlag(IsLinkFlag); }
372
373     void setInNamedFlow() { setFlag(InNamedFlowFlag); }
374     void clearInNamedFlow() { clearFlag(InNamedFlowFlag); }
375
376     bool hasScopedHTMLStyleChild() const { return getFlag(HasScopedHTMLStyleChildFlag); }
377     void setHasScopedHTMLStyleChild(bool flag) { setFlag(flag, HasScopedHTMLStyleChildFlag); }
378
379     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
380     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
381
382     enum ShouldSetAttached {
383         SetAttached,
384         DoNotSetAttached
385     };
386     void lazyAttach(ShouldSetAttached = SetAttached);
387     void lazyReattach(ShouldSetAttached = SetAttached);
388
389     enum UserSelectAllTreatment {
390         UserSelectAllDoesNotAffectEditability,
391         UserSelectAllIsAlwaysNonEditable
392     };
393     bool isContentEditable(UserSelectAllTreatment = UserSelectAllDoesNotAffectEditability);
394     bool isContentRichlyEditable();
395
396     void inspect();
397
398     bool rendererIsEditable(EditableType editableType = ContentIsEditable, UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
399     {
400         switch (editableType) {
401         case ContentIsEditable:
402             return rendererIsEditable(Editable, treatment);
403         case HasEditableAXRole:
404             return isEditableToAccessibility(Editable);
405         }
406         ASSERT_NOT_REACHED();
407         return false;
408     }
409
410     bool rendererIsRichlyEditable(EditableType editableType = ContentIsEditable) const
411     {
412         switch (editableType) {
413         case ContentIsEditable:
414             return rendererIsEditable(RichlyEditable, UserSelectAllIsAlwaysNonEditable);
415         case HasEditableAXRole:
416             return isEditableToAccessibility(RichlyEditable);
417         }
418         ASSERT_NOT_REACHED();
419         return false;
420     }
421
422     virtual bool shouldUseInputMethod();
423     virtual LayoutRect boundingBox() const;
424     IntRect pixelSnappedBoundingBox() const { return pixelSnappedIntRect(boundingBox()); }
425     LayoutRect renderRect(bool* isReplaced);
426     IntRect pixelSnappedRenderRect(bool* isReplaced) { return pixelSnappedIntRect(renderRect(isReplaced)); }
427
428     unsigned nodeIndex() const;
429
430     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
431     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
432     Document* ownerDocument() const;
433
434     // Returns the document associated with this node. This method never returns NULL, except in the case 
435     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
436     Document* document() const
437     {
438         ASSERT(this);
439         // FIXME: below ASSERT is useful, but prevents the use of document() in the constructor or destructor
440         // due to the virtual function call to nodeType().
441         ASSERT(documentInternal() || (nodeType() == DOCUMENT_TYPE_NODE && !inDocument()));
442         return documentInternal();
443     }
444
445     TreeScope* treeScope() const { return m_treeScope; }
446
447     // Returns true if this node is associated with a document and is in its associated document's
448     // node tree, false otherwise.
449     bool inDocument() const 
450     { 
451         ASSERT(documentInternal() || !getFlag(InDocumentFlag));
452         return getFlag(InDocumentFlag);
453     }
454     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
455     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(InDocumentFlag | IsInShadowTreeFlag)); }
456
457     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
458     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
459     virtual bool childTypeAllowed(NodeType) const { return false; }
460     unsigned childNodeCount() const;
461     Node* childNode(unsigned index) const;
462
463     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
464     bool isDescendantOf(const Node*) const;
465     bool contains(const Node*) const;
466     bool containsIncludingShadowDOM(const Node*) const;
467     bool containsIncludingHostElements(const Node*) const;
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     // As renderer() includes a branch you should avoid calling it repeatedly in hot code paths.
486     RenderObject* renderer() const { return hasRareData() ? m_data.m_rareData->renderer() : m_data.m_renderer; };
487     void setRenderer(RenderObject* renderer)
488     {
489         if (hasRareData())
490             m_data.m_rareData->setRenderer(renderer);
491         else
492             m_data.m_renderer = renderer;
493     }
494
495     // Use these two methods with caution.
496     RenderBox* renderBox() const;
497     RenderBoxModelObject* renderBoxModelObject() const;
498
499     // Attaches this node to the rendering tree. This calculates the style to be applied to the node and creates an
500     // appropriate RenderObject which will be inserted into the tree (except when the style has display: none). This
501     // makes the node visible in the FrameView.
502     virtual void attach();
503
504     // Detaches the node from the rendering tree, making it invisible in the rendered view. This method will remove
505     // the node's rendering object from the rendering tree and delete it.
506     virtual void detach();
507
508 #ifndef NDEBUG
509     bool inDetach() const;
510 #endif
511
512     void reattach();
513     void reattachIfAttached();
514     ContainerNode* parentNodeForRenderingAndStyle();
515     
516     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
517     RenderStyle* renderStyle() const;
518
519     RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return virtualComputedStyle(pseudoElementSpecifier); }
520
521     // -----------------------------------------------------------------------------
522     // Notification of document structure changes (see ContainerNode.h for more notification methods)
523     //
524     // At first, WebKit notifies the node that it has been inserted into the document. This is called during document parsing, and also
525     // 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.
526     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
527     // dispatching.
528     //
529     // WebKit notifies this callback regardless if the subtree of the node is a document tree or a floating subtree.
530     // Implementation can determine the type of subtree by seeing insertionPoint->inDocument().
531     // For a performance reason, notifications are delivered only to ContainerNode subclasses if the insertionPoint is out of document.
532     //
533     // There are another callback named didNotifyDescendantInsertions(), which is called after all the descendant is notified.
534     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallDidNotifyDescendantInsertions
535     // from insrtedInto().
536     //
537     enum InsertionNotificationRequest {
538         InsertionDone,
539         InsertionShouldCallDidNotifySubtreeInsertions
540     };
541
542     virtual InsertionNotificationRequest insertedInto(ContainerNode* insertionPoint);
543     virtual void didNotifySubtreeInsertions(ContainerNode*) { }
544
545     // Notifies the node that it is no longer part of the tree.
546     //
547     // This is a dual of insertedInto(), and is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
548     // dispatching, and is called _after_ the node is removed from the tree.
549     //
550     virtual void removedFrom(ContainerNode* insertionPoint);
551
552 #ifndef NDEBUG
553     virtual void formatForDebugger(char* buffer, unsigned length) const;
554
555     void showNode(const char* prefix = "") const;
556     void showTreeForThis() const;
557     void showNodePathForThis() const;
558     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
559     void showTreeForThisAcrossFrame() const;
560 #endif
561
562     void invalidateNodeListCachesInAncestors(const QualifiedName* attrName = 0, Element* attributeOwnerElement = 0);
563     NodeListsNodeData* nodeLists();
564     void clearNodeLists();
565
566     PassRefPtr<NodeList> getElementsByTagName(const AtomicString&);
567     PassRefPtr<NodeList> getElementsByTagNameNS(const AtomicString& namespaceURI, const AtomicString& localName);
568     PassRefPtr<NodeList> getElementsByName(const String& elementName);
569     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
570     PassRefPtr<RadioNodeList> radioNodeList(const AtomicString&);
571
572     virtual bool willRespondToMouseMoveEvents();
573     virtual bool willRespondToMouseClickEvents();
574     virtual bool willRespondToTouchEvents();
575
576     PassRefPtr<Element> querySelector(const AtomicString& selectors, ExceptionCode&);
577     PassRefPtr<NodeList> querySelectorAll(const AtomicString& selectors, ExceptionCode&);
578
579     unsigned short compareDocumentPosition(Node*);
580
581     virtual Node* toNode();
582     virtual HTMLInputElement* toInputElement();
583
584     virtual const AtomicString& interfaceName() const;
585     virtual ScriptExecutionContext* scriptExecutionContext() const;
586
587     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
588     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
589
590     // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
591     // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
592     virtual void* preDispatchEventHandler(Event*) { return 0; }
593     virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
594
595     using EventTarget::dispatchEvent;
596     virtual bool dispatchEvent(PassRefPtr<Event>) OVERRIDE;
597
598     void dispatchScopedEvent(PassRefPtr<Event>);
599     void dispatchScopedEventDispatchMediator(PassRefPtr<EventDispatchMediator>);
600
601     virtual void handleLocalEvents(Event*);
602
603     void dispatchSubtreeModifiedEvent();
604     bool dispatchDOMActivateEvent(int detail, PassRefPtr<Event> underlyingEvent);
605
606     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
607     bool dispatchWheelEvent(const PlatformWheelEvent&);
608     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType, int clickCount = 0, Node* relatedTarget = 0);
609 #if ENABLE(GESTURE_EVENTS)
610     bool dispatchGestureEvent(const PlatformGestureEvent&);
611 #endif
612 #if ENABLE(TOUCH_EVENTS)
613     bool dispatchTouchEvent(PassRefPtr<TouchEvent>);
614 #endif
615
616     bool dispatchBeforeLoadEvent(const String& sourceURL);
617
618     virtual void dispatchChangeEvent();
619     virtual void dispatchInputEvent();
620
621     // Perform the default action for an event.
622     virtual void defaultEventHandler(Event*);
623
624     using TreeShared<Node>::ref;
625     using TreeShared<Node>::deref;
626
627     virtual EventTargetData* eventTargetData();
628     virtual EventTargetData* ensureEventTargetData();
629
630 #if ENABLE(MICRODATA)
631     DOMSettableTokenList* itemProp();
632     DOMSettableTokenList* itemRef();
633     DOMSettableTokenList* itemType();
634     PassRefPtr<PropertyNodeList> propertyNodeList(const String&);
635 #endif
636
637     void getRegisteredMutationObserversOfType(HashMap<MutationObserver*, MutationRecordDeliveryOptions>&, MutationObserver::MutationType, const QualifiedName* attributeName);
638     void registerMutationObserver(MutationObserver*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
639     void unregisterMutationObserver(MutationObserverRegistration*);
640     void registerTransientMutationObserver(MutationObserverRegistration*);
641     void unregisterTransientMutationObserver(MutationObserverRegistration*);
642     void notifyMutationObserversNodeWillDetach();
643
644     virtual void registerScopedHTMLStyleChild();
645     virtual void unregisterScopedHTMLStyleChild();
646     size_t numberOfScopedHTMLStyleChildren() const;
647
648     void textRects(Vector<IntRect>&) const;
649
650     unsigned connectedSubframeCount() const;
651     void incrementConnectedSubframeCount(unsigned amount = 1);
652     void decrementConnectedSubframeCount(unsigned amount = 1);
653     void updateAncestorConnectedSubframeCountForRemoval() const;
654     void updateAncestorConnectedSubframeCountForInsertion() const;
655
656 private:
657     enum NodeFlags {
658         IsTextFlag = 1,
659         IsContainerFlag = 1 << 1,
660         IsElementFlag = 1 << 2,
661         IsStyledElementFlag = 1 << 3,
662         IsHTMLFlag = 1 << 4,
663         IsSVGFlag = 1 << 5,
664         IsAttachedFlag = 1 << 6,
665         ChildNeedsStyleRecalcFlag = 1 << 7,
666         InDocumentFlag = 1 << 8,
667         IsLinkFlag = 1 << 9,
668         IsUserActionElement = 1 << 10,
669         HasRareDataFlag = 1 << 11,
670         IsDocumentFragmentFlag = 1 << 12,
671
672         // These bits are used by derived classes, pulled up here so they can
673         // be stored in the same memory word as the Node bits above.
674         IsParsingChildrenFinishedFlag = 1 << 13, // Element
675 #if ENABLE(SVG)
676         HasSVGRareDataFlag = 1 << 14, // SVGElement
677 #endif
678
679         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1),
680
681         SelfOrAncestorHasDirAutoFlag = 1 << 17,
682
683         HasNameOrIsEditingTextFlag = 1 << 18,
684
685         InNamedFlowFlag = 1 << 19,
686         HasSyntheticAttrChildNodesFlag = 1 << 20,
687         HasCustomStyleCallbacksFlag = 1 << 21,
688         HasScopedHTMLStyleChildFlag = 1 << 22,
689         HasEventTargetDataFlag = 1 << 23,
690         NeedsShadowTreeWalkerFlag = 1 << 25,
691         IsInShadowTreeFlag = 1 << 26,
692
693         DefaultNodeFlags = IsParsingChildrenFinishedFlag
694     };
695
696     // 5 bits remaining
697
698     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
699     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
700     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
701     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; } 
702
703 protected:
704     enum ConstructionType { 
705         CreateOther = DefaultNodeFlags,
706         CreateText = DefaultNodeFlags | IsTextFlag,
707         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
708         CreateElement = CreateContainer | IsElementFlag, 
709         CreatePseudoElement =  CreateElement | InDocumentFlag | NeedsShadowTreeWalkerFlag,
710         CreateShadowRoot = CreateContainer | IsDocumentFragmentFlag | NeedsShadowTreeWalkerFlag | IsInShadowTreeFlag,
711         CreateDocumentFragment = CreateContainer | IsDocumentFragmentFlag,
712         CreateStyledElement = CreateElement | IsStyledElementFlag, 
713         CreateHTMLElement = CreateStyledElement | IsHTMLFlag,
714         CreateSVGElement = CreateStyledElement | IsSVGFlag,
715         CreateDocument = CreateContainer | InDocumentFlag,
716         CreateInsertionPoint = CreateHTMLElement | NeedsShadowTreeWalkerFlag,
717         CreateEditingText = CreateText | HasNameOrIsEditingTextFlag,
718     };
719     Node(Document*, ConstructionType);
720
721     virtual void didMoveToNewDocument(Document* oldDocument);
722     
723     virtual void addSubresourceAttributeURLs(ListHashSet<KURL>&) const { }
724
725     bool hasRareData() const { return getFlag(HasRareDataFlag); }
726
727     NodeRareData* rareData() const;
728     NodeRareData* ensureRareData();
729     void clearRareData();
730
731     void clearEventTargetData();
732
733     void setHasCustomStyleCallbacks() { setFlag(true, HasCustomStyleCallbacksFlag); }
734
735     Document* documentInternal() const { return treeScope()->documentScope(); }
736     void setTreeScope(TreeScope* scope) { m_treeScope = scope; }
737
738 private:
739     friend class TreeShared<Node>;
740
741     virtual PseudoId customPseudoId() const
742     {
743         ASSERT(hasCustomStyleCallbacks());
744         return NOPSEUDO;
745     }
746
747     void removedLastRef();
748     bool hasTreeSharedParent() const { return !!parentOrShadowHostNode(); }
749
750     enum EditableLevel { Editable, RichlyEditable };
751     bool rendererIsEditable(EditableLevel, UserSelectAllTreatment = UserSelectAllIsAlwaysNonEditable) const;
752     bool isEditableToAccessibility(EditableLevel) const;
753
754     void setStyleChange(StyleChangeType);
755
756     // Used to share code between lazyAttach and setNeedsStyleRecalc.
757     void markAncestorsWithChildNeedsStyleRecalc();
758
759     virtual void refEventTarget();
760     virtual void derefEventTarget();
761
762     virtual RenderStyle* nonRendererStyle() const { return 0; }
763     virtual RenderStyle* virtualComputedStyle(PseudoId = NOPSEUDO);
764
765     Element* ancestorElement() const;
766
767     void trackForDebugging();
768
769     Vector<OwnPtr<MutationObserverRegistration> >* mutationObserverRegistry();
770     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
771
772     mutable uint32_t m_nodeFlags;
773     ContainerNode* m_parentOrShadowHostNode;
774     TreeScope* m_treeScope;
775     Node* m_previous;
776     Node* m_next;
777     // When a node has rare data we move the renderer into the rare data.
778     union DataUnion {
779         DataUnion() : m_renderer(0) { }
780         RenderObject* m_renderer;
781         NodeRareDataBase* m_rareData;
782     } m_data;
783
784 protected:
785     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
786     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
787     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
788
789 #if ENABLE(SVG)
790     bool hasSVGRareData() const { return getFlag(HasSVGRareDataFlag); }
791     void setHasSVGRareData() { setFlag(HasSVGRareDataFlag); }
792     void clearHasSVGRareData() { clearFlag(HasSVGRareDataFlag); }
793 #endif
794
795 #if ENABLE(MICRODATA)
796     void setItemProp(const String&);
797     void setItemRef(const String&);
798     void setItemType(const String&);
799 #endif
800 };
801
802 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
803 inline void addSubresourceURL(ListHashSet<KURL>& urls, const KURL& url)
804 {
805     if (!url.isNull())
806         urls.add(url);
807 }
808
809 inline void Node::setParentOrShadowHostNode(ContainerNode* parent)
810 {
811     ASSERT(isMainThread());
812     m_parentOrShadowHostNode = parent;
813 }
814
815 inline ContainerNode* Node::parentOrShadowHostNode() const
816 {
817     ASSERT(isMainThreadOrGCThread());
818     return m_parentOrShadowHostNode;
819 }
820
821 inline ContainerNode* Node::parentNode() const
822 {
823     return isShadowRoot() ? 0 : parentOrShadowHostNode();
824 }
825
826 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
827 {
828     ASSERT(!isShadowRoot());
829     return parentOrShadowHostNode();
830 }
831
832 inline void Node::reattach()
833 {
834     if (attached())
835         detach();
836     attach();
837 }
838
839 inline void Node::reattachIfAttached()
840 {
841     if (attached())
842         reattach();
843 }
844
845 inline void Node::lazyReattach(ShouldSetAttached shouldSetAttached)
846 {
847     if (attached())
848         detach();
849     lazyAttach(shouldSetAttached);
850 }
851
852 } //namespace
853
854 #ifndef NDEBUG
855 // Outside the WebCore namespace for ease of invocation from gdb.
856 void showTree(const WebCore::Node*);
857 void showNodePath(const WebCore::Node*);
858 #endif
859
860 #endif