dc3a8fe3c3cd849ae1b5ee5f2e4285117bc7483d
[WebKit-https.git] / Source / WebCore / bindings / js / JSNodeCustom.cpp
1 /*
2  * Copyright (C) 2007, 2009, 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "JSNode.h"
28
29 #include "Attr.h"
30 #include "CDATASection.h"
31 #include "Comment.h"
32 #include "Document.h"
33 #include "DocumentFragment.h"
34 #include "DocumentType.h"
35 #include "Entity.h"
36 #include "EntityReference.h"
37 #include "ExceptionCode.h"
38 #include "HTMLAudioElement.h"
39 #include "HTMLCanvasElement.h"
40 #include "HTMLElement.h"
41 #include "HTMLFrameElementBase.h"
42 #include "HTMLImageElement.h"
43 #include "HTMLLinkElement.h"
44 #include "HTMLNames.h"
45 #include "HTMLScriptElement.h"
46 #include "HTMLStyleElement.h"
47 #include "JSAttr.h"
48 #include "JSCDATASection.h"
49 #include "JSComment.h"
50 #include "JSDOMBinding.h"
51 #include "JSDocument.h"
52 #include "JSDocumentFragment.h"
53 #include "JSDocumentType.h"
54 #include "JSEntity.h"
55 #include "JSEntityReference.h"
56 #include "JSEventListener.h"
57 #include "JSHTMLElement.h"
58 #include "JSHTMLElementWrapperFactory.h"
59 #include "JSNotation.h"
60 #include "JSProcessingInstruction.h"
61 #include "JSSVGElementWrapperFactory.h"
62 #include "JSText.h"
63 #include "Node.h"
64 #include "Notation.h"
65 #include "ProcessingInstruction.h"
66 #include "RegisteredEventListener.h"
67 #include "SVGElement.h"
68 #include "ShadowRoot.h"
69 #include "StyleSheet.h"
70 #include "StyledElement.h"
71 #include "Text.h"
72 #include <wtf/PassRefPtr.h>
73 #include <wtf/RefPtr.h>
74
75 using namespace JSC;
76
77 namespace WebCore {
78
79 using namespace HTMLNames;
80
81 static inline bool isObservable(JSNode* jsNode, Node* node)
82 {
83     // The root node keeps the tree intact.
84     if (!node->parentNode())
85         return true;
86
87     if (jsNode->hasCustomProperties())
88         return true;
89
90     // A node's JS wrapper is responsible for marking its JS event listeners.
91     if (node->hasEventListeners())
92         return true;
93
94     return false;
95 }
96
97 static inline bool isReachableFromDOM(JSNode* jsNode, Node* node, SlotVisitor& visitor)
98 {
99     if (!node->inDocument()) {
100         // If a wrapper is the last reference to an image element
101         // that is loading but not in the document, the wrapper is observable
102         // because it is the only thing keeping the image element alive, and if
103         // the element is destroyed, its load event will not fire.
104         // FIXME: The DOM should manage this issue without the help of JavaScript wrappers.
105         if (isHTMLImageElement(node)) {
106             if (toHTMLImageElement(node)->hasPendingActivity())
107                 return true;
108         }
109     #if ENABLE(VIDEO)
110         else if (isHTMLAudioElement(node)) {
111             if (!toHTMLAudioElement(node)->paused())
112                 return true;
113         }
114     #endif
115
116         // If a node is firing event listeners, its wrapper is observable because
117         // its wrapper is responsible for marking those event listeners.
118         if (node->isFiringEventListeners())
119             return true;
120     }
121
122     return isObservable(jsNode, node) && visitor.containsOpaqueRoot(root(node));
123 }
124
125 bool JSNodeOwner::isReachableFromOpaqueRoots(JSC::Handle<JSC::Unknown> handle, void*, SlotVisitor& visitor)
126 {
127     JSNode* jsNode = jsCast<JSNode*>(handle.get().asCell());
128     return isReachableFromDOM(jsNode, &jsNode->impl(), visitor);
129 }
130
131 JSValue JSNode::insertBefore(ExecState* exec)
132 {
133     ExceptionCode ec = 0;
134     bool ok = impl().insertBefore(toNode(exec->argument(0)), toNode(exec->argument(1)), ec);
135     setDOMException(exec, ec);
136     if (ok)
137         return exec->argument(0);
138     return jsNull();
139 }
140
141 JSValue JSNode::replaceChild(ExecState* exec)
142 {
143     ExceptionCode ec = 0;
144     bool ok = impl().replaceChild(toNode(exec->argument(0)), toNode(exec->argument(1)), ec);
145     setDOMException(exec, ec);
146     if (ok)
147         return exec->argument(1);
148     return jsNull();
149 }
150
151 JSValue JSNode::removeChild(ExecState* exec)
152 {
153     ExceptionCode ec = 0;
154     bool ok = impl().removeChild(toNode(exec->argument(0)), ec);
155     setDOMException(exec, ec);
156     if (ok)
157         return exec->argument(0);
158     return jsNull();
159 }
160
161 JSValue JSNode::appendChild(ExecState* exec)
162 {
163     ExceptionCode ec = 0;
164     bool ok = impl().appendChild(toNode(exec->argument(0)), ec);
165     setDOMException(exec, ec);
166     if (ok)
167         return exec->argument(0);
168     return jsNull();
169 }
170
171 JSScope* JSNode::pushEventHandlerScope(ExecState* exec, JSScope* node) const
172 {
173     if (inherits(JSHTMLElement::info()))
174         return jsCast<const JSHTMLElement*>(this)->pushEventHandlerScope(exec, node);
175     return node;
176 }
177
178 void JSNode::visitChildren(JSCell* cell, SlotVisitor& visitor)
179 {
180     JSNode* thisObject = jsCast<JSNode*>(cell);
181     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
182     COMPILE_ASSERT(StructureFlags & OverridesVisitChildren, OverridesVisitChildrenWithoutSettingFlag);
183     ASSERT(thisObject->structure()->typeInfo().overridesVisitChildren());
184     Base::visitChildren(thisObject, visitor);
185
186     Node& node = thisObject->impl();
187     node.visitJSEventListeners(visitor);
188
189     visitor.addOpaqueRoot(root(node));
190 }
191
192 static ALWAYS_INLINE JSValue createWrapperInline(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
193 {
194     ASSERT(node);
195     ASSERT(!getCachedWrapper(currentWorld(exec), node));
196     
197     JSDOMWrapper* wrapper;    
198     switch (node->nodeType()) {
199         case Node::ELEMENT_NODE:
200             if (node->isHTMLElement())
201                 wrapper = createJSHTMLWrapper(exec, globalObject, toHTMLElement(node));
202             else if (node->isSVGElement())
203                 wrapper = createJSSVGWrapper(exec, globalObject, toSVGElement(node));
204             else
205                 wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Element, node);
206             break;
207         case Node::ATTRIBUTE_NODE:
208             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Attr, node);
209             break;
210         case Node::TEXT_NODE:
211             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Text, node);
212             break;
213         case Node::CDATA_SECTION_NODE:
214             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, CDATASection, node);
215             break;
216         case Node::ENTITY_NODE:
217             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Entity, node);
218             break;
219         case Node::PROCESSING_INSTRUCTION_NODE:
220             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, ProcessingInstruction, node);
221             break;
222         case Node::COMMENT_NODE:
223             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Comment, node);
224             break;
225         case Node::DOCUMENT_NODE:
226             // we don't want to cache the document itself in the per-document dictionary
227             return toJS(exec, globalObject, toDocument(node));
228         case Node::DOCUMENT_TYPE_NODE:
229             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, DocumentType, node);
230             break;
231         case Node::NOTATION_NODE:
232             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Notation, node);
233             break;
234         case Node::DOCUMENT_FRAGMENT_NODE:
235             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, DocumentFragment, node);
236             break;
237         case Node::ENTITY_REFERENCE_NODE:
238             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, EntityReference, node);
239             break;
240         default:
241             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Node, node);
242     }
243
244     return wrapper;    
245 }
246
247 JSValue createWrapper(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
248 {
249     return createWrapperInline(exec, globalObject, node);
250 }
251     
252 JSValue toJSNewlyCreated(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
253 {
254     if (!node)
255         return jsNull();
256     
257     return createWrapperInline(exec, globalObject, node);
258 }
259
260 void willCreatePossiblyOrphanedTreeByRemovalSlowCase(Node* root)
261 {
262     JSC::ExecState* scriptState = mainWorldExecState(root->document().frame());
263     if (!scriptState)
264         return;
265
266     JSLockHolder lock(scriptState);
267     toJS(scriptState, static_cast<JSDOMGlobalObject*>(scriptState->lexicalGlobalObject()), root);
268 }
269
270 } // namespace WebCore