autocomplete: Add AutocompleteProvider::Type enum.

chrome/browser/autocomplete/autocomplete_controller.cc

 // 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.
 
 #include "chrome/browser/autocomplete/autocomplete_controller.h"
 
 #include <set>
 #include <string>
 
 #include "base/command_line.h"
 #include "base/format_macros.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/string_number_conversions.h"
 #include "base/stringprintf.h"
 #include "base/time.h"
 #include "chrome/browser/autocomplete/autocomplete_controller_delegate.h"
 #include "chrome/browser/autocomplete/builtin_provider.h"
 #include "chrome/browser/autocomplete/extension_app_provider.h"
 #include "chrome/browser/autocomplete/history_contents_provider.h"
 #include "chrome/browser/autocomplete/history_quick_provider.h"
 #include "chrome/browser/autocomplete/history_url_provider.h"
-#include "chrome/browser/autocomplete/keyword_provider.h"
-#include "chrome/browser/autocomplete/search_provider.h"
 #include "chrome/browser/autocomplete/shortcuts_provider.h"
 #include "chrome/browser/autocomplete/zero_suggest_provider.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/chrome_switches.h"
 #include "content/public/browser/notification_service.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
@@ skipping 34 matching lines @@
 // providers (such as SearchProvider) wait for the user to stop typing before
 // they initiate a query.
 const int kExpireTimeMS = 500;
 
 }  // namespace
 
 const int AutocompleteController::kNoItemSelected = -1;
 
 AutocompleteController::AutocompleteController(
     Profile* profile,
-    AutocompleteControllerDelegate* delegate)
+    AutocompleteControllerDelegate* delegate,
+    int provider_types)
     : delegate_(delegate),
       keyword_provider_(NULL),
