[DRAFT] Create RenderFrameHostManager.

content/browser/renderer_host/render_view_host_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_RENDERER_HOST_RENDER_VIEW_HOST_IMPL_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_VIEW_HOST_IMPL_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/process/kill.h"
 #include "content/browser/frame_host/render_frame_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/site_instance_impl.h"
 #include "content/common/accessibility_node_data.h"
 #include "content/common/drag_event_source_info.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/common/javascript_message_type.h"
+#include "content/public/common/page_transition_types.h"
 #include "content/public/common/window_container_type.h"
 #include "net/base/load_states.h"
 #include "third_party/WebKit/public/web/WebAXEnums.h"
 #include "third_party/WebKit/public/web/WebConsoleMessage.h"
 #include "third_party/WebKit/public/web/WebPopupType.h"
 #include "third_party/WebKit/public/web/WebTextDirection.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/base/window_open_disposition.h"
 
 class SkBitmap;
@@ skipping 19 matching lines @@
 
 namespace ui {
 struct SelectedFileInfo;
 }
 
 namespace content {
 
 class BrowserMediaPlayerManager;
 class ChildProcessSecurityPolicyImpl;
 class PageState;
-class RenderFrameHostImpl;
 class RenderWidgetHostDelegate;
 class SessionStorageNamespace;
 class SessionStorageNamespaceImpl;
 class TestRenderViewHost;
 struct ContextMenuParams;
 struct FileChooserParams;
 struct Referrer;
 struct ShowDesktopNotificationHostMsgParams;
 
 #if defined(COMPILER_MSVC)
@@ skipping 145 matching lines @@
                                          float y) OVERRIDE;
   virtual void RequestFindMatchRects(int current_version) OVERRIDE;
   virtual void DisableFullscreenEncryptedMediaPlayback() OVERRIDE;
 #endif
 
   void set_delegate(RenderViewHostDelegate* d) {
     CHECK(d);  // http://crbug.com/82827
     delegate_ = d;
   }
 
+  // Map renderer-specific frame IDs to browser-global FrameTreeNode IDs.
+  // TODO(creis): Unregister as well.  Think about where this map belongs.
+  void RegisterFrameTreeNodeID(int64 frame_id, int64 frame_tree_node_id);
+  bool HasFrameTreeNodeID(int64 frame_id) const;
+  int64 GetFrameTreeNodeID(int64 frame_id);
+
   // Set up the RenderView child process. Virtual because it is overridden by
   // TestRenderViewHost. If the |frame_name| parameter is non-empty, it is used
   // as the name of the new top-level frame.
   // The |opener_route_id| parameter indicates which RenderView created this
   // (MSG_ROUTING_NONE if none). If |max_page_id| is larger than -1, the
   // RenderView is told to start issuing page IDs at |max_page_id| + 1.
   virtual bool CreateRenderView(const string16& frame_name,
                                 int opener_route_id,
                                 int32 max_page_id);
 
@@ skipping 44 matching lines @@
   // page, making it unsafe to show the pending URL.  Always false after the
   // first commit.
   bool has_accessed_initial_document() {
     return has_accessed_initial_document_;
   }
 
   // Whether this RenderViewHost has been swapped out to be displayed by a
   // different process.
   bool is_swapped_out() const { return is_swapped_out_; }
 
+  // Called on the pending RenderViewHost when the network response is ready to
+  // commit.  We should ensure that the old RenderViewHost runs its unload
+  // handler and determine whether a transfer to a different RenderViewHost is
+  // needed.
+  // TODO(creis): This should happen on RenderFrameHost.
+  void OnCrossSiteResponse(
+      const GlobalRequestID& global_request_id,
+      bool is_transfer,
+      const std::vector<GURL>& transfer_url_chain,
+      const Referrer& referrer,
+      PageTransition page_transition,
+      int64 frame_id);
+
   // Tells the renderer that this RenderView is being swapped out for one in a
   // different renderer process.  It should run its unload handler and move to
   // a blank document.  The renderer should preserve the Frame object until it
   // exits, in case we come back.  The renderer can exit if it has no other
   // active RenderViews, but not until WasSwappedOut is called (when it is no
   // longer visible).
   void SwapOut();
 
   // Called when either the SwapOut request has been acknowledged or has timed
   // out.
@@ skipping 99 matching lines @@
 
   // User rotated the screen. Calls the "onorientationchange" Javascript hook.
   void SendOrientationChangeEvent(int orientation);
 
   // Sets a bit indicating whether the RenderView is responsible for displaying
   // a subframe in a different process from its parent page.
   void set_is_subframe(bool is_subframe) {
     is_subframe_ = is_subframe;
   }
 
-  int64 main_frame_id() const {
-    return main_frame_id_;
-  }
-
   // Set the opener to null in the renderer process.
   void DisownOpener();
 
   // Turn on accessibility testing. The given callback will be run
   // every time an accessibility notification is received from the
   // renderer process, and the accessibility tree it sent can be
   // retrieved using accessibility_tree_for_testing().
   void SetAccessibilityCallbackForTesting(
       const base::Callback<void(WebKit::WebAXEvent)>& callback);
 
