Part 4 of search provider refactoring.

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 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 39 matching lines @@
   static const int kDefaultProviderURLFetcherID;
 
   // ID used in creating URLFetcher for keyword provider's suggest results.
   static const int kKeywordProviderURLFetcherID;
 
   // ID used in creating URLFetcher for deleting suggestion results.
   static const int kDeletionURLFetcherID;
 
   SearchProvider(AutocompleteProviderListener* listener, Profile* profile);
 
-  // Returns whether the SearchProvider previously flagged |match| as a query
-  // that should be prefetched.
-  static bool ShouldPrefetch(const AutocompleteMatch& match);
-
   // Extracts the suggest response metadata which SearchProvider previously
   // stored for |match|.
   static std::string GetSuggestMetadata(const AutocompleteMatch& match);
 
   // AutocompleteProvider:
   virtual void DeleteMatch(const AutocompleteMatch& match) OVERRIDE;
   virtual void ResetSession() OVERRIDE;
 
   // This URL may be sent with suggest requests; see comments on CanSendURL().
   void set_current_page_url(const GURL& current_page_url) {
@@ skipping 86 matching lines @@
                                                   bool prefer_keyword);
 
   // AutocompleteProvider:
   virtual void Start(const AutocompleteInput& input,
                      bool minimal_changes) OVERRIDE;
   virtual void Stop(bool clear_cached_results) OVERRIDE;
 
   // net::URLFetcherDelegate:
   virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;
 
+  // BaseSearchProvider:
+  virtual bool ShouldAppendExtraParams(
+      const SuggestResult& result) const OVERRIDE;
+
   // This gets called when we have requested a suggestion deletion from the
   // server to handle the results of the deletion.
   void OnDeletionComplete(bool success,
                           SuggestionDeletionHandler* handler);
 
   // Records in UMA whether the deletion request resulted in success.
   // This is virtual so test code can override it to check that we
   // correctly handle the request result.
   virtual void RecordDeletionResult(bool success);
 
@@ skipping 89 matching lines @@
                                      bool base_prevent_inline_autocomplete,
                                      bool input_multiple_words,
                                      const base::string16& input_text,
                                      bool is_keyword);
 
   // Adds matches for |results| to |map|.
   void AddSuggestResultsToMap(const SuggestResults& results,
                               const std::string& metadata,
                               MatchMap* map);
 
+  // Returns the AutocompleteInput object corresponding to the given |result|.

[Mark P, 2014/02/12 23:35:49]

Can we try a comment that makes it clearer most properties of result don't
matter?  Perhaps something like:
// Return the relevant AutocompleteInput object based on whether result is from
the keyword provider.

ditto analogous comment for GetTemplateURL

[Maria, 2014/02/13 21:07:36]

I decided to change this to take is_keyword instead because I realized that will
be more useful in one of my next refactorings. Comment adjusted.

+  const AutocompleteInput GetInput(const SuggestResult& result) const;
+
+  // Returns the TemplateURL used to search for the |result|.
+  const TemplateURL* GetTemplateURL(const SuggestResult& result) const;

[H Fung, 2014/02/13 01:43:33]

Maybe consider moving this into BaseSearchProvider and override it in
SearchProvider and ZeroSuggestProvider?  That way, it doesn't need to be passed
to AddMatchToMap().

[msw, 2014/02/13 02:43:50]

+1

[Maria, 2014/02/13 21:07:36]

Done.

+
   // Gets the relevance score for the verbatim result.  This value may be
   // provided by the suggest server or calculated locally; if
   // |relevance_from_server| is non-NULL, it will be set to indicate which of
   // those is true.
   int GetVerbatimRelevance(bool* relevance_from_server) const;
 
   // Calculates the relevance score for the verbatim result from the
   // default search engine.  This version takes into account context:
   // i.e., whether the user has entered a keyword-based search or not.
   int CalculateRelevanceForVerbatim() const;
@@ skipping 16 matching lines @@
   // indicates whether the results correspond to the keyword provider or default
   // provider. |use_aggressive_method| says whether this function can use a
   // method that gives high scores (1200+) rather than one that gives lower
   // scores.  When using the aggressive method, scores may exceed 1300
   // unless |prevent_search_history_inlining| is set.
   int CalculateRelevanceForHistory(const base::Time& time,
                                    bool is_keyword,
                                    bool use_aggressive_method,
                                    bool prevent_search_history_inlining) const;
 
-  // Creates an AutocompleteMatch for "Search <engine> for |query_string|" with
-  // the supplied details.  Adds this match to |map|; if such a match already
-  // exists, whichever one has lower relevance is eliminated.
-  void AddMatchToMap(const SuggestResult& result,
-                     const base::string16& input_text,
-                     const std::string& metadata,
-                     int accepted_suggestion,
-                     MatchMap* map);
-
   // Returns an AutocompleteMatch for a navigational suggestion.
   AutocompleteMatch NavigationToMatch(const NavigationResult& navigation);
 
   // Resets the scores of all |keyword_navigation_results_| matches to
   // be below that of the top keyword query match (the verbatim match
   // as expressed by |keyword_verbatim_relevance_| or keyword query
   // suggestions stored in |keyword_suggest_results_|).  If there
   // are no keyword suggestions and keyword verbatim is suppressed,
   // then drops the suggested relevance scores for the navsuggestions
   // and drops the request to suppress verbatim, thereby introducing the
   // keyword verbatim match which will naturally outscore the navsuggestions.
   void DemoteKeywordNavigationMatchesPastTopQuery();
 
   // Updates the value of |done_| from the internal state.
   void UpdateDone();
 
   // The amount of time to wait before sending a new suggest request after the
   // previous one.  Non-const because some unittests modify this value.
   static int kMinimumTimeBetweenSuggestQueriesMs;
 
-  // The following keys are used to record additional information on matches.
-
-  // We annotate our AutocompleteMatches with whether their relevance scores
-  // were server-provided using this key in the |additional_info| field.
-  static const char kRelevanceFromServerKey[];
-
-  // Indicates whether the server said a match should be prefetched.
-  static const char kShouldPrefetchKey[];
-
-  // Used to store metadata from the server response, which is needed for
-  // prefetching.
-  static const char kSuggestMetadataKey[];
-
-  // Used to store a deletion request url for server-provided suggestions.
-  static const char kDeletionUrlKey[];
-
-  // These are the values for the above keys.
-  static const char kTrue[];
-  static const char kFalse[];
-
   // Maintains the TemplateURLs used.
   Providers providers_;
 
   // The user's input.
   AutocompleteInput input_;
 
   // Input when searching against the keyword provider.
   AutocompleteInput keyword_input_;
 
   // Searches in the user's history that begin with the input text.
@@ skipping 23 matching lines @@
   // that a server delete a personalized suggestion. Making this a ScopedVector
   // causes us to auto-cancel all such requests on shutdown.
   SuggestionDeletionHandlers deletion_handlers_;
 
   GURL current_page_url_;
 
   DISALLOW_COPY_AND_ASSIGN(SearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_SEARCH_PROVIDER_H_