Add bindings code for RemoteDOMWindow
[WebKit-https.git] / Source / WebCore / bindings / js / JSDOMWindowProxy.h
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 #pragma once
30
31 #include "JSDOMWindow.h"
32 #include <JavaScriptCore/JSProxy.h>
33
34 namespace JSC {
35 class Debugger;
36 }
37
38 namespace WebCore {
39
40 class AbstractDOMWindow;
41 class AbstractFrame;
42
43 class JSDOMWindowProxy final : public JSC::JSProxy {
44     using Base = JSC::JSProxy;
45 public:
46     static JSDOMWindowProxy& create(JSC::VM&, DOMWindow&, DOMWrapperWorld&);
47     static void destroy(JSCell*);
48
49     DECLARE_INFO;
50
51     JSDOMGlobalObject* window() const { return JSC::jsCast<JSDOMGlobalObject*>(target()); }
52     void setWindow(JSC::VM&, JSDOMGlobalObject&);
53     void setWindow(AbstractDOMWindow&);
54
55     AbstractDOMWindow& wrapped() const;
56     static WEBCORE_EXPORT AbstractDOMWindow* toWrapped(JSC::VM&, JSC::JSObject*);
57
58     DOMWrapperWorld& world() { return m_world; }
59
60     void attachDebugger(JSC::Debugger*);
61
62 private:
63     JSDOMWindowProxy(JSC::VM&, JSC::Structure&, DOMWrapperWorld&);
64     void finishCreation(JSC::VM&, DOMWindow&);
65
66     Ref<DOMWrapperWorld> m_world;
67 };
68
69 // JSDOMWindowProxy is a little odd in that it's not a traditional wrapper and has no back pointer.
70 // It is, however, strongly owned by Frame via its ScriptController, so we can get one from a frame.
71 JSC::JSValue toJS(JSC::ExecState*, AbstractFrame&);
72 inline JSC::JSValue toJS(JSC::ExecState* state, AbstractFrame* frame) { return frame ? toJS(state, *frame) : JSC::jsNull(); }
73
74 JSDOMWindowProxy& toJSDOMWindowProxy(AbstractFrame&, DOMWrapperWorld&);
75 inline JSDOMWindowProxy* toJSDOMWindowProxy(AbstractFrame* frame, DOMWrapperWorld& world) { return frame ? &toJSDOMWindowProxy(*frame, world) : nullptr; }
76
77 } // namespace WebCore