@@ skipping 27 matching lines @@
   bool CanCommitURL(const GURL& url);
 
   // Checks that the given renderer can request |url|, if not it sets it to
   // about:blank.
   // empty_allowed must be set to false for navigations for security reasons.
   static void FilterURL(ChildProcessSecurityPolicyImpl* policy,
                         const RenderProcessHost* process,
                         bool empty_allowed,
                         GURL* url);
 
-  // Update the FrameTree to use this RenderViewHost's main frame
-  // RenderFrameHost. Called when the RenderViewHost is committed.
-  //
-  // TODO(ajwong): Remove once RenderViewHost no longer owns the main frame
-  // RenderFrameHost.
-  void AttachToFrameTree();
-
   // The following IPC handlers are public so RenderFrameHost can call them,
   // while we transition the code to not use RenderViewHost.
   //
   // TODO(nasko): Remove those methods once we are done moving navigation
   // into RenderFrameHost.
   void OnDidStartProvisionalLoadForFrame(int64 frame_id,
                                          int64 parent_frame_id,
                                          bool main_frame,
                                          const GURL& url);
 
@@ skipping 103 matching lines @@
   void OnCancelDesktopNotification(int notification_id);
   void OnRunFileChooser(const FileChooserParams& params);
   void OnDidAccessInitialDocument();
   void OnDomOperationResponse(const std::string& json_string,
                               int automation_id);
 
 #if defined(OS_MACOSX) || defined(OS_ANDROID)
   void OnShowPopup(const ViewHostMsg_ShowPopup_Params& params);
 #endif
 
-  // TODO(nasko): Remove this accessor once RenderFrameHost moves into the frame
-  // tree.
-  RenderFrameHostImpl* main_render_frame_host() const {
-    return main_render_frame_host_.get();
-  }
-
  private:
   friend class TestRenderViewHost;
   FRIEND_TEST_ALL_PREFIXES(RenderViewHostTest, BasicRenderFrameHost);
   FRIEND_TEST_ALL_PREFIXES(RenderViewHostTest, RoutingIdSane);
 
+  typedef base::hash_map<int64, int64> FrameIDMap;
+
   // Sets whether this RenderViewHost is swapped out in favor of another,
   // and clears any waiting state that is no longer relevant.
   void SetSwappedOut(bool is_swapped_out);
 
   bool CanAccessFilesOfPageState(const PageState& state) const;
 
-  // All RenderViewHosts must have a RenderFrameHost for its main frame.
-  // Currently the RenderFrameHost is created in lock step on construction
-  // and a pointer to the main frame is given to the FrameTreeNode
-  // when the RenderViewHost commits (see AttachToFrameTree()).
-  //
-  // TODO(ajwong): Make this reference non-owning. The root FrameTreeNode of
-  // the FrameTree should be responsible for owning the main frame's
-  // RenderFrameHost.
-  scoped_ptr<RenderFrameHostImpl> main_render_frame_host_;
-
   // Our delegate, which wants to know about changes in the RenderView.
   RenderViewHostDelegate* delegate_;
 
   // The SiteInstance associated with this RenderViewHost.  All pages drawn
   // in this RenderViewHost are part of this SiteInstance.  Should not change
   // over time.
   scoped_refptr<SiteInstanceImpl> instance_;
 
+  // Map of renderer-specific frame IDs to browser-global FrameTreeNode IDs.
+  FrameIDMap frame_id_map_;
+
   // true if we are currently waiting for a response for drag context
   // information.
   bool waiting_for_drag_context_response_;
 
   // A bitwise OR of bindings types that have been enabled for this RenderView.
   // See BindingsPolicy for details.
   int enabled_bindings_;
 
   // Whether we should buffer outgoing Navigate messages rather than sending
   // them.  This will be true when a RenderViewHost is created for a cross-site
@@ skipping 14 matching lines @@
   bool has_accessed_initial_document_;
 
   // Whether this RenderViewHost is currently swapped out, such that the view is
   // being rendered by another process.
   bool is_swapped_out_;
 
   // Whether this RenderView is responsible for displaying a subframe in a
   // different process from its parent page.
   bool is_subframe_;
 
-  // The frame id of the main (top level) frame. This value is set on the
-  // initial navigation of a RenderView and reset when the RenderView's
-  // process is terminated (in RenderProcessGone).
-  int64 main_frame_id_;
+  // Routing ID for the main frame's RenderFrameHost.
+  // TODO(creis): Does this need to be updated on a crash?
+  int main_frame_routing_id_;
 
   // If we were asked to RunModal, then this will hold the reply_msg that we
   // must return to the renderer to unblock it.
   IPC::Message* run_modal_reply_msg_;
   // This will hold the routing id of the RenderView that opened us.
   int run_modal_opener_id_;
 
   // Set to true when there is a pending ViewMsg_ShouldClose message.  This
   // ensures we don't spam the renderer with multiple beforeunload requests.
   // When either this value or is_waiting_for_unload_ack_ is true, the value of
@@ skipping 44 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(RenderViewHostImpl);
 };
 
 #if defined(COMPILER_MSVC)
 #pragma warning(pop)
 #endif
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_VIEW_HOST_IMPL_H_