Experimental AutocompleteProvider for zerosuggest.

chrome/browser/autocomplete/autocomplete_controller.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.
 
 #ifndef CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/string16.h"
 #include "base/timer.h"
 #include "chrome/browser/autocomplete/autocomplete_input.h"
 #include "chrome/browser/autocomplete/autocomplete_provider.h"
 #include "chrome/browser/autocomplete/autocomplete_provider_listener.h"
 #include "chrome/browser/autocomplete/autocomplete_result.h"
 
 class AutocompleteControllerDelegate;
 class KeywordProvider;
 class Profile;
 class SearchProvider;
+class ZeroSuggestProvider;
 
 // The AutocompleteController is the center of the autocomplete system.  A
 // class creates an instance of the controller, which in turn creates a set of
 // AutocompleteProviders to serve it.  The owning class can ask the controller
 // to Start() a query; the controller in turn passes this call down to the
 // providers, each of which keeps track of its own matches and whether it has
 // finished processing the query.  When a provider gets more matches or finishes
 // processing, it notifies the controller, which merges the combined matches
 // together and makes the result available to interested observers.
 //
@@ skipping 69 matching lines @@
              bool allow_exact_keyword_match,
              AutocompleteInput::MatchesRequested matches_requested);
 
   // Cancels the current query, ensuring there will be no future notifications
   // fired.  If new matches have come in since the most recent notification was
   // fired, they will be discarded.
   //
   // If |clear_result| is true, the controller will also erase the result set.
   void Stop(bool clear_result);
 
+  // Begin asynchronously fetching zero-suggest suggestions for |url|.
+  // |user_text| is the text entered in the omnibox, which may be non-empty if
+  // the user previously focused in the omnibox during this interaction.
+  // TODO(jered): Rip out |user_text| once the first match is decoupled from
+  // the current typing in the omnibox.
+  void StartZeroSuggest(const GURL& url, const string16& user_text);
+
+  // Cancels any pending zero-suggest fetch.
+  void StopZeroSuggest();
+
   // Asks the relevant provider to delete |match|, and ensures observers are
   // notified of resulting changes immediately.  This should only be called when
   // no query is running.
   void DeleteMatch(const AutocompleteMatch& match);
 
   // Removes any entries that were copied from the last result. This is used by
   // the popup to ensure it's not showing an out-of-date query.
   void ExpireCopiedEntries();
 
 #ifdef UNIT_TEST
@@ skipping 60 matching lines @@
 
   AutocompleteControllerDelegate* delegate_;
 
   // A list of all providers.
   ACProviders providers_;
 
   KeywordProvider* keyword_provider_;
 
   SearchProvider* search_provider_;
 
+  ZeroSuggestProvider* zero_suggest_provider_;
+
   // Input passed to Start.
   AutocompleteInput input_;
 
   // Data from the autocomplete query.
   AutocompleteResult result_;
 
   // Timer used to remove any matches copied from the last result. When run
   // invokes |ExpireCopiedEntries|.
   base::OneShotTimer<AutocompleteController> expire_timer_;
 
   // True if a query is not currently running.
   bool done_;
 
   // Are we in Start()? This is used to avoid updating |result_| and sending
   // notifications until Start() has been invoked on all providers.
   bool in_start_;
 
+  // Has StartZeroSuggest() been called but not Start()?
+  bool in_zero_suggest_;
+
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(AutocompleteController);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_