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