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