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

components/omnibox/browser/omnibox_view.h

 // Copyright (c) 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.
 
 // This file defines the interface class OmniboxView.  Each toolkit will
 // implement the edit view differently, so that code is inherently platform
 // specific.  However, the OmniboxEditModel needs to do some communication with
 // the view.  Since the model is shared between platforms, we need to define an
 // interface that all view implementations will share.
 
 #ifndef COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_VIEW_H_
 #define COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_VIEW_H_
 
 #include <stddef.h>
 
 #include <string>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "components/omnibox/browser/autocomplete_match.h"
-#include "components/omnibox/browser/omnibox_edit_model.h"
 #include "ui/base/window_open_disposition.h"
 #include "ui/gfx/native_widget_types.h"
 
 class GURL;
 class OmniboxClient;
 class OmniboxEditController;
 class OmniboxViewMacTest;
 class ToolbarModel;
+class OmniboxEditModel;
 
 namespace gfx {
 enum class VectorIconId;
 }
 
 class OmniboxView {
  public:
+  // 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().
+  struct StateChanges {
+    // |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;
+  };
+
   virtual ~OmniboxView();
 
   // Used by the automation system for getting at the model from the view.
   OmniboxEditModel* model() { return model_.get(); }
   const OmniboxEditModel* model() const { return model_.get(); }
 
   // Shared cross-platform focus handling.
   void OnDidKillFocus();
 
   // Called when any relevant state changes other than changing tabs.
@@ skipping 38 matching lines @@
   virtual void SetUserText(const base::string16& text,
                            bool update_popup);
 
   // Sets the window text and the caret position. |notify_text_changed| is true
   // if the model should be notified of the change.
   virtual void SetWindowTextAndCaretPos(const base::string16& text,
                                         size_t caret_pos,
                                         bool update_popup,
                                         bool notify_text_changed) = 0;
 
-  // Sets the edit to forced query mode.  Practically speaking, this means that
-  // if the edit is not in forced query mode, its text is set to "?" with the
-  // cursor at the end, and if the edit is in forced query mode (its first
-  // non-whitespace character is '?'), the text after the '?' is selected.
-  //
-  // In the future we should display the search engine UI for the default engine
-  // rather than '?'.
-  virtual void SetForcedQuery() = 0;
+  // Transitions the user into keyword mode with their default search provider,
+  // preserving and selecting the user's text if they already typed in a query.
+  virtual void EnterKeywordModeForDefaultSearchProvider() = 0;
 
   // Returns true if all text is selected or there is no text at all.
   virtual bool IsSelectAll() const = 0;
 
   // Returns true if the user deleted the suggested text.
   virtual bool DeleteAtEndPressed() = 0;
 
   // Fills |start| and |end| with the indexes of the current selection's bounds.
   // It is not guaranteed that |*start < *end|, as the selection can be
   // directed.  If there is no selection, |start| and |end| will both be equal
@@ skipping 116 matching lines @@
   // First, calls StripJavascriptSchemas().  Then automatically collapses
   // internal whitespace as follows:
   // * If the only whitespace in |text| is newlines, users are most likely
   // pasting in URLs split into multiple lines by terminals, email programs,
   // etc. So all newlines are removed.
   // * Otherwise, users may be pasting in search data, e.g. street addresses. In
   // this case, runs of whitespace are collapsed down to single spaces.
   static base::string16 SanitizeTextForPaste(const base::string16& text);
 
  protected:
+  // Tracks important state that may change between OnBeforePossibleChange() and
+  // OnAfterPossibleChange().
+  struct State {
+    base::string16 text;
+    base::string16 keyword;
+    bool is_keyword_selected;
+    size_t sel_start;
+    size_t sel_end;
+  };
+
   OmniboxView(OmniboxEditController* controller,
               std::unique_ptr<OmniboxClient> client);
 
+  // Fills |state| with the current text state.
+  void GetState(State* state);
+
+  // Returns the delta between |before| and |after|.
+  StateChanges GetStateChanges(const State& before,
+                                          const State& after);
+
   // Internally invoked whenever the text changes in some way.
   virtual void TextChanged();
 
   // Return the number of characters in the current buffer. The name
   // |GetTextLength| can't be used as the Windows override of this class
   // inherits from a class that defines a method with that name.
   virtual int GetOmniboxTextLength() const = 0;
 
   // Try to parse the current text as a URL and colorize the components.
   virtual void EmphasizeURLComponents() = 0;
 
   OmniboxEditController* controller() { return controller_; }
   const OmniboxEditController* controller() const { return controller_; }
 
  private:
   friend class OmniboxViewMacTest;
   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, ShowURL);
 
   // |model_| can be NULL in tests.
   std::unique_ptr<OmniboxEditModel> model_;
   OmniboxEditController* controller_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxView);
 };
 
 #endif  // COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_VIEW_H_