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