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