Browser Plugin: Simplify BrowserPluginGuestHelper

content/browser/browser_plugin/browser_plugin_guest.h

 // 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.
 
-// A BrowserPluginGuest represents the browser side of browser <--> renderer
-// communication. A BrowserPlugin (a WebPlugin) is on the renderer side of
-// browser <--> guest renderer communication. The 'guest' renderer is a
-// <browser> tag.
+// A BrowserPluginGuest is the browser side of a browser <--> embedder
+// renderer channel. A BrowserPlugin (a WebPlugin) is on the embedder
+// renderer side of browser <--> embedder renderer communication.
 //
 // BrowserPluginGuest lives on the UI thread of the browser process. It has a
 // helper, BrowserPluginGuestHelper, which is a RenderViewHostObserver. The
-// helper object receives messages (ViewHostMsg_*) directed at the browser
-// plugin and redirects them to this class. Any messages the embedder might be
-// interested in knowing or modifying about the guest should be listened for
-// here.
+// helper object intercepts messages (ViewHostMsg_*) directed at the browser
+// process and redirects them to this class. Any messages about the guest render
+// process that the embedder might be interested in receiving should be listened
+// for here.
 //
-// Since BrowserPlugin is a WebPlugin, we need to provide overridden behaviors
-// for messages like handleInputEvent, updateGeometry. Such messages get
-// routed into BrowserPluginGuest via its embedder (BrowserPluginEmbedder).
-// These are BrowserPluginHost_* messages sent from the BrowserPlugin.
-//
-// BrowserPluginGuest knows about its embedder process. Communication to
-// renderer happens through the embedder process.
-//
-// A BrowserPluginGuest is also associated directly with the WebContents related
-// to the BrowserPlugin. BrowserPluginGuest is a WebContentsDelegate and
-// WebContentsObserver for the WebContents.
+// BrowserPluginGuest is a WebContentsDelegate and WebContentsObserver for the
+// guest WebContents. BrowserPluginGuest operates under the assumption that the
+// guest will be accessible through only one RenderViewHost for the lifetime of
+// the guest WebContents. Thus, cross-process navigation is not supported.
 
 #ifndef CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_GUEST_H_
 #define CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_GUEST_H_
 
 #include <map>
 
 #include "base/compiler_specific.h"
 #include "base/id_map.h"
 #include "base/time.h"
+#include "content/port/common/input_event_ack_state.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/web_contents_delegate.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDragStatus.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDragOperation.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
 #include "ui/gfx/rect.h"
 #include "ui/surface/transport_dib.h"
 
 struct BrowserPluginHostMsg_AutoSize_Params;
 struct BrowserPluginHostMsg_CreateGuest_Params;
 struct BrowserPluginHostMsg_ResizeGuest_Params;
 #if defined(OS_MACOSX)
 struct ViewHostMsg_ShowPopup_Params;
 #endif
 struct ViewHostMsg_UpdateRect_Params;
@@ skipping 71 matching lines @@
   virtual void DidCommitProvisionalLoadForFrame(
       int64 frame_id,
       bool is_main_frame,
       const GURL& url,
       PageTransition transition_type,
       RenderViewHost* render_view_host) OVERRIDE;
   virtual void DidStopLoading(RenderViewHost* render_view_host) OVERRIDE;
 
   virtual void RenderViewReady() OVERRIDE;
   virtual void RenderViewGone(base::TerminationStatus status) OVERRIDE;
+  virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
+
 
   // WebContentsDelegate implementation.
   virtual bool CanDownload(RenderViewHost* render_view_host,
                            int request_id,
                            const std::string& request_method) OVERRIDE;
   virtual bool HandleContextMenu(const ContextMenuParams& params) OVERRIDE;
   virtual void RendererUnresponsive(WebContents* source) OVERRIDE;
   virtual void RendererResponsive(WebContents* source) OVERRIDE;
   virtual void RunFileChooser(WebContents* web_contents,
                               const FileChooserParams& params) OVERRIDE;
   virtual bool ShouldFocusPageAfterCrash() OVERRIDE;
 
-  void UpdateRect(RenderViewHost* render_view_host,
-                  const ViewHostMsg_UpdateRect_Params& params);
   void UpdateRectACK(
-      int message_id,
       const BrowserPluginHostMsg_AutoSize_Params& auto_size_params,
       const BrowserPluginHostMsg_ResizeGuest_Params& resize_guest_params);