+      search_provider_(NULL),
       zero_suggest_provider_(NULL),
       done_(true),
       in_start_(false),
       in_zero_suggest_(false),
       profile_(profile) {
-  search_provider_ = new SearchProvider(this, profile);
-  providers_.push_back(search_provider_);
-#if !defined(OS_ANDROID)
-  // History quick provider is enabled on all platforms other than Android.
-  bool hqp_enabled = true;
-  providers_.push_back(new HistoryQuickProvider(this, profile));
-  // Search provider/"tab to search" is enabled on all platforms other than
-  // Android.
-  keyword_provider_ = new KeywordProvider(this, profile);
-  providers_.push_back(keyword_provider_);
-#else
-  // TODO(mrossetti): Remove the following and permanently modify the
-  // HistoryURLProvider to not search titles once HQP is turned on permanently.
+  // TODO(mrossetti): Permanently modify the HistoryURLProvider to not search
+  // titles once HQP is turned on permanently.
   // TODO(jcivelli): Enable the History Quick Provider and figure out why it
   // reports the wrong results for some pages.
-  bool hqp_enabled = false;
-#endif  // !OS_ANDROID
-  providers_.push_back(new HistoryURLProvider(this, profile));
-  providers_.push_back(new ShortcutsProvider(this, profile));
-  providers_.push_back(new HistoryContentsProvider(this, profile, hqp_enabled));
-  providers_.push_back(new BuiltinProvider(this, profile));
-  providers_.push_back(new ExtensionAppProvider(this, profile));
-  // Create ZeroSuggest if its switch is present.
+  bool use_hqp = false;
+#if !defined(OS_ANDROID)
+  // History quick provider can be used on all platforms other than Android.

[Peter Kasting, 2012/09/11 01:38:42]

Nit: I'd move this comment to just below the other comments.

[Daniel Erat, 2012/09/11 02:09:22]

Done.

+  if (provider_types & AutocompleteProvider::TYPE_HISTORY_QUICK)

[Peter Kasting, 2012/09/11 01:38:42]

Nit: Simpler:

  use_hqp = (provider_types & AutocompleteProvider::TYPE_HISTORY_QUICK);

(May force you to add !! to avoid compiler warning)

You may find it clearer to init the variable to this and then force to false
inside a subsequent OS_ANDROID block, I don't know.  Six of one, half a dozen of
the other.

[Daniel Erat, 2012/09/11 02:09:22]

Done.

+    use_hqp = true;
+#endif
+
+  if (provider_types & AutocompleteProvider::TYPE_BUILTIN)
+    providers_.push_back(new BuiltinProvider(this, profile));
+  if (provider_types & AutocompleteProvider::TYPE_EXTENSION_APP)
+    providers_.push_back(new ExtensionAppProvider(this, profile));
+  if (provider_types & AutocompleteProvider::TYPE_HISTORY_CONTENTS)
+    providers_.push_back(new HistoryContentsProvider(this, profile, use_hqp));
+#if !defined(OS_ANDROID)

[Peter Kasting, 2012/09/11 01:38:42]

Nit: No need for this #ifdef (handled above)

[Daniel Erat, 2012/09/11 02:09:22]

Ah.  I was thinking that we might not be compiling the class on Android, but
that doesn't make sense; we're including the header above.  Done.

+  if (use_hqp)
+    providers_.push_back(new HistoryQuickProvider(this, profile));
+#endif
+  if (provider_types & AutocompleteProvider::TYPE_HISTORY_URL)
+    providers_.push_back(new HistoryURLProvider(this, profile));
+#if !defined(OS_ANDROID)
+  if (provider_types & AutocompleteProvider::TYPE_KEYWORD) {
+    // Search provider/"tab to search" can be used on all platforms other than

[Peter Kasting, 2012/09/11 01:38:42]

Nit: I'd move this comment to just above the #ifdef.

[Daniel Erat, 2012/09/11 02:09:22]

Done.

+    // Android.
+    keyword_provider_ = new KeywordProvider(this, profile);
+    providers_.push_back(keyword_provider_);
+  }
+#endif
+  if (provider_types & AutocompleteProvider::TYPE_SEARCH) {
+    search_provider_ = new SearchProvider(this, profile);
+    providers_.push_back(search_provider_);
+  }
+  if (provider_types & AutocompleteProvider::TYPE_SHORTCUTS)
+    providers_.push_back(new ShortcutsProvider(this, profile));
+
   CommandLine* cl = CommandLine::ForCurrentProcess();
-  if (cl->HasSwitch(switches::kExperimentalZeroSuggestURLPrefix)) {
+  if ((provider_types & AutocompleteProvider::TYPE_ZERO_SUGGEST) &&
+      cl->HasSwitch(switches::kExperimentalZeroSuggestURLPrefix)) {
     zero_suggest_provider_ = new ZeroSuggestProvider(this, profile,
         cl->GetSwitchValueASCII(switches::kExperimentalZeroSuggestURLPrefix));
     providers_.push_back(zero_suggest_provider_);
   }
+
   for (ACProviders::iterator i(providers_.begin()); i != providers_.end(); ++i)
     (*i)->AddRef();
 }
 
 AutocompleteController::~AutocompleteController() {
   // The providers may have tasks outstanding that hold refs to them.  We need
   // to ensure they won't call us back if they outlive us.  (Practically,
   // calling Stop() should also cancel those tasks and make it so that we hold
   // the only refs.)  We also don't want to bother notifying anyone of our
   // result changes here, because the notification observer is in the midst of
@@ skipping 260 matching lines @@
     match->destination_url = GURL(template_url->url_ref().ReplaceSearchTerms(
         *match->search_terms_args));
   }
 }
 
 void AutocompleteController::UpdateKeywordDescriptions(
     AutocompleteResult* result) {
   string16 last_keyword;
   for (AutocompleteResult::iterator i(result->begin()); i != result->end();
        ++i) {
-    if ((i->provider == keyword_provider_ && !i->keyword.empty()) ||
-        (i->provider == search_provider_ &&
+    if ((i->provider->type() == AutocompleteProvider::TYPE_KEYWORD &&
+         !i->keyword.empty()) ||
+        (i->provider->type() == AutocompleteProvider::TYPE_SEARCH &&
          AutocompleteMatch::IsSearchType(i->type))) {
       i->description.clear();
       i->description_class.clear();
       DCHECK(!i->keyword.empty());
       if (i->keyword != last_keyword) {
         const TemplateURL* template_url = i->GetTemplateURL(profile_);
         if (template_url) {
           i->description = l10n_util::GetStringFUTF16(
               IDS_AUTOCOMPLETE_SEARCH_DESCRIPTION,
               template_url->AdjustedShortNameForLocaleDirection());
@@ skipping 29 matching lines @@
   }
   done_ = true;
 }
 
 void AutocompleteController::StartExpireTimer() {
   if (result_.HasCopiedMatches())
     expire_timer_.Start(FROM_HERE,
                         base::TimeDelta::FromMilliseconds(kExpireTimeMS),
                         this, &AutocompleteController::ExpireCopiedEntries);
 }