Instant Extended: Add prominent search term support

chrome/browser/ui/toolbar/toolbar_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_TOOLBAR_TOOLBAR_MODEL_H_
 #define CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_
 
 #include <string>
 
 #include "base/basictypes.h"
@@ skipping 11 matching lines @@
  public:
   // TODO(wtc): unify ToolbarModel::SecurityLevel with SecurityStyle.  We
   // don't need two sets of security UI levels.  SECURITY_STYLE_AUTHENTICATED
   // needs to be refined into three levels: warning, standard, and EV.
   enum SecurityLevel {
 #define DEFINE_TOOLBAR_MODEL_SECURITY_LEVEL(name,value)  name = value,
 #include "chrome/browser/ui/toolbar/toolbar_model_security_level_list.h"
 #undef DEFINE_TOOLBAR_MODEL_SECURITY_LEVEL
   };
 
+  enum SearchTermType {

[Peter Kasting, 2013/04/25 19:42:54]

Nit: Add comment above enum:

If search URLs may be displayed as search terms, these are the types of search
terms that may be extracted from the URL.  See comments on GetText() and
GetSearchTermsType().

[sail, 2013/04/25 22:18:46]

Done.

+    // There are no search terms.
+    SEARCH_TERM_NONE,
+    // There are regular search terms.
+    SEARCH_TERM_NORMAL,
+    // There are search terms that require a more prominent UI. For example,
+    // if the search term looks like a URL then it should be clear to the user
+    // that a search term is being displayed.
+    SEARCH_TERM_PROMINENT,

[Peter Kasting, 2013/04/25 19:42:54]

I think these would make more sense named as:

NO_SEARCH_TERMS,
NORMAL_SEARCH_TERMS,
URL_LIKE_SEARCH_TERMS

This removes the idea of "what is the UI to show these" from the ToolbarModel,
which really doesn't care about such a concept, and instead just phrases things
in terms of different kinds of search terms.  It also avoids using "PROMINENT"
alone which is a bit confusing (as compared to something like
PROMINENT_UI_NEEDED).

I realize that URL_LIKE_... may be a misnomer for normal-looking search terms
with a mixed-content warning present; since that's intended to be an
error-handling case (Google should normally never have mixed-content problems),
I think it's OK to just add a comment about why we're doing this to the
appropriate spot in the implementation.

[sail, 2013/04/25 22:18:46]

Done.

+  };
+
   virtual ~ToolbarModel() {}
 
   // Returns the text for the current page's URL. This will have been formatted
   // for display to the user:
   //   - Some characters may be unescaped.
   //   - The scheme and/or trailing slash may be dropped.
   //   - if |display_search_urls_as_search_terms| is true, the query will be
   //   extracted from search URLs for the user's default search engine and those
   //   will be displayed in place of the URL.
   virtual string16 GetText(bool display_search_urls_as_search_terms) 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 string16 GetCorpusNameForMobile() const = 0;
 
   // Returns the URL of the current navigation entry.
   virtual GURL GetURL() const = 0;
 
-  // Returns true if a call to GetText(true) would successfully replace the URL
-  // with search terms.
-  virtual bool WouldReplaceSearchURLWithSearchTerms() const = 0;
+  // This indicates the type of search terms returned by a call to
+  // GetText(true).
+  virtual SearchTermType GetSearchTermType() const = 0;

[Peter Kasting, 2013/04/25 19:42:54]

Tiny nit: GetSearchTermsType() seems more correct

[sail, 2013/04/25 22:18:46]

Done.

+
+  // Setter for whether the UI can display a more prominent UI for search terms
+  // that require it.
+  virtual void SetIsProminentSearchTermUISupported(bool value) = 0;

[Peter Kasting, 2013/04/25 19:42:54]

With the enum naming change above, this would become

  SetSupportsExtractionOfURLLikeSearchTerms()

[sail, 2013/04/25 22:18:46]

Done.

 
   // Returns the security level that the toolbar should display.
   virtual SecurityLevel GetSecurityLevel() const = 0;
 
   // Returns the resource_id of the icon to show to the left of the address,
   // based on the current URL.  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.  Only call this when the security
   // level is EV_SECURE.
   virtual string16 GetEVCertName() const = 0;
 
   // Returns whether the URL for the current navigation entry should be
   // in the location bar.
   virtual bool ShouldDisplayURL() const = 0;
 
   // Getter/setter of whether the text in location bar is currently being
   // edited.
   virtual void SetInputInProgress(bool value) = 0;
   virtual bool GetInputInProgress() const = 0;
 
  protected:
    ToolbarModel() {}
 };
 
 #endif  // CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_