Instant API: tell page whether the browser is capturing key strokes.

chrome/browser/instant/instant_controller.cc

 // Copyright 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.
 
 #include "chrome/browser/instant/instant_controller.h"
 
 #include "base/command_line.h"
 #include "base/metrics/histogram.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
@@ skipping 134 matching lines @@
 
 InstantController::InstantController(chrome::BrowserInstantController* browser,
                                      bool extended_enabled)
     : browser_(browser),
       extended_enabled_(extended_enabled),
       instant_enabled_(false),
       model_(ALLOW_THIS_IN_INITIALIZER_LIST(this)),
       last_verbatim_(false),
       last_transition_type_(content::PAGE_TRANSITION_LINK),
       last_match_was_search_(false),
-      is_omnibox_focused_(false) {
+      omnibox_focus_state_(NONE) {
 }
 
 InstantController::~InstantController() {
 }
 
 bool InstantController::Update(const AutocompleteMatch& match,
                                const string16& user_text,
                                const string16& full_text,
                                const bool verbatim,
                                const bool user_input_in_progress,
@@ skipping 303 matching lines @@
 
   // Try to create another loader immediately so that it is ready for the next
   // user interaction.
   CreateDefaultLoader();
 
   return true;
 }
 
 void InstantController::OmniboxLostFocus(gfx::NativeView view_gaining_focus) {
   DVLOG(1) << "OmniboxLostFocus";
-  is_omnibox_focused_ = false;
+  omnibox_focus_state_ = NONE;
 
   if (!extended_enabled_ && !instant_enabled_)
     return;
 
   // If the preview isn't showing search suggestions, nothing to do. The check
   // for GetPreviewContents() (which normally is redundant, given IsCurrent())
   // is to handle the case when we get here during a commit.
   if (!IsCurrent() || !GetPreviewContents()) {
     OnStaleLoader();
     return;
   }
 
+  SendKeyCaptureModeToPage();

[sreeram, 2012/11/29 13:22:31]

IsCurrent() returns false when on the NTP. Don't you want to send the keycapture
mode when on the NTP? If so, you should put this above the IsCurrent() check.

[samarth, 2012/11/29 17:28:21]

Good catch.  Fixed it so that the Send..() call is always right after the
omnibox focus changes.

 #if defined(OS_MACOSX)
   if (!loader_->IsPointerDownFromActivate())
     Hide(true);
 #else
   if (IsViewInContents(GetViewGainingFocus(view_gaining_focus),
                        GetPreviewContents()->web_contents()))
     CommitIfCurrent(INSTANT_COMMIT_FOCUS_LOST);
   else
     Hide(true);
 #endif
 }
 
-void InstantController::OmniboxGotFocus() {
+void InstantController::OmniboxGotFocus(bool focus_is_visible) {
   DVLOG(1) << "OmniboxGotFocus";
-  is_omnibox_focused_ = true;
+  omnibox_focus_state_ = focus_is_visible ? VISIBLE : INVISIBLE;
 
   if (!extended_enabled_ && !instant_enabled_)
     return;
 
+  SendKeyCaptureModeToPage();
+
   if (!GetPreviewContents())
     CreateDefaultLoader();
 }
 
 void InstantController::SearchModeChanged(
     const chrome::search::Mode& old_mode,
     const chrome::search::Mode& new_mode) {
   if (!extended_enabled_)
     return;
 
@@ skipping 179 matching lines @@
   if (!GetInstantURL(template_url, &instant_url))
     return false;
 
   if (GetPreviewContents() && loader_->instant_url() != instant_url)
     DeleteLoader();
 
   if (!GetPreviewContents()) {
     loader_.reset(new InstantLoader(this, instant_url, active_tab));
     loader_->Init();
 
-    // Ensure the searchbox API has the correct theme-related info and context.
+    // Ensure the searchbox API has correct state.
     if (extended_enabled_) {
       browser_->UpdateThemeInfoForPreview();
       loader_->SearchModeChanged(search_mode_);
+      SendKeyCaptureModeToPage();
     }
 
     // Reset the loader timer.
     stale_loader_timer_.Start(
         FROM_HERE,
         base::TimeDelta::FromMilliseconds(kStaleLoaderTimeoutMS), this,
         &InstantController::OnStaleLoader);
   }
 
   return true;
 }
 
 bool InstantController::CreateDefaultLoader() {
   // If there's no active tab, the browser is closing.
   const TabContents* active_tab = browser_->GetActiveTabContents();
   if (!active_tab)
     return false;
 
   const TemplateURL* template_url =
       TemplateURLServiceFactory::GetForProfile(active_tab->profile())->
                                  GetDefaultSearchProvider();
 
   return ResetLoader(template_url, active_tab);
 }
 
 void InstantController::OnStaleLoader() {
   // If the preview is showing or the omnibox has focus, don't delete the
   // loader. It will get refreshed the next time the preview is hidden or the
   // omnibox loses focus.
-  if (!stale_loader_timer_.IsRunning() && !is_omnibox_focused_ &&
+  if (!stale_loader_timer_.IsRunning() && omnibox_focus_state_ == NONE &&
       model_.mode().is_default()) {
     DeleteLoader();
     CreateDefaultLoader();
   }
 }
 
 void InstantController::DeleteLoader() {
   // Clear all state, except |last_transition_type_| as it's used during commit.
   last_user_text_.clear();
   last_full_text_.clear();
@@ skipping 89 matching lines @@
   // There is no point in sanity-checking |intersection.y()| because the omnibox
   // can be placed anywhere vertically relative to the preview (for example, in
   // Mac fullscreen mode, the omnibox is fully enclosed by the preview bounds).
   DCHECK_LE(0, intersection.x());
   DCHECK_LE(0, intersection.width());
   DCHECK_LE(0, intersection.height());
 
   loader_->SetOmniboxBounds(intersection);
 }
 
+void InstantController::SendKeyCaptureModeToPage() {
+  loader_->OnKeyCaptureChange(omnibox_focus_state_ == INVISIBLE);

[sreeram, 2012/11/29 13:22:31]

You should guard this on these two clauses (either here, or at the call sites):
if (extended_enabled_ && GetPreviewContents())
  loader_->OnKeyCaptureChange(...);

[samarth, 2012/11/29 17:28:21]

Added the checks here to be safe.

+}
+
 bool InstantController::GetInstantURL(const TemplateURL* template_url,
                                       std::string* instant_url) const {
   CommandLine* command_line = CommandLine::ForCurrentProcess();
   if (command_line->HasSwitch(switches::kInstantURL)) {
     *instant_url = command_line->GetSwitchValueASCII(switches::kInstantURL);
     return template_url != NULL;
   }
 
   if (!template_url)
     return false;
@@ skipping 31 matching lines @@
   }
 
   std::map<std::string, int>::const_iterator iter =
       blacklisted_urls_.find(*instant_url);
   if (iter != blacklisted_urls_.end() &&
       iter->second > kMaxInstantSupportFailures)
     return false;
 
   return true;
 }