Omnibox refactor. Move StartAutocomplete and DoInstant to controller.

chrome/browser/ui/omnibox/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 CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 72 matching lines @@
   virtual ~OmniboxEditModel();
 
   // TODO(beaudoin): Remove this accessor when the AutocompleteController has
   //     completely moved to OmniboxController.
   AutocompleteController* autocomplete_controller() const {
     return omnibox_controller_->autocomplete_controller();
   }
 
   void set_popup_model(OmniboxPopupModel* popup_model) {
     omnibox_controller_->set_popup_model(popup_model);
-   }
+  }
 
   // TODO: The edit and popup should be siblings owned by the LocationBarView,
   // making this accessor unnecessary.
   OmniboxPopupModel* popup_model() const {
     return omnibox_controller_->popup_model();
   }
 
   OmniboxEditController* controller() const { return controller_; }
 
   Profile* profile() const { return profile_; }
 
   // Returns the current state.  This assumes we are switching tabs, and changes
   // the internal state appropriately.
   const State GetStateForTabSwitch();
 
   // Restores local state from the saved |state|.
   void RestoreState(const State& state);
 
   // Returns the match for the current text. If the user has not edited the text
   // this is the match corresponding to the permanent text.
   AutocompleteMatch CurrentMatch();
 
   // Called when the user wants to export the entire current text as a URL.
   // Sets the url, and if known, the title and favicon.
   void GetDataForURLExport(GURL* url, string16* title, gfx::Image* favicon);
 
-  // Returns true if a verbatim query should be used for Instant. A verbatim
-  // query is forced in certain situations, such as pressing delete at the end
-  // of the edit.
-  bool UseVerbatimInstant();
-
   // Returns true if the current edit contents will be treated as a
   // URL/navigation, as opposed to a search.
   bool CurrentTextIsURL() const;
 
   // Returns the match type for the current edit contents.
   AutocompleteMatch::Type CurrentTextType() const;
 
   // Invoked to adjust the text before writting to the clipboard for a copy
   // (e.g. by adding 'http' to the front). |sel_min| gives the minimum position
   // of the selection e.g. min(selection_start, selection_end). |text| is the
@@ skipping 17 matching lines @@
   // editing or the edit does not have focus.
   bool UpdatePermanentText(const string16& new_permanent_text);
 
   // Returns the URL corresponding to the permanent text.
   GURL PermanentURL();
 
   // Sets the user_text_ to |text|.  Only the View should call this.
   void SetUserText(const string16& text);
 
   // Calls through to SearchProvider::FinalizeInstantQuery.
-  // If |skip_inline_autocomplete| is true then the |suggestion| text will be
-  // turned into final text instead of inline autocomplete suggest.
   void FinalizeInstantQuery(const string16& input_text,
-                            const InstantSuggestion& suggestion,
-                            bool skip_inline_autocomplete);
+                            const InstantSuggestion& suggestion);
 
   // Sets the suggestion text.
   void SetInstantSuggestion(const InstantSuggestion& suggestion);
 
-  // Commits the suggested text. If |skip_inline_autocomplete| is true then the
-  // suggested text will be committed as final text as if it's inputted by the
-  // user, rather than as inline autocomplete suggest.
+  // Commits the gray suggested text as if it's been input by the user.
   // Returns true if the text was committed.
   // TODO: can the return type be void?
-  bool CommitSuggestedText(bool skip_inline_autocomplete);
+  bool CommitSuggestedText();
 
   // Invoked any time the text may have changed in the edit. Updates Instant and
   // notifies the controller.
   void OnChanged();
 
   // Reverts the edit model back to its unedited state (permanent text showing,
   // no user input in progress).
   void Revert();
 
   // Directs the popup to start autocomplete.
@@ skipping 141 matching lines @@
   // this.
   // Invoked when the popup has changed its bounds to |bounds|. |bounds| here
   // is in screen coordinates.
   void OnPopupBoundsChanged(const gfx::Rect& bounds) {
     omnibox_controller_->OnPopupBoundsChanged(bounds);
   }
 
   // Called when the results have changed in the OmniboxController.
   void OnResultChanged(bool default_match_changed);
 
+  // TODO(beaudoin): We need this to allow OmniboxController access the
+  // InstantController via OmniboxEditController, because the only valid pointer
+  // to InstantController is kept in Browser. We should try to get rid of this,
+  // maybe by ensuring InstantController lives as long as Browser.
+  InstantController* GetInstantController() const;
+
  private:
   friend class InstantTestBase;
   friend class OmniboxControllerTest;
 
   enum PasteState {
     NONE,           // Most recent edit was not a paste.
     PASTING,        // In the middle of doing a paste. We need this intermediate
                     // state because OnPaste() does the actual detection of
                     // paste, but OnAfterPossibleChange() has to update the
                     // paste state for every edit. If OnPaste() set the state
@@ skipping 21 matching lines @@
   // AutocompleteController but resides here for now.  This method is used by
   // AutomationProvider::AutocompleteEditIsQueryInProgress.
   bool query_in_progress() const;
 
   // Called whenever user_text_ should change.
   void InternalSetUserText(const string16& text);
 
   // Returns true if a keyword is selected.
   bool KeywordIsSelected() const;
 
+  // Turns off keyword mode for the current match.
+  void ClearPopupKeywordMode() const;
+
   // Conversion between user text and display text. User text is the text the
   // user has input. Display text is the text being shown in the edit. The
   // two are different if a keyword is selected.
   string16 DisplayTextFromUserText(const string16& text) const;
   string16 UserTextFromDisplayText(const string16& text) const;
 
   // If there's a selected match, copies it into |match|. Else, returns the
   // default match for the current text, as well as the alternate nav URL, if
   // |alternate_nav_url| is non-NULL and there is such a URL.
   void GetInfoForCurrentText(AutocompleteMatch* match,
@@ skipping 11 matching lines @@
   // Returns true if the current keyword is accepted.
   bool MaybeAcceptKeywordBySpace(const string16& new_text);
 
   // Checks whether the user inserted a space into |old_text| and by doing so
   // created a |new_text| that looks like "<keyword> <search phrase>".
   bool CreatedKeywordSearchByInsertingSpaceInMiddle(
       const string16& old_text,
       const string16& new_text,
       size_t caret_position) const;
 
-  // Tries to start an Instant preview for |match|. Returns true if Instant
-  // processed the match.
-  bool DoInstant(const AutocompleteMatch& match);
-
-  // Starts a DNS prefetch for the given |match|.
-  void DoPreconnect(const AutocompleteMatch& match);
-
   // Checks if a given character is a valid space character for accepting
   // keyword.
   static bool IsSpaceCharForAcceptingKeyword(wchar_t c);
 
   // Classify the current page being viewed as, for example, the new tab
   // page or a normal web page.  Used for logging omnibox events for
   // UMA opted-in users.  Examines the user's profile to determine if the
   // current page is the user's home page.
   metrics::OmniboxEventProto::PageClassification ClassifyPage(
       const GURL& gurl) const;
@@ skipping 139 matching lines @@
   // 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_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxEditModel);
 };
 
 #endif  // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_