c1f58b2f248ba9c0a6bc5f21e584c4a1f36c4d88
[WebKit-https.git] / WebCore / plugins / win / PluginViewWin.h
1 /*
2  * Copyright (C) 2006, 2007 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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef PluginViewWin_H
27 #define PluginViewWin_H
28
29 #include <winsock2.h>
30 #include <windows.h>
31
32 #include "CString.h"
33 #include "IntRect.h"
34 #include "KURL.h"
35 #include "PlatformString.h"
36 #include "ResourceRequest.h"
37 #include "Timer.h"
38 #include "Widget.h"
39 #include "npapi.h"
40 #include <wtf/HashMap.h>
41 #include <wtf/HashSet.h>
42 #include <wtf/OwnPtr.h>
43 #include <wtf/RefPtr.h>
44 #include <wtf/Vector.h>
45
46 namespace KJS {
47     namespace Bindings {
48         class Instance;
49     }
50 }
51
52 namespace WebCore {
53     class Element;
54     class Frame;
55     struct FrameLoadRequest;
56     class KeyboardEvent;
57     class MouseEvent;
58     class KURL;
59     class PluginMessageThrottlerWin;
60     class PluginPackageWin;
61     class PluginRequestWin;
62     class PluginStreamWin;
63     class ResourceError;
64     class ResourceResponse;
65     
66     enum PluginQuirks {
67         PluginQuirkWantsMozillaUserAgent = 1 << 0,
68         PluginQuirkDeferFirstSetWindowCall = 1 << 1,
69         PluginQuirkThrottleInvalidate = 1 << 2, 
70         PluginQuirkRemoveWindowlessVideoParam = 1 << 3,
71         PluginQuirkThrottleWMUserPlusOneMessages = 1 << 4,
72         PluginQuirkDontUnloadPlugin = 1 << 5,
73         PluginQuirkDontCallWndProcForSameMessageRecursively = 1 << 6
74     };
75
76     enum PluginStatus {
77         PluginStatusCanNotFindPlugin,
78         PluginStatusCanNotLoadPlugin,
79         PluginStatusLoadedSuccessfully
80     };
81
82     class PluginViewWin : public Widget {
83     friend static LRESULT CALLBACK PluginViewWndProc(HWND, UINT, WPARAM, LPARAM);
84
85     public:
86         PluginViewWin(Frame* parentFrame, const IntSize&, PluginPackageWin* plugin, Element*, const KURL&, const Vector<String>& paramNames, const Vector<String>& paramValues, const String& mimeType, bool loadManually);
87         virtual ~PluginViewWin();
88
89         PluginPackageWin* plugin() const { return m_plugin.get(); }
90         NPP instance() const { return m_instance; }
91
92         void setNPWindowRect(const IntRect&);
93         static PluginViewWin* currentPluginView();
94
95         KJS::Bindings::Instance* bindingInstance();
96
97         PluginStatus status() const { return m_status; }
98
99         // NPN functions
100         NPError getURLNotify(const char* url, const char* target, void* notifyData);
101         NPError getURL(const char* url, const char* target);
102         NPError postURLNotify(const char* url, const char* target, uint32 len, const char* but, NPBool file, void* notifyData);
103         NPError postURL(const char* url, const char* target, uint32 len, const char* but, NPBool file);
104         NPError newStream(NPMIMEType type, const char* target, NPStream** stream);
105         int32 write(NPStream* stream, int32 len, void* buffer);
106         NPError destroyStream(NPStream* stream, NPReason reason);
107         const char* userAgent();
108         void status(const char* message);
109         NPError getValue(NPNVariable variable, void* value);
110         NPError setValue(NPPVariable variable, void* value);
111         void invalidateRect(NPRect*);
112         void invalidateRegion(NPRegion);
113         void forceRedraw();
114         void pushPopupsEnabledState(bool state);
115         void popPopupsEnabledState();
116
117         bool arePopupsAllowed() const;
118
119         void disconnectStream(PluginStreamWin*);
120
121         // Widget functions
122         virtual void setFrameGeometry(const IntRect&);
123         virtual void geometryChanged() const;
124         virtual void setFocus();
125         virtual void show();
126         virtual void hide();
127         virtual void paint(GraphicsContext*, const IntRect&);
128         virtual IntRect windowClipRect() const;
129         virtual void handleEvent(Event*);
130         virtual void setParent(ScrollView*);
131
132         virtual void attachToWindow();
133         virtual void detachFromWindow();
134
135         LRESULT wndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
136         WNDPROC pluginWndProc() const { return m_pluginWndProc; }
137
138         // Used for manual loading
139         void didReceiveResponse(const ResourceResponse&);
140         void didReceiveData(const char*, int);
141         void didFinishLoading();
142         void didFail(const ResourceError&);
143     private:
144         void setParameters(const Vector<String>& paramNames, const Vector<String>& paramValues);
145         void init();
146         bool start();
147         void stop();
148         static void setCurrentPluginView(PluginViewWin*);
149         NPError load(const FrameLoadRequest&, bool sendNotification, void* notifyData);
150         NPError handlePost(const char* url, const char* target, uint32 len, const char* buf, bool file, void* notifyData, bool sendNotification, bool allowHeaders);
151         RefPtr<PluginPackageWin> m_plugin;
152         Element* m_element;
153         Frame* m_parentFrame;
154         bool m_isStarted;
155         KURL m_url;
156         KURL m_baseURL;
157         PluginStatus m_status;
158         Vector<IntRect> m_invalidRects;
159
160         void performRequest(PluginRequestWin*);
161         void scheduleRequest(PluginRequestWin*);
162         void requestTimerFired(Timer<PluginViewWin>*);
163         void invalidateTimerFired(Timer<PluginViewWin>*);
164         Timer<PluginViewWin> m_requestTimer;
165         Timer<PluginViewWin> m_invalidateTimer;
166
167         void popPopupsStateTimerFired(Timer<PluginViewWin>*);
168         Timer<PluginViewWin> m_popPopupsStateTimer;
169
170         bool dispatchNPEvent(NPEvent*);
171         OwnPtr<PluginMessageThrottlerWin> m_messageThrottler;
172
173         void updateWindow() const;
174         void determineQuirks(const String& mimeType);
175         void paintMissingPluginIcon(GraphicsContext*, const IntRect&);
176
177         void handleKeyboardEvent(KeyboardEvent*);
178         void handleMouseEvent(MouseEvent*);
179
180         int m_mode;
181         int m_paramCount;
182         char** m_paramNames;
183         char** m_paramValues;
184
185         CString m_mimeType;
186         CString m_userAgent;
187         
188         NPP m_instance;
189         NPP_t m_instanceStruct;
190         NPWindow m_npWindow;
191
192         Vector<bool, 4> m_popupStateStack;
193
194         HashSet<RefPtr<PluginStreamWin> > m_streams;
195         Vector<PluginRequestWin*> m_requests;
196
197         int m_quirks;
198         bool m_isWindowed;
199         bool m_isTransparent;
200         bool m_isVisible;
201         bool m_attachedToWindow;
202         bool m_haveInitialized;
203
204         WNDPROC m_pluginWndProc;
205         HWND m_window; // for windowed plug-ins
206         mutable IntRect m_clipRect; // The clip rect to apply to a windowed plug-in
207         mutable IntRect m_windowRect; // Our window rect.
208
209         unsigned m_lastMessage;
210         bool m_isCallingPluginWndProc;
211
212         bool m_loadManually;
213         RefPtr<PluginStreamWin> m_manualStream;
214
215         static PluginViewWin* s_currentPluginView;
216     };
217
218 } // namespace WebCore
219
220 #endif