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