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