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/WebPlugin.h" 17 #include "third_party/WebKit/public/web/WebViewClient.h" 18 19 struct WebPreferences; 20 21 namespace blink { 22 class WebMouseEvent; 23 } 24 25 // This class implements the WebPlugin interface by forwarding drawing and 26 // handling input events to a WebView. 27 // It can be used as a placeholder for an actual plugin, using HTML for the UI. 28 // To show HTML data inside the WebViewPlugin, 29 // call web_view->mainFrame()->loadHTMLString() with the HTML data and a fake 30 // chrome:// URL as origin. 31 32 class WebViewPlugin : public blink::WebPlugin, 33 public blink::WebViewClient, 34 public blink::WebFrameClient { 35 public: 36 class Delegate { 37 public: 38 // Bind |frame| to a Javascript object, enabling the delegate to receive 39 // callback methods from Javascript inside the WebFrame. 40 // This method is called from WebFrameClient::didClearWindowObject. 41 virtual void BindWebFrame(blink::WebFrame* frame) = 0; 42 43 // Called before the WebViewPlugin is destroyed. The delegate should delete 44 // itself here. 45 virtual void WillDestroyPlugin() = 0; 46 47 // Called upon a context menu event. 48 virtual void ShowContextMenu(const blink::WebMouseEvent&) = 0; 49 }; 50 51 explicit WebViewPlugin(Delegate* delegate); 52 53 // Convenience method to set up a new WebViewPlugin using |preferences| 54 // and displaying |html_data|. |url| should be a (fake) chrome:// URL; it is 55 // only used for navigation and never actually resolved. 56 static WebViewPlugin* Create(Delegate* delegate, 57 const WebPreferences& preferences, 58 const std::string& html_data, 59 const GURL& url); 60 web_view()61 blink::WebView* web_view() { return web_view_; } 62 63 // When loading a plug-in document (i.e. a full page plug-in not embedded in 64 // another page), we save all data that has been received, and replay it with 65 // this method on the actual plug-in. 66 void ReplayReceivedData(blink::WebPlugin* plugin); 67 68 void RestoreTitleText(); 69 70 // WebPlugin methods: 71 virtual blink::WebPluginContainer* container() const; 72 virtual bool initialize(blink::WebPluginContainer*); 73 virtual void destroy(); 74 75 virtual NPObject* scriptableObject(); 76 virtual struct _NPP* pluginNPP(); 77 78 virtual bool getFormValue(blink::WebString& value); 79 80 virtual void paint(blink::WebCanvas* canvas, const blink::WebRect& rect); 81 82 // Coordinates are relative to the containing window. 83 virtual void updateGeometry( 84 const blink::WebRect& frame_rect, 85 const blink::WebRect& clip_rect, 86 const blink::WebVector<blink::WebRect>& cut_out_rects, 87 bool is_visible); 88 updateFocus(bool)89 virtual void updateFocus(bool) {} updateVisibility(bool)90 virtual void updateVisibility(bool) {} 91 92 virtual bool acceptsInputEvents(); 93 virtual bool handleInputEvent(const blink::WebInputEvent& event, 94 blink::WebCursorInfo& cursor_info); 95 96 virtual void didReceiveResponse(const blink::WebURLResponse& response); 97 virtual void didReceiveData(const char* data, int data_length); 98 virtual void didFinishLoading(); 99 virtual void didFailLoading(const blink::WebURLError& error); 100 101 // Called in response to WebPluginContainer::loadFrameRequest didFinishLoadingFrameRequest(const blink::WebURL & url,void * notifyData)102 virtual void didFinishLoadingFrameRequest(const blink::WebURL& url, 103 void* notifyData) {} didFailLoadingFrameRequest(const blink::WebURL & url,void * notify_data,const blink::WebURLError & error)104 virtual void didFailLoadingFrameRequest(const blink::WebURL& url, 105 void* notify_data, 106 const blink::WebURLError& error) {} 107 108 // WebViewClient methods: 109 virtual bool acceptsLoadDrops(); 110 111 virtual void setToolTipText(const blink::WebString&, 112 blink::WebTextDirection); 113 114 virtual void startDragging(blink::WebFrame* frame, 115 const blink::WebDragData& drag_data, 116 blink::WebDragOperationsMask mask, 117 const blink::WebImage& image, 118 const blink::WebPoint& point); 119 120 // WebWidgetClient methods: 121 virtual void didInvalidateRect(const blink::WebRect&); 122 virtual void didChangeCursor(const blink::WebCursorInfo& cursor); 123 124 // WebFrameClient methods: 125 virtual void didClearWindowObject(blink::WebFrame* frame); 126 127 // This method is defined in WebPlugin as well as in WebFrameClient, but with 128 // different parameters. We only care about implementing the WebPlugin 129 // version, so we implement this method and call the default in WebFrameClient 130 // (which does nothing) to correctly overload it. 131 virtual void didReceiveResponse(blink::WebFrame* frame, 132 unsigned identifier, 133 const blink::WebURLResponse& response); 134 135 private: 136 friend class base::DeleteHelper<WebViewPlugin>; 137 virtual ~WebViewPlugin(); 138 139 Delegate* delegate_; 140 // Destroys itself. 141 blink::WebCursorInfo current_cursor_; 142 // Owns us. 143 blink::WebPluginContainer* container_; 144 // Owned by us, deleted via |close()|. 145 blink::WebView* web_view_; 146 gfx::Rect rect_; 147 148 blink::WebURLResponse response_; 149 std::list<std::string> data_; 150 bool finished_loading_; 151 scoped_ptr<blink::WebURLError> error_; 152 blink::WebString old_title_; 153 }; 154 155 #endif // COMPONENTS_PLUGINS_RENDERER_WEBVIEW_PLUGIN_H_ 156