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