Omnibox refactor, moved OnResultChanged to 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"
@@ skipping 71 matching lines @@
                    Profile* profile);
   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) {
-    popup_ = popup_model;
-  }
+    omnibox_controller_->set_popup_model(popup_model);

[Peter Kasting, 2013/05/22 23:56:54]

I have no idea whether this is possible but it'd be cool to nuke this and
instead pass the popup model to the omnibox controller at construction time or
something.

[beaudoin, 2013/05/23 14:16:41]

I'd love this, unfortunately they're on two totally different lifecycles and the
OmniboxController outlives the popup_model. It roughly works like this:
- OmniboxView owns OmniboxEditModel who owns OmniboxController
- OmniboxPopupView owns OmniboxPopupModel

I've been thinking of an OmniboxPopupModel that would outlive the PopupView (ie.
owned by OmniboxView or below) but I'm not sure it would be useful, besides
cleaning-up the lifecycle above.

[sreeram, 2013/05/23 14:18:45]

I wouldn't worry too much about this. One of the goals of this refactor is to
allow us to get to a state where we can get rid of the popup model and view
entirely.

+   }
 
   // TODO: The edit and popup should be siblings owned by the LocationBarView,
   // making this accessor unnecessary.
-  OmniboxPopupModel* popup_model() const { return popup_; }
+  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|.
@@ skipping 114 matching lines @@
   // is_keyword_hint_).
   const string16& keyword() const { return keyword_; }
   bool is_keyword_hint() const { return is_keyword_hint_; }
 
   // 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);
 
+  // Accepts the current temporary text as the user text.
+  void AcceptTemporaryTextAsUserText();
+
   // Clears the current keyword.  |visible_text| is the (non-keyword) text
   // currently visible in the edit.
   void ClearKeyword(const string16& visible_text);
 
   // 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.
-  const AutocompleteResult& result() const;
+  const AutocompleteResult& result() const {
+    return omnibox_controller_->result();
+  }
 
   // Called when the view is gaining focus.  |control_down| is whether the
   // control key is down (at the time we're gaining focus).
   void OnSetFocus(bool control_down);
 
   // Sets the visibility of the caret in the omnibox, if it has focus. The
   // visibility of the caret is reset to visible if either
   //   - The user starts typing, or
   //   - We explicitly focus the omnibox again.
   // The latter case must be handled in three separate places--OnSetFocus(),
@@ skipping 17 matching lines @@
   // Called when the user presses or releases the control key.  Changes state as
   // necessary.
   void OnControlKeyChanged(bool pressed);
 
   // Called when the user pastes in text.
   void on_paste() { paste_state_ = PASTING; }
 
   // Returns true if pasting is in progress.
   bool is_pasting() const { return paste_state_ == PASTING; }
 
+  // TODO(beaudoin): Try not to expose this.
+  bool in_revert() const { return in_revert_; }
+
   // Called when the user presses up or down.  |count| is a repeat count,
   // negative for moving up, positive for moving down.
   virtual void OnUpOrDownKeyPressed(int count);
 
   // Called when any relevant data changes.  This rolls together several
   // separate pieces of data into one call so we can update all the UI
   // efficiently:
   //   |text| is either the new temporary text from the user manually selecting
   //     a different match, or the inline autocomplete text.  We distinguish by
   //     checking if |destination_for_temporary_text_change| is NULL.
@@ skipping 20 matching lines @@
   // may be false when the user is composing a text with an IME.
   bool OnAfterPossibleChange(const string16& old_text,
                              const string16& new_text,
                              size_t selection_start,
                              size_t selection_end,
                              bool selection_differs,
                              bool text_differs,
                              bool just_deleted_text,
                              bool allow_keyword_ui_change);
 
+  // TODO(beaudoin): Mac code still calls this here. We should try to untangle
+  // this.
   // Invoked when the popup has changed its bounds to |bounds|. |bounds| here
   // is in screen coordinates.
-  void OnPopupBoundsChanged(const gfx::Rect& bounds);
+  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);
 
  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
                     // directly to PASTED, OnAfterPossibleChange() wouldn't know
                     // whether that represented the current edit or a past one.
     PASTED,         // Most recent edit was a paste.
@@ skipping 18 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 45 matching lines @@
   // 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<OmniboxController> omnibox_controller_;
 
   OmniboxView* view_;
 
-  OmniboxPopupModel* popup_;
-
   OmniboxEditController* controller_;
 
   scoped_ptr<OmniboxCurrentPageDelegate> delegate_;
 
   OmniboxFocusState focus_state_;
 
   // The URL of the currently displayed page.
   string16 permanent_text_;
 
   // This flag is true when the user has modified the contents of the edit, but
@@ skipping 112 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_