Componentize ToolbarModel

The ToolbarModel interface is used in omnibox code targeted for sharing with
iOS. This CL componentizes that interface to eliminate a blocker on the omnibox
componentization. There are no problematic dependencies, so the
componentization is straightforward.

TBR=yfriedman

BUG=511938

Review URL: https://codereview.chromium.org/1262133002

Cr-Commit-Position: refs/heads/master@{#341319}

1 files changed, 99 insertions, 0 deletions

diff --git a/components/toolbar/toolbar_model.h b/components/toolbar/toolbar_model.h
new file mode 100644
index 0000000..b592f30
--- /dev/null
+++ b/components/toolbar/toolbar_model.h
@@ -0,0 +1,99 @@
+// 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 COMPONENTS_TOOLBAR_TOOLBAR_MODEL_H_
+#define COMPONENTS_TOOLBAR_TOOLBAR_MODEL_H_
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/strings/string16.h"
+#include "url/gurl.h"
+
+namespace net {
+class X509Certificate;
+}
+
+// This class is the model used by the toolbar, location bar and autocomplete
+// edit.  It populates its states from the current navigation entry retrieved
+// from the navigation controller returned by GetNavigationController().
+class ToolbarModel {
+ public:
+  virtual ~ToolbarModel();
+
+  // Returns the text to be displayed in the toolbar for the current page.
+  // This will have been formatted for display to the user.
+  //   - If the current page's URL is a search URL for the user's default search
+  //     engine, the query will be extracted and returned for display instead
+  //     of the URL.
+  //   - Otherwise, the text will contain the URL returned by GetFormattedURL().
+  virtual base::string16 GetText() const = 0;
+
+  // Returns a formatted URL for display in the toolbar. The formatting
+  // includes:
+  //   - Some characters may be unescaped.
+  //   - The scheme and/or trailing slash may be dropped.
+  // If |prefix_end| is non-NULL, it is set to the length of the pre-hostname
+  // portion of the resulting URL.
+  virtual base::string16 GetFormattedURL(size_t* prefix_end) const = 0;
+
+  // Some search URLs bundle a special "corpus" param that we can extract and
+  // display next to users' search terms in cases where we'd show the search
+  // terms instead of the URL anyway.  For example, a Google image search might
+  // show the corpus "Images:" plus a search string.  This is only used on
+  // mobile.
+  virtual base::string16 GetCorpusNameForMobile() const = 0;
+
+  // Returns the URL of the current navigation entry.
+  virtual GURL GetURL() const = 0;
+
+  // Returns true if a call to GetText() would successfully replace the URL
+  // with search terms.  If |ignore_editing| is true, the result reflects the
+  // underlying state of the page without regard to any user edits that may be
+  // in progress in the omnibox.
+  virtual bool WouldPerformSearchTermReplacement(bool ignore_editing) const = 0;
+
+  // Returns true if a call to GetText() would return something other than the
+  // URL because of search term replacement.
+  bool WouldReplaceURL() const;
+
+  // Returns the resource_id of the icon to show to the left of the address,
+  // based on the current URL.  When search term replacement is active, this
+  // returns a search icon.  This doesn't cover specialized icons while the
+  // user is editing; see OmniboxView::GetIcon().
+  virtual int GetIcon() const = 0;
+
+  // Returns the name of the EV cert holder.  This returns an empty string if
+  // the security level is not EV_SECURE.
+  virtual base::string16 GetEVCertName() const = 0;
+
+  // Returns whether the URL for the current navigation entry should be
+  // in the location bar.
+  virtual bool ShouldDisplayURL() const = 0;
+
+  // Whether the text in the omnibox is currently being edited.
+  void set_input_in_progress(bool input_in_progress) {
+    input_in_progress_ = input_in_progress;
+  }
+  bool input_in_progress() const { return input_in_progress_; }
+
+  // Whether URL replacement should be enabled.
+  void set_url_replacement_enabled(bool enabled) {
+    url_replacement_enabled_ = enabled;
+  }
+  bool url_replacement_enabled() const {
+    return url_replacement_enabled_;
+  }
+
+ protected:
+  ToolbarModel();
+
+ private:
+  bool input_in_progress_;
+  bool url_replacement_enabled_;
+
+  DISALLOW_COPY_AND_ASSIGN(ToolbarModel);
+};
+
+#endif  // COMPONENTS_TOOLBAR_TOOLBAR_MODEL_H_