Interpret '?' and Ctrl-K or Ctrl-E as putting omnibox in keyword search mode for Default Search Pro…

components/omnibox/browser/omnibox_edit_model.cc

Index: components/omnibox/browser/omnibox_edit_model.cc
diff --git a/components/omnibox/browser/omnibox_edit_model.cc b/components/omnibox/browser/omnibox_edit_model.cc
index 87302727e29dab8cfd900d491954909f218c6b3c..d4981e7f3e05c74e98e40dd2155c1bfc3a517986 100644
--- a/components/omnibox/browser/omnibox_edit_model.cc
+++ b/components/omnibox/browser/omnibox_edit_model.cc
@@ -149,6 +149,7 @@ OmniboxEditModel::State::State(bool user_input_in_progress,
                                const base::string16& gray_text,
                                const base::string16& keyword,
                                bool is_keyword_hint,
+                               EnteredKeywordModeMethod keyword_entered_method,
                                bool url_replacement_enabled,
                                OmniboxFocusState focus_state,
                                FocusSource focus_source,
@@ -158,6 +159,7 @@ OmniboxEditModel::State::State(bool user_input_in_progress,
       gray_text(gray_text),
       keyword(keyword),
       is_keyword_hint(is_keyword_hint),
+      keyword_entered_method(keyword_entered_method),
       url_replacement_enabled(url_replacement_enabled),
       focus_state(focus_state),
       focus_source(focus_source),
@@ -183,6 +185,7 @@ OmniboxEditModel::OmniboxEditModel(OmniboxView* view,
       user_input_in_progress_(false),
       user_input_since_focus_(true),
       just_deleted_text_(false),
+      just_cleared_keyword_(false),
       has_temporary_text_(false),
       paste_state_(NONE),
       control_key_state_(UP),
@@ -217,7 +220,7 @@ const OmniboxEditModel::State OmniboxEditModel::GetStateForTabSwitch() {
                         user_input_in_progress_);
   return State(
       user_input_in_progress_, user_text_, view_->GetGrayTextAutocompletion(),
-      keyword_, is_keyword_hint_,
+      keyword_, is_keyword_hint_, keyword_entered_method_,
       controller_->GetToolbarModel()->url_replacement_enabled(),
       focus_state_, focus_source_, input_);
 }
@@ -246,6 +249,7 @@ void OmniboxEditModel::RestoreState(const State* state) {
     // DisplayTextFromUserText(), as its result depends upon this state.
     keyword_ = state->keyword;
     is_keyword_hint_ = state->is_keyword_hint;
+    keyword_entered_method_ = state->keyword_entered_method;
     view_->SetUserText(state->user_text,
         DisplayTextFromUserText(state->user_text), false);
     view_->SetGrayTextAutocompletion(state->gray_text);
@@ -328,6 +332,14 @@ bool OmniboxEditModel::CommitSuggestedText() {
 }
 
 void OmniboxEditModel::OnChanged() {
+  // If the user input a "?", put them into keyword mode.
+  if (!just_cleared_keyword_ && !just_deleted_text_ &&
+      user_text_ == base::ASCIIToUTF16("?")) {

[Peter Kasting, 2016/04/13 02:52:16]

It doesn't seem like this handles the case of inserting a '?' before an existing
string, which it probably should?

[Tom (Use chromium acct), 2016/04/13 23:37:40]

It does not.  However, it would be a bit complex to add that logic, as we would
have to keep the user_text_ before OnChanged was called in order to determine if
a question mark was typed.  Is it worth it to add this?

[Peter Kasting, 2016/04/15 00:58:55]

I think so -- if you prefix some existing text with a keyword and a space, the
space will flip into keyword mode, so we should be parallel here.

I am OK with that being a separate change, as long as you're up for doing it
after this one.  Or if you think it would be reasonably easy/not add lots of
complications and bugs, you can do it in this CL.

+    user_text_ = base::string16();
+    EnterKeywordModeForDefaultSearchProvider(
+        ENTERED_KEYWORD_MODE_VIA_QUESTION_MARK);
+  }
+
   // Hide any suggestions we might be showing.
   view_->SetGrayTextAutocompletion(base::string16());
 
@@ -625,6 +637,25 @@ void OmniboxEditModel::AcceptInput(WindowOpenDisposition disposition,
                    popup_model()->selected_line());
 }
 
+void OmniboxEditModel::EnterKeywordModeForDefaultSearchProvider(
+    EnteredKeywordModeMethod keyword_entered_method) {
+  autocomplete_controller()->Stop(false);
+
+  base::string16 query = DisplayTextFromUserText(user_text_);
+  keyword_ = client_->GetTemplateURLService()->
+      GetDefaultSearchProvider()->keyword();
+  is_keyword_hint_ = false;
+  keyword_entered_method_ = keyword_entered_method;
+  InternalSetUserText(keyword_ + base::ASCIIToUTF16(" ") + query);
+
+  view_->OnTemporaryTextMaybeChanged(user_text_, false, true);
+  StartAutocomplete(false, false, true);
+
+  UMA_HISTOGRAM_ENUMERATION(kEnteredKeywordModeHistogram,
+                            keyword_entered_method,
+                            ENTERED_KEYWORD_MODE_NUM_ITEMS);
+}
+
 void OmniboxEditModel::OpenMatch(AutocompleteMatch match,
                                  WindowOpenDisposition disposition,
                                  const GURL& alternate_nav_url,
@@ -788,6 +819,7 @@ bool OmniboxEditModel::AcceptKeyword(EnteredKeywordModeMethod entered_method) {
 
   autocomplete_controller()->Stop(false);
   is_keyword_hint_ = false;
+  keyword_entered_method_ = entered_method;
 
   if (popup_model() && popup_model()->IsOpen())
     popup_model()->SetSelectedLineState(OmniboxPopupModel::KEYWORD);
@@ -844,6 +876,7 @@ void OmniboxEditModel::AcceptTemporaryTextAsUserText() {
 
 void OmniboxEditModel::ClearKeyword() {
   autocomplete_controller()->Stop(false);
+  just_cleared_keyword_ = true;

[Peter Kasting, 2016/04/13 02:52:16]

Nit: Use base::AutoReset here to ensure you set this false on all exit paths,
instead of doing it manually.

Although... is clearing this on exit to this function safe?  Maybe this should
persist until the next time something actually changes?  What I'm worried about
is a case where you backspace out of keyword mode and then hit something that
doesn't actually change the text -- like the home or end keys or up arrow or
something.  This shouldn't suddenly jump back into keyword mode.  Make sure that
isn't broken...

[Tom (Use chromium acct), 2016/04/13 23:37:41]

Not broken.  Added base::AutoReset for now.
On a side note, if I were to add the complex logic for OnChanged that I
described in another reply, we would not need just_cleared_keyword_, so that
could be a bonus.

 
   // While we're always in keyword mode upon reaching here, sometimes we've just
   // toggled in via space or tab, and sometimes we're on a non-toggled line
@@ -854,6 +887,23 @@ void OmniboxEditModel::ClearKeyword() {
 
   omnibox_controller_->ClearPopupKeywordMode();
 
+  // If we entered keyword mode in a special way like using a keyboard shortcut
+  // or typing a question mark in a blank omnibox, don't restore the keyword.

[Peter Kasting, 2016/04/13 02:52:16]

Nit: "... Instead, restore the question mark iff the user originally typed one."

[Tom (Use chromium acct), 2016/04/13 23:37:41]

Done.

+  if (keyword_entered_method_ == ENTERED_KEYWORD_MODE_VIA_KEYBOARD_SHORTCUT ||
+      keyword_entered_method_ == ENTERED_KEYWORD_MODE_VIA_QUESTION_MARK) {
+    view_->OnBeforePossibleChange();

[Peter Kasting, 2016/04/13 02:52:16]

Nit: This function body is basically identical to the "states 1-3" block below,
and if we changed one place we'd probably want to change the other.

I suspect given the comments below that these two entry methods can't result in
us winding up in the state 4 block anyway.  Therefore maybe instead of adding
all this, we should just modify the states 1-3 block to set the right window
text.  At that point, we'd basically want to use conditionals to set a "prefix"
variable to one of (keyword + space, question mark, nothing), then call
SetWindowTextAndCaretPos(prefix + view_->GetText(), prefix.length(), false,
false);.

[Tom (Use chromium acct), 2016/04/13 23:37:40]

Done.

+    if (keyword_entered_method_ == ENTERED_KEYWORD_MODE_VIA_QUESTION_MARK)

[Peter Kasting, 2016/04/13 02:52:16]

Nit: Needs {}

[Tom (Use chromium acct), 2016/04/13 23:37:41]

Done.

+      view_->SetWindowTextAndCaretPos(
+          base::ASCIIToUTF16("?") + view_->GetText(), 1, false, false);
+    else
+      view_->SetWindowTextAndCaretPos(view_->GetText(), 0, false, false);
+    keyword_.clear();
+    is_keyword_hint_ = false;
+    view_->OnAfterPossibleChange(false);
+    just_cleared_keyword_ = false;
+    return;
+  }
+
   // There are several possible states we could have been in before the user hit
   // backspace or shift-tab to enter this function:
   // (1) was_toggled_into_keyword_mode == false, has_temporary_text_ == false
@@ -921,6 +971,7 @@ void OmniboxEditModel::ClearKeyword() {
     is_keyword_hint_ = false;
     view_->OnAfterPossibleChange(false);
   }
+  just_cleared_keyword_ = false;
 }
 
 void OmniboxEditModel::OnSetFocus(bool control_down) {
@@ -1155,6 +1206,7 @@ bool OmniboxEditModel::OnAfterPossibleChange(const base::string16& old_text,
                                              size_t selection_end,
                                              bool selection_differs,
                                              bool text_differs,
+                                             bool keyword_differs,
                                              bool just_deleted_text,
                                              bool allow_keyword_ui_change) {
   // Update the paste state as appropriate: if we're just finishing a paste
@@ -1194,7 +1246,7 @@ bool OmniboxEditModel::OnAfterPossibleChange(const base::string16& old_text,
     control_key_state_ = DOWN_WITH_CHANGE;
 
   if (!user_text_changed)
-    return false;
+    return keyword_differs;
 
   // If the user text has not changed, we do not want to change the model's
   // state associated with the text.  Otherwise, we can get surprising behavior