Browser Plugin: Reduce code repetition in BrowserPluginManager.

content/renderer/browser_plugin/browser_plugin.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.
 
 #ifndef  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
 #define  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
 
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebPlugin.h"
 
 #include "base/memory/scoped_ptr.h"
@@ skipping 12 matching lines @@
 struct BrowserPluginHostMsg_ResizeGuest_Params;
 struct BrowserPluginMsg_LoadCommit_Params;
 struct BrowserPluginMsg_UpdateRect_Params;
 
 namespace content {
 
 class BrowserPluginManager;
 class MockBrowserPlugin;
 
 class CONTENT_EXPORT BrowserPlugin :
-    NON_EXPORTED_BASE(public WebKit::WebPlugin) {
+    NON_EXPORTED_BASE(public WebKit::WebPlugin),
+    public IPC::Listener {

[sadrul, 2012/12/14 16:08:39]

The plugin doesn't need to be an IPC::Listener, right? From what I can see, it
receives messages only from the BrowserPluginManager. So it doesn't actually
need to be a listener?

[Fady Samuel, 2012/12/14 17:05:54]

It does not and I don't have immediate plans to pass it in to methods that
expect an IPC::Listener. Removed. Thanks!

  public:
   RenderViewImpl* render_view() const { return render_view_.get(); }
   // Called only by tests to clean up before we blow away the MockRenderProcess.
   void Cleanup();
 
+  virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
+
   // Update Browser Plugin's DOM Node attribute |attribute_name| with the value
   // |attribute_value|.
   void UpdateDOMAttribute(const std::string& attribute_name,
                           const std::string& attribute_value);
 
   // Get the src attribute value of the BrowserPlugin instance.
   std::string src_attribute() const { return src_; }
   // Set the src attribute value of the BrowserPlugin instance.
   bool SetSrcAttribute(const std::string& src, std::string* error_message);
   // Get the autosize attribute value.
@@ skipping 28 matching lines @@
   // Query whether the guest can navigate back to the previous entry.
   bool CanGoBack() const;
   // Query whether the guest can navigation forward to the next entry.
   bool CanGoForward() const;
   // This method can be successfully called only before the first navigation for
   // this instance of BrowserPlugin. If an error occurs, the |error_message| is
   // set appropriately to indicate the failure reason.
   bool SetPartitionAttribute(const std::string& partition_id,
                              std::string* error_message);
 
-  // Inform the BrowserPlugin to update its backing store with the pixels in
-  // its damage buffer.
-  void UpdateRect(int message_id,
-                  const BrowserPluginMsg_UpdateRect_Params& params);
-  // Inform the BrowserPlugin that its guest process is gone.
-  void GuestGone(int process_id, base::TerminationStatus status);
-  // Inform the BrowserPlugin that the guest process is unresponsive.
-  void GuestUnresponsive(int process_id);
-  // Inform the BrowserPlugin that the guest process is responsive again after
-  // being reported as unresponsive.
-  void GuestResponsive(int process_id);
-  // Inform the BrowserPlugin that the guest has navigated to a new URL.
-  void LoadCommit(const BrowserPluginMsg_LoadCommit_Params& params);
-  // Inform the BrowserPlugin that the guest has started loading a new page.
-  void LoadStart(const GURL& url, bool is_top_level);
-  // Inform the BrowserPlugin that the guest has finished loading a new page.
-  void LoadStop();
-  // Inform the BrowserPlugin that the guest has aborted loading a new page.
-  void LoadAbort(const GURL& url, bool is_top_level, const std::string& type);
-  // Inform the BrowserPlugin that the guest has redirected a navigation.
-  void LoadRedirect(const GURL& old_url,
-                    const GURL& new_url,
-                    bool is_top_level);
-  // Tells the BrowserPlugin to advance the focus to the next (or previous)
-  // element.
-  void AdvanceFocus(bool reverse);
   // Inform the BrowserPlugin of the focus state of the embedder RenderView.
   void SetEmbedderFocus(bool focused);
   // Informs the guest of an updated focus state.
   void UpdateGuestFocusState();
   // Indicates whether the guest should be focused.
   bool ShouldGuestBeFocused() const;
 
-  // Inform the BrowserPlugin that the guest's contentWindow is ready,
-  // and provide it with a routing ID to grab it.
-  void GuestContentWindowReady(int content_window_routing_id);
-
-  // Informs the BrowserPlugin that the guest has started/stopped accepting
-  // touch events.
-  void SetAcceptTouchEvents(bool accept);
-
   // Tells the BrowserPlugin to tell the guest to navigate to the previous
   // navigation entry in the navigation history.
   void Back();
   // Tells the BrowserPlugin to tell the guest to navigate to the next
   // navigation entry in the navigation history.
   void Forward();
   // Tells the BrowserPlugin to tell the guest to navigate to a position
   // relative to the current index in its navigation history.
   void Go(int relativeIndex);
   // Tells the BrowserPlugin to terminate the guest process.
   void TerminateGuest();
 
   // A request from Javascript has been made to stop the loading of the page.
   void Stop();
   // A request from Javascript has been made to reload the page.
   void Reload();
 
-  // Informs the BrowserPlugin of the cursor that the guest has requested.
-  void SetCursor(const WebCursor& cursor);
-
   // Returns true if |point| lies within the bounds of the plugin rectangle.
   // Not OK to use this function for making security-sensitive decision since it
   // can return false positives when the plugin has rotation transformation
   // applied.
   bool InBounds(const gfx::Point& point) const;
 
   gfx::Point ToLocalCoordinates(const gfx::Point& point) const;
 
   // WebKit::WebPlugin implementation.
   virtual WebKit::WebPluginContainer* container() const OVERRIDE;
@@ skipping 117 matching lines @@
 
 #if defined(OS_MACOSX)
   bool DamageBufferMatches(const TransportDIB* damage_buffer,
                            const TransportDIB::Id& other_damage_buffer_id);
 #else
   bool DamageBufferMatches(
       const TransportDIB* damage_buffer,
       const TransportDIB::Handle& other_damage_buffer_handle);
 #endif
 
+  // IPC message handlers.
+  // Please keep in alphabetical order.
+  void OnAdvanceFocus(int instance_id, bool reverse);
+  void OnGuestContentWindowReady(int instance_id,
+                                 int content_window_routing_id);
+  void OnGuestGone(int instance_id, int process_id, int status);
+  void OnGuestResponsive(int instance_id, int process_id);
+  void OnGuestUnresponsive(int instance_id, int process_id);
+  void OnLoadAbort(int instance_id,
+                   const GURL& url,
+                   bool is_top_level,
+                   const std::string& type);
+  void OnLoadCommit(int instance_id,
+                    const BrowserPluginMsg_LoadCommit_Params& params);
+  void OnLoadRedirect(int instance_id,
+                      const GURL& old_url,
+                      const GURL& new_url,
+                      bool is_top_level);
+  void OnLoadStart(int instance_id, const GURL& url, bool is_top_level);
+  void OnLoadStop(int instance_id);
+  void OnSetCursor(int instance_id, const WebCursor& cursor);
+  void OnShouldAcceptTouchEvents(int instance_id, bool accept);
+  void OnUpdateRect(int instance_id,
+                    int message_id,
+                    const BrowserPluginMsg_UpdateRect_Params& params);
+
   int instance_id_;
   base::WeakPtr<RenderViewImpl> render_view_;
   // We cache the |render_view_|'s routing ID because we need it on destruction.
   // If the |render_view_| is destroyed before the BrowserPlugin is destroyed
   // then we will attempt to access a NULL pointer.
   int render_view_routing_id_;
   WebKit::WebPluginContainer* container_;
   scoped_ptr<BrowserPluginBindings> bindings_;
   scoped_ptr<BrowserPluginBackingStore> backing_store_;
   TransportDIB* current_damage_buffer_;
@@ skipping 43 matching lines @@
   // the changes are not always obvious.  For example, there is a maximum
   // number of entries and earlier ones will automatically be pruned.
   int current_nav_entry_index_;
   int nav_entry_count_;
   DISALLOW_COPY_AND_ASSIGN(BrowserPlugin);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_