Moving common code into OmniboxView from OmniboxView*

chrome/browser/ui/omnibox/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 CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_
 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_
 
 #include <string>
 
 #include "base/string16.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
+#include "chrome/browser/ui/omnibox/omnibox_edit_model.h"
+#include "chrome/browser/ui/toolbar/toolbar_model.h"
 #include "content/public/common/url_constants.h"
 #include "ui/gfx/native_widget_types.h"
 #include "webkit/glue/window_open_disposition.h"
 
 class CommandUpdater;
 class GURL;
+class OmniboxEditController;
 class OmniboxEditModel;
+class Profile;
+class ToolbarModel;
 
 namespace content {
 class WebContents;
 }
 
 #if defined(TOOLKIT_VIEWS)
 // TODO(beng): Move all views-related code to a views-specific sub-interface.
 namespace gfx {
 class Font;
 }
 
 namespace views {
 class DropTargetEvent;
 class View;
 }
 #endif
 
 class OmniboxView {
  public:
   // Used by the automation system for getting at the model from the view.
-  virtual OmniboxEditModel* model() = 0;
-  virtual const OmniboxEditModel* model() const = 0;
+  virtual OmniboxEditModel* GetModel();
+  virtual const OmniboxEditModel* GetModel() const;
 
   // For use when switching tabs, this saves the current state onto the tab so
   // that it can be restored during a later call to Update().
   virtual void SaveStateToTab(content::WebContents* tab) = 0;
 
   // Called when any LocationBarView state changes. If
   // |tab_for_state_restoring| is non-NULL, it points to a WebContents whose
   // state we should restore.
   virtual void Update(const content::WebContents* tab_for_state_restoring) = 0;
 
   // Asks the browser to load the specified match's |destination_url|, which
   // is assumed to be one of the popup entries, using the supplied disposition
   // and transition type. |alternate_nav_url|, if non-empty, contains the
   // alternate navigation URL for for this match. See comments on
   // AutocompleteResult::GetAlternateNavURL().
   //
   // |selected_line| is passed to SendOpenNotification(); see comments there.
   //
   // This may close the popup.
   virtual void OpenMatch(const AutocompleteMatch& match,
                          WindowOpenDisposition disposition,
                          const GURL& alternate_nav_url,
-                         size_t selected_line) = 0;
+                         size_t selected_line);
 
   // Returns the current text of the edit control, which could be the
   // "temporary" text set by the popup, the "permanent" text set by the
   // browser, or just whatever the user has currently typed.
   virtual string16 GetText() const = 0;
 
   // |true| if the user is in the process of editing the field, or if
   // the field is empty.
-  virtual bool IsEditingOrEmpty() const = 0;
+  virtual bool IsEditingOrEmpty() const;
 
   // Returns the resource ID of the icon to show for the current text.
-  virtual int GetIcon() const = 0;
+  virtual int GetIcon() const;
 
   // The user text is the text the user has manually keyed in.  When present,
   // this is shown in preference to the permanent text; hitting escape will
   // revert to the permanent text.
