c4a11bbe006d69988f99e48bd5e8ed2c4bb7a7d5
[WebKit-https.git] / 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 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef Node_h
25 #define Node_h
26
27 #include "DocPtr.h"
28 #include "PlatformString.h"
29 #include "TreeShared.h"
30 #include <wtf/Assertions.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/OwnPtr.h>
33 #include <wtf/PassRefPtr.h>
34
35 namespace WebCore {
36
37 class AtomicString;
38 class ContainerNode;
39 class Document;
40 class DynamicNodeList;
41 class Element;
42 class Event;
43 class EventListener;
44 class IntRect;
45 class KURL;
46 class KeyboardEvent;
47 class NSResolver;
48 class NamedAttrMap;
49 class NodeList;
50 class PlatformKeyboardEvent;
51 class PlatformMouseEvent;
52 class PlatformWheelEvent;
53 class QualifiedName;
54 class RegisteredEventListener;
55 class RenderArena;
56 class RenderObject;
57 class RenderStyle;
58 class StringBuilder;
59
60 struct NodeListsNodeData;
61
62 typedef int ExceptionCode;
63
64 enum StyleChangeType { NoStyleChange, InlineStyleChange, FullStyleChange, AnimationStyleChange };
65
66 const unsigned short DOCUMENT_POSITION_EQUIVALENT = 0x00;
67 const unsigned short DOCUMENT_POSITION_DISCONNECTED = 0x01;
68 const unsigned short DOCUMENT_POSITION_PRECEDING = 0x02;
69 const unsigned short DOCUMENT_POSITION_FOLLOWING = 0x04;
70 const unsigned short DOCUMENT_POSITION_CONTAINS = 0x08;
71 const unsigned short DOCUMENT_POSITION_CONTAINED_BY = 0x10;
72 const unsigned short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;
73
74 // this class implements nodes, which can have a parent but no children:
75 class Node : public TreeShared<Node> {
76     friend class Document;
77 public:
78     enum NodeType {
79         ELEMENT_NODE = 1,
80         ATTRIBUTE_NODE = 2,
81         TEXT_NODE = 3,
82         CDATA_SECTION_NODE = 4,
83         ENTITY_REFERENCE_NODE = 5,
84         ENTITY_NODE = 6,
85         PROCESSING_INSTRUCTION_NODE = 7,
86         COMMENT_NODE = 8,
87         DOCUMENT_NODE = 9,
88         DOCUMENT_TYPE_NODE = 10,
89         DOCUMENT_FRAGMENT_NODE = 11,
90         NOTATION_NODE = 12,
91         XPATH_NAMESPACE_NODE = 13
92     };
93     
94     static bool isSupported(const String& feature, const String& version);
95
96     static void startIgnoringLeaks();
97     static void stopIgnoringLeaks();
98
99     enum StyleChange { NoChange, NoInherit, Inherit, Detach, Force };    
100     static StyleChange diff(RenderStyle*, RenderStyle*);
101
102     Node(Document*, bool isElement = false);
103     virtual ~Node();
104
105     // DOM methods & attributes for Node
106
107     bool hasTagName(const QualifiedName& name) const { return virtualHasTagName(name); }
108     virtual String nodeName() const = 0;
109     virtual String nodeValue() const;
110     virtual void setNodeValue(const String&, ExceptionCode&);
111     virtual NodeType nodeType() const = 0;
112     Node* parentNode() const { return parent(); }
113     Node* parentElement() const { return parent(); } // IE extension
114     Node* previousSibling() const { return m_previous; }
115     Node* nextSibling() const { return m_next; }
116     virtual PassRefPtr<NodeList> childNodes();
117     Node* firstChild() const { return virtualFirstChild(); }
118     Node* lastChild() const { return virtualLastChild(); }
119     virtual bool hasAttributes() const;
120     virtual NamedAttrMap* attributes() const;
121
122     virtual KURL baseURI() const;
123     
124     void getSubresourceURLs(Vector<KURL>&) const;
125
126     // These should all actually return a node, but this is only important for language bindings,
127     // which will already know and hold a ref on the right node to return. Returning bool allows
128     // these methods to be more efficient since they don't need to return a ref
129     virtual bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
130     virtual bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
131     virtual bool removeChild(Node* child, ExceptionCode&);
132     virtual bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
133
134     virtual void remove(ExceptionCode&);
135     bool hasChildNodes() const { return firstChild(); }
136     virtual PassRefPtr<Node> cloneNode(bool deep) = 0;
137     virtual const AtomicString& localName() const;
138     virtual const AtomicString& namespaceURI() const;
139     virtual const AtomicString& prefix() const;
140     virtual void setPrefix(const AtomicString&, ExceptionCode&);
141     void normalize();
142
143     bool isSameNode(Node* other) const { return this == other; }
144     bool isEqualNode(Node*) const;
145     bool isDefaultNamespace(const String& namespaceURI) const;
146     String lookupPrefix(const String& namespaceURI) const;
147     String lookupNamespaceURI(const String& prefix) const;
148     String lookupNamespacePrefix(const String& namespaceURI, const Element* originalElement) const;
149     
150     String textContent(bool convertBRsToNewlines = false) const;
151     void setTextContent(const String&, ExceptionCode&);
152     
153     Node* lastDescendant() const;
154     Node* firstDescendant() const;
155     
156     // Other methods (not part of DOM)
157
158     bool isElementNode() const { return m_isElement; }
159     virtual bool isHTMLElement() const { return false; }
160
161 #if ENABLE(SVG)
162     virtual
163 #endif
164         bool isSVGElement() const { return false; }
165
166     virtual bool isStyledElement() const { return false; }
167     virtual bool isFrameOwnerElement() const { return false; }
168     virtual bool isAttributeNode() const { return false; }
169     virtual bool isTextNode() const { return false; }
170     virtual bool isCommentNode() const { return false; }
171     virtual bool isCharacterDataNode() const { return false; }
172     virtual bool isDocumentNode() const { return false; }
173     virtual bool isEventTargetNode() const { return false; }
174     virtual bool isShadowNode() const { return false; }
175     virtual Node* shadowParentNode() { return 0; }
176     Node* shadowAncestorNode();
177     Node* shadowTreeRootNode();
178
179     // The node's parent for the purpose of event capture and bubbling.
180     virtual Node* eventParentNode() { return parentNode(); }
181
182     bool isBlockFlow() const;
183     bool isBlockFlowOrBlockTable() const;
184     
185     // Used by <form> elements to indicate a malformed state of some kind, typically
186     // used to keep from applying the bottom margin of the form.
187     virtual bool isMalformed() { return false; }
188     virtual void setMalformed(bool malformed) { }
189     
190     // These low-level calls give the caller responsibility for maintaining the integrity of the tree.
191     void setPreviousSibling(Node* previous) { m_previous = previous; }
192     void setNextSibling(Node* next) { m_next = next; }
193
194     // FIXME: These two functions belong in editing -- "atomic node" is an editing concept.
195     Node* previousNodeConsideringAtomicNodes() const;
196     Node* nextNodeConsideringAtomicNodes() const;
197     
198     /** (Not part of the official DOM)
199      * Returns the next leaf node.
200      *
201      * Using this function delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
202      * @return next leaf node or 0 if there are no more.
203      */
204     Node* nextLeafNode() const;
205
206     /** (Not part of the official DOM)
207      * Returns the previous leaf node.
208      *
209      * Using this function delivers leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
210      * @return previous leaf node or 0 if there are no more.
211      */
212     Node* previousLeafNode() const;
213
214     bool isEditableBlock() const;
215     
216     // enclosingBlockFlowElement() is deprecated.  Use enclosingBlock instead.
217     Element* enclosingBlockFlowElement() const;
218     
219     Element* enclosingInlineElement() const;
220     Element* rootEditableElement() const;
221     
222     bool inSameContainingBlockFlowElement(Node*);
223     
224     // Used by the parser. Checks against the DTD, unlike DOM operations like appendChild().
225     // Also does not dispatch DOM mutation events.
226     // Returns the appropriate container node for future insertions as you parse, or 0 for failure.
227     virtual ContainerNode* addChild(PassRefPtr<Node>);
228
229     // Called by the parser when this element's close tag is reached,
230     // signalling that all child tags have been parsed and added.
231     // This is needed for <applet> and <object> elements, which can't lay themselves out
232     // until they know all of their nested <param>s. [Radar 3603191, 4040848].
233     // Also used for script elements and some SVG elements for similar purposes,
234     // but making parsing a special case in this respect should be avoided if possible.
235     virtual void finishParsingChildren() { }
236     virtual void beginParsingChildren() { }
237
238     // Called by the frame right before dispatching an unloadEvent. [Radar 4532113]
239     // This is needed for HTMLInputElements to tell the frame that it is done editing 
240     // (sends textFieldDidEndEditing notification)
241     virtual void aboutToUnload() { }
242
243     // For <link> and <style> elements.
244     virtual bool sheetLoaded() { return true; }
245
246     bool hasID() const { return m_hasId; }
247     bool hasClass() const { return m_hasClass; }
248     bool active() const { return m_active; }
249     bool inActiveChain() const { return m_inActiveChain; }
250     bool inDetach() const { return m_inDetach; }
251     bool hovered() const { return m_hovered; }
252     bool focused() const { return m_focused; }
253     bool attached() const { return m_attached; }
254     void setAttached(bool b = true) { m_attached = b; }
255     bool changed() const { return m_styleChange != NoStyleChange; }
256     StyleChangeType styleChangeType() const { return static_cast<StyleChangeType>(m_styleChange); }
257     bool hasChangedChild() const { return m_hasChangedChild; }
258     bool isLink() const { return m_isLink; }
259     void setHasID(bool b = true) { m_hasId = b; }
260     void setHasClass(bool b = true) { m_hasClass = b; }
261     void setHasChangedChild( bool b = true ) { m_hasChangedChild = b; }
262     void setInDocument(bool b = true) { m_inDocument = b; }
263     void setInActiveChain(bool b = true) { m_inActiveChain = b; }
264     void setChanged(StyleChangeType changeType = FullStyleChange);
265     void setIsLink(bool b = true) { m_isLink = b; }
266
267     bool inSubtreeMark() const { return m_inSubtreeMark; }
268     void setInSubtreeMark(bool b = true) { m_inSubtreeMark = b; }
269
270     void lazyAttach();
271     virtual bool canLazyAttach();
272
273     virtual void setFocus(bool b = true) { m_focused = b; }
274     virtual void setActive(bool b = true, bool pause=false) { m_active = b; }
275     virtual void setHovered(bool b = true) { m_hovered = b; }
276
277     virtual short tabIndex() const { return m_tabIndex; }
278
279     /**
280      * Whether this node can receive the keyboard focus.
281      */
282     virtual bool supportsFocus() const { return isFocusable(); }
283     virtual bool isFocusable() const;
284     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
285     virtual bool isMouseFocusable() const;
286
287     virtual bool isControl() const { return false; } // Eventually the notion of what is a control will be extensible.
288     virtual bool isEnabled() const { return true; }
289     virtual bool isChecked() const { return false; }
290     virtual bool isIndeterminate() const { return false; }
291     virtual bool isReadOnlyControl() const { return false; }
292     virtual bool isTextControl() const { return false; }
293
294     virtual bool isContentEditable() const;
295     virtual bool isContentRichlyEditable() const;
296     virtual bool shouldUseInputMethod() const;
297     virtual IntRect getRect() const;
298
299     virtual void recalcStyle(StyleChange = NoChange) { }
300
301     unsigned nodeIndex() const;
302
303     // Returns the DOM ownerDocument attribute. This method never returns NULL, except in the case 
304     // of (1) a Document node or (2) a DocumentType node that is not used with any Document yet. 
305     virtual Document* ownerDocument() const;
306
307     // Returns the document associated with this node. This method never returns NULL, except in the case 
308     // of a DocumentType node that is not used with any Document yet. A Document node returns itself.
309     Document* document() const
310     {
311       ASSERT(this);
312       ASSERT(m_document || nodeType() == DOCUMENT_TYPE_NODE && !inDocument());
313       return m_document.get();
314     }
315     void setDocument(Document*);
316
317     // Returns true if this node is associated with a document and is in its associated document's
318     // node tree, false otherwise.
319     bool inDocument() const 
320     { 
321       ASSERT(m_document || !m_inDocument);
322       return m_inDocument; 
323     }
324     
325     bool isReadOnlyNode() const { return nodeType() == ENTITY_REFERENCE_NODE; }
326     virtual bool childTypeAllowed(NodeType) { return false; }
327     virtual unsigned childNodeCount() const;
328     virtual Node* childNode(unsigned index) const;
329
330     /**
331      * Does a pre-order traversal of the tree to find the node next node after this one. This uses the same order that
332      * the tags appear in the source file.
333      *
334      * @param stayWithin If not null, the traversal will stop once the specified node is reached. This can be used to
335      * restrict traversal to a particular sub-tree.
336      *
337      * @return The next node, in document order
338      *
339      * see @ref traversePreviousNode()
340      */
341     Node* traverseNextNode(const Node* stayWithin = 0) const;
342     
343     // Like traverseNextNode, but skips children and starts with the next sibling.
344     Node* traverseNextSibling(const Node* stayWithin = 0) const;
345
346     /**
347      * Does a reverse pre-order traversal to find the node that comes before the current one in document order
348      *
349      * see @ref traverseNextNode()
350      */
351     Node* traversePreviousNode(const Node * stayWithin = 0) const;
352
353     // Like traverseNextNode, but visits parents after their children.
354     Node* traverseNextNodePostOrder() const;
355
356     // Like traversePreviousNode, but visits parents before their children.
357     Node* traversePreviousNodePostOrder(const Node *stayWithin = 0) const;
358     Node* traversePreviousSiblingPostOrder(const Node *stayWithin = 0) const;
359
360     /**
361      * Finds previous or next editable leaf node.
362      */
363     Node* previousEditable() const;
364     Node* nextEditable() const;
365
366     RenderObject* renderer() const { return m_renderer; }
367     RenderObject* nextRenderer();
368     RenderObject* previousRenderer();
369     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
370     
371     void checkSetPrefix(const AtomicString& prefix, ExceptionCode&);
372     bool isDescendantOf(const Node*) const;
373
374     // These two methods are mutually exclusive.  The former is used to do strict error-checking
375     // when adding children via the public DOM API (e.g., appendChild()).  The latter is called only when parsing, 
376     // to sanity-check against the DTD for error recovery.
377     void checkAddChild(Node* newChild, ExceptionCode&); // Error-checking when adding via the DOM API
378     virtual bool childAllowed(Node* newChild);          // Error-checking during parsing that checks the DTD
379
380     void checkReplaceChild(Node* newChild, Node* oldChild, ExceptionCode&);
381     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
382     
383     // Used to determine whether range offsets use characters or node indices.
384     virtual bool offsetInCharacters() const;
385     // Number of DOM 16-bit units contained in node. Note that rendered text length can be different - e.g. because of
386     // css-transform:capitalize breaking up precomposed characters and ligatures.
387     virtual int maxCharacterOffset() const;
388     
389     // FIXME: We should try to find a better location for these methods.
390     virtual bool canSelectAll() const { return false; }
391     virtual void selectAll() { }
392
393     // Whether or not a selection can be started in this object
394     virtual bool canStartSelection() const;
395
396     // -----------------------------------------------------------------------------
397     // Integration with rendering tree
398
399     /**
400      * Attaches this node to the rendering tree. This calculates the style to be applied to the node and creates an
401      * appropriate RenderObject which will be inserted into the tree (except when the style has display: none). This
402      * makes the node visible in the FrameView.
403      */
404     virtual void attach();
405
406     /**
407      * Detaches the node from the rendering tree, making it invisible in the rendered view. This method will remove
408      * the node's rendering object from the rendering tree and delete it.
409      */
410     virtual void detach();
411
412     virtual void willRemove();
413     void createRendererIfNeeded();
414     virtual RenderStyle* styleForRenderer(RenderObject* parent);
415     virtual bool rendererIsNeeded(RenderStyle*);
416 #if ENABLE(SVG)
417     virtual bool childShouldCreateRenderer(Node*) const { return true; }
418 #endif
419     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
420     
421     // Wrapper for nodes that don't have a renderer, but still cache the style (like HTMLOptionElement).
422     virtual RenderStyle* renderStyle() const;
423     virtual void setRenderStyle(RenderStyle*);
424
425     virtual RenderStyle* computedStyle();
426
427     // -----------------------------------------------------------------------------
428     // Notification of document structure changes
429
430     /**
431      * Notifies the node that it has been inserted into the document. This is called during document parsing, and also
432      * when a node is added through the DOM methods insertBefore(), appendChild() or replaceChild(). Note that this only
433      * happens when the node becomes part of the document tree, i.e. only when the document is actually an ancestor of
434      * the node. The call happens _after_ the node has been added to the tree.
435      *
436      * This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
437      * dispatching.
438      */
439     virtual void insertedIntoDocument();
440
441     /**
442      * Notifies the node that it is no longer part of the document tree, i.e. when the document is no longer an ancestor
443      * node.
444      *
445      * This is similar to the DOMNodeRemovedFromDocument DOM event, but does not require the overhead of event
446      * dispatching, and is called _after_ the node is removed from the tree.
447      */
448     virtual void removedFromDocument();
449
450     // These functions are called whenever you are connected or disconnected from a tree.  That tree may be the main
451     // document tree, or it could be another disconnected tree.  Override these functions to do any work that depends
452     // on connectedness to some ancestor (e.g., an ancestor <form> for example).
453     virtual void insertedIntoTree(bool deep) { }
454     virtual void removedFromTree(bool deep) { }
455
456     /**
457      * Notifies the node that it's list of children have changed (either by adding or removing child nodes), or a child
458      * node that is of the type CDATA_SECTION_NODE, TEXT_NODE or COMMENT_NODE has changed its value.
459      */
460     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0) {};
461
462 #ifndef NDEBUG
463     virtual void formatForDebugger(char* buffer, unsigned length) const;
464
465     void showNode(const char* prefix = "") const;
466     void showTreeForThis() const;
467     void showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2 = 0, const char* markedLabel2 = 0) const;
468 #endif
469
470     void registerDynamicNodeList(DynamicNodeList*);
471     void unregisterDynamicNodeList(DynamicNodeList*);
472     void notifyNodeListsChildrenChanged();
473     void notifyLocalNodeListsChildrenChanged();
474     void notifyNodeListsAttributeChanged();
475     void notifyLocalNodeListsAttributeChanged();
476     
477     PassRefPtr<NodeList> getElementsByTagName(const String&);
478     PassRefPtr<NodeList> getElementsByTagNameNS(const String& namespaceURI, const String& localName);
479     PassRefPtr<NodeList> getElementsByName(const String& elementName);
480     PassRefPtr<NodeList> getElementsByClassName(const String& classNames);
481
482     PassRefPtr<Element> querySelector(const String& selectors, NSResolver*, ExceptionCode&, KJS::ExecState*);
483     PassRefPtr<NodeList> querySelectorAll(const String& selectors, NSResolver*, ExceptionCode&, KJS::ExecState*);
484
485     // For non-JS bindings. Silently ignores the JavaScript exception if any.
486     // FIXME: We should support the NSResolver interface for non-JS bindings.
487     PassRefPtr<Element> querySelector(const String& selectors, ExceptionCode&);
488     PassRefPtr<NodeList> querySelectorAll(const String& selectors, ExceptionCode&);
489
490     unsigned short compareDocumentPosition(Node*);
491
492 protected:
493     virtual void willMoveToNewOwnerDocument() { }
494     virtual void didMoveToNewOwnerDocument() { }
495     
496     virtual void getSubresourceAttributeStrings(Vector<String>&) const { }
497     void setTabIndexExplicitly(short i)
498     { 
499         m_tabIndex = i; 
500         m_tabIndexSetExplicitly = true;
501     }
502
503 private:
504     DocPtr<Document> m_document;
505     Node* m_previous;
506     Node* m_next;
507     RenderObject* m_renderer;
508
509     OwnPtr<NodeListsNodeData> m_nodeLists;
510
511     short m_tabIndex;
512
513     // make sure we don't use more than 16 bits here -- adding more would increase the size of all Nodes
514
515     unsigned m_styleChange : 2;
516     bool m_hasId : 1;
517     bool m_hasClass : 1;
518     bool m_attached : 1;
519     bool m_hasChangedChild : 1;
520     bool m_inDocument : 1;
521     bool m_isLink : 1;
522     bool m_focused : 1;
523     bool m_active : 1;
524     bool m_hovered : 1;
525     bool m_inActiveChain : 1;
526     bool m_inDetach : 1;
527     bool m_inSubtreeMark : 1;
528     bool m_tabIndexSetExplicitly : 1;
529     const bool m_isElement : 1;
530     // no bits left
531
532     Element* ancestorElement() const;
533
534     void appendTextContent(bool convertBRsToNewlines, StringBuilder&) const;
535
536     virtual Node* virtualFirstChild() const;
537     virtual Node* virtualLastChild() const;
538     virtual bool virtualHasTagName(const QualifiedName&) const;
539 };
540
541 } //namespace
542
543 #ifndef NDEBUG
544 // Outside the WebCore namespace for ease of invocation from gdb.
545 void showTree(const WebCore::Node*);
546 #endif
547
548 #endif