| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CONTENT_CHILD_NPAPI_WEBPLUGIN_DELEGATE_IMPL_H_ |
| #define CONTENT_CHILD_NPAPI_WEBPLUGIN_DELEGATE_IMPL_H_ |
| |
| #include <stdint.h> |
| |
| #include <string> |
| #include <vector> |
| |
| #include "base/macros.h" |
| #include "base/memory/ref_counted.h" |
| #include "base/memory/scoped_ptr.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/sequenced_task_runner_helpers.h" |
| #include "base/timer/timer.h" |
| #include "build/build_config.h" |
| #include "content/child/npapi/webplugin_delegate.h" |
| #include "content/common/cursors/webcursor.h" |
| #include "third_party/npapi/bindings/npapi.h" |
| #include "ui/gfx/geometry/rect.h" |
| #include "ui/gfx/native_widget_types.h" |
| |
| namespace base { |
| class FilePath; |
| } |
| |
| #if defined(OS_MACOSX) |
| #ifdef __OBJC__ |
| @class CALayer; |
| @class CARenderer; |
| #else |
| class CALayer; |
| class CARenderer; |
| #endif |
| #endif |
| |
| namespace content { |
| class PluginInstance; |
| class WebPlugin; |
| |
| #if defined(OS_MACOSX) |
| class WebPluginAcceleratedSurface; |
| class ExternalDragTracker; |
| #endif // OS_MACOSX |
| |
| // An implementation of WebPluginDelegate that runs in the plugin process, |
| // proxied from the renderer by WebPluginDelegateProxy. |
| class WebPluginDelegateImpl : public WebPluginDelegate { |
| public: |
| enum PluginQuirks { |
| PLUGIN_QUIRK_SETWINDOW_TWICE = 1, // Win32 |
| PLUGIN_QUIRK_THROTTLE_WM_USER_PLUS_ONE = 2, // Win32 |
| PLUGIN_QUIRK_DONT_CALL_WND_PROC_RECURSIVELY = 4, // Win32 |
| PLUGIN_QUIRK_DONT_SET_NULL_WINDOW_HANDLE_ON_DESTROY = 8, // Win32 |
| PLUGIN_QUIRK_DONT_ALLOW_MULTIPLE_INSTANCES = 16, // Win32 |
| PLUGIN_QUIRK_DIE_AFTER_UNLOAD = 32, // Win32 |
| PLUGIN_QUIRK_PATCH_SETCURSOR = 64, // Win32 |
| PLUGIN_QUIRK_BLOCK_NONSTANDARD_GETURL_REQUESTS = 128, // Win32 |
| PLUGIN_QUIRK_WINDOWLESS_OFFSET_WINDOW_TO_DRAW = 256, // Linux |
| PLUGIN_QUIRK_WINDOWLESS_INVALIDATE_AFTER_SET_WINDOW = 512, // Linux |
| PLUGIN_QUIRK_NO_WINDOWLESS = 1024, // Windows |
| PLUGIN_QUIRK_PATCH_REGENUMKEYEXW = 2048, // Windows |
| PLUGIN_QUIRK_ALWAYS_NOTIFY_SUCCESS = 4096, // Windows |
| PLUGIN_QUIRK_HANDLE_MOUSE_CAPTURE = 16384, // Windows |
| PLUGIN_QUIRK_WINDOWLESS_NO_RIGHT_CLICK = 32768, // Linux |
| PLUGIN_QUIRK_IGNORE_FIRST_SETWINDOW_CALL = 65536, // Windows. |
| PLUGIN_QUIRK_EMULATE_IME = 131072, // Windows. |
| PLUGIN_QUIRK_FAKE_WINDOW_FROM_POINT = 262144, // Windows. |
| PLUGIN_QUIRK_COPY_STREAM_DATA = 524288, // All platforms |
| }; |
| |
| static WebPluginDelegateImpl* Create(WebPlugin* plugin, |
| const base::FilePath& filename, |
| const std::string& mime_type); |
| |
| // WebPluginDelegate implementation |
| bool Initialize(const GURL& url, |
| const std::vector<std::string>& arg_names, |
| const std::vector<std::string>& arg_values, |
| bool load_manually) override; |
| void PluginDestroyed() override; |
| void UpdateGeometry(const gfx::Rect& window_rect, |
| const gfx::Rect& clip_rect) override; |
| void Paint(SkCanvas* canvas, const gfx::Rect& rect) override; |
| void SetFocus(bool focused) override; |
| bool HandleInputEvent(const blink::WebInputEvent& event, |
| WebCursor::CursorInfo* cursor_info) override; |
| int GetProcessId() override; |
| // End of WebPluginDelegate implementation. |
| |
| PluginInstance* instance() { return instance_.get(); } |
| gfx::Rect GetRect() const { return window_rect_; } |
| gfx::Rect GetClipRect() const { return clip_rect_; } |
| |
| // Returns the path for the library implementing this plugin. |
| base::FilePath GetPluginPath(); |
| |
| // Returns a combination of PluginQuirks. |
| int GetQuirks() const { return quirks_; } |
| |
| // Informs the plugin that the view it is in has gained or lost focus. |
| void SetContentAreaHasFocus(bool has_focus); |
| |
| #if defined(OS_MACOSX) && !defined(USE_AURA) |
| // Informs the plugin that the geometry has changed, as with UpdateGeometry, |
| // but also includes the new buffer context for that new geometry. |
| void UpdateGeometryAndContext(const gfx::Rect& window_rect, |
| const gfx::Rect& clip_rect, |
| gfx::NativeDrawingContext context); |
| // Informs the delegate that the plugin called NPN_Invalidate*. Used as a |
| // trigger for Core Animation drawing. |
| void PluginDidInvalidate(); |
| // Returns the delegate currently processing events. |
| static WebPluginDelegateImpl* GetActiveDelegate(); |
| // Informs the plugin that the window it is in has gained or lost focus. |
| void SetWindowHasFocus(bool has_focus); |
| // Informs the plugin that its tab or window has been hidden or shown. |
| void SetContainerVisibility(bool is_visible); |
| // Informs the plugin that its containing window's frame has changed. |
| // Frames are in screen coordinates. |
| void WindowFrameChanged(const gfx::Rect& window_frame, |
| const gfx::Rect& view_frame); |
| // Informs the plugin that IME composition has completed. |
| // If |text| is empty, IME was cancelled. |
| void ImeCompositionCompleted(const base::string16& text); |
| // Informs the delegate that the plugin set a Cocoa NSCursor. |
| void SetNSCursor(NSCursor* cursor); |
| |
| // Indicates that the windowless plugins will draw directly to the window |
| // context instead of a buffer context. |
| void SetNoBufferContext(); |
| |
| // TODO(caryclark): This is a temporary workaround to allow the Darwin / Skia |
| // port to share code with the Darwin / CG port. Later, this will be removed |
| // and all callers will use the Paint defined above. |
| void CGPaint(CGContextRef context, const gfx::Rect& rect); |
| #endif // OS_MACOSX && !USE_AURA |
| |
| private: |
| friend class base::DeleteHelper<WebPluginDelegateImpl>; |
| friend class WebPluginDelegate; |
| |
| WebPluginDelegateImpl(WebPlugin* plugin, PluginInstance* instance); |
| ~WebPluginDelegateImpl() override; |
| |
| // Called by Initialize() for platform-specific initialization. |
| // If this returns false, the plugin shouldn't be started--see Initialize(). |
| bool PlatformInitialize(); |
| |
| // Called by DestroyInstance(), used for platform-specific destruction. |
| void PlatformDestroyInstance(); |
| |
| //---------------------------- |
| // used for windowless plugins |
| void WindowlessUpdateGeometry(const gfx::Rect& window_rect, |
| const gfx::Rect& clip_rect); |
| void WindowlessPaint(gfx::NativeDrawingContext hdc, const gfx::Rect& rect); |
| |
| // Tells the plugin about the current state of the window. |
| // See NPAPI NPP_SetWindow for more information. |
| void WindowlessSetWindow(); |
| |
| // Informs the plugin that it has gained or lost keyboard focus (on the Mac, |
| // this just means window first responder status). |
| void SetPluginHasFocus(bool focused); |
| |
| // Handles the platform specific details of setting plugin focus. Returns |
| // false if the platform cancelled the focus tranfer. |
| bool PlatformSetPluginHasFocus(bool focused); |
| |
| //----------------------------------------- |
| // used for windowed and windowless plugins |
| |
| // Does platform-specific event handling. Arguments and return are identical |
| // to HandleInputEvent. |
| bool PlatformHandleInputEvent(const blink::WebInputEvent& event, |
| WebCursor::CursorInfo* cursor_info); |
| |
| // Closes down and destroys our plugin instance. |
| void DestroyInstance(); |
| |
| |
| // Note: on Mac OS X, the only time the windowed handle is non-zero |
| // is the case of accelerated rendering, which uses a fake window handle to |
| // identify itself back to the browser. It still performs all of its |
| // work offscreen. |
| |
| WebPlugin* plugin_; |
| scoped_refptr<PluginInstance> instance_; |
| |
| NPWindow window_; |
| gfx::Rect window_rect_; |
| gfx::Rect clip_rect_; |
| int quirks_; |
| |
| #if defined(OS_MACOSX) && !defined(USE_AURA) |
| // Sets window_rect_ to |rect| |
| void SetPluginRect(const gfx::Rect& rect); |
| // Sets content_area_origin to |origin| |
| void SetContentAreaOrigin(const gfx::Point& origin); |
| // Updates everything that depends on the plugin's absolute screen location. |
| void PluginScreenLocationChanged(); |
| // Updates anything that depends on plugin visibility. |
| void PluginVisibilityChanged(); |
| |
| // Starts an IME session. |
| void StartIme(); |
| |
| // Informs the browser about the updated accelerated drawing surface. |
| void UpdateAcceleratedSurface(); |
| |
| // Uses a CARenderer to draw the plugin's layer in our OpenGL surface. |
| void DrawLayerInSurface(); |
| |
| bool use_buffer_context_; |
| CGContextRef buffer_context_; // Weak ref. |
| |
| CALayer* layer_; // Used for CA drawing mode. Weak, retained by plugin. |
| WebPluginAcceleratedSurface* surface_; // Weak ref. |
| CARenderer* renderer_; // Renders layer_ to surface_. |
| scoped_ptr<base::RepeatingTimer> redraw_timer_; |
| |
| // The upper-left corner of the web content area in screen coordinates, |
| // relative to an upper-left (0,0). |
| gfx::Point content_area_origin_; |
| |
| bool containing_window_has_focus_; |
| bool initial_window_focus_; |
| bool container_is_visible_; |
| bool have_called_set_window_; |
| |
| gfx::Rect cached_clip_rect_; |
| |
| bool ime_enabled_; |
| int keyup_ignore_count_; |
| |
| scoped_ptr<ExternalDragTracker> external_drag_tracker_; |
| #endif // OS_MACOSX && !USE_AURA |
| |
| // Called by the message filter hook when the plugin enters a modal loop. |
| void OnModalLoopEntered(); |
| |
| // Returns true if the message passed in corresponds to a user gesture. |
| static bool IsUserGesture(const blink::WebInputEvent& event); |
| |
| // The url with which the plugin was instantiated. |
| std::string plugin_url_; |
| |
| // Holds the depth of the HandleEvent callstack. |
| int handle_event_depth_; |
| |
| // Holds the current cursor set by the windowless plugin. |
| WebCursor current_windowless_cursor_; |
| |
| // Set to true initially and indicates if this is the first npp_setwindow |
| // call received by the plugin. |
| bool first_set_window_call_; |
| |
| // True if the plugin thinks it has keyboard focus |
| bool plugin_has_focus_; |
| // True if the plugin element has focus within the web content, regardless of |
| // whether its containing view currently has focus. |
| bool has_webkit_focus_; |
| // True if the containing view currently has focus. |
| // Initially set to true so that plugin focus still works in environments |
| // where SetContentAreaHasFocus is never called. See |
| // https://bugs.webkit.org/show_bug.cgi?id=46013 for details. |
| bool containing_view_has_focus_; |
| |
| // True if NPP_New did not return an error. |
| bool creation_succeeded_; |
| |
| #if defined(OS_WIN) |
| // Runnable Method Factory used to invoke the OnUserGestureEnd method |
| // asynchronously. |
| base::WeakPtrFactory<WebPluginDelegateImpl> user_gesture_msg_factory_; |
| #endif |
| |
| DISALLOW_COPY_AND_ASSIGN(WebPluginDelegateImpl); |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_CHILD_NPAPI_WEBPLUGIN_DELEGATE_IMPL_H_ |