Browser Plugin: New Implementation (Browser Side)

content/browser/web_contents/web_contents_impl.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_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
 #define CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
 
 #include <map>
 #include <string>
 
@@ skipping 20 matching lines @@
 #include "base/win/scoped_handle.h"
 #endif
 
 class InterstitialPageImpl;
 class SavePackage;
 class SessionStorageNamespaceImpl;
 class WebContentsImpl;
 struct ViewMsg_PostMessage_Params;
 
 namespace content {
+class BrowserPluginEmbedder;
+class BrowserPluginGuest;
 class ColorChooser;
 class DownloadItem;
 class JavaScriptDialogCreator;
 class RenderViewHost;
 class RenderViewHostDelegateView;
 class RenderViewHostImpl;
 class SiteInstance;
 class TestWebContents;
 class WebContentsDelegate;
 class WebContentsObserver;
@@ skipping 103 matching lines @@
     return java_bridge_dispatcher_host_manager_.get();
   }
 
   content::old::BrowserPluginHost* old_browser_plugin_host() const {
     return old_browser_plugin_host_.get();
   }
 
   // Expose the render manager for testing.
   RenderViewHostManager* GetRenderManagerForTesting();
 
+  // Sets guest to this WebContents embedder.

[awong, 2012/09/06 00:23:27]

I expect a SetXXX() function to take an object that gets put into a member
variable and to be symmetrical with the GetXXX functions.

But this function seems to be creating the guest.  Is it more like
AssignBrowserPluingGuest?

The comment also doesn't quite explain the functionality. BTW, is it okay to
call this function twice?

[lazyboy, 2012/09/06 04:33:53]

Renamed the function.
There should be no side effect calling it > 1. We don't expect it to be called
more than once for a given web_contents though.

[awong, 2012/09/06 19:55:26]

Ah, I see.  Though looking at this more, this seems like it should be a
construction. A WebContents never switches between being a guest, and being
{normal,embedder}.

What about making a WebContents::CreateGuest() constructor?  You wouldn't even
need the base_web_contents and could move the messy custom SiteInstance creation
logic into there so you just take the host's GURL.

[lazyboy, 2012/09/07 19:33:19]

Embedder and guest can be seen as roles A WC can play, it can have none, any or
both role in theory.
A guest can be an embedder that way, although for first cut we will disable
recursive embedding.
+1, So to be clear, we would have:
gwc = WebContentsImpl* WebContentsImpl::CreateGuest(
    BrowserContext*, string& url, int guest_instance_id);
remove function WebContentsImpl::Assign/SetBrowserPluginGuest()
work with gwc->GetBrowserPluginGuest() in embedder.
?
I can do the change.

[awong, 2012/09/07 20:51:03]

Yep. I think constructing the right state from the get go makes a class of
possible problems impossible. :)

[lazyboy, 2012/09/08 02:12:22]

Done.

+  content::BrowserPluginGuest* SetBrowserPluginGuest(int instance_id);
+  // Returns guest browser plugin object, or NULL if this WebContents is not a
+  // guest.
+  content::BrowserPluginGuest* GetBrowserPluginGuest();
+  // Returns embedder browser plugin object, or NULL if this WebContents is not
+  // an embedder.
+  content::BrowserPluginEmbedder* GetBrowserPluginEmbedder();
+
   // content::WebContents ------------------------------------------------------
   virtual content::WebContentsDelegate* GetDelegate() OVERRIDE;
   virtual void SetDelegate(content::WebContentsDelegate* delegate) OVERRIDE;
   virtual NavigationControllerImpl& GetController() OVERRIDE;
   virtual const NavigationControllerImpl& GetController() const OVERRIDE;
   virtual content::BrowserContext* GetBrowserContext() const OVERRIDE;
   virtual content::RenderProcessHost* GetRenderProcessHost() const OVERRIDE;
   virtual content::RenderViewHost* GetRenderViewHost() const OVERRIDE;
   virtual int GetRoutingID() const OVERRIDE;
   virtual content::RenderWidgetHostView*
