1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/*
* Copyright (C) 2010 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PluginController_h
#define PluginController_h
#include <wtf/Forward.h>
#if PLATFORM(MAC)
#include "PluginComplexTextInputState.h"
#endif
struct NPObject;
typedef struct _NPVariant NPVariant;
typedef void* NPIdentifier;
namespace WebCore {
class HTTPHeaderMap;
class IntRect;
class KURL;
class ProtectionSpace;
}
namespace WebKit {
class PluginController {
public:
// Returns false if the plugin has explicitly been hidden. Returns true otherwise (even if the plugin is currently obscured from view on screen.)
virtual bool isPluginVisible() = 0;
// Tells the controller that the plug-in wants the given rect to be repainted. The rect is in the plug-in's coordinate system.
virtual void invalidate(const WebCore::IntRect&) = 0;
// Returns the user agent string.
virtual String userAgent() = 0;
// Loads the given URL and associates it with the request ID.
//
// If a target is specified, then the URL will be loaded in the window or frame that the target refers to.
// Once the URL finishes loading, Plugin::frameDidFinishLoading will be called with the given requestID. If the URL
// fails to load, Plugin::frameDidFailToLoad will be called.
//
// If the URL is a JavaScript URL, the JavaScript code will be evaluated and the result sent back using Plugin::didEvaluateJavaScript.
virtual 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) = 0;
/// Cancels the load of a stream that was requested by loadURL.
virtual void cancelStreamLoad(uint64_t streamID) = 0;
// Cancels the load of the manual stream.
virtual void cancelManualStreamLoad() = 0;
#if ENABLE(NETSCAPE_PLUGIN_API)
// Get the NPObject that corresponds to the window JavaScript object. Returns a retained object.
virtual NPObject* windowScriptNPObject() = 0;
// Get the NPObject that corresponds to the plug-in's element. Returns a retained object.
virtual NPObject* pluginElementNPObject() = 0;
// Evaluates the given script string in the context of the given NPObject.
virtual bool evaluate(NPObject*, const String& scriptString, NPVariant* result, bool allowPopups) = 0;
#endif
// Set the statusbar text.
virtual void setStatusbarText(const String&) = 0;
#if USE(ACCELERATED_COMPOSITING)
// Return whether accelerated compositing is enabled.
virtual bool isAcceleratedCompositingEnabled() = 0;
#endif
// Tells the controller that the plug-in process has crashed.
virtual void pluginProcessCrashed() = 0;
// Tells the controller that we're about to dispatch an event to the plug-in.
virtual void willSendEventToPlugin() = 0;
#if PLATFORM(MAC)
// Tells the controller that the plug-in focus or window focus did change.
virtual void pluginFocusOrWindowFocusChanged(bool) = 0;
// Tells the controller that complex text input be enabled or disabled for the plug-in.
virtual void setComplexTextInputState(PluginComplexTextInputState) = 0;
// Returns the mach port of the compositing render server.
virtual mach_port_t compositingRenderServerPort() = 0;
// Open the preference pane for this plug-in (as stated in the plug-in's Info.plist).
virtual void openPluginPreferencePane() = 0;
#endif
// Returns the contents scale factor.
virtual float contentsScaleFactor() = 0;
// Returns the proxies for the given URL or null on failure.
virtual String proxiesForURL(const String&) = 0;
// Returns the cookies for the given URL or null on failure.
virtual String cookiesForURL(const String&) = 0;
// Sets the cookies for the given URL.
virtual void setCookiesForURL(const String& urlString, const String& cookieString) = 0;
// Get authentication credentials for the given protection space.
virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password) = 0;
// Returns whether private browsing is enabled.
virtual bool isPrivateBrowsingEnabled() = 0;
// Returns whether or not asynchronous plugin initialization is enabled.
virtual bool asynchronousPluginInitializationEnabled() const { return false; }
// Returns whether or not asynchronous plugin initialization should be attempted for all plugins.
virtual bool asynchronousPluginInitializationEnabledForAllPlugins() const { return false; }
// Returns the articifical plugin delay to use for testing of asynchronous plugin initialization.
virtual bool artificialPluginInitializationDelayEnabled() const { return false; }
// Increments a counter that prevents the plug-in from being destroyed.
virtual void protectPluginFromDestruction() = 0;
// Decrements a counter that, when it reaches 0, stops preventing the plug-in from being destroyed.
virtual void unprotectPluginFromDestruction() = 0;
#if PLUGIN_ARCHITECTURE(X11)
// Create a plugin container for windowed plugins
virtual uint64_t createPluginContainer() = 0;
virtual void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID) = 0;
#endif
// Called when the a plug-in instance is successfully initialized, either synchronously or asynchronously.
virtual void didInitializePlugin() = 0;
// Called when the a plug-in instance fails to initialized, either synchronously or asynchronously.
virtual void didFailToInitializePlugin() = 0;
// Helper class for delaying destruction of a plug-in.
class PluginDestructionProtector {
public:
explicit PluginDestructionProtector(PluginController* pluginController)
: m_pluginController(pluginController)
{
m_pluginController->protectPluginFromDestruction();
}
~PluginDestructionProtector()
{
m_pluginController->unprotectPluginFromDestruction();
}
private:
PluginController* m_pluginController;
};
protected:
virtual ~PluginController() { }
};
} // namespace WebKit
#endif // PluginController_h
|
