[Mac] Should be able to scroll embedded PDFs using mouse
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PluginView.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 PluginView_h
27 #define PluginView_h
28
29 #include "NPRuntimeObjectMap.h"
30 #include "Plugin.h"
31 #include "PluginController.h"
32 #include "RunLoop.h"
33 #include "WebFrame.h"
34
35 #include <WebCore/MediaCanStartListener.h>
36 #include <WebCore/ResourceError.h>
37 #include <WebCore/ResourceResponse.h>
38 #include <WebCore/PluginViewBase.h>
39 #include <wtf/Deque.h>
40
41 // FIXME: Eventually this should move to WebCore.
42
43 namespace WebCore {
44     class Frame;
45     class HTMLPlugInElement;
46 }
47
48 namespace WebKit {
49
50 class PluginView : public WebCore::PluginViewBase, public PluginController, private WebCore::MediaCanStartListener, private WebFrame::LoadListener {
51 public:
52     static PassRefPtr<PluginView> create(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters&);
53
54     WebCore::Frame* frame() const;
55
56     bool isBeingDestroyed() const { return m_isBeingDestroyed; }
57
58     void manualLoadDidReceiveResponse(const WebCore::ResourceResponse&);
59     void manualLoadDidReceiveData(const char* bytes, int length);
60     void manualLoadDidFinishLoading();
61     void manualLoadDidFail(const WebCore::ResourceError&);
62
63 #if PLATFORM(MAC)
64     void setWindowIsVisible(bool);
65     void setWindowIsFocused(bool);
66     void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
67     bool sendComplexTextInput(uint64_t pluginComplexTextInputIdentifier, const String& textInput);
68 #endif
69
70 private:
71     PluginView(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters& parameters);
72     virtual ~PluginView();
73
74     void initializePlugin();
75     void destroyPlugin();
76
77     void viewGeometryDidChange();
78     void viewVisibilityDidChange();
79     WebCore::IntRect clipRectInWindowCoordinates() const;
80     void focusPluginElement();
81     
82     void pendingURLRequestsTimerFired();
83     class URLRequest;
84     void performURLRequest(URLRequest*);
85
86     // Perform a URL request where the frame target is not null.
87     void performFrameLoadURLRequest(URLRequest*);
88
89     // Perform a URL request where the URL protocol is "javascript:".
90     void performJavaScriptURLRequest(URLRequest*);
91
92     class Stream;
93     void addStream(Stream*);
94     void removeStream(Stream*);
95     void cancelAllStreams();
96
97     void redeliverManualStream();
98
99     // WebCore::PluginViewBase
100 #if PLATFORM(MAC)
101     virtual PlatformLayer* platformLayer() const;
102 #endif
103     virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*);
104     virtual void privateBrowsingStateChanged(bool);
105     virtual bool getFormValue(String&);
106     virtual bool scroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
107     virtual WebCore::Scrollbar* horizontalScrollbar();
108     virtual WebCore::Scrollbar* verticalScrollbar();
109
110     // WebCore::Widget
111     virtual void setFrameRect(const WebCore::IntRect&);
112     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect&);
113     virtual void invalidateRect(const WebCore::IntRect&);
114     virtual void setFocus(bool);
115     virtual void frameRectsChanged();
116     virtual void setParent(WebCore::ScrollView*);
117     virtual void handleEvent(WebCore::Event*);
118     virtual void notifyWidget(WebCore::WidgetNotification);
119     virtual void show();
120     virtual void hide();
121
122     // WebCore::MediaCanStartListener
123     virtual void mediaCanStart();
124
125     // PluginController
126     virtual bool isPluginVisible();
127     virtual void invalidate(const WebCore::IntRect&);
128     virtual String userAgent();
129     virtual void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, 
130                          const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups);
131     virtual void cancelStreamLoad(uint64_t streamID);
132     virtual void cancelManualStreamLoad();
133     virtual NPObject* windowScriptNPObject();
134     virtual NPObject* pluginElementNPObject();
135     virtual bool evaluate(NPObject*, const String&scriptString, NPVariant* result, bool allowPopups);
136     virtual bool tryToShortCircuitInvoke(NPObject*, NPIdentifier methodName, const NPVariant* arguments, uint32_t argumentCount, bool& returnValue, NPVariant& result);
137     virtual void setStatusbarText(const String&);
138     virtual bool isAcceleratedCompositingEnabled();
139     virtual void pluginProcessCrashed();
140     virtual void willSendEventToPlugin();
141 #if PLATFORM(WIN)
142     virtual HWND nativeParentWindow();
143     virtual void scheduleWindowedPluginGeometryUpdate(const WindowGeometry&);
144 #endif
145 #if PLATFORM(MAC)
146     virtual void pluginFocusOrWindowFocusChanged(bool pluginHasFocusAndWindowHasFocus);
147     virtual void setComplexTextInputState(PluginComplexTextInputState);
148     virtual mach_port_t compositingRenderServerPort();
149 #endif
150     virtual String proxiesForURL(const String&);
151     virtual String cookiesForURL(const String&);
152     virtual void setCookiesForURL(const String& urlString, const String& cookieString);
153     virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password);
154     virtual bool isPrivateBrowsingEnabled();
155     virtual void protectPluginFromDestruction();
156     virtual void unprotectPluginFromDestruction();
157
158     // WebFrame::LoadListener
159     virtual void didFinishLoad(WebFrame*);
160     virtual void didFailLoad(WebFrame*, bool wasCancelled);
161
162     RefPtr<WebCore::HTMLPlugInElement> m_pluginElement;
163     RefPtr<Plugin> m_plugin;
164     WebPage* m_webPage;
165     Plugin::Parameters m_parameters;
166     
167     bool m_isInitialized;
168     bool m_isWaitingUntilMediaCanStart;
169     bool m_isBeingDestroyed;
170
171     // Pending URLRequests that the plug-in has made.
172     Deque<RefPtr<URLRequest> > m_pendingURLRequests;
173     RunLoop::Timer<PluginView> m_pendingURLRequestsTimer;
174
175     // Pending frame loads that the plug-in has made.
176     typedef HashMap<RefPtr<WebFrame>, RefPtr<URLRequest> > FrameLoadMap;
177     FrameLoadMap m_pendingFrameLoads;
178
179     // Streams that the plug-in has requested to load. 
180     HashMap<uint64_t, RefPtr<Stream> > m_streams;
181
182     // A map of all related NPObjects for this plug-in view.
183     NPRuntimeObjectMap m_npRuntimeObjectMap;
184
185     // The manual stream state. This is used so we can deliver a manual stream to a plug-in
186     // when it is initialized.
187     enum ManualStreamState {
188         StreamStateInitial,
189         StreamStateHasReceivedResponse,
190         StreamStateFinished,
191         StreamStateFailed
192     };
193     ManualStreamState m_manualStreamState;
194
195     WebCore::ResourceResponse m_manualStreamResponse;
196     WebCore::ResourceError m_manualStreamError;
197     RefPtr<WebCore::SharedBuffer> m_manualStreamData;
198     
199     RefPtr<ShareableBitmap> m_snapshot;
200 };
201
202 } // namespace WebKit
203
204 #endif // PluginView_h