Prerender/Instant interopability.

chrome/browser/instant/instant_loader.cc

 // 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.
 
 #include "chrome/browser/instant/instant_loader.h"
 
 #include <algorithm>
 #include <string>
 #include <utility>
 #include <vector>
@@ skipping 17 matching lines @@
 #include "chrome/common/render_messages.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/browser/renderer_host/render_widget_host.h"
 #include "content/browser/renderer_host/render_widget_host_view.h"
 #include "content/browser/tab_contents/navigation_controller.h"
 #include "content/browser/tab_contents/navigation_entry.h"
 #include "content/browser/tab_contents/provisional_load_details.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/browser/tab_contents/tab_contents_delegate.h"
 #include "content/browser/tab_contents/tab_contents_view.h"
+#include "content/common/content_constants.h"
 #include "content/common/notification_details.h"
 #include "content/common/notification_observer.h"
 #include "content/common/notification_registrar.h"
 #include "content/common/notification_service.h"
 #include "content/common/notification_source.h"
 #include "content/common/notification_type.h"
 #include "content/common/page_transition_types.h"
 #include "content/common/renderer_preferences.h"
 #include "net/http/http_util.h"
 #include "ui/base/l10n/l10n_util.h"
@@ skipping 88 matching lines @@
     default:
       NOTREACHED();
       break;
   }
 }
 
 // TabContentsDelegateImpl -----------------------------------------------------
 
 class InstantLoader::TabContentsDelegateImpl
     : public TabContentsDelegate,
+      public TabContentsWrapperDelegate,
       public NotificationObserver,
       public TabContentsObserver,
       public DownloadTabHelperDelegate {
  public:
   explicit TabContentsDelegateImpl(InstantLoader* loader);
 
   // Invoked prior to loading a new URL.
   void PrepareForNewLoad();
 
   // Invoked when the preview paints. Invokes PreviewPainted on the loader.
@@ skipping 56 matching lines @@
   // move around.
   virtual void DragEnded() OVERRIDE;
   virtual void HandleMouseUp() OVERRIDE;
   virtual void HandleMouseActivate() OVERRIDE;
   virtual bool OnGoToEntryOffset(int offset) OVERRIDE;
   virtual bool ShouldAddNavigationToHistory(
       const history::HistoryAddPageArgs& add_page_args,
       NavigationType::Type navigation_type) OVERRIDE;
   virtual bool ShouldShowHungRendererDialog() OVERRIDE;
 
+  // TabContentsWrapperDelegate:
+  virtual void SwapTabContents(TabContentsWrapper* old_tc,
+                               TabContentsWrapper* new_tc) OVERRIDE;
+
   // TabContentsObserver:
   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 
   // DownloadTabHelperDelegate:
   virtual bool CanDownload(int request_id) OVERRIDE;
   virtual void OnStartDownload(DownloadItem* download,
                                TabContentsWrapper* tab) OVERRIDE;
 
  private:
   typedef std::vector<scoped_refptr<history::HistoryAddPageArgs> >
@@ skipping 311 matching lines @@
   return false;
 }
 
 bool InstantLoader::TabContentsDelegateImpl::ShouldShowHungRendererDialog() {
   // If we allow the hung renderer dialog to be shown it'll gain focus,
   // stealing focus from the omnibox causing instant to be cancelled. Return
   // false so that doesn't happen.
   return false;
 }
 
+// If this is being called, something is swapping in to our preview_contents_
+// before we've added it to the tab strip.
+void InstantLoader::TabContentsDelegateImpl::SwapTabContents(
+    TabContentsWrapper* old_tc,
+    TabContentsWrapper* new_tc) {
+  loader_->ReplacePreviewContents(old_tc, new_tc);
+}
+
+
 bool InstantLoader::TabContentsDelegateImpl::OnMessageReceived(
     const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(TabContentsDelegateImpl, message)
     IPC_MESSAGE_HANDLER(ViewHostMsg_SetSuggestions, OnSetSuggestions)
     IPC_MESSAGE_HANDLER(ViewHostMsg_InstantSupportDetermined,
                         OnInstantSupportDetermined)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
@@ skipping 421 matching lines @@
 
   if (preview_contents_.get() && is_showing_instant() &&
       (force_if_waiting || !is_waiting_for_load())) {
     last_omnibox_bounds_ = omnibox_bounds_;
     RenderViewHost* host = preview_contents_->render_view_host();
     host->Send(new ViewMsg_SearchBoxResize(
         host->routing_id(), GetOmniboxBoundsInTermsOfPreview()));
   }
 }
 
