Rename a couple of NetscapePlugin and PluginProxy member variables
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / Netscape / NetscapePlugin.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 NetscapePlugin_h
27 #define NetscapePlugin_h
28
29 #include "NetscapePluginModule.h"
30 #include "Plugin.h"
31 #include "RunLoop.h"
32 #include <WebCore/GraphicsLayer.h>
33 #include <WebCore/IntRect.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/text/CString.h>
36 #include <wtf/text/StringHash.h>
37
38 namespace WebCore {
39     class HTTPHeaderMap;
40     class ProtectionSpace;
41 }
42
43 namespace WebKit {
44
45 class NetscapePluginStream;
46     
47 class NetscapePlugin : public Plugin {
48 public:
49     static PassRefPtr<NetscapePlugin> create(PassRefPtr<NetscapePluginModule> pluginModule);
50     virtual ~NetscapePlugin();
51
52     static PassRefPtr<NetscapePlugin> fromNPP(NPP);
53
54 #if PLATFORM(MAC)
55     NPError setDrawingModel(NPDrawingModel);
56     NPError setEventModel(NPEventModel);
57     NPBool convertPoint(double sourceX, double sourceY, NPCoordinateSpace sourceSpace, double& destX, double& destY, NPCoordinateSpace destSpace);
58     NPError popUpContextMenu(NPMenu*);
59
60     void setPluginReturnsNonretainedLayer(bool pluginReturnsNonretainedLayer) { m_pluginReturnsNonretainedLayer = pluginReturnsNonretainedLayer; }
61     void setPluginWantsLegacyCocoaTextInput(bool pluginWantsLegacyCocoaTextInput) { m_pluginWantsLegacyCocoaTextInput = pluginWantsLegacyCocoaTextInput; }
62
63     bool hasHandledAKeyDownEvent() const { return m_hasHandledAKeyDownEvent; }
64
65     mach_port_t compositingRenderServerPort();
66     double contentsScaleFactor();
67
68 #ifndef NP_NO_CARBON
69     WindowRef windowRef() const;
70     bool isWindowActive() const { return m_windowHasFocus; }
71
72     static NetscapePlugin* netscapePluginFromWindow(WindowRef);
73     static unsigned buttonState();
74 #endif
75
76 #elif PLATFORM(WIN)
77     HWND containingWindow();
78 #endif
79
80     PluginQuirks quirks() const { return m_pluginModule->pluginQuirks(); }
81
82     void invalidate(const NPRect*);
83     static const char* userAgent(NPP);
84     void loadURL(const String& method, const String& urlString, const String& target, const WebCore::HTTPHeaderMap& headerFields,
85                  const Vector<uint8_t>& httpBody, bool sendNotification, void* notificationData);
86     NPError destroyStream(NPStream*, NPReason);
87     void setIsWindowed(bool);
88     void setIsTransparent(bool);
89     void setStatusbarText(const String&);
90     static void setException(const String&);
91     bool evaluate(NPObject*, const String&scriptString, NPVariant* result);
92     bool isPrivateBrowsingEnabled();
93
94     static void setSetExceptionFunction(void (*)(const String&));
95
96     // These return retained objects.
97     NPObject* windowScriptNPObject();
98     NPObject* pluginElementNPObject();
99
100     bool tryToShortCircuitInvoke(NPObject*, NPIdentifier methodName, const NPVariant* arguments, uint32_t argumentCount, bool& returnValue, NPVariant& result);
101
102     void cancelStreamLoad(NetscapePluginStream*);
103     void removePluginStream(NetscapePluginStream*);
104
105     bool isAcceleratedCompositingEnabled();
106
107     void pushPopupsEnabledState(bool enabled);
108     void popPopupsEnabledState();
109
110     void pluginThreadAsyncCall(void (*function)(void*), void* userData);
111
112     // Called on the plug-in run loop (which is currently the main thread run loop).
113     void handlePluginThreadAsyncCall(void (*function)(void*), void* userData);
114
115     unsigned scheduleTimer(unsigned interval, bool repeat, void (*timerFunc)(NPP, unsigned timerID));
116     void unscheduleTimer(unsigned timerID);
117
118     String proxiesForURL(const String& urlString);
119     String cookiesForURL(const String& urlString);
120     void setCookiesForURL(const String& urlString, const String& cookieString);
121     bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password);
122
123     // Member functions for calling into the plug-in.
124     NPError NPP_New(NPMIMEType pluginType, uint16_t mode, int16_t argc, char* argn[], char* argv[], NPSavedData*);
125     NPError NPP_Destroy(NPSavedData**);
126     NPError NPP_SetWindow(NPWindow*);
127     NPError NPP_NewStream(NPMIMEType, NPStream*, NPBool seekable, uint16_t* stype);
128     NPError NPP_DestroyStream(NPStream*, NPReason);
129     void NPP_StreamAsFile(NPStream*, const char* filename);
130     int32_t NPP_WriteReady(NPStream*);
131     int32_t NPP_Write(NPStream*, int32_t offset, int32_t len, void* buffer);
132     int16_t NPP_HandleEvent(void* event);
133     void NPP_URLNotify(const char* url, NPReason, void* notifyData);
134     NPError NPP_GetValue(NPPVariable, void *value);
135     NPError NPP_SetValue(NPNVariable, void *value);
136
137 private:
138     NetscapePlugin(PassRefPtr<NetscapePluginModule> pluginModule);
139
140     void callSetWindow();
141     bool shouldLoadSrcURL();
142     NetscapePluginStream* streamFromID(uint64_t streamID);
143     void stopAllStreams();
144     bool allowPopups() const;
145
146     const char* userAgent();
147
148     bool platformPostInitialize();
149     void platformDestroy();
150     bool platformInvalidate(const WebCore::IntRect&);
151     void platformGeometryDidChange();
152     void platformVisibilityDidChange();
153     void platformPaint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRect, bool isSnapshot = false);
154
155     bool platformHandleMouseEvent(const WebMouseEvent&);
156     bool platformHandleWheelEvent(const WebWheelEvent&);
157     bool platformHandleMouseEnterEvent(const WebMouseEvent&);
158     bool platformHandleMouseLeaveEvent(const WebMouseEvent&);
159     bool platformHandleKeyboardEvent(const WebKeyboardEvent&);
160     void platformSetFocus(bool);
161
162     // Plugin
163     virtual bool initialize(const Parameters&);
164     virtual void destroy();
165     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRect);
166     virtual PassRefPtr<ShareableBitmap> snapshot();
167 #if PLATFORM(MAC)
168     virtual PlatformLayer* pluginLayer();
169 #endif
170     virtual bool isTransparent();
171     virtual void deprecatedGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect);
172     virtual void geometryDidChange(const WebCore::IntSize& pluginSize, const WebCore::IntRect& clipRect, const WebCore::AffineTransform& pluginToRootViewTransform);
173     virtual void visibilityDidChange();
174     virtual void frameDidFinishLoading(uint64_t requestID);
175     virtual void frameDidFail(uint64_t requestID, bool wasCancelled);
176     virtual void didEvaluateJavaScript(uint64_t requestID, const String& result);
177     virtual void streamDidReceiveResponse(uint64_t streamID, const WebCore::KURL& responseURL, uint32_t streamLength, 
178                                           uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName);
179     virtual void streamDidReceiveData(uint64_t streamID, const char* bytes, int length);
180     virtual void streamDidFinishLoading(uint64_t streamID);
181     virtual void streamDidFail(uint64_t streamID, bool wasCancelled);
182     virtual void manualStreamDidReceiveResponse(const WebCore::KURL& responseURL, uint32_t streamLength, 
183                                                 uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName);
184     virtual void manualStreamDidReceiveData(const char* bytes, int length);
185     virtual void manualStreamDidFinishLoading();
186     virtual void manualStreamDidFail(bool wasCancelled);
187     
188     virtual bool handleMouseEvent(const WebMouseEvent&);
189     virtual bool handleWheelEvent(const WebWheelEvent&);
190     virtual bool handleMouseEnterEvent(const WebMouseEvent&);
191     virtual bool handleMouseLeaveEvent(const WebMouseEvent&);
192     virtual bool handleContextMenuEvent(const WebMouseEvent&);
193     virtual bool handleKeyboardEvent(const WebKeyboardEvent&);
194     virtual void setFocus(bool);
195     virtual NPObject* pluginScriptableNPObject();
196
197 #if PLATFORM(MAC)
198     virtual void windowFocusChanged(bool);
199     virtual void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
200     virtual void windowVisibilityChanged(bool);
201     virtual void contentsScaleFactorChanged(float);
202
203     virtual uint64_t pluginComplexTextInputIdentifier() const;
204     virtual void sendComplexTextInput(const String& textInput);
205
206     void pluginFocusOrWindowFocusChanged();
207     void setComplexTextInputEnabled(bool);
208 #endif
209
210     virtual void privateBrowsingStateChanged(bool);
211     virtual bool getFormValue(String& formValue);
212     virtual bool handleScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
213     virtual bool wantsWindowRelativeCoordinates();
214     virtual WebCore::Scrollbar* horizontalScrollbar();
215     virtual WebCore::Scrollbar* verticalScrollbar();
216
217     bool supportsSnapshotting() const;
218
219 #if PLUGIN_ARCHITECTURE(WIN)
220     static BOOL WINAPI hookedTrackPopupMenu(HMENU, UINT uFlags, int x, int y, int nReserved, HWND, const RECT*);
221     void scheduleWindowedGeometryUpdate();
222 #endif
223
224     uint64_t m_nextRequestID;
225
226     typedef HashMap<uint64_t, std::pair<String, void*> > PendingURLNotifyMap;
227     PendingURLNotifyMap m_pendingURLNotifications;
228
229     typedef HashMap<uint64_t, RefPtr<NetscapePluginStream> > StreamsMap;
230     StreamsMap m_streams;
231
232     RefPtr<NetscapePluginModule> m_pluginModule;
233     NPP_t m_npp;
234     NPWindow m_npWindow;
235
236     // FIXME: Get rid of these.
237     WebCore::IntRect m_frameRectInWindowCoordinates;
238     WebCore::IntRect m_clipRectInWindowCoordinates;
239
240     CString m_userAgent;
241
242     bool m_isStarted;
243     bool m_isWindowed;
244     bool m_isTransparent;
245     bool m_inNPPNew;
246     bool m_loadManually;
247     RefPtr<NetscapePluginStream> m_manualStream;
248     Vector<bool, 8> m_popupEnabledStates;
249
250     class Timer {
251         WTF_MAKE_NONCOPYABLE(Timer);
252
253     public:
254         typedef void (*TimerFunc)(NPP, uint32_t timerID);
255
256         static PassOwnPtr<Timer> create(NetscapePlugin*, unsigned timerID, unsigned interval, bool repeat, TimerFunc);
257         ~Timer();
258
259         void start();
260         void stop();
261
262     private:
263         Timer(NetscapePlugin*, unsigned timerID, unsigned interval, bool repeat, TimerFunc);
264
265         void timerFired();
266
267         // This is a weak pointer since Timer objects are destroyed before the NetscapePlugin object itself is destroyed.
268         NetscapePlugin* m_netscapePlugin;
269
270         unsigned m_timerID;
271         unsigned m_interval;
272         bool m_repeat;
273         TimerFunc m_timerFunc;
274
275         RunLoop::Timer<Timer> m_timer;
276     };
277     typedef HashMap<unsigned, Timer*> TimerMap;
278     TimerMap m_timers;
279     unsigned m_nextTimerID;
280
281 #if PLUGIN_ARCHITECTURE(MAC)
282     NPDrawingModel m_drawingModel;
283     NPEventModel m_eventModel;
284
285     RetainPtr<PlatformLayer> m_pluginLayer;
286     bool m_pluginReturnsNonretainedLayer;
287
288     NPCocoaEvent* m_currentMouseEvent;
289
290     bool m_pluginHasFocus;
291     bool m_windowHasFocus;
292
293     // Whether the plug-in wants to use the legacy Cocoa text input handling that
294     // existed in WebKit1, or the updated Cocoa text input handling specified on
295     // https://wiki.mozilla.org/NPAPI:CocoaEventModel#Text_Input
296     bool m_pluginWantsLegacyCocoaTextInput;
297
298     // Whether complex text input is enabled.
299     bool m_isComplexTextInputEnabled;
300
301     // Whether the plug-in has handled a keydown event. This is used to determine
302     // if we can tell the plug-in that we support the updated Cocoa text input specification.
303     bool m_hasHandledAKeyDownEvent;
304
305     // The number of NPCocoaEventKeyUp events that  should be ignored.
306     unsigned m_ignoreNextKeyUpEventCounter;
307
308     WebCore::IntRect m_windowFrameInScreenCoordinates;
309     WebCore::IntRect m_viewFrameInWindowCoordinates;
310
311 #ifndef NP_NO_CARBON
312     void nullEventTimerFired();
313
314     // FIXME: It's a bit wasteful to have one null event timer per plug-in.
315     // We should investigate having one per window.
316     RunLoop::Timer<NetscapePlugin> m_nullEventTimer;
317     NP_CGContext m_npCGContext;
318 #endif
319 #elif PLUGIN_ARCHITECTURE(WIN)
320     HWND m_window;
321     HWND m_contextMenuOwnerWindow;
322 #elif PLUGIN_ARCHITECTURE(X11)
323     Pixmap m_drawable;
324     Display* m_pluginDisplay;
325 #endif
326 };
327
328 } // namespace WebKit
329
330 #endif // NetscapePlugin_h