Instant: Use only one hidden WebContents per profile.

chrome/browser/ui/search/search.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright 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_UI_SEARCH_SEARCH_H_
 #define CHROME_BROWSER_UI_SEARCH_SEARCH_H_
 
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/string16.h"
 
 class GURL;
+class PrefRegistrySyncable;
 class Profile;
 class TemplateURL;
 class TemplateURLRef;
 
 namespace content {
 class NavigationEntry;
 class WebContents;
 }
 
 namespace chrome {
 namespace search {
 
 // The key used to store search terms data in the NavigationEntry to be later
 // displayed in the omnibox. With the context of the user's exact query,
 // InstantController sets the correct search terms to be displayed.
 extern const char kInstantExtendedSearchTermsKey[];
 
 // The URL for the local omnibox popup (rendered in a WebContents).
 extern const char kLocalOmniboxPopupURL[];
 
-// The default value we should assign to the instant_extended.enabled pref.
-// As with other prefs, the default is used only when the user hasn't toggled
-// the pref explicitly.
-enum InstantExtendedDefault {
-  INSTANT_DEFAULT_ON,    // Default the pref to be enabled.
-  INSTANT_USE_EXISTING,  // Use the current value of the instant.enabled pref.
-  INSTANT_DEFAULT_OFF,   // Default the pref to be disabled.
-};
-
-// Returns an enum value indicating which mode to set the new
-// instant_extended.enabled pref to by default.
-InstantExtendedDefault GetInstantExtendedDefaultSetting();
-
 // Returns whether the Instant Extended API is enabled in this profile.
 bool IsInstantExtendedAPIEnabled(const Profile* profile);
 
 // Returns the value to pass to the &espv CGI parameter when loading the
 // embedded search page from the user's default search provider. Will be
 // 0 if the Instant Extended API is not enabled.
 uint64 EmbeddedSearchPageVersion(const Profile* profile);
 
 // Returns whether query extraction is enabled.
 bool IsQueryExtractionEnabled(const Profile* profile);
 
 // Returns the search terms attached to a specific NavigationEntry, or empty
 // string otherwise. Does not consider IsQueryExtractionEnabled(), so most
 // callers should use GetSearchTerms() below instead.
 string16 GetSearchTermsFromNavigationEntry(
     const content::NavigationEntry* entry);
 
 // Returns search terms if this WebContents is a search results page. It looks
 // in the visible NavigationEntry first, to see if search terms have already
 // been extracted. Failing that, it tries to extract search terms from the URL.
 // Returns a blank string if search terms were not found, or if search terms
 // extraction is disabled for this WebContents or profile.
 string16 GetSearchTerms(const content::WebContents* contents);
 
 // Returns true if |url| should be rendered in the Instant renderer process.
 bool ShouldAssignURLToInstantRenderer(const GURL& url, Profile* profile);
 
+// Registers Instant-related user preferences. Called at startup.
+void RegisterUserPrefs(PrefRegistrySyncable* registry);
+
+// Returns prefs::kInstantExtendedEnabled in extended mode;
+// prefs::kInstantEnabled otherwise.
+const char* GetInstantPrefName(const Profile* profile);
+
+// Returns whether the Instant pref (as per GetInstantPrefName()) is enabled.
+bool IsInstantPrefEnabled(Profile* profile);
+
+// Sets the default value of prefs::kInstantExtendedEnabled, based on field
+// trials and the current value of prefs::kInstantEnabled.
+void SetInstantExtendedPrefDefault(Profile* profile);
+
+// Returns the Instant URL of the default search engine. Returns an empty GURL
+// if the engine doesn't have an Instant URL, or if it shouldn't be used (say
+// because it doesn't satisfy the requirements for extended mode or if Instant
+// is disabled through preferences). Callers must check that the returned URL is
+// valid before using it.
+// NOTE: This method expands the default search engine's instant_url, so it
+// shouldn't be called from SearchTermsData or other such code that would lead
+// to an infinite recursion.
+GURL GetInstantURL(Profile* profile);
+
+// Instant (loading a remote server page and talking to it using the searchbox
+// API) is considered enabled if there's a valid Instant URL that can be used,
+// so this simply returns whether GetInstantURL() is a valid URL.
+// NOTE: This method expands the default search engine's instant_url, so it
+// shouldn't be called from SearchTermsData or other such code that would lead
+// to an infinite recursion.
+bool IsInstantEnabled(Profile* profile);
+
 // -----------------------------------------------------
 // The following APIs are exposed for use in tests only.
 // -----------------------------------------------------
 
 // Forces the Instant Extended API to be enabled for tests.
 void EnableInstantExtendedAPIForTesting();
 
 // Forces query extraction to be enabled for tests.
 void EnableQueryExtractionForTesting();
 
@@ skipping 39 matching lines @@
 
 // Coerces the commandline Instant URL to look like a template URL, so that we
 // can extract search terms from it.
 GURL CoerceCommandLineURLToTemplateURL(const GURL& instant_url,
                                        const TemplateURLRef& ref);
 
 }  // namespace search
 }  // namespace chrome
 
 #endif  // CHROME_BROWSER_UI_SEARCH_SEARCH_H_