JSDOMWindowProxy.h   [plain text]

/*
 * Copyright (C) 2008 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "DOMWindow.h"
#include "JSDOMWindow.h"
#include <runtime/JSProxy.h>

namespace WebCore {

class Frame;

class JSDOMWindowProxy : public JSC::JSProxy {
    typedef JSC::JSProxy Base;
public:
    static void destroy(JSCell*);

    JSDOMWindow* window() const { return JSC::jsCast<JSDOMWindow*>(target()); }
    void setWindow(JSC::VM&, JSDOMWindow*);
    void setWindow(RefPtr<DOMWindow>&&);

    DECLARE_INFO;

    DOMWindow& wrapped() const;
    static WEBCORE_EXPORT DOMWindow* toWrapped(JSC::VM&, JSC::JSObject*);

    static JSDOMWindowProxy* create(JSC::VM& vm, RefPtr<DOMWindow>&& window, JSC::Structure* structure, DOMWrapperWorld& world)
    {
        JSDOMWindowProxy* proxy = new (NotNull, JSC::allocateCell<JSDOMWindowProxy>(vm.heap)) JSDOMWindowProxy(vm, structure, world);
        proxy->finishCreation(vm, WTFMove(window));
        return proxy;
    }

    static JSC::Structure* createStructure(JSC::VM& vm, JSC::JSValue prototype)
    {
        return JSC::Structure::create(vm, 0, prototype, JSC::TypeInfo(JSC::PureForwardingProxyType, StructureFlags), info());
    }

    DOMWrapperWorld& world() { return m_world; }

protected:
    JSDOMWindowProxy(JSC::VM&, JSC::Structure*, DOMWrapperWorld&);
    void finishCreation(JSC::VM&, RefPtr<DOMWindow>&&);

    Ref<DOMWrapperWorld> m_world;
};

// JSDOMWindowProxy is a little odd in that it's not a traditional wrapper and has no back pointer. It
// is however strongly owned by Frame (via its ScriptController), and therefore, to get the JSDOMWindowProxy
// a Frame is passed.
JSC::JSValue toJS(JSC::ExecState*, Frame&);
inline JSC::JSValue toJS(JSC::ExecState* state, Frame* frame) { return frame ? toJS(state, *frame) : JSC::jsNull(); }

JSDOMWindowProxy* toJSDOMWindowProxy(Frame&, DOMWrapperWorld&);
inline JSDOMWindowProxy* toJSDOMWindowProxy(Frame* frame, DOMWrapperWorld& world) { return frame ? toJSDOMWindowProxy(*frame, world) : nullptr; }

} // namespace WebCore