Omnibox SearchProvider Experiment Client Implementation.

chrome/browser/autocomplete/search_provider.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 contains the Search autocomplete provider.  This provider is
 // responsible for all non-keyword autocomplete entries that start with
 // "Search <engine> for ...", including searching for the current input string,
 // search history, and search suggestions.  An instance of it gets created and
 // managed by the autocomplete controller.
 //
@@ skipping 140 matching lines @@
     TemplateURL cached_default_provider_;
     TemplateURL cached_keyword_provider_;
 
     // TODO(pkasting): http://b/1162970  We shouldn't need these.
     const TemplateURL* default_provider_;
     const TemplateURL* keyword_provider_;
 
     DISALLOW_COPY_AND_ASSIGN(Providers);
   };
 
-  struct NavigationResult {
-    NavigationResult(const GURL& url, const string16& site_name)
-        : url(url),
-          site_name(site_name) {
-    }
+  struct SuggestResult {
+    SuggestResult(const string16& suggestion,
+                  bool has_suggested_relevance,
+                  int relevance);
 
-    // The URL.
-    GURL url;
+    string16 suggestion;
 
-    // Name for the site.
-    string16 site_name;
+    bool has_suggested_relevance;
+    int relevance;
   };
 
-  typedef std::vector<string16> SuggestResults;
+  struct NavigationResult {
+    NavigationResult(const GURL& url,
+                     const string16& site_name,
+                     bool has_suggested_relevance,
+                     int relevance);
+
+    GURL url;
+    string16 site_name;
+
+    bool has_suggested_relevance;
+    int relevance;
+  };
+
+  typedef std::vector<SuggestResult> SuggestResults;
   typedef std::vector<NavigationResult> NavigationResults;
   typedef std::vector<history::KeywordSearchTermVisit> HistoryResults;
   typedef std::map<string16, AutocompleteMatch> MatchMap;
   typedef std::pair<string16, int> ScoredTerm;
   typedef std::vector<ScoredTerm> ScoredTerms;
 
   class CompareScoredTerms;
 
   // Called when timer_ expires.
   void Run();
 
   // Runs the history query, if necessary. The history query is synchronous.
   // This does not update |done_|.
   void DoHistoryQuery(bool minimal_changes);
 
   // Determines whether an asynchronous subcomponent query should run for the
   // current input.  If so, starts it if necessary; otherwise stops it.
   // NOTE: This function does not update |done_|.  Callers must do so.
   void StartOrStopSuggestQuery(bool minimal_changes);
 
   // Returns true when the current query can be sent to the Suggest service.
   // This will be false e.g. when Suggest is disabled, the query contains
   // potentially private data, etc.
   bool IsQuerySuitableForSuggest() const;
 
   // Stops the suggest query.
   // NOTE: This does not update |done_|.  Callers must do so.
   void StopSuggest();
 
+  // Clears the current results.
+  void ClearResults();
+
   // Creates a URLFetcher requesting suggest results from the specified
   // |suggestions_url|. The caller owns the returned URLFetcher.
   content::URLFetcher* CreateSuggestFetcher(
       int id,
       const TemplateURLRef& suggestions_url,
       const string16& text);
 
   // Parses the results from the Suggest server and stores up to kMaxMatches of
   // them in server_results_.  Returns whether parsing succeeded.
   bool ParseSuggestResults(base::Value* root_val,
@@ skipping 40 matching lines @@
   // |time| is the time at which this query was last seen.  |is_keyword|
   // indicates whether the results correspond to the keyword provider or default
   // provider. |prevent_inline_autocomplete| is true if we should not inline
   // autocomplete this query.
   int CalculateRelevanceForHistory(const base::Time& time,
                                    bool is_keyword,
                                    bool prevent_inline_autocomplete) const;
   // |result_number| is the index of the suggestion in the result set from the
   // server; the best suggestion is suggestion number 0.  |is_keyword| is true
   // if the search is from the keyword provider.
-  int CalculateRelevanceForSuggestion(size_t num_results,
+  int CalculateRelevanceForSuggestion(const SuggestResults& results,
                                       size_t result_number,
                                       bool is_keyword) const;
   // |result_number| is same as above. |is_keyword| is true if the navigation
   // result was suggested by the keyword provider.
-  int CalculateRelevanceForNavigation(size_t num_results,
+  int CalculateRelevanceForNavigation(const NavigationResults& results,
                                       size_t result_number,
                                       bool is_keyword) const;
 
   // Creates an AutocompleteMatch for "Search <engine> for |query_string|" with
   // the supplied relevance.  Adds this match to |map|; if such a match already
   // exists, whichever one has lower relevance is eliminated.
   void AddMatchToMap(const string16& query_string,
                      const string16& input_text,
                      int relevance,
                      AutocompleteMatch::Type type,
@@ skipping 13 matching lines @@
   // Should we query for suggest results immediately? This is normally false,
   // but may be set to true during testing.
   static bool query_suggest_immediately_;
 
   // Maintains the TemplateURLs used.
   Providers providers_;
 
   // The user's input.
   AutocompleteInput input_;
 
+  // The suggested verbatim relevance for SEARCH_WHAT_YOU_TYPED.
+  bool has_verbatim_relevance_;
+  int verbatim_relevance_;
+
   // Input text when searching against the keyword provider.
   string16 keyword_input_text_;
 
   // Searches in the user's history that begin with the input text.
   HistoryResults keyword_history_results_;
   HistoryResults default_history_results_;
 
   // Number of suggest results that haven't yet arrived. If greater than 0 it
   // indicates either |timer_| or one of the URLFetchers is still running.
   int suggest_results_pending_;
@@ skipping 23 matching lines @@
   // Has FinalizeInstantQuery been invoked since the last |Start|?
   bool instant_finalized_;
 
   // The |suggest_text| parameter passed to FinalizeInstantQuery.
   string16 default_provider_suggest_text_;
 
   DISALLOW_COPY_AND_ASSIGN(SearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_SEARCH_PROVIDER_H_