Part 6 of search provider refactoring.

chrome/browser/autocomplete/zero_suggest_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 zero-suggest autocomplete provider. This experimental
 // provider is invoked when the user focuses in the omnibox prior to editing,
 // and generates search query suggestions based on the current URL. To enable
 // this provider, point --experimental-zero-suggest-url-prefix at an
 // appropriate suggestion service.
 //
@@ skipping 63 matching lines @@
   // BaseSearchProvider:
   virtual const TemplateURL* GetTemplateURL(
       const SuggestResult& result) const OVERRIDE;
   virtual const AutocompleteInput GetInput(
       const SuggestResult& result) const OVERRIDE;
   virtual bool ShouldAppendExtraParams(
       const SuggestResult& result) const OVERRIDE;
   virtual void StopSuggest() OVERRIDE;
   virtual void ClearAllResults() OVERRIDE;
 
-  // The 4 functions below (that take classes defined in SearchProvider as
-  // arguments) were copied and trimmed from SearchProvider.
-  // TODO(hfung): Refactor them into a new base class common to both

[H Fung, 2014/02/19 06:33:31]

I think the comment and TODO are still valid, except the 4 should now be 2.

[Maria, 2014/02/19 18:25:53]

I figure that rather than keep updating the countdown, I'd remove the TODO -- I
don't think we are going to need it at the end of the refactoring.

-  // ZeroSuggestProvider and SearchProvider.
-
-  // From the OpenSearch formatted response |root_val|, populate query
-  // suggestions into |suggest_results|, navigation suggestions into
-  // |navigation_results|, and the verbatim relevance score into
-  // |verbatim_relevance|.
-  void FillResults(const base::Value& root_val,
-                   int* verbatim_relevance,
-                   SuggestResults* suggest_results,
-                   NavigationResults* navigation_results);
-
   // Adds AutocompleteMatches for each of the suggestions in |results| to
   // |map|.
   void AddSuggestResultsToMap(const SuggestResults& results,
                               MatchMap* map);
 
   // Returns an AutocompleteMatch for a navigational suggestion |navigation|.
   AutocompleteMatch NavigationToMatch(const NavigationResult& navigation);
 
   // Fetches zero-suggest suggestions by sending a request using |suggest_url|.
   void Run(const GURL& suggest_url);
 
-  // Parses results from the zero-suggest server and updates results.
+  // Parses results from the zero-suggest server and updates |results_|.
   void ParseSuggestResults(const base::Value& root_val);
 
   // Converts the parsed results to a set of AutocompleteMatches and adds them
   // to |matches_|.  Also update the histograms for how many results were
   // received.
   void ConvertResultsToAutocompleteMatches();
 
   // Returns an AutocompleteMatch for the current URL. The match should be in
   // the top position so that pressing enter has the effect of reloading the
   // page.
   AutocompleteMatch MatchForCurrentURL();
 
   // When the user is in the Most Visited field trial, we ask the TopSites
   // service for the most visited URLs during Run().  It calls back to this
   // function to return those |urls|.
   void OnMostVisitedUrlsAvailable(const history::MostVisitedURLList& urls);
 
+  // Returns the relevance score for the verbatim result.
+  int GetVerbatimRelevance() const;
+
   // Used to build default search engine URLs for suggested queries.
   TemplateURLService* template_url_service_;
 
   // The URL for which a suggestion fetch is pending.
   std::string current_query_;
 
   // The type of page the user is viewing (a search results page doing search
   // term replacement, an arbitrary URL, etc.).
   AutocompleteInput::PageClassification current_page_classification_;
 
   // Copy of OmniboxEditModel::permanent_text_.
   base::string16 permanent_text_;
 
   // Fetcher used to retrieve results.
   scoped_ptr<net::URLFetcher> fetcher_;
   // Whether there's a pending request in flight.
   bool have_pending_request_;
 
   // Suggestion for the current URL.
   AutocompleteMatch current_url_match_;
-  // Navigation suggestions for the most recent ZeroSuggest input URL.
-  NavigationResults navigation_results_;
-  // Query suggestions for the most recent ZeroSuggest input URL.
-  MatchMap query_matches_map_;
-  // The relevance score for the URL of the current page.
-  int verbatim_relevance_;
+
+  // Contains suggest and navigation results as well as relevance parsed from
+  // the response for the most recent zero suggest input URL.
+  Results results_;
 
   history::MostVisitedURLList most_visited_urls_;
 
   // For callbacks that may be run after destruction.
   base::WeakPtrFactory<ZeroSuggestProvider> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ZeroSuggestProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_ZERO_SUGGEST_PROVIDER_H_