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