[GTK] Windowed plugins visibility doesn't work
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PluginProxy.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 PluginProxy_h
27 #define PluginProxy_h
28
29 #if ENABLE(NETSCAPE_PLUGIN_API)
30
31 #include "Connection.h"
32 #include "Plugin.h"
33 #include "PluginProcess.h"
34 #include <WebCore/AffineTransform.h>
35 #include <WebCore/FindOptions.h>
36 #include <WebCore/IntRect.h>
37 #include <WebCore/SecurityOrigin.h>
38 #include <memory>
39
40 #if PLATFORM(COCOA)
41 #include <wtf/RetainPtr.h>
42 OBJC_CLASS CALayer;
43 #endif
44
45 namespace WebCore {
46     class HTTPHeaderMap;
47     class ProtectionSpace;
48 }
49
50 namespace WebKit {
51
52 class ShareableBitmap;
53 class NPVariantData;
54 class PluginProcessConnection;
55
56 struct PluginCreationParameters;
57
58 class PluginProxy : public Plugin {
59 public:
60     static PassRefPtr<PluginProxy> create(uint64_t pluginProcessToken, bool isRestartedProcess);
61     ~PluginProxy();
62
63     uint64_t pluginInstanceID() const { return m_pluginInstanceID; }
64     void pluginProcessCrashed();
65
66     void didReceivePluginProxyMessage(IPC::Connection*, IPC::MessageDecoder&);
67     void didReceiveSyncPluginProxyMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
68
69     bool isBeingAsynchronouslyInitialized() const { return m_waitingOnAsynchronousInitialization; }
70
71 private:
72     explicit PluginProxy(uint64_t pluginProcessToken, bool isRestartedProcess);
73
74     // Plugin
75     virtual bool initialize(const Parameters&);
76     bool initializeSynchronously();
77
78     virtual void destroy();
79     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRect);
80     virtual bool supportsSnapshotting() const;
81     virtual PassRefPtr<ShareableBitmap> snapshot();
82 #if PLATFORM(COCOA)
83     virtual PlatformLayer* pluginLayer();
84 #endif
85     virtual bool isTransparent();
86     virtual bool wantsWheelEvents() override;
87     virtual void geometryDidChange(const WebCore::IntSize& pluginSize, const WebCore::IntRect& clipRect, const WebCore::AffineTransform& pluginToRootViewTransform);
88     virtual void visibilityDidChange(bool isVisible);
89     virtual void frameDidFinishLoading(uint64_t requestID);
90     virtual void frameDidFail(uint64_t requestID, bool wasCancelled);
91     virtual void didEvaluateJavaScript(uint64_t requestID, const String& result);
92     virtual void streamDidReceiveResponse(uint64_t streamID, const WebCore::URL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName);
93     virtual void streamDidReceiveData(uint64_t streamID, const char* bytes, int length);
94     virtual void streamDidFinishLoading(uint64_t streamID);
95     virtual void streamDidFail(uint64_t streamID, bool wasCancelled);
96     virtual void manualStreamDidReceiveResponse(const WebCore::URL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const WTF::String& mimeType, const WTF::String& headers, const String& suggestedFileName);
97     virtual void manualStreamDidReceiveData(const char* bytes, int length);
98     virtual void manualStreamDidFinishLoading();
99     virtual void manualStreamDidFail(bool wasCancelled);
100     
101     virtual bool handleMouseEvent(const WebMouseEvent&);
102     virtual bool handleWheelEvent(const WebWheelEvent&);
103     virtual bool handleMouseEnterEvent(const WebMouseEvent&);
104     virtual bool handleMouseLeaveEvent(const WebMouseEvent&);
105     virtual bool handleContextMenuEvent(const WebMouseEvent&);
106     virtual bool handleKeyboardEvent(const WebKeyboardEvent&);
107     virtual void setFocus(bool);
108     virtual bool handleEditingCommand(const String& commandName, const String& argument) override;
109     virtual bool isEditingCommandEnabled(const String& commandName) override;
110     virtual bool shouldAllowScripting() override { return true; }
111     virtual bool shouldAllowNavigationFromDrags() override { return false; }
112     
113     virtual bool handlesPageScaleFactor();
114     
115     virtual NPObject* pluginScriptableNPObject();
116 #if PLATFORM(COCOA)
117     virtual void windowFocusChanged(bool);
118     virtual void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
119     virtual void windowVisibilityChanged(bool);
120     virtual uint64_t pluginComplexTextInputIdentifier() const;
121     virtual void sendComplexTextInput(const String& textInput);
122     virtual void setLayerHostingMode(LayerHostingMode) override;
123 #endif
124
125     virtual void contentsScaleFactorChanged(float);
126     virtual void storageBlockingStateChanged(bool);
127     virtual void privateBrowsingStateChanged(bool);
128     virtual bool getFormValue(String& formValue);
129     virtual bool handleScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
130     virtual WebCore::Scrollbar* horizontalScrollbar();
131     virtual WebCore::Scrollbar* verticalScrollbar();
132
133     virtual unsigned countFindMatches(const String&, WebCore::FindOptions, unsigned) override  { return 0; }
134     virtual bool findString(const String&, WebCore::FindOptions, unsigned) override { return false; }
135
136     virtual WebCore::IntPoint convertToRootView(const WebCore::IntPoint&) const override;
137
138     virtual PassRefPtr<WebCore::SharedBuffer> liveResourceData() const override;
139     virtual bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&) override { return false; }
140
141     virtual String getSelectionString() const override { return String(); }
142
143 #if PLATFORM(COCOA)
144     virtual WebCore::AudioHardwareActivityType audioHardwareActivity() const override;
145 #endif
146
147     float contentsScaleFactor();
148     bool needsBackingStore() const;
149     bool updateBackingStore();
150     uint64_t windowNPObjectID();
151     WebCore::IntRect pluginBounds();
152
153     void geometryDidChange();
154
155     // Message handlers.
156     void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups);
157     void update(const WebCore::IntRect& paintedRect);
158     void proxiesForURL(const String& urlString, String& proxyString);
159     void cookiesForURL(const String& urlString, String& cookieString);
160     void setCookiesForURL(const String& urlString, const String& cookieString);
161     void getAuthenticationInfo(const WebCore::ProtectionSpace&, bool& returnValue, String& username, String& password);
162     void getPluginElementNPObject(uint64_t& pluginElementNPObjectID);
163     void evaluate(const NPVariantData& npObjectAsVariantData, const String& scriptString, bool allowPopups, bool& returnValue, NPVariantData& resultData);
164     void cancelStreamLoad(uint64_t streamID);
165     void cancelManualStreamLoad();
166     void setStatusbarText(const String& statusbarText);
167 #if PLATFORM(COCOA)
168     void pluginFocusOrWindowFocusChanged(bool);
169     void setComplexTextInputState(uint64_t);
170     void setLayerHostingContextID(uint32_t);
171 #endif
172 #if PLUGIN_ARCHITECTURE(X11)
173     void createPluginContainer(uint64_t& windowID);
174     void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID);
175     void windowedPluginVisibilityDidChange(bool isVisible, uint64_t windowID);
176 #endif
177
178     bool canInitializeAsynchronously() const;
179
180     void didCreatePlugin(bool wantsWheelEvents, uint32_t remoteLayerClientID);
181     void didFailToCreatePlugin();
182
183     void didCreatePluginInternal(bool wantsWheelEvents, uint32_t remoteLayerClientID);
184     void didFailToCreatePluginInternal();
185
186     uint64_t m_pluginProcessToken;
187
188     RefPtr<PluginProcessConnection> m_connection;
189     uint64_t m_pluginInstanceID;
190
191     WebCore::IntSize m_pluginSize;
192
193     // The clip rect in plug-in coordinates.
194     WebCore::IntRect m_clipRect;
195
196     // A transform that can be used to convert from root view coordinates to plug-in coordinates.
197     WebCore::AffineTransform m_pluginToRootViewTransform;
198
199     // This is the backing store that we paint when we're told to paint.
200     RefPtr<ShareableBitmap> m_backingStore;
201
202     // This is the shared memory backing store that the plug-in paints into. When the plug-in tells us
203     // that it's painted something in it, we'll blit from it to our own backing store.
204     RefPtr<ShareableBitmap> m_pluginBackingStore;
205     
206     // Whether all of the plug-in backing store contains valid data.
207     bool m_pluginBackingStoreContainsValidData;
208
209     bool m_isStarted;
210
211     // Whether we're called invalidate in response to an update call, and are now waiting for a paint call.
212     bool m_waitingForPaintInResponseToUpdate;
213
214     // Whether we should send wheel events to this plug-in or not.
215     bool m_wantsWheelEvents;
216
217     // The client ID for the CA layer in the plug-in process. Will be 0 if the plug-in is not a CA plug-in.
218     uint32_t m_remoteLayerClientID;
219     
220     std::unique_ptr<PluginCreationParameters> m_pendingPluginCreationParameters;
221     bool m_waitingOnAsynchronousInitialization;
222
223 #if PLATFORM(COCOA)
224     RetainPtr<CALayer> m_pluginLayer;
225 #endif
226
227     bool m_isRestartedProcess;
228 };
229
230 } // namespace WebKit
231
232 #endif // ENABLE(NETSCAPE_PLUGIN_API)
233
234 #endif // PluginProxy_h