@@ skipping 361 matching lines @@
   void OnSetSelectedColorInColorChooser(int color_chooser_id, SkColor color);
   void OnPepperPluginHung(int plugin_child_id,
                           const FilePath& path,
                           bool is_hung);
   void OnWebUISend(const GURL& source_url,
                    const std::string& name,
                    const base::ListValue& args);
   void OnRequestPpapiBrokerPermission(int request_id,
                                       const GURL& url,
                                       const FilePath& plugin_path);
+  void OnBrowserPluginNavigateGuest(int instance_id,
+                                    int64 frame_id,
+                                    std::string src,

[awong, 2012/09/06 00:23:27]

Use a const std::string&?

[lazyboy, 2012/09/06 04:33:53]

Done.

+                                    gfx::Size size);
 
   // Changes the IsLoading state and notifies delegate as needed
   // |details| is used to provide details on the load that just finished
   // (but can be null if not applicable). Can be overridden.
   void SetIsLoading(bool is_loading,
                     content::LoadNotificationDetails* details);
 
   // Called by derived classes to indicate that we're no longer waiting for a
   // response. This won't actually update the throbber, but it will get picked
   // up at the next animation step if the throbber is going.
@@ skipping 85 matching lines @@
   void SaveURL(const GURL& url,
                const content::Referrer& referrer,
                bool is_main_frame);
 
   content::RenderViewHostImpl* GetRenderViewHostImpl();
 
   void GetBrowserPluginEmbedderInfo(content::RenderViewHost* render_view_host,
                                     std::string* embedder_channel_name,
                                     int* embedder_container_id);
 
+  // Removes browser plugin embedder if there is one and its associated
+  // RenderViewHost has been swapped out.
+  void RemoveSwappedOutBrowserPluginEmbedder();
+
   // Data for core operation ---------------------------------------------------
 
   // Delegate for notifying our owner about stuff. Not owned by us.
   content::WebContentsDelegate* delegate_;
 
   // Handles the back/forward list and loading.
   NavigationControllerImpl controller_;
 
   // The corresponding view.
   scoped_ptr<content::WebContentsView> view_;
@@ skipping 27 matching lines @@
 
   // Manages creation and swapping of render views.
   RenderViewHostManager render_manager_;
 
   // Manages injecting Java objects into all RenderViewHosts associated with
   // this WebContentsImpl.
   scoped_ptr<JavaBridgeDispatcherHostManager>
       java_bridge_dispatcher_host_manager_;
 
   // TODO(fsamuel): Remove this once upstreaming of the new browser plugin
-  // implmentation is complete.
+  // implementation is complete.
   // Manages the browser plugin instances hosted by this WebContents.
   scoped_ptr<content::old::BrowserPluginHost> old_browser_plugin_host_;
 
   // SavePackage, lazily created.
   scoped_refptr<SavePackage> save_package_;
 
   // Data for loading state ----------------------------------------------------
 
   // Indicates whether we're currently loading a resource.
   bool is_loading_;
@@ skipping 98 matching lines @@
   // The intrinsic size of the page.
   gfx::Size preferred_size_;
 
   // Content restrictions, used to disable print/copy etc based on content's
   // (full-page plugins for now only) permissions.
   int content_restrictions_;
 
   // Color chooser that was opened by this tab.
   content::ColorChooser* color_chooser_;
 
+  // Manages the embedder state for browser plugins, if this WebContents is an
+  // embedder; NULL otherwise.
+  scoped_ptr<content::BrowserPluginEmbedder> browser_plugin_embedder_;
+  // Manages the guest state for browser plugin, if this WebContents is a guest;
+  // NULL otherwise.
+  scoped_ptr<content::BrowserPluginGuest> browser_plugin_guest_;
+
   // This must be at the end, or else we might get notifications and use other
   // member variables that are gone.
   content::NotificationRegistrar registrar_;
 
   // Used during IPC message dispatching so that the handlers can get a pointer
   // to the RVH through which the message was received.
   content::RenderViewHost* message_source_;
 
   DISALLOW_COPY_AND_ASSIGN(WebContentsImpl);
 };
 
 #endif  // CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_