Omnibox: Prevent Asynchronous Suggestions from Changing Default Match

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 39 matching lines @@
   static const int kDeletionURLFetcherID;
 
   BaseSearchProvider(TemplateURLService* template_url_service,
                      Profile* profile,
                      AutocompleteProvider::Type type);
 
   // Returns whether |match| is flagged as a query that should be prefetched.
   static bool ShouldPrefetch(const AutocompleteMatch& match);
 
   // Returns a simpler AutocompleteMatch suitable for persistence like in
-  // ShortcutsDatabase.
+  // ShortcutsDatabase.  This wrapper function uses a number of default values
+  // that may or may not be appropriate for your needs.
   // NOTE: Use with care. Most likely you want the other CreateSearchSuggestion
   // with protected access.
   static AutocompleteMatch CreateSearchSuggestion(
       const base::string16& suggestion,
       AutocompleteMatchType::Type type,
       bool from_keyword_provider,
       const TemplateURL* template_url,
       const SearchTermsData& search_terms_data);
 
   // AutocompleteProvider:
@@ skipping 35 matching lines @@
   // 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| 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 also necessary for various other details, like whether we should
   // allow inline autocompletion and what the transition type should be.
+  // |in_keyword_mode| helps guarantee a non-keyword suggestion does not
+  // appear as the default match when the user is in keyword mode.
   // |accepted_suggestion| is 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 bool in_keyword_mode,
       const SearchSuggestionParser::SuggestResult& suggestion,
       const TemplateURL* template_url,
       const SearchTermsData& search_terms_data,
       int accepted_suggestion,
       bool append_extra_query_params);
 
   // Returns whether the requirements for requesting zero suggest results
   // are met. The requirements are
   // * The user is enrolled in a zero suggest experiment.
   // * The user is not on the NTP.
@@ skipping 40 matching lines @@
   // the key |kDeletionUrlKey|.
   void SetDeletionURL(const std::string& deletion_url,
                       AutocompleteMatch* match);
 
   // Creates an AutocompleteMatch from |result| to search for the query in
   // |result|. Adds the created match to |map|; if such a match
   // already exists, whichever one has lower relevance is eliminated.
   // |metadata| and |accepted_suggestion| are used for generating an
   // AutocompleteMatch.
   // |mark_as_deletable| indicates whether the match should be marked deletable.
+  // |in_keyword_mode| helps guarantee a non-keyword suggestion does not
+  // appear as the default match when the user is in keyword mode.
   // NOTE: Any result containing a deletion URL is always marked deletable.
   void AddMatchToMap(const SearchSuggestionParser::SuggestResult& result,
                      const std::string& metadata,
                      int accepted_suggestion,
                      bool mark_as_deletable,
+                     bool in_keyword_mode,
                      MatchMap* map);
 
   // Parses results from the suggest server and updates the appropriate suggest
   // and navigation result lists in |results|. |default_result_relevance| is
   // the relevance to use if it was not explicitly set by the server.
   // |is_keyword_result| indicates whether the response was received from the
   // keyword provider.
   // Returns whether the appropriate result list members were updated.
   bool ParseSuggestResults(const base::Value& root_val,
                            int default_result_relevance,
@@ skipping 55 matching lines @@
 
   // Each deletion handler in this vector corresponds to an outstanding request
   // that a server delete a personalized suggestion. Making this a ScopedVector
   // causes us to auto-cancel all such requests on shutdown.
   SuggestionDeletionHandlers deletion_handlers_;
 
   DISALLOW_COPY_AND_ASSIGN(BaseSearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_