components/plugins/renderer/webview_plugin.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_PLUGINS_RENDERER_WEBVIEW_PLUGIN_H_
   6 #define COMPONENTS_PLUGINS_RENDERER_WEBVIEW_PLUGIN_H_
   7
   8 #include <list>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/sequenced_task_runner_helpers.h"
  12 #include "third_party/WebKit/public/platform/WebCursorInfo.h"
  13 #include "third_party/WebKit/public/platform/WebString.h"
  14 #include "third_party/WebKit/public/platform/WebURLResponse.h"
  15 #include "third_party/WebKit/public/web/WebFrameClient.h"
  16 #include "third_party/WebKit/public/web/WebKit.h"
  17 #include "third_party/WebKit/public/web/WebPlugin.h"
  18 #include "third_party/WebKit/public/web/WebViewClient.h"
  19
  20 namespace blink {
  21 class WebMouseEvent;
  22 }
  23
  24 namespace content {
  25 class RenderView;
  26 struct WebPreferences;
  27 }
  28
  29 namespace gfx {
  30 class Size;
  31 }
  32
  33 // This class implements the WebPlugin interface by forwarding drawing and
  34 // handling input events to a WebView.
  35 // It can be used as a placeholder for an actual plugin, using HTML for the UI.
  36 // To show HTML data inside the WebViewPlugin,
  37 // call web_view->mainFrame()->loadHTMLString() with the HTML data and a fake
  38 // chrome:// URL as origin.
  39
  40 class WebViewPlugin : public blink::WebPlugin,
  41                       public blink::WebViewClient,
  42                       public blink::WebFrameClient {
  43  public:
  44   class Delegate {
  45    public:
  46     // Called to get the V8 handle used to bind the lifetime to the frame.
  47     virtual v8::Local<v8::Value> GetV8Handle(v8::Isolate*) = 0;
  48
  49     // Called upon a context menu event.
  50     virtual void ShowContextMenu(const blink::WebMouseEvent&) = 0;
  51
  52     // Called when the WebViewPlugin is destroyed.
  53     virtual void PluginDestroyed() = 0;
  54
  55     // Called to enable JavaScript pass-through to a throttled plugin, which is
  56     // loaded but idle. Doesn't work for blocked plugins, which is not loaded.
  57     virtual v8::Local<v8::Object> GetV8ScriptableObject(v8::Isolate*) const = 0;
  58
  59     // Called when the unobscured rect of the plugin is updated.
  60     virtual void OnUnobscuredRectUpdate(const gfx::Rect& unobscured_rect) {}
  61   };
  62
  63   // Convenience method to set up a new WebViewPlugin using |preferences|
  64   // and displaying |html_data|. |url| should be a (fake) data:text/html URL;
  65   // it is only used for navigation and never actually resolved.
  66   static WebViewPlugin* Create(Delegate* delegate,
  67                                const content::WebPreferences& preferences,
  68                                const std::string& html_data,
  69                                const GURL& url);
  70
  71   blink::WebView* web_view() { return web_view_; }
  72
  73   // When loading a plugin document (i.e. a full page plugin not embedded in
  74   // another page), we save all data that has been received, and replay it with
  75   // this method on the actual plugin.
  76   void ReplayReceivedData(blink::WebPlugin* plugin);
  77
  78   void RestoreTitleText();
  79
  80   // WebPlugin methods:
  81   virtual blink::WebPluginContainer* container() const;
  82   virtual bool initialize(blink::WebPluginContainer*);
  83   virtual void destroy();
  84
  85   virtual v8::Local<v8::Object> v8ScriptableObject(v8::Isolate* isolate);
  86
  87   virtual void layoutIfNeeded() override;
  88   virtual void paint(blink::WebCanvas* canvas,
  89                      const blink::WebRect& rect) override;
  90
  91   // Coordinates are relative to the containing window.
  92   virtual void updateGeometry(
  93       const blink::WebRect& window_rect,
  94       const blink::WebRect& clip_rect,
  95       const blink::WebRect& unobscured_rect,
  96       const blink::WebVector<blink::WebRect>& cut_outs_rects,
  97       bool is_visible);
  98
  99   virtual void updateFocus(bool foucsed, blink::WebFocusType focus_type);
 100   virtual void updateVisibility(bool) {}
 101
 102   virtual bool acceptsInputEvents();
 103   virtual bool handleInputEvent(const blink::WebInputEvent& event,
 104                                 blink::WebCursorInfo& cursor_info);
 105
 106   virtual void didReceiveResponse(const blink::WebURLResponse& response);
 107   virtual void didReceiveData(const char* data, int data_length);
 108   virtual void didFinishLoading();
 109   virtual void didFailLoading(const blink::WebURLError& error);
 110
 111   // Called in response to WebPluginContainer::loadFrameRequest
 112   virtual void didFinishLoadingFrameRequest(const blink::WebURL& url,
 113                                             void* notifyData) {}
 114   virtual void didFailLoadingFrameRequest(const blink::WebURL& url,
 115                                           void* notify_data,
 116                                           const blink::WebURLError& error) {}
 117
 118   // WebViewClient methods:
 119   virtual bool acceptsLoadDrops();
 120
 121   virtual void setToolTipText(const blink::WebString&,
 122                               blink::WebTextDirection);
 123
 124   virtual void startDragging(blink::WebLocalFrame* frame,
 125                              const blink::WebDragData& drag_data,
 126                              blink::WebDragOperationsMask mask,
 127                              const blink::WebImage& image,
 128                              const blink::WebPoint& point);
 129
 130   // TODO(ojan): Remove this override and have this class use a non-null
 131   // layerTreeView.
 132   virtual bool allowsBrokenNullLayerTreeView() const;
 133
 134   // WebWidgetClient methods:
 135   virtual void didInvalidateRect(const blink::WebRect&);
 136   virtual void didUpdateLayoutSize(const blink::WebSize&);
 137   virtual void didChangeCursor(const blink::WebCursorInfo& cursor);
 138   virtual void scheduleAnimation();
 139
 140   // WebFrameClient methods:
 141   virtual void didClearWindowObject(blink::WebLocalFrame* frame);
 142
 143   // This method is defined in WebPlugin as well as in WebFrameClient, but with
 144   // different parameters. We only care about implementing the WebPlugin
 145   // version, so we implement this method and call the default in WebFrameClient
 146   // (which does nothing) to correctly overload it.
 147   virtual void didReceiveResponse(blink::WebLocalFrame* frame,
 148                                   unsigned identifier,
 149                                   const blink::WebURLResponse& response);
 150
 151  private:
 152   friend class base::DeleteHelper<WebViewPlugin>;
 153   WebViewPlugin(Delegate* delegate, const content::WebPreferences& preferences);
 154   virtual ~WebViewPlugin();
 155
 156   // Manages its own lifetime.
 157   Delegate* delegate_;
 158
 159   blink::WebCursorInfo current_cursor_;
 160
 161   // Owns us.
 162   blink::WebPluginContainer* container_;
 163
 164   // Owned by us, deleted via |close()|.
 165   blink::WebView* web_view_;
 166
 167   // Owned by us, deleted via |close()|.
 168   blink::WebFrame* web_frame_;
 169   gfx::Rect rect_;
 170
 171   blink::WebURLResponse response_;
 172   std::list<std::string> data_;
 173   scoped_ptr<blink::WebURLError> error_;
 174   blink::WebString old_title_;
 175   bool finished_loading_;
 176   bool focused_;
 177 };
 178
 179 #endif  // COMPONENTS_PLUGINS_RENDERER_WEBVIEW_PLUGIN_H_