-  virtual void SetUserText(const string16& text) = 0;
+  void SetUserText(const string16& text);
   virtual void SetUserText(const string16& text,
                            const string16& display_text,
-                           bool update_popup) = 0;
+                           bool update_popup);
 
   // Sets the window text and the caret position.
   virtual void SetWindowTextAndCaretPos(const 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
@@ skipping 14 matching lines @@
   // directed.  If there is no selection, |start| and |end| will both be equal
   // to the current cursor position.
   virtual void GetSelectionBounds(size_t* start, size_t* end) const = 0;
 
   // Selects all the text in the edit.  Use this in place of SetSelAll() to
   // avoid selecting the "phantom newline" at the end of the edit.
   virtual void SelectAll(bool reversed) = 0;
 
   // Reverts the edit and popup back to their unedited state (permanent text
   // showing, popup closed, no user input in progress).
-  virtual void RevertAll() = 0;
+  virtual void RevertAll();
 
   // Updates the autocomplete popup and other state after the text has been
   // changed by the user.
   virtual void UpdatePopup() = 0;
 
   // Closes the autocomplete popup, if it's open.
-  virtual void ClosePopup() = 0;
+  virtual void ClosePopup();
 
   // Sets the focus to the autocomplete view.
   virtual void SetFocus() = 0;
 
   // Called when the temporary text in the model may have changed.
   // |display_text| is the new text to show; |save_original_selection| is true
   // when there wasn't previously a temporary text and thus we need to save off
   // the user's existing selection.
   virtual void OnTemporaryTextMaybeChanged(const string16& display_text,
                                            bool save_original_selection) = 0;
@@ skipping 19 matching lines @@
 
   // Returns the gfx::NativeView of the edit view.
   virtual gfx::NativeView GetNativeView() const = 0;
 
   // Gets the relative window for the pop up window of OmniboxPopupView. The pop
   // up window will be shown under the relative window. When an IME is attached
   // to the rich edit control, the IME window is the relative window. Otherwise,
   // the top-most window is the relative window.
   virtual gfx::NativeView GetRelativeWindowForPopup() const = 0;
 
-  // Returns the command updater for this view.
-  virtual CommandUpdater* GetCommandUpdater() = 0;
-
   // Shows the instant suggestion text. If |animate_to_complete| is true the
   // view should start an animation that when done commits the text.
   virtual void SetInstantSuggestion(const string16& input,
                                     bool animate_to_complete) = 0;
 
   // Returns the current instant suggestion text.
   virtual string16 GetInstantSuggestion() const = 0;
 
   // Returns the width in pixels needed to display the current text. The
   // returned value includes margins.
@@ skipping 13 matching lines @@
   virtual int OnPerformDrop(const views::DropTargetEvent& event) = 0;
 
   // Returns the font.
   virtual gfx::Font GetFont() = 0;
 
   // Returns the width in pixels needed to display the text from one character
   // before the caret to the end of the string.
   virtual int WidthOfTextAfterCursor() = 0;
 #endif
 
+  virtual CommandUpdater* GetCommandUpdater();
+  virtual const CommandUpdater* GetCommandUpdater() const;
+
   // Returns a string with any leading javascript schemas stripped from the
   // input text.
   static string16 StripJavascriptSchemas(const string16& text);
 
   // Returns the current clipboard contents as a string that can be pasted in.
   // In addition to just getting CF_UNICODETEXT out, this can also extract URLs
   // from bookmarks on the clipboard.
   static string16 GetClipboardText();
 
-  virtual ~OmniboxView() {}
+  virtual ~OmniboxView();

[Peter Kasting, 2012/07/26 03:59:17]

Nit: Destructor should be at the top of the relevant section, just below the
constructor.  This destructor can perhaps be protected?

[dominich, 2012/07/26 22:33:24]

It can't be protected. It's destroyed through scoped_ptr on at least CrOS.

[Peter Kasting, 2012/07/26 23:03:24]

Ah, I see.  Yeah, has to be public.

+
+ protected:
+  OmniboxView(Profile* profile,
+              OmniboxEditController* controller,
+              ToolbarModel* toolbar_model,
+              CommandUpdater* command_updater);
+
+  // Internally invoked whenever the text changes in some way.
+  virtual void TextChanged();
+
+  // Return the number of characters in the current buffer.
+  virtual int GetOmniboxTextLength() const = 0;
+
+  // Try to parse the current text as a URL and colorize the components.
+  virtual void EmphasizeURLComponents() = 0;
+
+  scoped_ptr<OmniboxEditModel> model_;

[Peter Kasting, 2012/07/26 03:59:17]

Nit: The Google style guide forbids protected data members and requests that
subclasses use accessors to get at base class members.

[dominich, 2012/07/26 22:33:24]

Done.

+  OmniboxEditController* controller_;
+  ToolbarModel* toolbar_model_;
+
+  // The object that handles additional command functionality exposed on the
+  // edit, such as invoking the keyword editor.
+  CommandUpdater* command_updater_;
 };
 
 #endif  // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_