Rename JSDOMWindowProxy to JSWindowProxy
[WebKit.git] / Source / WebCore / bindings / js / JSWindowProxy.cpp
1 /*
2  * Copyright (C) 2008-2018 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "JSWindowProxy.h"
31
32 #include "AbstractFrame.h"
33 #include "CommonVM.h"
34 #include "GCController.h"
35 #include "JSDOMWindow.h"
36 #include "JSDOMWindowProperties.h"
37 #include "JSEventTarget.h"
38 #include "JSRemoteDOMWindow.h"
39 #include "ScriptController.h"
40 #include <JavaScriptCore/Debugger.h>
41 #include <JavaScriptCore/JSObject.h>
42 #include <JavaScriptCore/StrongInlines.h>
43
44 namespace WebCore {
45
46 const ClassInfo JSWindowProxy::s_info = { "JSWindowProxy", &Base::s_info, nullptr, nullptr, CREATE_METHOD_TABLE(JSWindowProxy) };
47
48 inline JSWindowProxy::JSWindowProxy(VM& vm, Structure& structure, DOMWrapperWorld& world)
49     : Base(vm, &structure)
50     , m_world(world)
51 {
52 }
53
54 void JSWindowProxy::finishCreation(VM& vm, AbstractDOMWindow& window)
55 {
56     Base::finishCreation(vm);
57     ASSERT(inherits(vm, info()));
58     setWindow(window);
59 }
60
61 JSWindowProxy& JSWindowProxy::create(JSC::VM& vm, AbstractDOMWindow& window, DOMWrapperWorld& world)
62 {
63     auto& structure = *JSC::Structure::create(vm, 0, jsNull(), JSC::TypeInfo(JSC::PureForwardingProxyType, StructureFlags), info());
64     auto& proxy = *new (NotNull, JSC::allocateCell<JSWindowProxy>(vm.heap)) JSWindowProxy(vm, structure, world);
65     proxy.finishCreation(vm, window);
66     return proxy;
67 }
68
69 void JSWindowProxy::destroy(JSCell* cell)
70 {
71     static_cast<JSWindowProxy*>(cell)->JSWindowProxy::~JSWindowProxy();
72 }
73
74 void JSWindowProxy::setWindow(VM& vm, JSDOMGlobalObject& window)
75 {
76     ASSERT(window.classInfo() == JSDOMWindow::info() || window.classInfo() == JSRemoteDOMWindow::info());
77     setTarget(vm, &window);
78     structure()->setGlobalObject(vm, &window);
79     GCController::singleton().garbageCollectSoon();
80 }
81
82 void JSWindowProxy::setWindow(AbstractDOMWindow& domWindow)
83 {
84     // Replacing JSDOMWindow via telling JSWindowProxy to use the same DOMWindow it already uses makes no sense,
85     // so we'd better never try to.
86     ASSERT(!window() || &domWindow != &wrapped());
87
88     bool isRemoteDOMWindow = is<RemoteDOMWindow>(domWindow);
89
90     VM& vm = commonVM();
91     auto& prototypeStructure = isRemoteDOMWindow ? *JSRemoteDOMWindowPrototype::createStructure(vm, nullptr, jsNull()) : *JSDOMWindowPrototype::createStructure(vm, nullptr, jsNull());
92
93     // Explicitly protect the prototype so it isn't collected when we allocate the global object.
94     // (Once the global object is fully constructed, it will mark its own prototype.)
95     // FIXME: Why do we need to protect this when there's a pointer to it on the stack?
96     // Perhaps the issue is that structure objects aren't seen when scanning the stack?
97     Strong<JSNonFinalObject> prototype(vm, isRemoteDOMWindow ? static_cast<JSNonFinalObject*>(JSRemoteDOMWindowPrototype::create(vm, nullptr, &prototypeStructure)) : static_cast<JSNonFinalObject*>(JSDOMWindowPrototype::create(vm, nullptr, &prototypeStructure)));
98
99     JSDOMGlobalObject* window = nullptr;
100     if (isRemoteDOMWindow) {
101         auto& windowStructure = *JSRemoteDOMWindow::createStructure(vm, nullptr, prototype.get());
102         window = JSRemoteDOMWindow::create(vm, &windowStructure, downcast<RemoteDOMWindow>(domWindow), this);
103     } else {
104         auto& windowStructure = *JSDOMWindow::createStructure(vm, nullptr, prototype.get());
105         window = JSDOMWindow::create(vm, &windowStructure, downcast<DOMWindow>(domWindow), this);
106     }
107
108     prototype->structure()->setGlobalObject(vm, window);
109
110     auto& propertiesStructure = *JSDOMWindowProperties::createStructure(vm, window, JSEventTarget::prototype(vm, *window));
111     auto& properties = *JSDOMWindowProperties::create(&propertiesStructure, *window);
112     prototype->structure()->setPrototypeWithoutTransition(vm, &properties);
113
114     setWindow(vm, *window);
115
116     ASSERT(window->globalObject() == window);
117     ASSERT(prototype->globalObject() == window);
118 }
119
120 void JSWindowProxy::attachDebugger(JSC::Debugger* debugger)
121 {
122     auto* globalObject = window();
123     JSLockHolder lock(globalObject->vm());
124
125     if (debugger)
126         debugger->attach(globalObject);
127     else if (auto* currentDebugger = globalObject->debugger())
128         currentDebugger->detach(globalObject, JSC::Debugger::TerminatingDebuggingSession);
129 }
130
131 AbstractDOMWindow& JSWindowProxy::wrapped() const
132 {
133     auto* window = this->window();
134     if (auto* jsWindow = jsDynamicCast<JSRemoteDOMWindowBase*>(window->vm(), window))
135         return jsWindow->wrapped();
136     return jsCast<JSDOMWindowBase*>(window)->wrapped();
137 }
138
139 AbstractDOMWindow* JSWindowProxy::toWrapped(VM& vm, JSObject* value)
140 {
141     auto* wrapper = jsDynamicCast<JSWindowProxy*>(vm, value);
142     return wrapper ? &wrapper->wrapped() : nullptr;
143 }
144
145 JSValue toJS(ExecState* state, WindowProxy& windowProxy)
146 {
147     return &windowProxy.jsWindowProxy(currentWorld(*state));
148 }
149
150 JSWindowProxy& toJSWindowProxy(WindowProxy& windowProxy, DOMWrapperWorld& world)
151 {
152     return windowProxy.jsWindowProxy(world);
153 }
154
155 } // namespace WebCore