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

components/omnibox/browser/omnibox_edit_model.h

 // 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.
 
 #ifndef COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_EDIT_MODEL_H_
 #define COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_EDIT_MODEL_H_
 
 #include <stddef.h>
 
 #include <memory>
@@ skipping 19 matching lines @@
 class OmniboxPopupModel;
 class OmniboxView;
 
 namespace gfx {
 class Image;
 class Rect;
 }
 
 // Reasons why the Omnibox could change into keyword mode.
 // These numeric values are used in UMA logs; do not change them.
-enum EnteredKeywordModeMethod {
-  ENTERED_KEYWORD_MODE_VIA_TAB = 0,
-  ENTERED_KEYWORD_MODE_VIA_SPACE_AT_END = 1,
-  ENTERED_KEYWORD_MODE_VIA_SPACE_IN_MIDDLE = 2,
-  ENTERED_KEYWORD_MODE_NUM_ITEMS
+enum class KeywordModeEntryMethod {
+  TAB = 0,
+  SPACE_AT_END = 1,
+  SPACE_IN_MIDDLE = 2,
+  KEYBOARD_SHORTCUT = 3,
+  QUESTION_MARK = 4,
+  NUM_ITEMS,
 };
 
 class OmniboxEditModel {
  public:
   // Did the Omnibox focus originate via the user clicking on the Omnibox or on
   // the Fakebox?
   enum FocusSource {
     INVALID = 0,
     OMNIBOX = 1,
     FAKEBOX = 2
   };
 
   struct State {
     State(bool user_input_in_progress,
           const base::string16& user_text,
           const base::string16& gray_text,
           const base::string16& keyword,
           bool is_keyword_hint,
+          KeywordModeEntryMethod keyword_mode_entry_method,
           bool url_replacement_enabled,
           OmniboxFocusState focus_state,
           FocusSource focus_source,
           const AutocompleteInput& autocomplete_input);
     State(const State& other);
     ~State();
 
     bool user_input_in_progress;
     const base::string16 user_text;
     const base::string16 gray_text;
     const base::string16 keyword;
     const bool is_keyword_hint;
+    KeywordModeEntryMethod keyword_mode_entry_method;
     bool url_replacement_enabled;
     OmniboxFocusState focus_state;
     FocusSource focus_source;
     const AutocompleteInput autocomplete_input;
   };
 
+  // Used by |OnAfterPossibleChange|.
+  struct TextStateChange {

[Peter Kasting, 2016/06/04 02:17:18]

Nit: I think this should be defined in OmniboxView instead of here.  It seems
like everything else related to this, including the method that actually
computes it, is defined in that class already, and while its consumer is in this
class, all its concepts relate to things in the view.

Assuming you follow my name suggestion there, I would then name this
StateChanges and document like "Represents the changes between two State
objects.  This is used by the model to determine how its internal state should
be updated after the view state changes.  See
OmniboxEditModel::OnAfterPossibleChange()."

[Tom (Use chromium acct), 2016/06/04 20:39:09]

Done, but unfortunately you cannot forward-declare nested classes, so I instead
moved this to OmniboxViewStateChanges

+    // |old_text| and |new_text| are not owned.
+    const base::string16* old_text;
+    const base::string16* new_text;
+    size_t new_sel_start;
+    size_t new_sel_end;
+    bool selection_differs;
+    bool text_differs;
+    bool keyword_differs;
+    bool just_deleted_text;
+  };
+
   OmniboxEditModel(OmniboxView* view,
                    OmniboxEditController* controller,
                    std::unique_ptr<OmniboxClient> client);
   virtual ~OmniboxEditModel();
 
   // TODO(beaudoin): Remove this accessor when the AutocompleteController has
   //     completely moved to OmniboxController.
   AutocompleteController* autocomplete_controller() const {
     return omnibox_controller_->autocomplete_controller();
   }
@@ skipping 139 matching lines @@
 
   // Accessors for keyword-related state (see comments on keyword_ and
   // is_keyword_hint_).
   const base::string16& keyword() const { return keyword_; }
   bool is_keyword_hint() const { return is_keyword_hint_; }
   bool is_keyword_selected() const {
     return !is_keyword_hint_ && !keyword_.empty();
   }
 
   // Accepts the current keyword hint as a keyword. It always returns true for
-  // caller convenience. |entered_method| indicates how the use entered
-  // keyword mode. This parameter is only used for metrics/logging; it's not
-  // used to change user-visible behavior.
-  bool AcceptKeyword(EnteredKeywordModeMethod entered_method);
+  // caller convenience. |entered_method| indicates how the user entered
+  // keyword mode.
+  bool AcceptKeyword(KeywordModeEntryMethod entry_method);
+
+  // Sets the current keyword to that of the user's default search provider and
+  // updates the view so the user sees the keyword chip in the omnibox.
+  void EnterKeywordModeForDefaultSearchProvider(
+      KeywordModeEntryMethod entry_method);
 
   // Accepts the current temporary text as the user text.
   void AcceptTemporaryTextAsUserText();
 
   // Clears the current keyword.
   void ClearKeyword();
 
   // Returns the current autocomplete result.  This logic should in the future
   // live in AutocompleteController but resides here for now.  This method is
   // used by AutomationProvider::AutocompleteEditGetMatches.
@@ skipping 63 matching lines @@
   //     comments on keyword_ and is_keyword_hint_).
   void OnPopupDataChanged(
       const base::string16& text,
       GURL* destination_for_temporary_text_change,
       const base::string16& keyword,
       bool is_keyword_hint);
 
   // Called by the OmniboxView after something changes, with details about what
   // state changes occured.  Updates internal state, updates the popup if
   // necessary, and returns true if any significant changes occurred.  Note that
-  // |text_differs| may be set even if |old_text| == |new_text|, e.g. if we've
-  // just committed an IME composition.
+  // |text_change.text_differs| may be set even if |text_change.old_text| ==
+  // |text_change.new_text|, e.g. if we've just committed an IME composition.
   //
   // If |allow_keyword_ui_change| is false then the change should not affect
   // keyword ui state, even if the text matches a keyword exactly. This value
   // may be false when the user is composing a text with an IME.
-  bool OnAfterPossibleChange(const base::string16& old_text,
-                             const base::string16& new_text,
-                             size_t selection_start,
-                             size_t selection_end,
-                             bool selection_differs,
-                             bool text_differs,
-                             bool just_deleted_text,
+  bool OnAfterPossibleChange(const TextStateChange& text_change,
                              bool allow_keyword_ui_change);
 
   // Called when the current match has changed in the OmniboxController.
   void OnCurrentMatchChanged();
 
   // Name of the histogram tracking cut or copy omnibox commands.
   static const char kCutOrCopyAllTextHistogram[];
 
  private:
   friend class OmniboxControllerTest;
@@ skipping 190 matching lines @@
   // selected keyword, or just some input text that looks like a keyword (so we
   // can show a hint to press <tab>).  This is the keyword in either case;
   // is_keyword_hint_ (below) distinguishes the two cases.
   base::string16 keyword_;
 
   // True if the keyword associated with this match is merely a hint, i.e. the
   // user hasn't actually selected a keyword yet.  When this is true, we can use
   // keyword_ to show a "Press <tab> to search" sort of hint.
   bool is_keyword_hint_;
 
+  // Indicates how the user entered keyword mode if the user is actually in
+  // keyword mode.  Otherwise, the value of this variable is undefined.  This
+  // is used to restore the user's search terms upon a call to ClearKeyword().
+  KeywordModeEntryMethod keyword_mode_entry_method_;
+
   // This is needed to properly update the SearchModel state when the user
   // presses escape.
   bool in_revert_;
 
   // Indicates if the upcoming autocomplete search is allowed to be treated as
   // an exact keyword match.  If this is true then keyword mode will be
   // triggered automatically if the input is "<keyword> <search string>".  We
   // allow this when CreatedKeywordSearchByInsertingSpaceInMiddle() is true.
   // This has no effect if we're already in keyword mode.
   bool allow_exact_keyword_match_;
 
   // The input that was sent to the AutocompleteController. Since no
   // autocomplete query is started after a tab switch, it is possible for this
   // |input_| to differ from the one currently stored in AutocompleteController.
   AutocompleteInput input_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxEditModel);
 };
 
 #endif  // COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_EDIT_MODEL_H_