diff options
Diffstat (limited to 'src/3rdparty/webkit/Source/WebKit2/WebProcess/Plugins/PluginController.h')
-rw-r--r-- | src/3rdparty/webkit/Source/WebKit2/WebProcess/Plugins/PluginController.h | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/src/3rdparty/webkit/Source/WebKit2/WebProcess/Plugins/PluginController.h b/src/3rdparty/webkit/Source/WebKit2/WebProcess/Plugins/PluginController.h new file mode 100644 index 0000000..c45618a --- /dev/null +++ b/src/3rdparty/webkit/Source/WebKit2/WebProcess/Plugins/PluginController.h @@ -0,0 +1,148 @@ +/* + * 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> + +struct NPObject; +typedef struct _NPVariant NPVariant; + +namespace WebCore { + class HTTPHeaderMap; + class IntRect; + class KURL; +} + +namespace WebKit { + +class PluginController { +public: + // 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; + + // 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; + + // 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(WIN) + // The window to use as the parent of the plugin's window. + virtual HWND nativeParentWindow() = 0; + + // Tells the controller that the given HWND needs to be positioned and clipped to the given + // coordinates sometime soon. The controller will decide exactly when this will happen. + virtual void scheduleWindowedPluginGeometryUpdate(HWND, const WebCore::IntRect& rectInParentClientCoordinates, const WebCore::IntRect& clipRectInPluginWindowCoordinates) = 0; +#endif + +#if PLATFORM(MAC) + // Tells the controller that complex text input be enabled or disabled for the plug-in. + virtual void setComplexTextInputEnabled(bool) = 0; + + // Returns the mach port of the compositing render server. + virtual mach_port_t compositingRenderServerPort() = 0; +#endif + + // 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; + + // Returns whether private browsing is enabled. + virtual bool isPrivateBrowsingEnabled() = 0; + + // 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; + + // 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 |