2011-05-10 Anders Carlsson <andersca@apple.com>
[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
34 #if PLATFORM(MAC)
35 #include <wtf/RetainPtr.h>
36 OBJC_CLASS CALayer;
37 #endif
38
39 namespace WebCore {
40     class HTTPHeaderMap;
41     class ProtectionSpace;
42 }
43
44 namespace WebKit {
45
46 class ShareableBitmap;
47 class NPVariantData;
48 class PluginProcessConnection;
49
50 class PluginProxy : public Plugin {
51 public:
52     static PassRefPtr<PluginProxy> create(const String& pluginPath);
53     ~PluginProxy();
54
55     uint64_t pluginInstanceID() const { return m_pluginInstanceID; }
56     void pluginProcessCrashed();
57
58     void didReceivePluginProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID messageID, CoreIPC::ArgumentDecoder* arguments);
59     CoreIPC::SyncReplyMode didReceiveSyncPluginProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, CoreIPC::ArgumentEncoder*);
60
61 private:
62     explicit PluginProxy(const String& pluginPath);
63
64     // Plugin
65     virtual bool initialize(PluginController*, const Parameters&);
66     virtual void destroy();
67     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRect);
68     virtual PassRefPtr<ShareableBitmap> snapshot();
69 #if PLATFORM(MAC)
70     virtual PlatformLayer* pluginLayer();
71 #endif
72     virtual bool isTransparent();
73     virtual void geometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect);
74     virtual void visibilityDidChange();
75     virtual void frameDidFinishLoading(uint64_t requestID);
76     virtual void frameDidFail(uint64_t requestID, bool wasCancelled);
77     virtual void didEvaluateJavaScript(uint64_t requestID, const WTF::String& requestURLString, const WTF::String& result);
78     virtual void streamDidReceiveResponse(uint64_t streamID, const WebCore::KURL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const WTF::String& mimeType, const WTF::String& headers);
79     virtual void streamDidReceiveData(uint64_t streamID, const char* bytes, int length);
80     virtual void streamDidFinishLoading(uint64_t streamID);
81     virtual void streamDidFail(uint64_t streamID, bool wasCancelled);
82     virtual void manualStreamDidReceiveResponse(const WebCore::KURL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const WTF::String& mimeType, const WTF::String& headers);
83     virtual void manualStreamDidReceiveData(const char* bytes, int length);
84     virtual void manualStreamDidFinishLoading();
85     virtual void manualStreamDidFail(bool wasCancelled);
86     
87     virtual bool handleMouseEvent(const WebMouseEvent&);
88     virtual bool handleWheelEvent(const WebWheelEvent&);
89     virtual bool handleMouseEnterEvent(const WebMouseEvent&);
90     virtual bool handleMouseLeaveEvent(const WebMouseEvent&);
91     virtual bool handleKeyboardEvent(const WebKeyboardEvent&);
92     virtual void setFocus(bool);
93     virtual NPObject* pluginScriptableNPObject();
94 #if PLATFORM(MAC)
95     virtual void windowFocusChanged(bool);
96     virtual void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
97     virtual void windowVisibilityChanged(bool);
98     virtual uint64_t pluginComplexTextInputIdentifier() const;
99     virtual void sendComplexTextInput(const String& textInput);
100 #endif
101
102     virtual void privateBrowsingStateChanged(bool);
103
104     virtual PluginController* controller();
105
106     bool needsBackingStore() const;
107
108     // Message handlers.
109     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);
110     void update(const WebCore::IntRect& paintedRect);
111     void proxiesForURL(const String& urlString, String& proxyString);
112     void cookiesForURL(const String& urlString, String& cookieString);
113     void setCookiesForURL(const String& urlString, const String& cookieString);
114     void getAuthenticationInfo(const WebCore::ProtectionSpace&, bool& returnValue, String& username, String& password);
115     void getWindowScriptNPObject(uint64_t& windowScriptNPObjectID);
116     void getPluginElementNPObject(uint64_t& pluginElementNPObjectID);
117     void evaluate(const NPVariantData& npObjectAsVariantData, const String& scriptString, bool allowPopups, bool& returnValue, NPVariantData& resultData);
118     void cancelStreamLoad(uint64_t streamID);
119     void cancelManualStreamLoad();
120     void setStatusbarText(const String& statusbarText);
121 #if PLATFORM(MAC)
122     void setComplexTextInputEnabled(bool);
123 #endif
124
125     String m_pluginPath;
126
127     RefPtr<PluginProcessConnection> m_connection;
128     uint64_t m_pluginInstanceID;
129
130     PluginController* m_pluginController;
131
132     // The plug-in rect in window coordinates.
133     WebCore::IntRect m_frameRect;
134
135     // This is the backing store that we paint when we're told to paint.
136     RefPtr<ShareableBitmap> m_backingStore;
137
138     // This is the shared memory backing store that the plug-in paints into. When the plug-in tells us
139     // that it's painted something in it, we'll blit from it to our own backing store.
140     RefPtr<ShareableBitmap> m_pluginBackingStore;
141     
142     // Whether all of the plug-in backing store contains valid data.
143     bool m_pluginBackingStoreContainsValidData;
144
145     bool m_isStarted;
146
147     // Whether we're called invalidate in response to an update call, and are now waiting for a paint call.
148     bool m_waitingForPaintInResponseToUpdate;
149
150     // 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.
151     uint32_t m_remoteLayerClientID;
152
153 #if PLATFORM(MAC)
154     RetainPtr<CALayer> m_pluginLayer;
155 #endif
156 };
157
158 } // namespace WebKit
159
160 #endif // ENABLE(PLUGIN_PROCESS)
161
162 #endif // PluginProxy_h