Micro-optimize JSNodeOwner::isReachableFromOpaqueRoots().
[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 (node->isElementNode()) {
101             auto& element = toElement(*node);
102
103             // If a wrapper is the last reference to an image element
104             // that is loading but not in the document, the wrapper is observable
105             // because it is the only thing keeping the image element alive, and if
106             // the element is destroyed, its load event will not fire.
107             // FIXME: The DOM should manage this issue without the help of JavaScript wrappers.
108             if (isHTMLImageElement(element)) {
109                 if (toHTMLImageElement(element).hasPendingActivity())
110                     return true;
111             }
112 #if ENABLE(VIDEO)
113             else if (isHTMLAudioElement(element)) {
114                 if (!toHTMLAudioElement(element).paused())
115                     return true;
116             }
117 #endif
118         }
119
120         // If a node is firing event listeners, its wrapper is observable because
121         // its wrapper is responsible for marking those event listeners.
122         if (node->isFiringEventListeners())
123             return true;
124     }
125
126     return isObservable(jsNode, node) && visitor.containsOpaqueRoot(root(node));
127 }
128
129 bool JSNodeOwner::isReachableFromOpaqueRoots(JSC::Handle<JSC::Unknown> handle, void*, SlotVisitor& visitor)
130 {
131     JSNode* jsNode = jsCast<JSNode*>(handle.get().asCell());
132     return isReachableFromDOM(jsNode, &jsNode->impl(), visitor);
133 }
134
135 JSValue JSNode::insertBefore(ExecState* exec)
136 {
137     ExceptionCode ec = 0;
138     bool ok = impl().insertBefore(toNode(exec->argument(0)), toNode(exec->argument(1)), ec);
139     setDOMException(exec, ec);
140     if (ok)
141         return exec->argument(0);
142     return jsNull();
143 }
144
145 JSValue JSNode::replaceChild(ExecState* exec)
146 {
147     ExceptionCode ec = 0;
148     bool ok = impl().replaceChild(toNode(exec->argument(0)), toNode(exec->argument(1)), ec);
149     setDOMException(exec, ec);
150     if (ok)
151         return exec->argument(1);
152     return jsNull();
153 }
154
155 JSValue JSNode::removeChild(ExecState* exec)
156 {
157     ExceptionCode ec = 0;
158     bool ok = impl().removeChild(toNode(exec->argument(0)), ec);
159     setDOMException(exec, ec);
160     if (ok)
161         return exec->argument(0);
162     return jsNull();
163 }
164
165 JSValue JSNode::appendChild(ExecState* exec)
166 {
167     ExceptionCode ec = 0;
168     bool ok = impl().appendChild(toNode(exec->argument(0)), ec);
169     setDOMException(exec, ec);
170     if (ok)
171         return exec->argument(0);
172     return jsNull();
173 }
174
175 JSScope* JSNode::pushEventHandlerScope(ExecState* exec, JSScope* node) const
176 {
177     if (inherits(JSHTMLElement::info()))
178         return jsCast<const JSHTMLElement*>(this)->pushEventHandlerScope(exec, node);
179     return node;
180 }
181
182 void JSNode::visitChildren(JSCell* cell, SlotVisitor& visitor)
183 {
184     JSNode* thisObject = jsCast<JSNode*>(cell);
185     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
186     COMPILE_ASSERT(StructureFlags & OverridesVisitChildren, OverridesVisitChildrenWithoutSettingFlag);
187     ASSERT(thisObject->structure()->typeInfo().overridesVisitChildren());
188     Base::visitChildren(thisObject, visitor);
189
190     Node& node = thisObject->impl();
191     node.visitJSEventListeners(visitor);
192
193     visitor.addOpaqueRoot(root(node));
194 }
195
196 static ALWAYS_INLINE JSValue createWrapperInline(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
197 {
198     ASSERT(node);
199     ASSERT(!getCachedWrapper(currentWorld(exec), node));
200     
201     JSDOMWrapper* wrapper;    
202     switch (node->nodeType()) {
203         case Node::ELEMENT_NODE:
204             if (node->isHTMLElement())
205                 wrapper = createJSHTMLWrapper(exec, globalObject, toHTMLElement(node));
206             else if (node->isSVGElement())
207                 wrapper = createJSSVGWrapper(exec, globalObject, toSVGElement(node));
208             else
209                 wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Element, node);
210             break;
211         case Node::ATTRIBUTE_NODE:
212             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Attr, node);
213             break;
214         case Node::TEXT_NODE:
215             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Text, node);
216             break;
217         case Node::CDATA_SECTION_NODE:
218             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, CDATASection, node);
219             break;
220         case Node::ENTITY_NODE:
221             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Entity, node);
222             break;
223         case Node::PROCESSING_INSTRUCTION_NODE:
224             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, ProcessingInstruction, node);
225             break;
226         case Node::COMMENT_NODE:
227             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Comment, node);
228             break;
229         case Node::DOCUMENT_NODE:
230             // we don't want to cache the document itself in the per-document dictionary
231             return toJS(exec, globalObject, toDocument(node));
232         case Node::DOCUMENT_TYPE_NODE:
233             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, DocumentType, node);
234             break;
235         case Node::NOTATION_NODE:
236             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Notation, node);
237             break;
238         case Node::DOCUMENT_FRAGMENT_NODE:
239             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, DocumentFragment, node);
240             break;
241         case Node::ENTITY_REFERENCE_NODE:
242             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, EntityReference, node);
243             break;
244         default:
245             wrapper = CREATE_DOM_WRAPPER(exec, globalObject, Node, node);
246     }
247
248     return wrapper;    
249 }
250
251 JSValue createWrapper(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
252 {
253     return createWrapperInline(exec, globalObject, node);
254 }
255     
256 JSValue toJSNewlyCreated(ExecState* exec, JSDOMGlobalObject* globalObject, Node* node)
257 {
258     if (!node)
259         return jsNull();
260     
261     return createWrapperInline(exec, globalObject, node);
262 }
263
264 void willCreatePossiblyOrphanedTreeByRemovalSlowCase(Node* root)
265 {
266     JSC::ExecState* scriptState = mainWorldExecState(root->document().frame());
267     if (!scriptState)
268         return;
269
270     JSLockHolder lock(scriptState);
271     toJS(scriptState, static_cast<JSDOMGlobalObject*>(scriptState->lexicalGlobalObject()), root);
272 }
273
274 } // namespace WebCore