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