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