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