Unreviewed, rolling out r117095.
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / Netscape / NPRuntimeObjectMap.h
1 /*
2  * Copyright (C) 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef NPJSObjectWrapperMap_h
27 #define NPJSObjectWrapperMap_h
28
29 #include <WebCore/RunLoop.h>
30 #include <heap/Weak.h>
31 #include <wtf/Forward.h>
32 #include <wtf/HashMap.h>
33
34 struct NPObject;
35 typedef struct _NPVariant NPVariant;
36
37 namespace JSC {
38     class ExecState;
39     class JSGlobalData;
40     class JSGlobalObject;
41     class JSObject;
42     class JSValue;
43 }
44
45 namespace WebKit {
46
47 class JSNPObject;
48 class NPJSObject;
49 class PluginView;
50
51 // A per plug-in map of NPObjects that wrap JavaScript objects.
52 class NPRuntimeObjectMap : private JSC::WeakHandleOwner {
53 public:
54     explicit NPRuntimeObjectMap(PluginView*);
55
56     class PluginProtector {
57     public:
58         explicit PluginProtector(NPRuntimeObjectMap* npRuntimeObjectMap);
59         ~PluginProtector();
60         
61     private:
62         RefPtr<PluginView> m_pluginView;
63     };
64
65     // Returns an NPObject that wraps the given JSObject object. If there is already an NPObject that wraps this JSObject, it will
66     // retain it and return it.
67     NPObject* getOrCreateNPObject(JSC::JSGlobalData&, JSC::JSObject*);
68     void npJSObjectDestroyed(NPJSObject*);
69
70     // Returns a JSObject object that wraps the given NPObject.
71     JSC::JSObject* getOrCreateJSObject(JSC::JSGlobalObject*, NPObject*);
72     void jsNPObjectDestroyed(JSNPObject*);
73
74     void convertJSValueToNPVariant(JSC::ExecState*, JSC::JSValue, NPVariant&);
75     JSC::JSValue convertNPVariantToJSValue(JSC::ExecState*, JSC::JSGlobalObject*, const NPVariant&);
76
77     bool evaluate(NPObject*, const String& scriptString, NPVariant* result);
78
79     // Called when the plug-in is destroyed. Will invalidate all the NPObjects.
80     void invalidate();
81
82     JSC::JSGlobalObject* globalObject() const;
83     JSC::ExecState* globalExec() const;
84
85     static void setGlobalException(const String& exceptionString);
86     static void moveGlobalExceptionToExecState(JSC::ExecState*);
87
88 private:
89     // WeakHandleOwner
90     virtual void finalize(JSC::Handle<JSC::Unknown>, void* context);
91     void addToInvalidationQueue(NPObject*);
92     void invalidateQueuedObjects();
93
94     PluginView* m_pluginView;
95
96     HashMap<JSC::JSObject*, NPJSObject*> m_npJSObjects;
97     HashMap<NPObject*, JSC::Weak<JSNPObject> > m_jsNPObjects;
98     Vector<NPObject*> m_npObjectsToFinalize;
99     WebCore::RunLoop::Timer<NPRuntimeObjectMap> m_finalizationTimer;
100 };
101
102 } // namespace WebKit
103
104 #endif // NPJSObjectWrapperMap_h