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