Create render tree lazily
[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 "URLHash.h"
31 #include "LayoutRect.h"
32 #include "MutationObserver.h"
33 #include "RenderStyleConstants.h"
34 #include "ScriptWrappable.h"
35 #include "SimulatedClickOptions.h"
36 #include "TreeScope.h"
37 #include "TreeShared.h"
38 #include <wtf/Forward.h>
39 #include <wtf/ListHashSet.h>
40 #include <wtf/text/AtomicString.h>
41
42 namespace JSC {
43     class VM;
44     class SlotVisitor;
45 }
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 Element;
58 class Event;
59 class EventListener;
60 class FloatPoint;
61 class Frame;
62 class HTMLInputElement;
63 class IntRect;
64 class KeyboardEvent;
65 class NSResolver;
66 class NamedNodeMap;
67 class NameNodeList;
68 class NodeList;
69 class NodeListsNodeData;
70 class NodeRareData;
71 class QualifiedName;
72 class RadioNodeList;
73 class RegisteredEventListener;
74 class RenderBox;
75 class RenderBoxModelObject;
76 class RenderObject;
77 class RenderStyle;
78 class ShadowRoot;
79 class TagNodeList;
80
81 #if ENABLE(INDIE_UI)
82 class UIRequestEvent;
83 #endif
84     
85 #if ENABLE(TOUCH_EVENTS) && !PLATFORM(IOS)
86 class TouchEvent;
87 #endif
88
89 typedef int ExceptionCode;
90
91 const int nodeStyleChangeShift = 14;
92
93 // SyntheticStyleChange means that we need to go through the entire style change logic even though
94 // no style property has actually changed. It is used to restructure the tree when, for instance,
95 // RenderLayers are created or destroyed due to animation changes.
96 enum StyleChangeType { 
97     NoStyleChange = 0, 
98     InlineStyleChange = 1 << nodeStyleChangeShift, 
99     FullStyleChange = 2 << nodeStyleChangeShift, 
100     SyntheticStyleChange = 3 << nodeStyleChangeShift,
101     ReconstructRenderTree = 4 << nodeStyleChangeShift,
102 };
103
104 class NodeRareDataBase {
105 public:
106     RenderObject* renderer() const { return m_renderer; }
107     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
108
109 protected:
110     NodeRareDataBase(RenderObject* renderer)
111         : m_renderer(renderer)
112     { }
113
114 private:
115     RenderObject* m_renderer;
116 };
117
118 class Node : public EventTarget, public ScriptWrappable, public TreeShared<Node> {
119     friend class Document;
120     friend class TreeScope;
121     friend class TreeScopeAdopter;
122
123 public:
124     enum NodeType {
125         ELEMENT_NODE = 1,
126         ATTRIBUTE_NODE = 2,
127         TEXT_NODE = 3,
128         CDATA_SECTION_NODE = 4,
129         ENTITY_REFERENCE_NODE = 5,
130         ENTITY_NODE = 6,
131         PROCESSING_INSTRUCTION_NODE = 7,
132         COMMENT_NODE = 8,
133         DOCUMENT_NODE = 9,
134         DOCUMENT_TYPE_NODE = 10,
135         DOCUMENT_FRAGMENT_NODE = 11,
136         NOTATION_NODE = 12,
137         XPATH_NAMESPACE_NODE = 13,
138     };
139     enum DocumentPosition {
140         DOCUMENT_POSITION_EQUIVALENT = 0x00,
141         DOCUMENT_POSITION_DISCONNECTED = 0x01,
142         DOCUMENT_POSITION_PRECEDING = 0x02,
143         DOCUMENT_POSITION_FOLLOWING = 0x04,
144         DOCUMENT_POSITION_CONTAINS = 0x08,
145         DOCUMENT_POSITION_CONTAINED_BY = 0x10,
146         DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20,
147     };
148
149     static bool isSupported(const String& feature, const String& version);
150
151     static void startIgnoringLeaks();
152     static void stopIgnoringLeaks();
153
154     static void dumpStatistics();
155
156     virtual ~Node();
157     void willBeDeletedFrom(Document*);
158
159     // DOM methods & attributes for Node
160
161     bool hasTagName(const QualifiedName&) const;
162     bool hasLocalName(const AtomicString&) const;
163     virtual String nodeName() const = 0;
164     virtual String nodeValue() const;
165     virtual void setNodeValue(const String&, ExceptionCode&);
166     virtual NodeType nodeType() const = 0;
167     ContainerNode* parentNode() const;
168     Element* parentElement() const;
169     Node* previousSibling() const { return m_previous; }
170     Node* nextSibling() const { return m_next; }
171     PassRefPtr<NodeList> childNodes();
172     Node* firstChild() const;
173     Node* lastChild() const;
174     bool hasAttributes() const;
175     NamedNodeMap* attributes() const;
176     Node* pseudoAwareNextSibling() const;
177     Node* pseudoAwarePreviousSibling() const;
178     Node* pseudoAwareFirstChild() const;
179     Node* pseudoAwareLastChild() const;
180
181     virtual URL baseURI() const;
182     
183     void getSubresourceURLs(ListHashSet<URL>&) const;
184
185     // These should all actually return a node, but this is only important for language bindings,
186     // which will already know and hold a ref on the right node to return. Returning bool allows
187     // these methods to be more efficient since they don't need to return a ref
188     bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&);
189     bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&);
190     bool removeChild(Node* child, ExceptionCode&);
191     bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&);
192
193     void remove(ExceptionCode&);
194     bool hasChildNodes() const { return firstChild(); }
195     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
196     virtual const AtomicString& localName() const;
197     virtual const AtomicString& namespaceURI() const;
198     virtual const AtomicString& prefix() const;
199     virtual void setPrefix(const AtomicString&, ExceptionCode&);
200     void normalize();
201
202     bool isSameNode(Node* other) const { return this == other; }
203     bool isEqualNode(Node*) const;
204     bool isDefaultNamespace(const AtomicString& namespaceURI) const;
205     String lookupPrefix(const AtomicString& namespaceURI) const;
206     String lookupNamespaceURI(const String& prefix) const;
207     String lookupNamespacePrefix(const AtomicString& namespaceURI, const Element* originalElement) const;
208     
209     String textContent(bool convertBRsToNewlines = false) const;
210     void setTextContent(const String&, ExceptionCode&);
211     
212     Node* lastDescendant() const;
213     Node* firstDescendant() const;
214
215     // Other methods (not part of DOM)
216
217     bool isElementNode() const { return getFlag(IsElementFlag); }
218     bool isContainerNode() const { return getFlag(IsContainerFlag); }
219     bool isTextNode() const { return getFlag(IsTextFlag); }
220     bool isHTMLElement() const { return getFlag(IsHTMLFlag); }
221     bool isSVGElement() const { return getFlag(IsSVGFlag); }
222     bool isMathMLElement() const { return getFlag(IsMathMLFlag); }
223
224     bool isPseudoElement() const { return pseudoId() != NOPSEUDO; }
225     bool isBeforePseudoElement() const { return pseudoId() == BEFORE; }
226     bool isAfterPseudoElement() const { return pseudoId() == AFTER; }
227     PseudoId pseudoId() const { return (isElementNode() && hasCustomStyleResolveCallbacks()) ? customPseudoId() : NOPSEUDO; }
228
229     virtual bool isMediaControlElement() const { return false; }
230     virtual bool isMediaControls() const { return false; }
231 #if ENABLE(VIDEO_TRACK)
232     virtual bool isWebVTTElement() const { return false; }
233 #endif
234     bool isStyledElement() const { return getFlag(IsStyledElementFlag); }
235     virtual bool isAttributeNode() const { return false; }
236     virtual bool isCharacterDataNode() const { return false; }
237     virtual bool isFrameOwnerElement() const { return false; }
238     virtual bool isPluginElement() const { return false; }
239     virtual bool isInsertionPointNode() const { return false; }
240
241     bool isDocumentNode() const;
242     bool isTreeScope() const;
243     bool isDocumentFragment() const { return getFlag(IsDocumentFragmentFlag); }
244     bool isShadowRoot() const { return isDocumentFragment() && isTreeScope(); }
245     bool isInsertionPoint() const { return getFlag(NeedsNodeRenderingTraversalSlowPathFlag) && isInsertionPointNode(); }
246     // Returns Node rather than InsertionPoint. Should be used only for language bindings.
247     Node* insertionParentForBinding() const;
248
249     bool needsNodeRenderingTraversalSlowPath() const;
250
251     bool inNamedFlow() const { return getFlag(InNamedFlowFlag); }
252     bool hasCustomStyleResolveCallbacks() const { return getFlag(HasCustomStyleResolveCallbacksFlag); }
253
254     bool hasSyntheticAttrChildNodes() const { return getFlag(HasSyntheticAttrChildNodesFlag); }
255     void setHasSyntheticAttrChildNodes(bool flag) { setFlag(flag, HasSyntheticAttrChildNodesFlag); }
256
257     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns 0.
258     Element* shadowHost() const;
259     // If this node is in a shadow tree, returns its shadow host. Otherwise, returns this.
260     // Deprecated. Should use shadowHost() and check the return value.
261     Node* deprecatedShadowAncestorNode() const;
262     ShadowRoot* containingShadowRoot() const;
263     ShadowRoot* shadowRoot() const;
264
265     // Returns 0, a child of ShadowRoot, or a legacy shadow root.
266     Node* nonBoundaryShadowTreeRootNode();
267
268     // Node's parent or shadow tree host.
269     ContainerNode* parentOrShadowHostNode() const;
270     Element* parentOrShadowHostElement() const;
271     void setParentNode(ContainerNode*);
272     Node* highestAncestor() const;
273
274     // Use when it's guaranteed to that shadowHost is 0.
275     ContainerNode* parentNodeGuaranteedHostFree() const;
276     // Returns the parent node, but 0 if the parent node is a ShadowRoot.
277     ContainerNode* nonShadowBoundaryParentNode() const;
278
279     bool selfOrAncestorHasDirAutoAttribute() const { return getFlag(SelfOrAncestorHasDirAutoFlag); }
280     void setSelfOrAncestorHasDirAutoAttribute(bool flag) { setFlag(flag, SelfOrAncestorHasDirAutoFlag); }
281
282     // Returns the enclosing event parent Element (or self) that, when clicked, would trigger a navigation.
283     Element* enclosingLinkEventParentOrSelf();
284
285     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
286     void setPreviousSibling(Node* previous) { m_previous = previous; }
287     void setNextSibling(Node* next) { m_next = next; }
288
289     virtual bool canContainRangeEndPoint() const { return false; }
290
291     bool isRootEditableElement() const;
292     Element* rootEditableElement() const;
293     Element* rootEditableElement(EditableType) const;
294
295     // Called by the parser when this element's close tag is reached,
296     // signaling that all child tags have been parsed and added.
297     // This is needed for <applet> and <object> elements, which can't lay themselves out
298     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
299     // Also used for script elements and some SVG elements for similar purposes,
300     // but making parsing a special case in this respect should be avoided if possible.
301     virtual void finishParsingChildren() { }
302     virtual void beginParsingChildren() { }
303
304     // For <link> and <style> elements.
305     virtual bool sheetLoaded() { return true; }
306     virtual void notifyLoadedSheetAndAllCriticalSubresources(bool /* error loading subresource */) { }
307     virtual void startLoadingDynamicSheet() { ASSERT_NOT_REACHED(); }
308
309     bool isUserActionElement() const { return getFlag(IsUserActionElement); }
310     void setUserActionElement(bool flag) { setFlag(flag, IsUserActionElement); }
311
312     bool attached() const;
313     bool needsStyleRecalc() const { return styleChangeType() != NoStyleChange; }
314     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_nodeFlags & StyleChangeMask); }
315     bool childNeedsStyleRecalc() const { return getFlag(ChildNeedsStyleRecalcFlag); }
316     bool isLink() const { return getFlag(IsLinkFlag); }
317     bool isEditingText() const { return getFlag(IsEditingTextFlag); }
318
319     void setChildNeedsStyleRecalc() { setFlag(ChildNeedsStyleRecalcFlag); }
320     void clearChildNeedsStyleRecalc() { clearFlag(ChildNeedsStyleRecalcFlag); }
321
322     void setNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange);
323     void clearNeedsStyleRecalc() { m_nodeFlags &= ~StyleChangeMask; }
324     virtual void scheduleSetNeedsStyleRecalc(StyleChangeType changeType = FullStyleChange) { setNeedsStyleRecalc(changeType); }
325
326     void setIsLink(bool f) { setFlag(f, IsLinkFlag); }
327     void setIsLink() { setFlag(IsLinkFlag); }
328     void clearIsLink() { clearFlag(IsLinkFlag); }
329
330     void setInNamedFlow() { setFlag(InNamedFlowFlag); }
331     void clearInNamedFlow() { clearFlag(InNamedFlowFlag); }
332
333     bool hasEventTargetData() const { return getFlag(HasEventTargetDataFlag); }
334     void setHasEventTargetData(bool flag) { setFlag(flag, HasEventTargetDataFlag); }
335
336     enum UserSelectAllTreatment {
337         UserSelectAllDoesNotAffectEditability,
338         UserSelectAllIsAlwaysNonEditable
339     };
340     bool isContentEditable(UserSelectAllTreatment = UserSelectAllDoesNotAffectEditability);
341     bool isContentRichlyEditable();
342
343     void inspect();
344
345     bool rendererIsEditable(EditableType editableType = ContentIsEditable, UserSelectAllTreatment treatment = UserSelectAllIsAlwaysNonEditable) const
346     {
347         switch (editableType) {
348         case ContentIsEditable:
349             return rendererIsEditable(Editable, treatment);
350         case HasEditableAXRole:
351             return isEditableToAccessibility(Editable);
352         }
353         ASSERT_NOT_REACHED();
354         return false;
355     }
356
357     bool rendererIsRichlyEditable(EditableType editableType = ContentIsEditable) const
358     {
359         switch (editableType) {
360         case ContentIsEditable:
361             return rendererIsEditable(RichlyEditable, UserSelectAllIsAlwaysNonEditable);
362         case HasEditableAXRole:
363             return isEditableToAccessibility(RichlyEditable);
364         }
365         ASSERT_NOT_REACHED();
366         return false;
367     }
368
369     virtual LayoutRect boundingBox() const;
370     IntRect pixelSnappedBoundingBox() const { return pixelSnappedIntRect(boundingBox()); }
371     LayoutRect renderRect(bool* isReplaced);
372     IntRect pixelSnappedRenderRect(bool* isReplaced) { return pixelSnappedIntRect(renderRect(isReplaced)); }
373
374     unsigned nodeIndex() const;
375
376     // Returns the DOM ownerDocument attribute. This method never returns 0, except in the case
377     // of a Document node.
378     Document* ownerDocument() const;
379
380     // Returns the document associated with this node. This method never returns 0.
381     // A Document node returns itself.
382     Document& document() const
383     {
384         ASSERT(this);
385         ASSERT(documentInternal());
386         return *documentInternal();
387     }
388
389     TreeScope& treeScope() const
390     {
391         ASSERT(m_treeScope);
392         return *m_treeScope;
393     }
394
395     // Returns true if this node is associated with a document and is in its associated document's
396     // node tree, false otherwise.
397     bool inDocument() const 
398     { 
399         ASSERT(documentInternal() || !getFlag(InDocumentFlag));
400         return getFlag(InDocumentFlag);
401     }
402     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
403     bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(InDocumentFlag | IsInShadowTreeFlag)); }
404
405     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
406     bool isDocumentTypeNode() const { return nodeType() == DOCUMENT_TYPE_NODE; }
407     virtual bool childTypeAllowed(NodeType) const { return false; }
408     unsigned childNodeCount() const;
409     Node* childNode(unsigned index) const;
410
411     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
412
413     bool isDescendantOf(const Node*) const;
414     bool isDescendantOrShadowDescendantOf(const Node*) const;
415     bool contains(const Node*) const;
416     bool containsIncludingShadowDOM(const Node*) const;
417     bool containsIncludingHostElements(const Node*) const;
418
419     // Used to determine whether range offsets use characters or node indices.
420     virtual bool offsetInCharacters() const;
421     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
422     // css-transform:capitalize breaking up precomposed characters and ligatures.
423     virtual int maxCharacterOffset() const;
424
425     // Whether or not a selection can be started in this object
426     virtual bool canStartSelection() const;
427
428     // Getting points into and out of screen space
429     FloatPoint convertToPage(const FloatPoint&) const;
430     FloatPoint convertFromPage(const FloatPoint&) const;
431
432     // -----------------------------------------------------------------------------
433     // Integration with rendering tree
434
435     // As renderer() includes a branch you should avoid calling it repeatedly in hot code paths.
436     RenderObject* renderer() const { return hasRareData() ? m_data.m_rareData->renderer() : m_data.m_renderer; };
437     void setRenderer(RenderObject* renderer)
438     {
439         if (hasRareData())
440             m_data.m_rareData->setRenderer(renderer);
441         else
442             m_data.m_renderer = renderer;
443     }
444
445     // Use these two methods with caution.
446     RenderBox* renderBox() const;
447     RenderBoxModelObject* renderBoxModelObject() const;
448     
449     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
450     RenderStyle* renderStyle() const;
451
452     virtual RenderStyle* computedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO);
453
454     // -----------------------------------------------------------------------------
455     // Notification of document structure changes (see ContainerNode.h for more notification methods)
456     //
457     // At first, WebKit notifies the node that it has been inserted into the document. This is called during document parsing, and also
458     // 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.
459     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
460     // dispatching.
461     //
462     // WebKit notifies this callback regardless if the subtree of the node is a document tree or a floating subtree.
463     // Implementation can determine the type of subtree by seeing insertionPoint->inDocument().
464     // For a performance reason, notifications are delivered only to ContainerNode subclasses if the insertionPoint is out of document.
465     //
466     // There are another callback named didNotifyDescendantInsertions(), which is called after all the descendant is notified.
467     // Only a few subclasses actually need this. To utilize this, the node should return InsertionShouldCallDidNotifyDescendantInsertions
468     // from insrtedInto().
469     //
470     enum InsertionNotificationRequest {
471         InsertionDone,
472         InsertionShouldCallDidNotifySubtreeInsertions
473     };
474
475     virtual InsertionNotificationRequest insertedInto(ContainerNode& insertionPoint);
476     virtual void didNotifySubtreeInsertions(ContainerNode*) { }
477
478     // Notifies the node that it is no longer part of the tree.
479     //
480     // This is a dual of insertedInto(), and is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
481     // dispatching, and is called _after_ the node is removed from the tree.
482     //
483     virtual void removedFrom(ContainerNode& insertionPoint);
484
485 #ifndef NDEBUG
486     virtual void formatForDebugger(char* buffer, unsigned length) const;
487
488     void showNode(const char* prefix = "") const;
489     void showTreeForThis() const;
490     void showNodePathForThis() const;
491     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
492     void showTreeForThisAcrossFrame() const;
493 #endif
494
495     void invalidateNodeListAndCollectionCachesInAncestors(const QualifiedName* attrName = 0, Element* attributeOwnerElement = 0);
496     NodeListsNodeData* nodeLists();
497     void clearNodeLists();
498
499     virtual bool willRespondToMouseMoveEvents();
500     virtual bool willRespondToMouseClickEvents();
501     virtual bool willRespondToMouseWheelEvents();
502     virtual bool willRespondToTouchEvents();
503
504     unsigned short compareDocumentPosition(Node*);
505
506     virtual Node* toNode() OVERRIDE;
507     virtual HTMLInputElement* toInputElement();
508
509     virtual EventTargetInterface eventTargetInterface() const OVERRIDE;
510     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE FINAL; // Implemented in Document.h
511
512     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) OVERRIDE;
513     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) OVERRIDE;
514
515     using EventTarget::dispatchEvent;
516     virtual bool dispatchEvent(PassRefPtr<Event>) OVERRIDE;
517
518     void dispatchScopedEvent(PassRefPtr<Event>);
519
520     virtual void handleLocalEvents(Event&);
521
522     void dispatchSubtreeModifiedEvent();
523     bool dispatchDOMActivateEvent(int detail, PassRefPtr<Event> underlyingEvent);
524
525 #if ENABLE(TOUCH_EVENTS) && !PLATFORM(IOS)
526     bool dispatchTouchEvent(PassRefPtr<TouchEvent>);
527 #endif
528 #if ENABLE(INDIE_UI)
529     bool dispatchUIRequestEvent(PassRefPtr<UIRequestEvent>);
530 #endif
531
532     bool dispatchBeforeLoadEvent(const String& sourceURL);
533
534     virtual void dispatchInputEvent();
535
536     // Perform the default action for an event.
537     virtual void defaultEventHandler(Event*);
538
539     using TreeShared<Node>::ref;
540     using TreeShared<Node>::deref;
541
542     virtual EventTargetData* eventTargetData() OVERRIDE FINAL;
543     virtual EventTargetData& ensureEventTargetData() OVERRIDE FINAL;
544
545     void getRegisteredMutationObserversOfType(HashMap<MutationObserver*, MutationRecordDeliveryOptions>&, MutationObserver::MutationType, const QualifiedName* attributeName);
546     void registerMutationObserver(MutationObserver*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
547     void unregisterMutationObserver(MutationObserverRegistration*);
548     void registerTransientMutationObserver(MutationObserverRegistration*);
549     void unregisterTransientMutationObserver(MutationObserverRegistration*);
550     void notifyMutationObserversNodeWillDetach();
551
552     void textRects(Vector<IntRect>&) const;
553
554     unsigned connectedSubframeCount() const;
555     void incrementConnectedSubframeCount(unsigned amount = 1);
556     void decrementConnectedSubframeCount(unsigned amount = 1);
557     void updateAncestorConnectedSubframeCountForRemoval() const;
558     void updateAncestorConnectedSubframeCountForInsertion() const;
559
560     void markAncestorsWithChildNeedsStyleRecalc();
561
562 protected:
563     enum NodeFlags {
564         IsTextFlag = 1,
565         IsContainerFlag = 1 << 1,
566         IsElementFlag = 1 << 2,
567         IsStyledElementFlag = 1 << 3,
568         IsHTMLFlag = 1 << 4,
569         IsSVGFlag = 1 << 5,
570         ChildNeedsStyleRecalcFlag = 1 << 7,
571         InDocumentFlag = 1 << 8,
572         IsLinkFlag = 1 << 9,
573         IsUserActionElement = 1 << 10,
574         HasRareDataFlag = 1 << 11,
575         IsDocumentFragmentFlag = 1 << 12,
576
577         // These bits are used by derived classes, pulled up here so they can
578         // be stored in the same memory word as the Node bits above.
579         IsParsingChildrenFinishedFlag = 1 << 13, // Element
580
581         StyleChangeMask = 1 << nodeStyleChangeShift | 1 << (nodeStyleChangeShift + 1) | 1 << (nodeStyleChangeShift + 2),
582         IsEditingTextFlag = 1 << 17,
583         InNamedFlowFlag = 1 << 18,
584         HasSyntheticAttrChildNodesFlag = 1 << 19,
585         HasCustomStyleResolveCallbacksFlag = 1 << 20,
586         HasEventTargetDataFlag = 1 << 21,
587         NeedsNodeRenderingTraversalSlowPathFlag = 1 << 22,
588         IsInShadowTreeFlag = 1 << 23,
589         IsMathMLFlag = 1 << 24,
590
591         ChildrenAffectedByFirstChildRulesFlag = 1 << 25,
592         ChildrenAffectedByLastChildRulesFlag = 1 << 26,
593         ChildrenAffectedByDirectAdjacentRulesFlag = 1 << 27,
594         ChildrenAffectedByHoverRulesFlag = 1 << 28,
595
596         SelfOrAncestorHasDirAutoFlag = 1 << 29,
597
598         DefaultNodeFlags = IsParsingChildrenFinishedFlag
599     };
600
601     bool getFlag(NodeFlags mask) const { return m_nodeFlags & mask; }
602     void setFlag(bool f, NodeFlags mask) const { m_nodeFlags = (m_nodeFlags & ~mask) | (-(int32_t)f & mask); } 
603     void setFlag(NodeFlags mask) const { m_nodeFlags |= mask; } 
604     void clearFlag(NodeFlags mask) const { m_nodeFlags &= ~mask; }
605
606     enum ConstructionType {
607         CreateOther = DefaultNodeFlags,
608         CreateText = DefaultNodeFlags | IsTextFlag,
609         CreateContainer = DefaultNodeFlags | IsContainerFlag, 
610         CreateElement = CreateContainer | IsElementFlag, 
611         CreatePseudoElement =  CreateElement | InDocumentFlag | NeedsNodeRenderingTraversalSlowPathFlag,
612         CreateShadowRoot = CreateContainer | IsDocumentFragmentFlag | NeedsNodeRenderingTraversalSlowPathFlag | IsInShadowTreeFlag,
613         CreateDocumentFragment = CreateContainer | IsDocumentFragmentFlag,
614         CreateStyledElement = CreateElement | IsStyledElementFlag, 
615         CreateHTMLElement = CreateStyledElement | IsHTMLFlag,
616         CreateSVGElement = CreateStyledElement | IsSVGFlag | HasCustomStyleResolveCallbacksFlag,
617         CreateDocument = CreateContainer | InDocumentFlag,
618         CreateInsertionPoint = CreateHTMLElement | NeedsNodeRenderingTraversalSlowPathFlag,
619         CreateEditingText = CreateText | IsEditingTextFlag,
620         CreateMathMLElement = CreateStyledElement | IsMathMLFlag,
621     };
622     Node(Document*, ConstructionType);
623
624     virtual void didMoveToNewDocument(Document* oldDocument);
625     
626     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
627
628     bool hasRareData() const { return getFlag(HasRareDataFlag); }
629
630     NodeRareData* rareData() const;
631     NodeRareData& ensureRareData();
632     void clearRareData();
633
634     void clearEventTargetData();
635
636     void setHasCustomStyleResolveCallbacks() { setFlag(true, HasCustomStyleResolveCallbacksFlag); }
637
638     void setNeedsNodeRenderingTraversalSlowPath(bool flag) { setFlag(flag, NeedsNodeRenderingTraversalSlowPathFlag); }
639
640     Document* documentInternal() const { return treeScope().documentScope(); }
641     void setTreeScope(TreeScope& scope) { m_treeScope = &scope; }
642
643     void setStyleChange(StyleChangeType changeType) { m_nodeFlags = (m_nodeFlags & ~StyleChangeMask) | changeType; }
644
645 private:
646     friend class TreeShared<Node>;
647
648     virtual PseudoId customPseudoId() const
649     {
650         ASSERT(hasCustomStyleResolveCallbacks());
651         return NOPSEUDO;
652     }
653
654     void removedLastRef();
655     bool hasTreeSharedParent() const { return !!parentNode(); }
656
657     enum EditableLevel { Editable, RichlyEditable };
658     bool rendererIsEditable(EditableLevel, UserSelectAllTreatment = UserSelectAllIsAlwaysNonEditable) const;
659     bool isEditableToAccessibility(EditableLevel) const;
660
661     virtual void refEventTarget() OVERRIDE;
662     virtual void derefEventTarget() OVERRIDE;
663
664     virtual RenderStyle* nonRendererStyle() const { return 0; }
665
666     Element* ancestorElement() const;
667
668     void trackForDebugging();
669
670     Vector<OwnPtr<MutationObserverRegistration>>* mutationObserverRegistry();
671     HashSet<MutationObserverRegistration*>* transientMutationObserverRegistry();
672
673     mutable uint32_t m_nodeFlags;
674     ContainerNode* m_parentNode;
675     TreeScope* m_treeScope;
676     Node* m_previous;
677     Node* m_next;
678     // When a node has rare data we move the renderer into the rare data.
679     union DataUnion {
680         DataUnion() : m_renderer(0) { }
681         RenderObject* m_renderer;
682         NodeRareDataBase* m_rareData;
683     } m_data;
684
685 protected:
686     bool isParsingChildrenFinished() const { return getFlag(IsParsingChildrenFinishedFlag); }
687     void setIsParsingChildrenFinished() { setFlag(IsParsingChildrenFinishedFlag); }
688     void clearIsParsingChildrenFinished() { clearFlag(IsParsingChildrenFinishedFlag); }
689 };
690
691 // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
692 inline void addSubresourceURL(ListHashSet<URL>& urls, const URL& url)
693 {
694     if (!url.isNull())
695         urls.add(url);
696 }
697
698 inline void Node::setParentNode(ContainerNode* parent)
699 {
700     ASSERT(isMainThread());
701     m_parentNode = parent;
702 }
703
704 inline ContainerNode* Node::parentNode() const
705 {
706     ASSERT(isMainThreadOrGCThread());
707     return m_parentNode;
708 }
709
710 inline ContainerNode* Node::parentNodeGuaranteedHostFree() const
711 {
712     ASSERT(!isShadowRoot());
713     return parentNode();
714 }
715
716 #define NODE_TYPE_CASTS(ToClassName) \
717     TYPE_CASTS_BASE(ToClassName, Node, node, WebCore::is##ToClassName(*node), WebCore::is##ToClassName(node))
718
719 } // namespace WebCore
720
721 #ifndef NDEBUG
722 // Outside the WebCore namespace for ease of invocation from gdb.
723 void showTree(const WebCore::Node*);
724 void showNodePath(const WebCore::Node*);
725 #endif
726
727 #endif