-void InstantLoader::CreatePreviewContents(TabContentsWrapper* tab_contents) {
-  TabContents* new_contents =
-      new TabContents(
-          tab_contents->profile(), NULL, MSG_ROUTING_NONE, NULL, NULL);
-  preview_contents_.reset(new TabContentsWrapper(new_contents));
+void InstantLoader::ReplacePreviewContents(TabContentsWrapper* old_tc,
+                                           TabContentsWrapper* new_tc) {
+  DCHECK(old_tc == preview_contents_);
+  // We release here without deleting so that the caller still has reponsibility
+  // for deleting the TabContentsWrapper.
+  ignore_result(preview_contents_.release());
+  preview_contents_.reset(new_tc);
+
+  // Make sure the new preview contents acts like the old one.
+  SetupPreviewContents(old_tc);
+
+  // Cleanup the old preview contents.
+  old_tc->download_tab_helper()->set_delegate(NULL);

[sky, 2011/05/20 18:54:19]

Why do you need to reset the download_tab_helper delegate?

[dominich, 2011/05/20 23:22:34]

It's set to the preview_tab_contents_delegate_ and as we're no longer using this
TabContentsWrapper for preview I thought we'd want to reset all delegates.

[sky, 2011/05/20 23:38:33]

I see it. Sorry.

+  old_tc->tab_contents()->set_delegate(NULL);
+  old_tc->set_delegate(NULL);
+
+#if defined(OS_MACOSX)
+  registrar_.Remove(this,
+                    NotificationType::RENDER_VIEW_HOST_CHANGED,
+                    Source<NavigationController>(&old_tc->controller()));
+#endif
+  registrar_.Remove(this,
+                 NotificationType::NAV_ENTRY_COMMITTED,
+                 Source<NavigationController>(&old_tc->controller()));
+
+  // We prerendered so we should be ready to show.
+  ShowPreview();

[sky, 2011/05/20 18:54:19]

If the tabcontents was already showing then the ShowPreview does nothing and the
display won't update (meaning it'll still be displaying the old tabcontents you
are about to delete).

[sky, 2011/05/20 19:45:09]

To deal with this you'll likely want to add a new InstantLoaderDelegate method
and have InstantController then notify its delegate if the loader is active.

[dominich, 2011/05/20 23:22:34]

When would this happen though? If we're swapping in from the Prerender system it
must be a new, unseen, TabContents.

[sky, 2011/05/20 23:38:33]

Is that always the case? Lets say foo.com is prerendered. If I type 'food.com'
in the url bar so that so that instant loads 'food.com', and then before
pressing enter type in 'foo.com' won't this get swapped to the prerendered page?

+}
+
+void InstantLoader::SetupPreviewContents(TabContentsWrapper* tab_contents) {
+  preview_contents_->set_delegate(preview_tab_contents_delegate_.get());
+  preview_contents_->tab_contents()->set_delegate(
+      preview_tab_contents_delegate_.get());
   preview_contents_->blocked_content_tab_helper()->SetAllContentsBlocked(true);
-  // Propagate the max page id. That way if we end up merging the two
-  // NavigationControllers (which happens if we commit) none of the page ids
-  // will overlap.
-  int32 max_page_id = tab_contents->tab_contents()->GetMaxPageID();
-  if (max_page_id != -1)
-    preview_contents_->controller().set_max_restored_page_id(max_page_id + 1);
 
-  preview_tab_contents_delegate_.reset(new TabContentsDelegateImpl(this));
-  new_contents->set_delegate(preview_tab_contents_delegate_.get());
+  // Set the max page id to one greater than the largest we can ever have.
+  // That way if we end up merging the two NavigationControllers (which happens
+  // if we commit) none of the page ids will overlap irregardless of how many
+  // tabs have been opened in the mean-time.
+  preview_contents_->controller().set_max_restored_page_id(
+      content::kMaxSessionHistoryEntries + 1);
+
   preview_contents_->download_tab_helper()->set_delegate(
       preview_tab_contents_delegate_.get());
 
-  gfx::Rect tab_bounds;
-  tab_contents->view()->GetContainerBounds(&tab_bounds);
-  preview_contents_->view()->SizeContents(tab_bounds.size());
-
 #if defined(OS_MACOSX)
   // If |preview_contents_| does not currently have a RWHV, we will call
   // SetTakesFocusOnlyOnMouseDown() as a result of the
   // RENDER_VIEW_HOST_CHANGED notification.
   if (preview_contents_->tab_contents()->GetRenderWidgetHostView()) {
     preview_contents_->tab_contents()->GetRenderWidgetHostView()->
         SetTakesFocusOnlyOnMouseDown(true);
   }
   registrar_.Add(
       this,
       NotificationType::RENDER_VIEW_HOST_CHANGED,
       Source<NavigationController>(&preview_contents_->controller()));
 #endif
 
   registrar_.Add(
       this,
       NotificationType::NAV_ENTRY_COMMITTED,
       Source<NavigationController>(&preview_contents_->controller()));
 
+  gfx::Rect tab_bounds;
+  tab_contents->view()->GetContainerBounds(&tab_bounds);
+  preview_contents_->view()->SizeContents(tab_bounds.size());
+}
+
+void InstantLoader::CreatePreviewContents(TabContentsWrapper* tab_contents) {
+  TabContents* new_contents =
+      new TabContents(
+          tab_contents->profile(), NULL, MSG_ROUTING_NONE, NULL, NULL);
+  preview_contents_.reset(new TabContentsWrapper(new_contents));
+  preview_tab_contents_delegate_.reset(new TabContentsDelegateImpl(this));
+  SetupPreviewContents(tab_contents);
+
   preview_contents_->tab_contents()->ShowContents();
 }