Omnibox refactor, introduced OmniboxController.

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"
 #include "base/string16.h"
 #include "base/time.h"
 #include "chrome/browser/autocomplete/autocomplete_controller_delegate.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
+#include "chrome/browser/ui/omnibox/omnibox_controller.h"
 #include "chrome/common/metrics/proto/omnibox_event.pb.h"
 #include "chrome/common/omnibox_focus_state.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "ui/base/window_open_disposition.h"
 #include "ui/gfx/native_widget_types.h"
 
 class AutocompleteController;
 class AutocompleteResult;
 struct InstantSuggestion;
@@ skipping 25 matching lines @@
 
 // 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
 };
 
-class OmniboxEditModel : public AutocompleteControllerDelegate {
+class OmniboxEditModel {
  public:
   struct 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);
     ~State();
 
     bool user_input_in_progress;
     const string16 user_text;
     const string16 instant_suggestion;
     const string16 keyword;
     const bool is_keyword_hint;
     OmniboxFocusState focus_state;
   };
 
   OmniboxEditModel(OmniboxView* view,
                    OmniboxEditController* controller,
                    Profile* profile);
   virtual ~OmniboxEditModel();
 
   AutocompleteController* autocomplete_controller() const {

[Peter Kasting, 2013/04/25 18:24:55]

Ultimately, this accessor will disappear, right?  Since this class shouldn't
know about the AutocompleteController.  What outside this class uses this right
now?  Can we at least make it private?  Should we change the public function to
an OmniboxController accessor instead?

Also, this is another bad case of a const function returning a non-const
pointer.

[beaudoin, 2013/04/25 20:34:51]

It's used in ui_test_utils.cc. Instead of expanding this CL too much I've added
a TODO to remove this once the refactor is done.

There are two other const-returning-non-const methods below. *sigh*

Done.

-    return autocomplete_controller_.get();
+    return omnibox_controller_->autocomplete_controller();
   }
 
   void set_popup_model(OmniboxPopupModel* popup_model) {
     popup_ = popup_model;
   }
 
   // TODO: The edit and popup should be siblings owned by the LocationBarView,
   // making this accessor unnecessary.
   OmniboxPopupModel* popup_model() const { return popup_; }
 
@@ skipping 212 matching lines @@
                              size_t selection_end,
                              bool selection_differs,
                              bool text_differs,
                              bool just_deleted_text,
                              bool allow_keyword_ui_change);
 
   // Invoked when the popup has changed its bounds to |bounds|. |bounds| here
   // is in screen coordinates.
   void OnPopupBoundsChanged(const gfx::Rect& bounds);
 
+  // Called when the results have changed in the OmniboxController.
+  void OnResultChanged(bool default_match_changed);
+
  private:
   friend class InstantTestBase;
 
   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
                     // directly to PASTED, OnAfterPossibleChange() wouldn't know
                     // whether that represented the current edit or a past one.
     PASTED,         // Most recent edit was a paste.
   };
 
   enum ControlKeyState {
     UP,                   // The control key is not depressed.
     DOWN_WITHOUT_CHANGE,  // The control key is depressed, and the edit's
                           // contents/selection have not changed since it was
                           // depressed.  This is the only state in which we
                           // do the "ctrl-enter" behavior when the user hits
                           // enter.
     DOWN_WITH_CHANGE,     // The control key is depressed, and the edit's
                           // contents/selection have changed since it was
                           // depressed.  If the user now hits enter, we assume
                           // he simply hasn't released the key, rather than that
                           // he intended to hit "ctrl-enter".
   };
 
-  // AutocompleteControllerDelegate:
-  virtual void OnResultChanged(bool default_match_changed) OVERRIDE;
-
   // Returns true if a query to an autocomplete provider is currently
   // in progress.  This logic should in the future live in
   // 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.
@@ skipping 68 matching lines @@
   void ClassifyStringForPasteAndGo(const string16& text,
                                    AutocompleteMatch* match,
                                    GURL* alternate_nav_url) const;
 
   // If focus_state_ does not match |state|, we update it and notify the
   // InstantController about the change (passing along the |reason| for the
   // change). If the caret visibility changes, we call ApplyCaretVisibility() on
   // the view.
   void SetFocusState(OmniboxFocusState state, OmniboxFocusChangeReason reason);
 
-  scoped_ptr<AutocompleteController> autocomplete_controller_;
+  scoped_ptr<OmniboxController> omnibox_controller_;
 
   OmniboxView* view_;
 
   OmniboxPopupModel* popup_;
 
   OmniboxEditController* controller_;
 
   scoped_ptr<OmniboxCurrentPageDelegate> delegate_;
 
   OmniboxFocusState focus_state_;
@@ skipping 103 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_