Initialize BrowserPluginGuest to attach to the View hierarchy

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 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. Any
 // messages about the guest render process that the embedder might be interested
@@ skipping 28 matching lines @@
 #include "ui/gfx/rect.h"
 
 class SkBitmap;
 struct BrowserPluginHostMsg_Attach_Params;
 struct BrowserPluginHostMsg_ResizeGuest_Params;
 struct FrameHostMsg_CompositorFrameSwappedACK_Params;
 struct FrameHostMsg_ReclaimCompositorResources_Params;
 #if defined(OS_MACOSX)
 struct FrameHostMsg_ShowPopup_Params;
 #endif
+struct FrameMsg_CompositorFrameSwapped_Params;

[Charlie Reis, 2014/12/04 22:16:52]

Style nit: I think the ifdef'd structs are supposed to come in a separate block,
rather than alphabetized in the main block.  See the "Exception" note in:
http://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Names_and_Ord...

[Fady Samuel, 2014/12/05 00:56:30]

Done.

 
 namespace blink {
 class WebInputEvent;
 }  // namespace blink
 
 namespace cc {
 class CompositorFrame;
 }  // namespace cc
 
 namespace gfx {
@@ skipping 60 matching lines @@
 
   // Creates a new guest WebContentsImpl with the provided |params| with |this|
   // as the |opener|.
   WebContentsImpl* CreateNewGuestWindow(
       const WebContents::CreateParams& params);
 
   // Returns the identifier that uniquely identifies a browser plugin guest
   // within an embedder.
   int browser_plugin_instance_id() const { return browser_plugin_instance_id_; }
 
+  void Init();

[Charlie Reis, 2014/12/04 22:16:52]

Perhaps this should be closer to Create?  Can you add a comment about when it is
expected to be called?

[Fady Samuel, 2014/12/05 00:56:30]

I moved it right below the constructor.

+
   bool OnMessageReceivedFromEmbedder(const IPC::Message& message);
 
   WebContentsImpl* embedder_web_contents() const {
     return attached_ ? owner_web_contents_ : NULL;
   }
 
   // Returns the embedder's RenderWidgetHostView if it is available.
   // Returns NULL otherwise.
   RenderWidgetHostView* GetOwnerRenderWidgetHostView();
 
@@ skipping 70 matching lines @@
   class EmbedderVisibilityObserver;
 
   // BrowserPluginGuest is a WebContentsObserver of |web_contents| and
   // |web_contents| has to stay valid for the lifetime of BrowserPluginGuest.
   BrowserPluginGuest(bool has_render_view,
                      WebContentsImpl* web_contents,
                      BrowserPluginGuestDelegate* delegate);
 
   void WillDestroy();
 
-  void Initialize(int browser_plugin_instance_id,
-                  const BrowserPluginHostMsg_Attach_Params& params,
-                  WebContentsImpl* embedder_web_contents);
+  void InitInternal(const BrowserPluginHostMsg_Attach_Params& params,
+                    WebContentsImpl* owner_web_contents);
 
   bool InAutoSizeBounds(const gfx::Size& size) const;
 
   // Message handlers for messages from embedder.
   void OnCompositorFrameSwappedACK(
       int instance_id,
       const FrameHostMsg_CompositorFrameSwappedACK_Params& params);
   void OnDetach(int instance_id);
   // Handles drag events from the embedder.
   // When dragging, the drag events go to the embedder first, and if the drag
@@ skipping 13 matching lines @@
   void OnReclaimCompositorResources(
       int instance_id,
       const FrameHostMsg_ReclaimCompositorResources_Params& params);
 
   void OnLockMouse(bool user_gesture,
                    bool last_unlocked_by_target,
                    bool privileged);
   void OnLockMouseAck(int instance_id, bool succeeded);
   // Resizes the guest's web contents.
   void OnResizeGuest(
-      int instance_id, const BrowserPluginHostMsg_ResizeGuest_Params& params);
+      int browser_plugin_instance_id,
+      const BrowserPluginHostMsg_ResizeGuest_Params& params);
   void OnSetFocus(int instance_id, bool focused);
   // Sets the name of the guest so that other guests in the same partition can
   // access it.
   void OnSetName(int instance_id, const std::string& name);
   // Updates the size state of the guest.
   void OnSetEditCommandsForNextKeyEvent(
       int instance_id,
       const std::vector<EditCommand>& edit_commands);
   // 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
@@ skipping 85 matching lines @@
   // maintains a JavaScript reference to its opener.
   bool has_render_view_;
 
   // Last seen size of guest contents (by SwapCompositorFrame).
   gfx::Size last_seen_view_size_;
   // Last seen size of BrowserPlugin (by OnResizeGuest).
   gfx::Size last_seen_browser_plugin_size_;
 
   bool is_in_destruction_;
 
+  // BrowserPluginGuest::Init can only be called once. This flag allows it to
+  // exit early if it's already been called.
+  bool initialized_;
+
   // Text input type states.
   ui::TextInputType last_text_input_type_;
   ui::TextInputMode last_input_mode_;
   int last_input_flags_;
   bool last_can_compose_inline_;
 
   // The is the routing ID for a swapped out RenderView for the guest
   // WebContents in the embedder's process.
   int guest_proxy_routing_id_;
 
+  // Guests generate frames and send a CompositorFrameSwapped (CFS) message
+  // indicating the next frame is ready to be positioned and composited.
+  // Subsequent frames are not generated until the IPC is ACKed. We would like
+  // to ensure that the guest generates frames on attachment so we directly ACK
+  // an unACKed CFS. ACKs could get lost between the time a guest is detached
+  // from a container and the time it is attached elsewhere. This mitigates this
+  // race by ensuring the guest is ACKed on attachment.
+  scoped_ptr<FrameMsg_CompositorFrameSwapped_Params> pending_frame_;
+
   // This is a queue of messages that are destined to be sent to the embedder
   // once the guest is attached to a particular embedder.
   std::deque<linked_ptr<IPC::Message> > pending_messages_;
 
   BrowserPluginGuestDelegate* const delegate_;
 
   // Weak pointer used to ask GeolocationPermissionContext about geolocation
   // permission.
   base::WeakPtrFactory<BrowserPluginGuest> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowserPluginGuest);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_GUEST_H_