Instant extended: Remove suggest commit on lost focus

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/auto_reset.h"
 #include "base/format_macros.h"
@@ skipping 75 matching lines @@
   OMNIBOX_USER_TEXT_CLEARED_NUM_OF_ITEMS,
 };
 
 }  // namespace
 
 ///////////////////////////////////////////////////////////////////////////////
 // OmniboxEditModel::State
 
 OmniboxEditModel::State::State(bool user_input_in_progress,
                                const string16& user_text,
+                               const string16& instant_suggestion,
                                const string16& keyword,
                                bool is_keyword_hint,
                                OmniboxFocusState focus_state)
     : user_input_in_progress(user_input_in_progress),
       user_text(user_text),
+      instant_suggestion(instant_suggestion),
       keyword(keyword),
       is_keyword_hint(is_keyword_hint),
       focus_state(focus_state) {
 }
 
 OmniboxEditModel::State::~State() {
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 // OmniboxEditModel
@@ skipping 38 matching lines @@
     // on switching back, typing will "just work").
     const string16 user_text(UserTextFromDisplayText(view_->GetText()));
     if (user_text.empty()) {
       view_->RevertAll();
       view_->SelectAll(true);
     } else {
       InternalSetUserText(user_text);
     }
   }
 
-  return State(user_input_in_progress_, user_text_, keyword_, is_keyword_hint_,
+  return State(user_input_in_progress_,
+               user_text_,
+               view_->GetInstantSuggestion(),
+               keyword_,
+               is_keyword_hint_,
                focus_state_);
 }
 
 void OmniboxEditModel::RestoreState(const State& state) {
   SetFocusState(state.focus_state, OMNIBOX_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);
+    view_->SetInstantSuggestion(state.instant_suggestion);
   }
 }
 
 AutocompleteMatch OmniboxEditModel::CurrentMatch() {
   AutocompleteMatch match;
   GetInfoForCurrentText(&match, NULL);
   return match;
 }
 
 bool OmniboxEditModel::UpdatePermanentText(const string16& new_permanent_text) {
   // When there's a new URL, and the user is not editing anything or the edit
   // doesn't have focus, we want to revert the edit to show the new URL.  (The
   // common case where the edit doesn't have focus is when the user has started
-  // an edit and then abandoned it and clicked a link on the page.)
+  // an edit and then abandoned it and clicked a link on the page.) The only
+  // exception is if there's suggest text and the new URL is for a search result
+  // for the full text.

[Peter Kasting, 2013/04/03 00:35:35]

This added comment describes what, not why.  You need to say why.

Instead of adding this sentence, start a new paragraph and say this:

If the page is auto-committing an instant suggestion, however, we generally
don't want to make any change to the edit.  While auto-commits modify the
underlying permanent URL, they're intended to have no effect on the user's
editing process -- before and after the auto-commit, the omnibox should show the
same user text and the same instant suggestion, even if the auto-commit happens
while the edit doesn't have focus.

[sail, 2013/04/03 19:34:11]

Done.

+  string16 suggest_text = view_->GetInstantSuggestion();

[Peter Kasting, 2013/04/03 00:35:35]

Nit: Name this |instant_suggestion|

[sail, 2013/04/03 19:34:11]

Done.

   const bool visibly_changed_permanent_text =
       (permanent_text_ != new_permanent_text) &&
-      (!user_input_in_progress_ || !has_focus());
+      (!user_input_in_progress_ || !has_focus()) &&
+      (suggest_text.empty() || new_permanent_text != user_text_ + suggest_text);
 
   permanent_text_ = new_permanent_text;
   return visibly_changed_permanent_text;
 }
 
 GURL OmniboxEditModel::PermanentURL() {
   return URLFixerUpper::FixupURL(UTF16ToUTF8(permanent_text_), std::string());
 }
 
 void OmniboxEditModel::SetUserText(const string16& text) {
@@ skipping 607 matching lines @@
 }
 
 void OmniboxEditModel::OnWillKillFocus(gfx::NativeView view_gaining_focus) {
   InstantController* instant = controller_->GetInstant();
   if (instant) {
     instant->OmniboxFocusChanged(OMNIBOX_FOCUS_NONE,
                                  OMNIBOX_FOCUS_CHANGE_EXPLICIT,
                                  view_gaining_focus);
   }
 
-  SetInstantSuggestion(InstantSuggestion());
-
   // TODO(jered): Rip this out along with StartZeroSuggest.
   autocomplete_controller_->StopZeroSuggest();
   delegate_->NotifySearchTabHelper(user_input_in_progress_, !in_revert_);
 }
 
 void OmniboxEditModel::OnKillFocus() {
   // TODO(samarth): determine if it is safe to move the call to
   // OmniboxFocusChanged() from OnWillKillFocus() to here, which would let us
   // just call SetFocusState() to handle the state change.
   focus_state_ = OMNIBOX_FOCUS_NONE;
@@ skipping 556 matching lines @@
     instant->OmniboxFocusChanged(state, reason, NULL);
 
   // Update state and notify view if the omnibox has focus and the caret
   // visibility changed.
   const bool was_caret_visible = is_caret_visible();
   focus_state_ = state;
   if (focus_state_ != OMNIBOX_FOCUS_NONE &&
       is_caret_visible() != was_caret_visible)
     view_->ApplyCaretVisibility();
 }