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