Out-of-process plug-ins should support asynchronous initialization
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PluginController.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 PluginController_h
27 #define PluginController_h
28
29 #include <wtf/Forward.h>
30
31 #if PLATFORM(MAC)
32 #include "PluginComplexTextInputState.h"
33 #endif
34
35 struct NPObject;
36 typedef struct _NPVariant NPVariant;
37 typedef void* NPIdentifier;
38
39 namespace WebCore {
40     class HTTPHeaderMap;
41     class IntRect;
42     class KURL;
43     class ProtectionSpace;
44 }
45
46 namespace WebKit {
47
48 #if PLATFORM(WIN)
49 struct WindowGeometry;
50 #endif
51
52 class PluginController {
53 public:
54     // Returns false if the plugin has explicitly been hidden. Returns true otherwise (even if the plugin is currently obscured from view on screen.)
55     virtual bool isPluginVisible() = 0;
56
57     // Tells the controller that the plug-in wants the given rect to be repainted. The rect is in the plug-in's coordinate system.
58     virtual void invalidate(const WebCore::IntRect&) = 0;
59
60     // Returns the user agent string.
61     virtual String userAgent() = 0;
62
63     // Loads the given URL and associates it with the request ID.
64     // 
65     // If a target is specified, then the URL will be loaded in the window or frame that the target refers to.
66     // Once the URL finishes loading, Plugin::frameDidFinishLoading will be called with the given requestID. If the URL
67     // fails to load, Plugin::frameDidFailToLoad will be called.
68     //
69     // If the URL is a JavaScript URL, the JavaScript code will be evaluated and the result sent back using Plugin::didEvaluateJavaScript.
70     virtual void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, 
71                          const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups) = 0;
72
73     /// Cancels the load of a stream that was requested by loadURL.
74     virtual void cancelStreamLoad(uint64_t streamID) = 0;
75
76     // Cancels the load of the manual stream.
77     virtual void cancelManualStreamLoad() = 0;
78
79 #if ENABLE(NETSCAPE_PLUGIN_API)
80     // Get the NPObject that corresponds to the window JavaScript object. Returns a retained object.
81     virtual NPObject* windowScriptNPObject() = 0;
82
83     // Get the NPObject that corresponds to the plug-in's element. Returns a retained object.
84     virtual NPObject* pluginElementNPObject() = 0;
85
86     // Evaluates the given script string in the context of the given NPObject.
87     virtual bool evaluate(NPObject*, const String& scriptString, NPVariant* result, bool allowPopups) = 0;
88 #endif
89
90     // Set the statusbar text.
91     virtual void setStatusbarText(const String&) = 0;
92
93 #if USE(ACCELERATED_COMPOSITING)
94     // Return whether accelerated compositing is enabled.
95     virtual bool isAcceleratedCompositingEnabled() = 0;
96 #endif
97
98     // Tells the controller that the plug-in process has crashed.
99     virtual void pluginProcessCrashed() = 0;
100     
101     // Tells the controller that we're about to dispatch an event to the plug-in.
102     virtual void willSendEventToPlugin() = 0;
103     
104 #if PLATFORM(WIN)
105     // The window to use as the parent of the plugin's window.
106     virtual HWND nativeParentWindow() = 0;
107
108     // Tells the controller that the given HWND needs to be positioned and clipped to the given
109     // coordinates sometime soon. The controller will decide exactly when this will happen.
110     virtual void scheduleWindowedPluginGeometryUpdate(const WindowGeometry&) = 0;
111 #endif
112
113 #if PLATFORM(MAC)
114     // Tells the controller that the plug-in focus or window focus did change.
115     virtual void pluginFocusOrWindowFocusChanged(bool) = 0;
116
117     // Tells the controller that complex text input be enabled or disabled for the plug-in.
118     virtual void setComplexTextInputState(PluginComplexTextInputState) = 0;
119
120     // Returns the mach port of the compositing render server.
121     virtual mach_port_t compositingRenderServerPort() = 0;
122 #endif
123
124     // Returns the contents scale factor.
125     virtual float contentsScaleFactor() = 0;
126
127     // Returns the proxies for the given URL or null on failure.
128     virtual String proxiesForURL(const String&) = 0;
129
130     // Returns the cookies for the given URL or null on failure.
131     virtual String cookiesForURL(const String&) = 0;
132
133     // Sets the cookies for the given URL.
134     virtual void setCookiesForURL(const String& urlString, const String& cookieString) = 0;
135
136     // Get authentication credentials for the given protection space.
137     virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password) = 0;
138
139     // Returns whether private browsing is enabled.
140     virtual bool isPrivateBrowsingEnabled() = 0;
141     
142     // Returns whether or not asynchronous plugin initialization is enabled.
143     virtual bool asynchronousPluginInitializationEnabled() const { return false; }
144     
145     // Returns whether or not asynchronous plugin initialization should be attempted for all plugins.
146     virtual bool asynchronousPluginInitializationEnabledForAllPlugins() const { return false; }
147     
148     // Returns the articifical plugin delay to use for testing of asynchronous plugin initialization.
149     virtual bool artificialPluginInitializationDelayEnabled() const { return false; }
150
151     // Increments a counter that prevents the plug-in from being destroyed.
152     virtual void protectPluginFromDestruction() = 0;
153
154     // Decrements a counter that, when it reaches 0, stops preventing the plug-in from being destroyed.
155     virtual void unprotectPluginFromDestruction() = 0;
156
157 #if PLUGIN_ARCHITECTURE(X11)
158     // Create a plugin container for windowed plugins
159     virtual uint64_t createPluginContainer() = 0;
160     virtual void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID) = 0;
161 #endif
162
163     // Called when the a plug-in instance is successfully initialized, either synchronously or asynchronously.
164     virtual void didInitializePlugin() = 0;
165     
166     // Called when the a plug-in instance fails to initialized, either synchronously or asynchronously.
167     virtual void didFailToInitializePlugin() = 0;
168
169     // Helper class for delaying destruction of a plug-in.
170     class PluginDestructionProtector {
171     public:
172         explicit PluginDestructionProtector(PluginController* pluginController)
173             : m_pluginController(pluginController)
174         {
175             m_pluginController->protectPluginFromDestruction();
176         }
177         
178         ~PluginDestructionProtector()
179         {
180             m_pluginController->unprotectPluginFromDestruction();
181         }
182         
183     private:
184         PluginController* m_pluginController;
185     };
186     
187 protected:
188     virtual ~PluginController() { }
189 };
190
191 } // namespace WebKit
192
193 #endif // PluginController_h