#ifndef Plugin_h
#define Plugin_h
#include <WebCore/FindOptions.h>
#include <WebCore/GraphicsLayer.h>
#include <WebCore/URL.h>
#include <WebCore/ScrollTypes.h>
#include <WebCore/SecurityOrigin.h>
#include <wtf/RefCounted.h>
#include <wtf/RetainPtr.h>
#include <wtf/Vector.h>
#if PLATFORM(COCOA)
#include "LayerHostingContext.h"
typedef struct objc_object* id;
OBJC_CLASS NSDictionary;
OBJC_CLASS NSObject;
OBJC_CLASS PDFDocument;
OBJC_CLASS PDFSelection;
#endif
struct NPObject;
namespace IPC {
class Encoder;
class Decoder;
}
namespace WebCore {
class AffineTransform;
class FloatPoint;
class GraphicsContext;
class IntPoint;
class IntRect;
class IntSize;
class FloatPoint;
class Scrollbar;
class SharedBuffer;
}
namespace WebKit {
class ShareableBitmap;
class WebKeyboardEvent;
class WebMouseEvent;
class WebWheelEvent;
class PluginController;
enum PluginType {
PluginProxyType,
NetscapePluginType,
PDFPluginType,
};
class Plugin : public ThreadSafeRefCounted<Plugin> {
public:
struct Parameters {
WebCore::URL url;
Vector<String> names;
Vector<String> values;
String mimeType;
bool isFullFramePlugin;
bool shouldUseManualLoader;
#if PLATFORM(COCOA)
LayerHostingMode layerHostingMode;
#endif
void encode(IPC::Encoder&) const;
static bool decode(IPC::Decoder&, Parameters&);
};
bool initialize(PluginController*, const Parameters&);
virtual bool isBeingAsynchronouslyInitialized() const = 0;
void destroyPlugin();
bool isBeingDestroyed() const { return m_isBeingDestroyed; }
PluginController* controller() { return m_pluginController; }
const PluginController* controller() const { return m_pluginController; }
virtual ~Plugin();
PluginType type() const { return m_type; }
private:
virtual bool initialize(const Parameters&) = 0;
virtual void destroy() = 0;
public:
virtual void paint(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect) = 0;
virtual void updateControlTints(WebCore::GraphicsContext&);
virtual bool supportsSnapshotting() const = 0;
virtual RefPtr<ShareableBitmap> snapshot() = 0;
#if PLATFORM(COCOA)
virtual PlatformLayer* pluginLayer() = 0;
#endif
virtual bool isTransparent() = 0;
virtual bool wantsWheelEvents() = 0;
virtual void geometryDidChange(const WebCore::IntSize& pluginSize, const WebCore::IntRect& clipRect, const WebCore::AffineTransform& pluginToRootViewTransform) = 0;
virtual void visibilityDidChange(bool isVisible) = 0;
virtual void frameDidFinishLoading(uint64_t requestID) = 0;
virtual void frameDidFail(uint64_t requestID, bool wasCancelled) = 0;
virtual void didEvaluateJavaScript(uint64_t requestID, const String& result) = 0;
virtual void streamWillSendRequest(uint64_t streamID, const WebCore::URL& requestURL, const WebCore::URL& responseURL, int responseStatusCode) = 0;
virtual void streamDidReceiveResponse(uint64_t streamID, const WebCore::URL& responseURL, uint32_t streamLength,
uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName) = 0;
virtual void streamDidReceiveData(uint64_t streamID, const char* bytes, int length) = 0;
virtual void streamDidFinishLoading(uint64_t streamID) = 0;
virtual void streamDidFail(uint64_t streamID, bool wasCancelled) = 0;
virtual void manualStreamDidReceiveResponse(const WebCore::URL& responseURL, uint32_t streamLength,
uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName) = 0;
virtual void manualStreamDidReceiveData(const char* bytes, int length) = 0;
virtual void manualStreamDidFinishLoading() = 0;
virtual void manualStreamDidFail(bool wasCancelled) = 0;
virtual bool handleMouseEvent(const WebMouseEvent&) = 0;
virtual bool handleWheelEvent(const WebWheelEvent&) = 0;
virtual bool handleMouseEnterEvent(const WebMouseEvent&) = 0;
virtual bool handleMouseLeaveEvent(const WebMouseEvent&) = 0;
virtual bool handleContextMenuEvent(const WebMouseEvent&) = 0;
virtual bool handleKeyboardEvent(const WebKeyboardEvent&) = 0;
virtual bool handleEditingCommand(const String& commandName, const String& argument) = 0;
virtual bool isEditingCommandEnabled(const String&) = 0;
virtual bool shouldAllowScripting() = 0;
virtual bool shouldAllowNavigationFromDrags() = 0;
virtual bool handlesPageScaleFactor() const = 0;
virtual void setFocus(bool) = 0;
virtual NPObject* pluginScriptableNPObject() = 0;
virtual void windowFocusChanged(bool) = 0;
virtual void windowVisibilityChanged(bool) = 0;
#if PLATFORM(COCOA)
virtual void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates) = 0;
virtual uint64_t pluginComplexTextInputIdentifier() const = 0;
virtual void sendComplexTextInput(const String& textInput) = 0;
virtual void setLayerHostingMode(LayerHostingMode) = 0;
#endif
virtual void contentsScaleFactorChanged(float) = 0;
virtual void storageBlockingStateChanged(bool) = 0;
virtual void privateBrowsingStateChanged(bool) = 0;
virtual bool getFormValue(String& formValue) = 0;
virtual bool handleScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity) = 0;
virtual WebCore::Scrollbar* horizontalScrollbar() = 0;
virtual WebCore::Scrollbar* verticalScrollbar() = 0;
#if PLATFORM(COCOA)
virtual RetainPtr<PDFDocument> pdfDocumentForPrinting() const { return 0; }
virtual NSObject *accessibilityObject() const { return 0; }
virtual id accessibilityAssociatedPluginParentForElement(WebCore::Element*) const { return nullptr; }
#endif
virtual unsigned countFindMatches(const String& target, WebCore::FindOptions, unsigned maxMatchCount) = 0;
virtual bool findString(const String& target, WebCore::FindOptions, unsigned maxMatchCount) = 0;
virtual WebCore::IntPoint convertToRootView(const WebCore::IntPoint& pointInLocalCoordinates) const;
virtual bool shouldAlwaysAutoStart() const { return false; }
virtual RefPtr<WebCore::SharedBuffer> liveResourceData() const = 0;
virtual bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&) = 0;
virtual String getSelectionString() const = 0;
virtual String getSelectionForWordAtPoint(const WebCore::FloatPoint&) const = 0;
virtual bool existingSelectionContainsPoint(const WebCore::FloatPoint&) const = 0;
virtual void mutedStateChanged(bool) { }
virtual bool canCreateTransientPaintingSnapshot() const { return true; }
virtual bool requiresUnifiedScaleFactor() const { return false; }
virtual void willDetachRenderer() { }
virtual bool pluginHandlesContentOffsetForAccessibilityHitTest() const { return false; }
protected:
Plugin(PluginType);
PluginType m_type;
bool m_isBeingDestroyed { false };
private:
PluginController* m_pluginController;
};
}
#define SPECIALIZE_TYPE_TRAITS_PLUGIN(ToValueTypeName, SpecificPluginType) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
static bool isType(const WebKit::Plugin& plugin) { return plugin.type() == WebKit::SpecificPluginType; } \
SPECIALIZE_TYPE_TRAITS_END()
#endif // Plugin_h