InstantExtended: Committed NTP

chrome/browser/instant/instant_page.cc

+// Copyright 2013 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_page.h"
+
+#include "base/utf_string_conversions.h"
+#include "chrome/common/render_messages.h"
+#include "content/public/browser/web_contents.h"
+#include "ui/base/resource/resource_bundle.h"
+#include "ui/gfx/font.h"
+
+InstantPage::Delegate::~Delegate() {
+}
+
+InstantPage::~InstantPage() {
+}
+
+void InstantPage::Update(const string16& text,
+                         size_t selection_start,
+                         size_t selection_end,
+                         bool verbatim) {
+  Send(new ChromeViewMsg_SearchBoxChange(routing_id(), text, verbatim,
+                                         selection_start, selection_end));
+}
+
+void InstantPage::Submit(const string16& text) {
+  Send(new ChromeViewMsg_SearchBoxSubmit(routing_id(), text));
+}
+
+void InstantPage::Cancel(const string16& text) {
+  Send(new ChromeViewMsg_SearchBoxCancel(routing_id(), text));
+}
+
+void InstantPage::SetPopupBounds(const gfx::Rect& bounds) {
+  Send(new ChromeViewMsg_SearchBoxPopupResize(routing_id(), bounds));
+}
+
+void InstantPage::SetMarginSize(const int start, const int end) {
+  Send(new ChromeViewMsg_SearchBoxMarginChange(routing_id(), start, end));
+}
+
+void InstantPage::InitializeFonts() {
+  const gfx::Font& omnibox_font =
+      ui::ResourceBundle::GetSharedInstance().GetFont(
+          ui::ResourceBundle::MediumFont);
+  string16 omnibox_font_name = UTF8ToUTF16(omnibox_font.GetFontName());
+  size_t omnibox_font_size = omnibox_font.GetFontSize();
+  Send(new ChromeViewMsg_SearchBoxFontInformation(
+      routing_id(), omnibox_font_name, omnibox_font_size));
+}
+
+void InstantPage::DetermineIfPageSupportsInstant() {
+  Send(new ChromeViewMsg_DetermineIfPageSupportsInstant(routing_id()));
+}
+
+void InstantPage::SendAutocompleteResults(
+    const std::vector<InstantAutocompleteResult>& results) {
+  Send(new ChromeViewMsg_SearchBoxAutocompleteResults(routing_id(), results));
+}
+
+void InstantPage::UpOrDownKeyPressed(int count) {
+  Send(new ChromeViewMsg_SearchBoxUpOrDownKeyPressed(routing_id(), count));
+}
+
+void InstantPage::SearchModeChanged(const chrome::search::Mode& mode) {
+  Send(new ChromeViewMsg_SearchBoxModeChanged(routing_id(), mode));
+}
+
+void InstantPage::SendThemeBackgroundInfo(
+    const ThemeBackgroundInfo& theme_info) {
+  Send(new ChromeViewMsg_SearchBoxThemeChanged(routing_id(), theme_info));
+}
+
+void InstantPage::SendThemeAreaHeight(int height) {
+  Send(new ChromeViewMsg_SearchBoxThemeAreaHeightChanged(routing_id(), height));
+}
+
+void InstantPage::SetDisplayInstantResults(bool display_instant_results) {
+  Send(new ChromeViewMsg_SearchBoxSetDisplayInstantResults(
+      routing_id(), display_instant_results));
+}
+
+void InstantPage::KeyCaptureChanged(bool is_key_capture_enabled) {
+  Send(new ChromeViewMsg_SearchBoxKeyCaptureChanged(
+      routing_id(), is_key_capture_enabled));
+}
+
+InstantPage::InstantPage(Delegate* delegate)
+    : delegate_(delegate),
+      contents_(NULL),
+      supports_instant_(false) {
+}
+
+void InstantPage::SetContents(content::WebContents* contents) {
+  Observe(contents);
+  contents_ = contents;
+}
+
+bool InstantPage::ShouldProcessRenderViewCreated() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessRenderViewGone() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessAboutToNavigateMainFrame() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessSetSuggestions() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessShowInstantPreview() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessStartCapturingKeyStrokes() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessStopCapturingKeyStrokes() {
+  return true;
+}
+
+bool InstantPage::ShouldProcessNavigateToURL() {
+  return true;
+}
+
+void InstantPage::RenderViewCreated(content::RenderViewHost* render_view_host) {
+  if (ShouldProcessRenderViewCreated())
+    delegate_->InstantPageRenderViewCreated(contents_);
+}
+
+void InstantPage::DidFinishLoad(
+    int64 /* frame_id */,
+    const GURL& /* validated_url */,
+    bool is_main_frame,
+    content::RenderViewHost* /* render_view_host */) {
+  if (is_main_frame && !supports_instant_)
+    DetermineIfPageSupportsInstant();
+}
+
+bool InstantPage::OnMessageReceived(const IPC::Message& message) {
+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP(InstantPage, message)
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_SetSuggestions, OnSetSuggestions)
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_InstantSupportDetermined,
+                        OnInstantSupportDetermined)
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_ShowInstantPreview,
+                        OnShowInstantPreview)
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_StartCapturingKeyStrokes,
+                        OnStartCapturingKeyStrokes);
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_StopCapturingKeyStrokes,
+                        OnStopCapturingKeyStrokes);
+    IPC_MESSAGE_HANDLER(ChromeViewHostMsg_SearchBoxNavigate,
+                        OnSearchBoxNavigate);
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
+void InstantPage::RenderViewGone(base::TerminationStatus /* status */) {
+  if (ShouldProcessRenderViewGone())
+    delegate_->InstantPageRenderViewGone(contents_);
+}
+
+void InstantPage::DidCommitProvisionalLoadForFrame(
+    int64 /* frame_id */,
+    bool is_main_frame,
+    const GURL& url,
+    content::PageTransition /* transition_type */,
+    content::RenderViewHost* /* render_view_host */) {
+  if (is_main_frame && ShouldProcessAboutToNavigateMainFrame())
+    delegate_->InstantPageAboutToNavigateMainFrame(contents_, url);
+}
+
+void InstantPage::OnSetSuggestions(
+    int page_id,
+    const std::vector<InstantSuggestion>& suggestions) {
+  if (contents_ && contents_->IsActiveEntry(page_id)) {

[sreeram, 2013/02/07 22:09:54]

No need for "if (contents_)" clause. There's no way this should be called if
contents_ is null, so if you really want, you can DCHECK(contents_) instead.
This applies to all the other methods below too.

[samarth, 2013/02/07 22:45:42]

Done.

+    OnInstantSupportDetermined(page_id, true);
+    if (ShouldProcessSetSuggestions())
+      delegate_->SetSuggestions(contents_, suggestions);
+  }
+}
+
+void InstantPage::OnInstantSupportDetermined(int page_id,
+                                             bool supports_instant) {
+  if (!contents_ || !contents_->IsActiveEntry(page_id) || supports_instant_) {
+    // Nothing to do if the page already supports Instant.
+    return;
+  }
+
+  supports_instant_ = supports_instant;
+  delegate_->InstantSupportDetermined(contents_, supports_instant);
+
+  // If the page doesn't support Instant, stop listening to it.
+  if (!supports_instant)
+    Observe(NULL);

[sreeram, 2013/02/07 22:09:54]

This code above works as is now, but I'd like to make it more defensive. Just in
case the delegate_ doesn't take care to delay-delete us (in response to the page
not supporting instant), we should try not to access anything after the delegate
call. So, something like this:

supports_instant_ = supports_instant;
content::WebContents* contents = web_contents();
if (!supports_instant)
  Observe(NULL);
delegate_->InstantSupportDetermined(contents, supports_instant);

[samarth, 2013/02/07 22:45:42]

Done.

+}
+
+void InstantPage::OnShowInstantPreview(int page_id,
+                                       InstantShownReason reason,
+                                       int height,
+                                       InstantSizeUnits units) {
+  if (contents_ && contents_->IsActiveEntry(page_id)) {
+    OnInstantSupportDetermined(page_id, true);
+    if (ShouldProcessShowInstantPreview())
+      delegate_->ShowInstantPreview(contents_, reason, height, units);
+  }
+}
+
+void InstantPage::OnStartCapturingKeyStrokes(int page_id) {
+  if (contents_ && contents_->IsActiveEntry(page_id)) {
+    OnInstantSupportDetermined(page_id, true);
+    if (ShouldProcessStartCapturingKeyStrokes())
+      delegate_->StartCapturingKeyStrokes(contents_);
+  }
+}
+
+void InstantPage::OnStopCapturingKeyStrokes(int page_id) {
+  if (contents_ && contents_->IsActiveEntry(page_id)) {
+    OnInstantSupportDetermined(page_id, true);
+    if (ShouldProcessStopCapturingKeyStrokes())
+      delegate_->StopCapturingKeyStrokes(contents_);
+  }
+}
+
+void InstantPage::OnSearchBoxNavigate(int page_id,
+                                      const GURL& url,
+                                      content::PageTransition transition) {
+  if (contents_ && contents_->IsActiveEntry(page_id)) {
+    OnInstantSupportDetermined(page_id, true);
+    if (ShouldProcessNavigateToURL())
+      delegate_->NavigateToURL(contents_, url, transition);
+  }
+}