Part 4 of search provider refactoring.

chrome/browser/autocomplete/base_search_provider.h

 // Copyright 2014 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 class contains common functionality for search-based autocomplete
 // providers. Search provider and zero suggest provider both use it for common
 // functionality.
 
 #ifndef CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_
@@ skipping 21 matching lines @@
 // Base functionality for receiving suggestions from a search engine.
 // This class is abstract and should only be used as a base for other
 // autocomplete providers utilizing its functionality.
 class BaseSearchProvider : public AutocompleteProvider,
                            public net::URLFetcherDelegate {
  public:
   BaseSearchProvider(AutocompleteProviderListener* listener,
                      Profile* profile,
                      AutocompleteProvider::Type type);
 
+  // Returns whether |match| is flagged as a query that should be prefetched.
+  static bool ShouldPrefetch(const AutocompleteMatch& match);
+
   // AutocompleteProvider:
   virtual void AddProviderInfo(ProvidersInfo* provider_info) const OVERRIDE;
 
   bool field_trial_triggered_in_session() const {
     return field_trial_triggered_in_session_;
   }
 
  protected:
+  // 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[];
+
   virtual ~BaseSearchProvider();
 
   // The Result classes are intermediate representations of AutocompleteMatches,
   // simply containing relevance-ranked search and navigation suggestions.
   // They may be cached to provide some synchronous matches while requests for
   // new suggestions from updated input are in flight.
   // TODO(msw) Extend these classes to generate their corresponding matches and
   //           other requisite data, in order to consolidate and simplify the
   //           highly fragmented SearchProvider logic for each Result type.
   class Result {
@@ skipping 191 matching lines @@
     std::string metadata;
 
    private:
     DISALLOW_COPY_AND_ASSIGN(Results);
   };
 
   // Returns an AutocompleteMatch with the given |autocomplete_provider|
   // for the search |suggestion|, which represents a search via |template_url|.
   // If |template_url| is NULL, returns a match with an invalid destination URL.
   //
-  // |input_text| is the original user input.  This is used to highlight
+  // |input| is the original user input. Text in the input is used to highlight
   // portions of the match contents to distinguish locally-typed text from
   // suggested text.
   //
-  // |input| is necessary for various other details, like whether we should
+  // |input| is also necessary for various other details, like whether we should
   // allow inline autocompletion and what the transition type should be.
-  // |accepted_suggestion| and |omnibox_start_margin| are used along with
-  // |input_text| to generate Assisted Query Stats.
+  // |accepted_suggestion| and |omnibox_start_margin| are used to generate
+  // Assisted Query Stats.
   // |append_extra_query_params| should be set if |template_url| is the default
   // search engine, so the destination URL will contain any
   // command-line-specified query params.
   static AutocompleteMatch CreateSearchSuggestion(
       AutocompleteProvider* autocomplete_provider,
       const AutocompleteInput& input,
-      const base::string16& input_text,
       const SuggestResult& suggestion,
       const TemplateURL* template_url,
       int accepted_suggestion,
       int omnibox_start_margin,
       bool append_extra_query_params);
 
   // Parses JSON response received from the provider, stripping XSSI
   // protection if needed. Returns the parsed data if successful, NULL
   // otherwise.
   static scoped_ptr<base::Value> DeserializeJsonData(std::string json_data);
@@ skipping 20 matching lines @@
   //   especially if we want to support suggest providers other than Google, we
   //   may change this to be a standalone setting or part of some explicit
   //   general opt-in.
   static bool CanSendURL(
       const GURL& current_page_url,
       const GURL& suggest_url,
       const TemplateURL* template_url,
       AutocompleteInput::PageClassification page_classification,
       Profile* profile);
 
+  // Creates an AutocompleteMatch from |result| to search |template_url| for

[H Fung, 2014/02/13 22:52:39]

template_url and input are not parameters anymore.

[Maria, 2014/02/13 23:19:23]

Done.

+  // the query in |result|. Adds the created match to |map|; if such a match
+  // already exists, whichever one has lower relevance is eliminated.
+  // |input|, |metadata| and |accepted_suggestion| are used for generating an
+  // AutocompleteMatch.
+  void AddMatchToMap(const SuggestResult& result,
+                     const std::string& metadata,
+                     int accepted_suggestion,
+                     MatchMap* map);
+
+  // Returns the TemplateURL based on whether the |result| is from the default

[msw, 2014/02/13 22:47:18]

nit: consider "Returns the TemplateURL for the given |result|."
(discussing the implementation here doesn't seem helpful)

[Mark P, 2014/02/13 23:01:53]

I am okay with this suggestion.  (I mention this because I think Maria put in
this comment because of me.)

[Maria, 2014/02/13 23:19:23]

Done.

+  // provider or from the keyword provider.
+  virtual const TemplateURL* GetTemplateURL(
+      const SuggestResult& result) const = 0;
+
+  // Returns the AutocompleteInput based on whether the |result| is from the

[msw, 2014/02/13 22:47:18]

ditto nit: consider "Returns the AutocompleteInput for the given |result|."

[Mark P, 2014/02/13 23:01:53]

I disagree.  There's no natural notion for the AutocompleteInput for a given
result.  I prefer this comment as-is.

[msw, 2014/02/13 23:04:49]

That's a good point; this doesn't return the input from the time the Result was
constructed, but instead returns the current input corresponding to the result's
keyword/default source. Ignore my comment.

[Maria, 2014/02/13 23:19:23]

Done.

+  // default provider or from the keyword provider.
+  virtual const AutocompleteInput GetInput(
+      const SuggestResult& result) const = 0;
+
+  // Returns whether the destination URL corresponding to the given |result|
+  // should contain command-line-specified query params.
+  virtual bool ShouldAppendExtraParams(const SuggestResult& result) const = 0;
+
   // Whether a field trial, if any, has triggered in the most recent
   // autocomplete query. This field is set to true only if the suggestion
   // provider has completed and the response contained
   // '"google:fieldtrialtriggered":true'.
   bool field_trial_triggered_;
 
   // Same as above except that it is maintained across the current Omnibox
   // session.
   bool field_trial_triggered_in_session_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(BaseSearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_