-  // Overrides default ShowWidget message so we show them on the correct
-  // coordinates.
-  void ShowWidget(RenderViewHost* render_view_host,
-                  int route_id,
-                  const gfx::Rect& initial_pos);
-  // On MacOSX popups are painted by the browser process. We handle them here
-  // so that they are positioned correctly.
-#if defined(OS_MACOSX)
-  void ShowPopup(RenderViewHost* render_view_host,
-                 const ViewHostMsg_ShowPopup_Params& params);
-#endif
-  void SetCursor(const WebCursor& cursor);
-  // Handles input event acks so they are sent to browser plugin host (via
-  // embedder) instead of default view/widget host.
-  void HandleInputEventAck(RenderViewHost* render_view_host, bool handled);
-
-  // The guest needs to notify the plugin in the embedder to start (or stop)
-  // accepting touch events.
-  void SetIsAcceptingTouchEvents(bool accept);
 
   // The guest WebContents is visible if both its embedder is visible and
   // the browser plugin element is visible. If either one is not then the
   // WebContents is marked as hidden. A hidden WebContents will consume
   // fewer GPU and CPU resources.
   //
   // When the every WebContents in a RenderProcessHost is hidden, it will lower
   // the priority of the process (see RenderProcessHostImpl::WidgetHidden).
   //
   // It will also send a message to the guest renderer process to cleanup
@@ skipping 13 matching lines @@
   void DragStatusUpdate(WebKit::WebDragStatus drag_status,
                         const WebDropData& drop_data,
                         WebKit::WebDragOperationsMask drag_mask,
                         const gfx::Point& location);
 
   // Updates the size state of the guest.
   void SetSize(
       const BrowserPluginHostMsg_AutoSize_Params& auto_size_params,
       const BrowserPluginHostMsg_ResizeGuest_Params& resize_guest_params);
 
-  // Updates the cursor during dragging.
-  // During dragging, if the guest notifies to update the cursor for a drag,
-  // then it is necessary to route the cursor update to the embedder correctly
-  // so that the cursor updates properly.
-  void UpdateDragCursor(WebKit::WebDragOperation operation);
-
   // Exposes the protected web_contents() from WebContentsObserver.
   WebContents* GetWebContents();
 
   // Kill the guest process.
   void Terminate();
 
   // Grab the new damage buffer from the embedder, and resize the guest's
   // web contents.
   void Resize(RenderViewHost* embedder_rvh,
               const BrowserPluginHostMsg_ResizeGuest_Params& params);
 
   // Overridden in tests.
   // Handles input event routed through the embedder (which is initiated in the
   // browser plugin (renderer side of the embedder)).
   virtual void HandleInputEvent(RenderViewHost* render_view_host,
                                 const gfx::Rect& guest_window_rect,
                                 const gfx::Rect& guest_screen_rect,
                                 const WebKit::WebInputEvent& event);
-  virtual bool ViewTakeFocus(bool reverse);
   // If possible, navigate the guest to |relative_index| entries away from the
   // current navigation entry.
   virtual void Go(int relative_index);
   // Overridden in tests.
   virtual void SetFocus(bool focused);
   // Reload the guest.
   virtual void Reload();
   // Stop loading the guest.
   virtual void Stop();
   // Overridden in tests.
@@ skipping 33 matching lines @@
   TransportDIB* GetDamageBufferFromEmbedder(
       RenderViewHost* embedder_rvh,
       const BrowserPluginHostMsg_ResizeGuest_Params& params);
 
   // Called when a redirect notification occurs.
   void LoadRedirect(const GURL& old_url,
                     const GURL& new_url,
                     bool is_top_level);
 
   bool InAutoSizeBounds(const gfx::Size& size) const;
+
+  // Message handlers.
+
+  void OnHandleInputEventAck(
+      WebKit::WebInputEvent::Type event_type,
+      InputEventAckState ack_result);
+  void OnHasTouchEventHandlers(bool accept);
+  void OnSetCursor(const WebCursor& cursor);
+  // On MacOSX popups are painted by the browser process. We handle them here
+  // so that they are positioned correctly.
+#if defined(OS_MACOSX)
+  void OnShowPopup(const ViewHostMsg_ShowPopup_Params& params);
+#endif
+  void OnShowWidget(int route_id, const gfx::Rect& initial_pos);
+  // Overriden in tests
+  virtual void OnTakeFocus(bool reverse);
+  void OnUpdateDragCursor(WebKit::WebDragOperation operation);
+  void OnUpdateRect(const ViewHostMsg_UpdateRect_Params& params);
+
   // Static factory instance (always NULL for non-test).
   static content::BrowserPluginHostFactory* factory_;
 
   NotificationRegistrar notification_registrar_;
   WebContentsImpl* embedder_web_contents_;
   // An identifier that uniquely identifies a browser plugin guest within an
   // embedder.
   int instance_id_;
   scoped_ptr<TransportDIB> damage_buffer_;
 #if defined(OS_WIN)
   size_t damage_buffer_size_;
   TransportDIB::Handle remote_damage_buffer_handle_;
 #endif
   gfx::Size damage_view_size_;
   float damage_buffer_scale_factor_;
   gfx::Rect guest_window_rect_;
   gfx::Rect guest_screen_rect_;
-  IDMap<RenderViewHost> pending_updates_;
-  int pending_update_counter_;
   base::TimeDelta guest_hang_timeout_;
   bool focused_;
   bool visible_;
   bool auto_size_enabled_;
   gfx::Size max_auto_size_;
   gfx::Size min_auto_size_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowserPluginGuest);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_GUEST_H_