autocomplete: Add AutocompleteProvider::Type enum.

chrome/browser/autocomplete/autocomplete_provider.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_provider.h"
 
 #include "base/logging.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/autocomplete/autocomplete_provider_listener.h"
 #include "chrome/browser/bookmarks/bookmark_model.h"
 #include "chrome/browser/bookmarks/bookmark_model_factory.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/common/url_constants.h"
 #include "googleurl/src/gurl.h"
 #include "googleurl/src/url_util.h"
 #include "net/base/net_util.h"
 
 // static
 const size_t AutocompleteProvider::kMaxMatches = 3;
 
+// static
+const char* AutocompleteProvider::TypeToString(Type type) {
+  switch (type) {
+    case TYPE_BUILTIN:
+      return "Builtin";
+    case TYPE_EXTENSION_APP:
+      return "ExtensionApps";
+    case TYPE_HISTORY_CONTENTS:
+      return "HistoryContents";
+    case TYPE_HISTORY_QUICK:
+      return "HistoryQuick";
+    case TYPE_HISTORY_URL:
+      return "HistoryURL";
+    case TYPE_KEYWORD:
+      return "Keyword";
+    case TYPE_SEARCH:
+      return "Search";
+    case TYPE_SHORTCUTS:
+      return "Shortcuts";
+    case TYPE_ZERO_SUGGEST:
+      return "ZeroSuggest";
+    default:
+      NOTREACHED() << "Unhandled AutocompleteProvider::Type " << type;
+      return "Unknown";
+  }
+}
+
 AutocompleteProvider::AutocompleteProvider(
     AutocompleteProviderListener* listener,
     Profile* profile,
-    const char* name)
+    Type type)
     : profile_(profile),
       listener_(listener),
       done_(true),
-      name_(name) {
+      type_(type) {
 }
 
 void AutocompleteProvider::Stop(bool clear_cached_results) {
   done_ = true;
 }
 
 metrics::OmniboxEventProto_ProviderType AutocompleteProvider::
     AsOmniboxEventProviderType() const {

[Peter Kasting, 2012/09/07 23:23:02]

Nit: Can this function at least move to the metrics code?

You can ask mpearson if there's any way to eliminate this entirely and just use
the AutocompleteProvider type enum directly.  (Or maybe the metrics code can
just cast one to the other and then we can use comments or assertions or both to
try and ensure the two stay in sync.)

[Daniel Erat, 2012/09/08 16:37:36]

SearchProvider::AddProviderInfo() is calling it, too.  Mind if I go with a TODO
for now?

[Mark P, 2012/09/08 22:31:07]

I don't think there's simplification we can do to this at the moment.  We can
change the proto type because it's going in logs and switching logging formats
is a headache (which we've already recently done).  When finally delete the old
XML logging format from the chrome source tree, we should be able to eliminate
AutocompleteProvider::Type entirely and use the proto enum everywhere.

-  if (name_ == "HistoryURL")
-    return metrics::OmniboxEventProto::HISTORY_URL;
-  if (name_ == "HistoryContents")
-    return metrics::OmniboxEventProto::HISTORY_CONTENTS;
-  if (name_ == "HistoryQuick")
-    return metrics::OmniboxEventProto::HISTORY_QUICK;
-  if (name_ == "Search")
-    return metrics::OmniboxEventProto::SEARCH;
-  if (name_ == "Keyword")
-    return metrics::OmniboxEventProto::KEYWORD;
-  if (name_ == "Builtin")
-    return metrics::OmniboxEventProto::BUILTIN;
-  if (name_ == "Shortcuts")
-    return metrics::OmniboxEventProto::SHORTCUTS;
-  if (name_ == "ExtensionApps")
-    return metrics::OmniboxEventProto::EXTENSION_APPS;
-
-  NOTREACHED();
-  return metrics::OmniboxEventProto::UNKNOWN_PROVIDER;
+  switch (type_) {
+    case TYPE_BUILTIN:
+      return metrics::OmniboxEventProto::BUILTIN;
+    case TYPE_EXTENSION_APP:
+      return metrics::OmniboxEventProto::EXTENSION_APPS;
+    case TYPE_HISTORY_CONTENTS:
+      return metrics::OmniboxEventProto::HISTORY_CONTENTS;
+    case TYPE_HISTORY_QUICK:
+      return metrics::OmniboxEventProto::HISTORY_QUICK;
+    case TYPE_HISTORY_URL:
+      return metrics::OmniboxEventProto::HISTORY_URL;
+    case TYPE_KEYWORD:
+      return metrics::OmniboxEventProto::KEYWORD;
+    case TYPE_SEARCH:
+      return metrics::OmniboxEventProto::SEARCH;
+    case TYPE_SHORTCUTS:
+      return metrics::OmniboxEventProto::SHORTCUTS;
+    case TYPE_ZERO_SUGGEST:
+      // TODO: Add to OmniboxEventProto::ProviderType.
+    default:
+      NOTREACHED() << "Unhandled AutocompleteProvider::Type " << type_;
+      return metrics::OmniboxEventProto::UNKNOWN_PROVIDER;
+  }
 }
 
 void AutocompleteProvider::DeleteMatch(const AutocompleteMatch& match) {
-  DLOG(WARNING) << "The AutocompleteProvider '" << name_
+  DLOG(WARNING) << "The AutocompleteProvider '" << name()
                 << "' has not implemented DeleteMatch.";
 }
 
 void AutocompleteProvider::AddProviderInfo(ProvidersInfo* provider_info) const {
 }
 
 string16 AutocompleteProvider::StringForURLDisplay(const GURL& url,
                                                    bool check_accept_lang,
                                                    bool trim_http) const {
   std::string languages = (check_accept_lang && profile_) ?
@@ skipping 24 matching lines @@
   if (!profile_)
     return;
 
   BookmarkModel* bookmark_model = BookmarkModelFactory::GetForProfile(profile_);
   if (!bookmark_model || !bookmark_model->IsLoaded())
     return;
 
   for (ACMatches::iterator i(matches_.begin()); i != matches_.end(); ++i)
     i->starred = bookmark_model->IsBookmarked(i->destination_url);
 }