Prepare RenderFrameProxy for mirroring the frame tree

content/renderer/render_frame_proxy.cc

 // Copyright 2014 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.
 
 #include "content/renderer/render_frame_proxy.h"
 
 #include <map>
 
 #include "base/lazy_instance.h"
 #include "content/common/frame_messages.h"
 #include "content/common/swapped_out_messages.h"
 #include "content/renderer/child_frame_compositing_helper.h"
 #include "content/renderer/render_frame_impl.h"
 #include "content/renderer/render_thread_impl.h"
 #include "content/renderer/render_view_impl.h"
 #include "third_party/WebKit/public/web/WebView.h"
 
 namespace content {
 
 namespace {
 
+// Facilitates lookup of RenderFrameProxy by routing_id.
 typedef std::map<int, RenderFrameProxy*> RoutingIDProxyMap;
 static base::LazyInstance<RoutingIDProxyMap> g_routing_id_proxy_map =
     LAZY_INSTANCE_INITIALIZER;
 
+// Facilitates lookup of RenderFrameProxy by WebFrame.
+typedef std::map<blink::WebFrame*, RenderFrameProxy*> FrameMap;
+base::LazyInstance<FrameMap> g_frame_map = LAZY_INSTANCE_INITIALIZER;
+
 }  // namespace
 
 // static
-RenderFrameProxy* RenderFrameProxy::CreateFrameProxy(int routing_id,
-                                                     int frame_routing_id) {
-  DCHECK_NE(routing_id, MSG_ROUTING_NONE);
-  RenderFrameProxy* proxy = new RenderFrameProxy(routing_id, frame_routing_id);
-  return proxy;
+RenderFrameProxy* RenderFrameProxy::CreateProxyToReplaceFrame(
+    int routing_id,
+    int frame_routing_id) {

[dcheng, 2014/07/15 18:44:14]

Is there any particular reason to use a routing ID for the render frame that's
being replaced? It looks like in render_frame_impl.cc:943 we pass in the routing
ID for 'this', but then on line 43 we reconstitute the RenderFrameImpl from the
routing ID.

[ncarter (slow), 2014/07/16 01:13:52]

Good suggestion. Done.

+  CHECK_NE(routing_id, MSG_ROUTING_NONE);
+  CHECK_NE(frame_routing_id, MSG_ROUTING_NONE);
+
+  scoped_ptr<RenderFrameProxy> proxy(
+      new RenderFrameProxy(routing_id, frame_routing_id));
+  RenderFrameImpl* render_frame =
+      RenderFrameImpl::FromRoutingID(frame_routing_id);
+  CHECK(render_frame);
+#if 0
+  // TODO(nick): Enable this code when we're ready to create WebRemoteFrames.
+  blink::WebRemoteFrame* web_frame = NULL;
+  if (render_frame->GetWebFrame()->parent() &&
+      render_frame->GetWebFrame()->parent()->isWebRemoteFrame()) {
+    blink::WebRemoteFrame* parent_web_frame =
+        render_frame->GetWebFrame()->parent()->toWebRemoteFrame();
+    web_frame = parent_web_frame->createRemoteChild("", proxy.get());

[dcheng, 2014/07/15 18:44:14]

Could we pre-emptively plumb the frame name through here?

[ncarter (slow), 2014/07/16 01:13:52]

Since this is #if 0'ed code, I have no way to test it. let's try this in a
future patch.

+  } else {
+    web_frame = blink::WebRemoteFrame::create(proxy.get());
+  }
+#else
+  blink::WebFrame* web_frame = render_frame->GetWebFrame();
+#endif
+  proxy->Init(web_frame, render_frame->render_view());
+  return proxy.release();
+}
+
+RenderFrameProxy* RenderFrameProxy::CreateFrameProxy(
+    int routing_id,
+    int parent_routing_id,
+    int render_view_routing_id) {

[dcheng, 2014/07/15 18:44:14]

Similar question: can/should we pass in a RemoteFrameProxy/RenderView directly
here rather than using the ::FromRoutingID() functions to reconstitute it below?

[ncarter (slow), 2014/07/16 01:13:52]

The code that calls this just has raw IDs from an IPC, so I think it's fine to
pass these as ints. However, I fixed the other case though.

+  scoped_ptr<RenderFrameProxy> proxy(
+      new RenderFrameProxy(routing_id, MSG_ROUTING_NONE));
+  RenderViewImpl* render_view = NULL;
+  blink::WebRemoteFrame* web_frame = NULL;
+  if (parent_routing_id == MSG_ROUTING_NONE) {
+    // Create a top level frame.
+    render_view = RenderViewImpl::FromRoutingID(render_view_routing_id);
+    web_frame = blink::WebRemoteFrame::create(proxy.get());
+    render_view->webview()->setMainFrame(web_frame);
+  } else {
+    // Create a frame under an existing parent. The parent is always expected to
+    // be a RenderFrameProxy, because navigations initiated by local frames
+    // should not wind up here.
+    RenderFrameProxy* parent =
+        RenderFrameProxy::FromRoutingID(parent_routing_id);
+    CHECK(parent);
+    CHECK(parent->web_frame()->isWebRemoteFrame());
+    web_frame = parent->web_frame()->toWebRemoteFrame()->createRemoteChild(
+        "", proxy.get());
+    render_view = parent->render_view();
+  }
+
+  proxy->Init(web_frame, render_view);
+
+  return proxy.release();
 }
 
 // static
 RenderFrameProxy* RenderFrameProxy::FromRoutingID(int32 routing_id) {
   RoutingIDProxyMap* proxies = g_routing_id_proxy_map.Pointer();
   RoutingIDProxyMap::iterator it = proxies->find(routing_id);
   return it == proxies->end() ? NULL : it->second;
 }
 
+// static
+RenderFrameProxy* RenderFrameProxy::FromWebFrame(blink::WebFrame* web_frame) {
+  FrameMap::iterator iter = g_frame_map.Get().find(web_frame);
+  if (iter != g_frame_map.Get().end()) {
+    RenderFrameProxy* proxy = iter->second;
+    DCHECK_EQ(web_frame, proxy->web_frame());
+    return proxy;
+  }
+  return NULL;
+}
+
 RenderFrameProxy::RenderFrameProxy(int routing_id, int frame_routing_id)
     : routing_id_(routing_id),
-      frame_routing_id_(frame_routing_id) {
+      frame_routing_id_(frame_routing_id),
+      web_frame_(NULL),
+      render_view_(NULL) {
   std::pair<RoutingIDProxyMap::iterator, bool> result =
-    g_routing_id_proxy_map.Get().insert(std::make_pair(routing_id_, this));
+      g_routing_id_proxy_map.Get().insert(std::make_pair(routing_id_, this));
   CHECK(result.second) << "Inserting a duplicate item.";
   RenderThread::Get()->AddRoute(routing_id_, this);
-
-  render_frame_ = RenderFrameImpl::FromRoutingID(frame_routing_id);
-  CHECK(render_frame_);
-  render_frame_->render_view()->RegisterRenderFrameProxy(this);
 }
 
 RenderFrameProxy::~RenderFrameProxy() {
-  render_frame_->render_view()->UnregisterRenderFrameProxy(this);
+  render_view()->UnregisterRenderFrameProxy(this);
+
+  FrameMap::iterator it = g_frame_map.Get().find(web_frame_);
+  CHECK(it != g_frame_map.Get().end());
+  CHECK_EQ(it->second, this);
+  g_frame_map.Get().erase(it);
+
   RenderThread::Get()->RemoveRoute(routing_id_);
   g_routing_id_proxy_map.Get().erase(routing_id_);
+
+  // TODO(nick): Call close unconditionally when web_frame() is always remote.
+  if (web_frame()->isWebRemoteFrame())
+    web_frame()->close();
 }
 
-blink::WebFrame* RenderFrameProxy::GetWebFrame() {
-  return render_frame_->GetWebFrame();
+void RenderFrameProxy::Init(blink::WebFrame* web_frame,
+                            RenderViewImpl* render_view) {
+  CHECK(web_frame);
+  CHECK(render_view);
+
+  web_frame_ = web_frame;
+  render_view_ = render_view;
+
+  // TODO(nick): Should all RenderFrameProxies remain observers of their views?
+  render_view_->RegisterRenderFrameProxy(this);
+
+  std::pair<FrameMap::iterator, bool> result =
+      g_frame_map.Get().insert(std::make_pair(web_frame_, this));
+  CHECK(result.second) << "Inserted a duplicate item.";
 }
 
 void RenderFrameProxy::DidCommitCompositorFrame() {
   if (compositing_helper_)
     compositing_helper_->DidCommitCompositorFrame();
 }
 
 bool RenderFrameProxy::OnMessageReceived(const IPC::Message& msg) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(RenderFrameProxy, msg)
     IPC_MESSAGE_HANDLER(FrameMsg_DeleteProxy, OnDeleteProxy)
     IPC_MESSAGE_HANDLER(FrameMsg_ChildFrameProcessGone, OnChildFrameProcessGone)
     IPC_MESSAGE_HANDLER(FrameMsg_BuffersSwapped, OnBuffersSwapped)
     IPC_MESSAGE_HANDLER_GENERIC(FrameMsg_CompositorFrameSwapped,
                                 OnCompositorFrameSwapped(msg))
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
 
-  if (!handled)
-    return render_frame_->OnMessageReceived(msg);
+  RenderFrameImpl* render_frame =
+      RenderFrameImpl::FromRoutingID(frame_routing_id_);
+  if (!handled && render_frame)
+    return render_frame->OnMessageReceived(msg);
 
   return handled;
 }
 
 bool RenderFrameProxy::Send(IPC::Message* message) {
   if (!SwappedOutMessages::CanSendWhileSwappedOut(message)) {
     delete message;
     return false;
   }
   message->set_routing_id(routing_id_);
   return RenderThread::Get()->Send(message);
 }
 
 void RenderFrameProxy::OnDeleteProxy() {
   RenderFrameImpl* render_frame =
       RenderFrameImpl::FromRoutingID(frame_routing_id_);
-  CHECK(render_frame);
-  render_frame->set_render_frame_proxy(NULL);
+
+  if (render_frame)
+    render_frame->set_render_frame_proxy(NULL);
 
   delete this;
 }
 
 void RenderFrameProxy::OnChildFrameProcessGone() {
   if (compositing_helper_)
     compositing_helper_->ChildFrameGone();
 }
 
 void RenderFrameProxy::OnBuffersSwapped(
     const FrameMsg_BuffersSwapped_Params& params) {
-  if (!compositing_helper_.get()) {
+  if (!compositing_helper_) {
     compositing_helper_ =
-        ChildFrameCompositingHelper::CreateCompositingHelperForRenderFrame(
-            GetWebFrame(), this, routing_id_);
+        ChildFrameCompositingHelper::CreateForRenderFrameProxy(this);
     compositing_helper_->EnableCompositing(true);
   }
   compositing_helper_->OnBuffersSwapped(
       params.size,
       params.mailbox,
       params.gpu_route_id,
       params.gpu_host_id,
-      render_frame_->render_view()->GetWebView()->deviceScaleFactor());
+      web_frame()->view()->deviceScaleFactor());
 }
 
 void RenderFrameProxy::OnCompositorFrameSwapped(const IPC::Message& message) {
   FrameMsg_CompositorFrameSwapped::Param param;
   if (!FrameMsg_CompositorFrameSwapped::Read(&message, &param))
     return;
 
   scoped_ptr<cc::CompositorFrame> frame(new cc::CompositorFrame);
   param.a.frame.AssignTo(frame.get());
 
-  if (!compositing_helper_.get()) {
+  if (!compositing_helper_) {
     compositing_helper_ =
-        ChildFrameCompositingHelper::CreateCompositingHelperForRenderFrame(
-            GetWebFrame(), this, routing_id_);
+        ChildFrameCompositingHelper::CreateForRenderFrameProxy(this);
     compositing_helper_->EnableCompositing(true);
   }
   compositing_helper_->OnCompositorFrameSwapped(frame.Pass(),
                                                 param.a.producing_route_id,
                                                 param.a.output_surface_id,
                                                 param.a.producing_host_id,
                                                 param.a.shared_memory_handle);
 }
 
 }  // namespace