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