Support window.opener after a process swap.

content/browser/renderer_host/render_view_host.h

 // Copyright (c) 2011 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_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_VIEW_HOST_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 142 matching lines @@
   // RenderViewHost.  This is called when a pending RenderViewHost is created
   // for a cross-site navigation, because we must suspend any navigations until
   // we hear back from the old renderer's onbeforeunload handler.  Note that it
   // is important that only one navigation event happen after calling this
   // method with |suspend| equal to true.  If |suspend| is false and there is
   // a suspended_nav_message_, this will send the message.  This function
   // should only be called to toggle the state; callers should check
   // are_navigations_suspended() first.
   void SetNavigationsSuspended(bool suspend);
 
+  // Clears any suspended navigation state after a cross-site navigation is
+  // canceled or suspended.  This is important if we later return to this
+  // RenderViewHost.
+  void CancelSuspendedNavigations();
+
+  // Whether this RenderViewHost has been swapped out to be displayed by a
+  // different process.
+  bool is_swapped_out() const { return is_swapped_out_; }
+
   // Causes the renderer to invoke the onbeforeunload event handler.  The
-  // result will be returned via ViewMsg_ShouldClose. See also ClosePage which
-  // will fire the PageUnload event.
+  // result will be returned via ViewMsg_ShouldClose. See also ClosePage and
+  // SwapOut, which fire the PageUnload event.
   //
   // Set bool for_cross_site_transition when this close is just for the current
   // RenderView in the case of a cross-site transition. False means we're
   // closing the entire tab.
   void FirePageBeforeUnload(bool for_cross_site_transition);
 
+  // Tells the renderer that this RenderView is being swapped out for one in a
+  // different renderer process.  The renderer should preserve the Frame object
+  // until it exits (when it has no more active RenderViews).
+  //
+  // Please see ViewMsg_SwapOut_Params in view_messages.h for a description
+  // of the parameters.
+  void SwapOut(int new_render_process_host_id, int new_request_id);
+
+  // Called by ResourceDispatcherHost after the SwapOutACK is received.
+  void OnSwapOutACK();
+
+  // Called to notify the RenderWidget that it has been visibly swapped out,

[Matt Perry, 2011/04/29 19:25:18]

RenderView

[Charlie Reis, 2011/05/05 15:17:59]

Done.

+  // such that it is safe for the process to exit if not otherwise in use.
+  void WasSwappedOut();

[Matt Perry, 2011/04/29 19:25:18]

I'm a little confused on the difference between SwapOut and WasSwappedOut. When
would one be called rather than the other? Could you clarify this in the
comments?

[Charlie Reis, 2011/05/05 15:17:59]

Done.

+
   // Causes the renderer to close the current page, including running its
   // onunload event handler.  A ClosePage_ACK message will be sent to the
   // ResourceDispatcherHost when it is finished.
-  //
-  // Please see ViewMsg_ClosePage in resource_messages_internal.h for a
-  // description of the parameters.
-  void ClosePage(bool for_cross_site_transition,
-                 int new_render_process_host_id,
-                 int new_request_id);
-
-  // Called by ResourceDispatcherHost after the ClosePageACK is received.
-  void OnClosePageACK(bool for_cross_site_transition);
+  void ClosePage();
 
   // Close the page ignoring whether it has unload events registers.
   // This is called after the beforeunload and unload events have fired
   // and the user has agreed to continue with closing the page.
   void ClosePageIgnoringUnloadEvents();
 
   // Sets whether this RenderViewHost has an outstanding cross-site request,
   // for which another renderer will need to run an onunload event handler.
   // This is called before the first navigation event for this RenderViewHost,
   // and again after the corresponding OnCrossSiteResponse.
@@ skipping 252 matching lines @@
                         GURL* url);
 
  protected:
   friend class RenderViewHostObserver;
 
   // Add and remove observers for filtering IPC messages.  Clients must be sure
   // to remove the observer before they go away.
   void AddObserver(RenderViewHostObserver* observer);
   void RemoveObserver(RenderViewHostObserver* observer);
 
+  // Filter out most IPC messages while swapped out, except for messages needed
+  // to preserve consistent browser and renderer state.
+  bool CanHandleWhileSwappedOut(const IPC::Message& msg);
+
   // RenderWidgetHost protected overrides.
   virtual bool PreHandleKeyboardEvent(const NativeWebKeyboardEvent& event,
                                       bool* is_keyboard_shortcut);
   virtual void UnhandledKeyboardEvent(const NativeWebKeyboardEvent& event);
   virtual void OnUserGesture();
   virtual void NotifyRendererUnresponsive();
   virtual void NotifyRendererResponsive();
   virtual void OnMsgFocusedNodeChanged(bool is_editable_node);
   virtual void OnMsgFocus();
   virtual void OnMsgBlur();
@@ skipping 46 matching lines @@
                           const gfx::Point& image_offset);
   void OnUpdateDragCursor(WebKit::WebDragOperation drag_operation);
   void OnTakeFocus(bool reverse);
   void OnAddMessageToConsole(int32 level,
                              const std::wstring& message,
                              int32 line_no,
                              const std::wstring& source_id);
   void OnUpdateInspectorSetting(const std::string& key,
                                 const std::string& value);
   void OnMsgShouldCloseACK(bool proceed);
+  void OnMsgClosePageACK();
 
   void OnAccessibilityNotifications(
       const std::vector<ViewHostMsg_AccessibilityNotification_Params>& params);
   void OnCSSInserted();
   void OnContentBlocked(ContentSettingsType type,
                         const std::string& resource_identifier);
   void OnAppCacheAccessed(const GURL& manifest_url, bool blocked_by_policy);
   void OnWebDatabaseAccessed(const GURL& url,
                              const string16& name,
                              const string16& display_name,
@@ skipping 42 matching lines @@
   // request, until we hear back from the onbeforeunload handler of the old
   // RenderViewHost.
   bool navigations_suspended_;
 
   // We only buffer a suspended navigation message while we a pending RVH for a
   // TabContents.  There will only ever be one suspended navigation, because
   // TabContents will destroy the pending RVH and create a new one if a second
   // navigation occurs.
   scoped_ptr<ViewMsg_Navigate> suspended_nav_message_;
 
+  // Whether this RenderViewHost is currently swapped out, such that the view is
+  // being rendered by another process.
+  bool is_swapped_out_;
+
   // 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_;
 
   // 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
   // unload_ack_is_for_cross_site_transition_ indicates whether this is for a
   // cross-site transition or a tab close attempt.
   bool is_waiting_for_beforeunload_ack_;
@@ skipping 32 matching lines @@
   // The enabled/disabled states of various commands.
   std::map<RenderViewCommand, CommandState> command_states_;
 
   // A list of observers that filter messages.  Weak references.
   ObserverList<RenderViewHostObserver> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderViewHost);
 };
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_VIEW_HOST_H_