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

chrome/browser/ui/omnibox/omnibox_edit_model.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/ui/omnibox/omnibox_edit_model.h"
 
 #include <string>
 
 #include "base/format_macros.h"
 #include "base/metrics/histogram.h"
@@ skipping 118 matching lines @@
     } else {
       InternalSetUserText(user_text);
     }
   }
 
   return State(user_input_in_progress_, user_text_, keyword_, is_keyword_hint_,
                is_caret_visible_);
 }
 
 void OmniboxEditModel::RestoreState(const State& state) {
-  SetCaretVisibility(state.is_caret_visible);
+  SetCaretVisibilityInternal(state.is_caret_visible, FOCUS_CHANGE_TAB_SWITCH);
   // Restore any user editing.
   if (state.user_input_in_progress) {
     // NOTE: Be sure and set keyword-related state BEFORE invoking
     // DisplayTextFromUserText(), as its result depends upon this state.
     keyword_ = state.keyword;
     is_keyword_hint_ = state.is_keyword_hint;
     view_->SetUserText(state.user_text,
         DisplayTextFromUserText(state.user_text), false);
   }
 }
@@ skipping 558 matching lines @@
   }
 }
 
 const AutocompleteResult& OmniboxEditModel::result() const {
   return autocomplete_controller_->result();
 }
 
 void OmniboxEditModel::OnSetFocus(bool control_down) {
   has_focus_ = true;
   control_key_state_ = control_down ? DOWN_WITHOUT_CHANGE : UP;
-  // Restore caret visibility whenever the user focuses back into the omnibox.
+  // If the omnibox lost focus while the caret was hidden and then regained
+  // focus, OnSetFocus() is called and should restore visibility. Note that
+  // focus can be regained without an accompanying call to
+  // OmniboxView::SetFocus(), e.g. by tabbing in.
   SetCaretVisibility(true);
 
-  if (InstantController* instant = controller_->GetInstant())
-    instant->OmniboxGotFocus();
+  // The SetCaretVisibility call above will already send an update to the
+  // InstantController in some cases but we still need this here since it won't
+  // send an update if the caret was already visible.

[Peter Kasting, 2012/12/08 01:12:21]

But in that case why do we need to send an update?  The InstantController
shouldn't care, unless it doesn't realize the caret is already visible, in which
case you have a bug somewhere else.  No?

[samarth, 2012/12/08 01:51:34]

It's because InstantController also needs to know whether the omnibox has focus
or not (for other reasons), as in it cares it cares when the state changes from
FOCUS_NONE to FOCUS_VISIBLE.

[Peter Kasting, 2012/12/08 02:07:52]

Perhaps we should move this to the top of the function and call it only if
!has_focus_.

It would also be good to change the comment to something like:

"SetCaretVisibility() will notify the InstantController if caret visibility
changes while we have focus, but it also needs to know when we actually gain
focus to begin with, so we have to manually notify here."

This also makes me wonder about a larger change: combine the caret visibility
and focus tracking bools in the edit to a single caret visibility member that
uses the FOCUS_VISIBLE, FOCUS_INVISIBLE, FOCUS_NONE values.  Do this right and I
suspect we eliminate or at least clarify a lot of separate calls to the instant
controller.

[samarth, 2012/12/10 23:45:00]

Done.

+  if (InstantController* instant = controller_->GetInstant()) {
+    instant->OmniboxFocusChanged(FOCUS_VISIBLE,
+                                 FOCUS_CHANGE_EXPLICIT, NULL);
+  }
 
   content::WebContents* web_contents = controller_->GetWebContents();
   if (web_contents) {
     // TODO(jered): We may want to merge this into Start() and just call that
     // here rather than having a special entry point for zero-suggest.  Note
     // that we avoid PermanentURL() here because it's not guaranteed to give us
     // the actual underlying current URL, e.g. if we're on the NTP and the
     // |permanent_text_| is empty.
     autocomplete_controller_->StartZeroSuggest(web_contents->GetURL(),
                                                user_text_);
   }
 
   NotifySearchTabHelper();
 }
 
 void OmniboxEditModel::SetCaretVisibility(bool visible) {
-  if (has_focus_ && visible != is_caret_visible_) {
-    is_caret_visible_ = visible;
-    view_->ApplyCaretVisibility();
-  }
+  SetCaretVisibilityInternal(visible, FOCUS_CHANGE_EXPLICIT);
 }
 
 void OmniboxEditModel::OnWillKillFocus(gfx::NativeView view_gaining_focus) {
   SetInstantSuggestion(InstantSuggestion());
 
-  if (InstantController* instant = controller_->GetInstant())
-    instant->OmniboxLostFocus(view_gaining_focus);
+  if (InstantController* instant = controller_->GetInstant()) {
+    instant->OmniboxFocusChanged(FOCUS_NONE, FOCUS_CHANGE_EXPLICIT,
+                                 view_gaining_focus);
+  }
 
   // TODO(jered): Rip this out along with StartZeroSuggest.
   autocomplete_controller_->StopZeroSuggest();
   NotifySearchTabHelper();
 }
 
 void OmniboxEditModel::OnKillFocus() {
   has_focus_ = false;
   control_key_state_ = UP;
   paste_state_ = NONE;
@@ skipping 185 matching lines @@
   // that replaced all the text, preserve that information; otherwise, if we've
   // made some other edit, clear paste tracking.
   if (paste_state_ == PASTING)
     paste_state_ = PASTED;
   else if (text_differs)
     paste_state_ = NONE;
 
   // Restore caret visibility whenever the user changes text or selection in the
   // omnibox.
   if (text_differs || selection_differs)
-    SetCaretVisibility(true);
+    SetCaretVisibilityInternal(true, FOCUS_CHANGE_TYPING);
 
   // Modifying the selection counts as accepting the autocompleted text.
   const bool user_text_changed =
       text_differs || (selection_differs && !inline_autocomplete_text_.empty());
 
   // If something has changed while the control key is down, prevent
   // "ctrl-enter" until the control key is released.  When we do this, we need
   // to update the popup if it's open, since the desired_tld will have changed.
   if ((text_differs || selection_differs) &&
       (control_key_state_ == DOWN_WITHOUT_CHANGE)) {
@@ skipping 315 matching lines @@
 }
 
 void OmniboxEditModel::ClassifyStringForPasteAndGo(
     const string16& text,
     AutocompleteMatch* match,
     GURL* alternate_nav_url) const {
   DCHECK(match);
   AutocompleteClassifierFactory::GetForProfile(profile_)->Classify(text,
       string16(), false, false, match, alternate_nav_url);
 }
+
+void OmniboxEditModel::SetCaretVisibilityInternal(
+    bool visible,
+    OmniboxFocusChangeReason reason) {
+  if (has_focus_ && visible != is_caret_visible_) {
+    if (InstantController* instant = controller_->GetInstant()) {
+      instant->OmniboxFocusChanged(visible ? FOCUS_VISIBLE : FOCUS_INVISIBLE,
+                                   reason, NULL);
+    }
+    is_caret_visible_ = visible;
+    view_->ApplyCaretVisibility();
+  }
+}